My Project
programmer's documentation
Functions
cs_mesh_deform.h File Reference
#include "cs_defs.h"
#include "cs_domain.h"
#include "cs_mesh.h"
Include dependency graph for cs_mesh_deform.h:

Go to the source code of this file.

Functions

bool cs_mesh_deform_is_activated (void)
 Test if mesh deformation is activated. More...
 
void cs_mesh_deform_activate (void)
 Activate the future mesh deformation. More...
 
void cs_mesh_deform_define_dirichlet_bc_zones (cs_lnum_t n_boundary_zones, const int boundary_zone_ids[])
 Define the boundary zones on which mesh deformation is prescribed. More...
 
void cs_mesh_deform_setup (cs_domain_t *domain)
 Setup the equations related to mesh deformation. More...
 
void cs_mesh_deform_prescribe_displacement (cs_lnum_t n_vertices, const cs_lnum_t vertex_ids[], const cs_real_3_t displacement[])
 Prescribe the displacement vector for a set of vertices. More...
 
void cs_mesh_deform_force_displacements (cs_lnum_t n_vertices, const cs_lnum_t vertex_ids[], const cs_real_3_t displacement[])
 Define a fixed displacement vector for given vertices. More...
 
void cs_mesh_deform_solve_displacement (cs_domain_t *domain)
 Compute displacement for mesh deformation. More...
 
const cs_real_3_tcs_mesh_deform_get_displacement (void)
 Return pointer to current mesh displacement vector. More...
 
void cs_mesh_deform_finalize (void)
 Free structures used fo mesh deformation. More...
 

Function Documentation

◆ cs_mesh_deform_activate()

void cs_mesh_deform_activate ( void  )

Activate the future mesh deformation.

◆ cs_mesh_deform_define_dirichlet_bc_zones()

void cs_mesh_deform_define_dirichlet_bc_zones ( cs_lnum_t  n_boundary_zones,
const int  boundary_zone_ids[] 
)

Define the boundary zones on which mesh deformation is prescribed.

Only those values at vertices matching boundary zones with prescribed displacement will really be used.

Parameters
[in]n_boundary_zonesnumber of boundary zones at which to prescribe displacements
[in]boundary_zone_idsids of boundary zones at which to prescribe displacements

◆ cs_mesh_deform_finalize()

void cs_mesh_deform_finalize ( void  )

Free structures used fo mesh deformation.

◆ cs_mesh_deform_force_displacements()

void cs_mesh_deform_force_displacements ( cs_lnum_t  n_vertices,
const cs_lnum_t  vertex_ids[],
const cs_real_3_t  displacement[] 
)

Define a fixed displacement vector for given vertices.

This displacement is enforced at all given vertices, including interior vertices.

If this function is called multiple times, the previous definitions are overwritten, so all displacements of this type must be defined in a single call to this function.

Parameters
[in]n_verticesnumber of vertices at which to prescribe displacements
[in]vertex_idsids of vertices at which to prescribe displacements, or NULL if [0, ... n_vertices-1]
[in]displacementpointer to prescribed displacements, or NULL for no displacement

◆ cs_mesh_deform_get_displacement()

const cs_real_3_t* cs_mesh_deform_get_displacement ( void  )

Return pointer to current mesh displacement vector.

Returns
pointer to current displacement vector

◆ cs_mesh_deform_is_activated()

bool cs_mesh_deform_is_activated ( void  )

Test if mesh deformation is activated.

Returns
true if mesh deformation computation is requested, false otherwise

◆ cs_mesh_deform_prescribe_displacement()

void cs_mesh_deform_prescribe_displacement ( cs_lnum_t  n_vertices,
const cs_lnum_t  vertex_ids[],
const cs_real_3_t  displacement[] 
)

Prescribe the displacement vector for a set of vertices.

Only those values at vertices matching boundary zones with prescribed displacement will really be used, as defined by cs_mesh_deform_define_dirichlet_bc_zones.

When calling this function multiple times for different vertex sets, the most recently defined values are used for vertices belonging to multiple sets.

Parameters
[in]n_verticesnumber of vertices at which to prescribe displacements
[in]vertex_idsids of vertices at which to prescribe displacements, or NULL if [0, ... n_vertices-1]
[in]displacementpointer to prescribed displacements

◆ cs_mesh_deform_setup()

void cs_mesh_deform_setup ( cs_domain_t domain)

Setup the equations related to mesh deformation.

Parameters
[in,out]domainpointer to a cs_domain_t structure

◆ cs_mesh_deform_solve_displacement()

void cs_mesh_deform_solve_displacement ( cs_domain_t domain)

Compute displacement for mesh deformation.

Parameters
[in,out]domainpointer to a cs_domain_t structure