9.0
general documentation
Loading...
Searching...
No Matches
Predefined function objects

Variables

char * mpi_rank_id_cells
char * mpi_rank_id_interior_faces
char * mpi_rank_id_boundary_faces
char * mpi_rank_id_vertices
char * r_gen_cells
char * r_gen_interior_faces
char * r_gen_boundary_faces
char * r_gen_vertices
char * boundary_zone_class_id
char * boundary_stress
char * boundary_stress_normal
char * boundary_stress_tangential
char * boundary_thermal_flux
char * boundary_nusselt
char * relative_pressure
char * relative_velocity
char * absolute_pressure
char * absolute_velocity
char * elec_pot_gradient_im
char * elec_current_gradient_im
char * elec_pot_module
char * elec_pot_arg
char * q_criterion

Detailed Description

Note that a function object of a given name may always be accessed using cs_function_by_name.

Variable Documentation

◆ absolute_pressure

char* absolute_pressure

Absolute pressure (at cells) with Corilolis forces.

Automatically activated when Coriolis forces are present.

◆ absolute_velocity

char* absolute_velocity

Absolute velocity (at cells) with Coriolis forces.

Automatically activated when Coriolis forces are present.

◆ boundary_nusselt

char* boundary_nusselt

Boundary layer Nusselt number. This is based only on the near-boundary temperature value and heat flux, so does not require a bulk temperature value but is not a "true" Nusselt number computation, as the fluid value used may be sensitive to mesh refinement.

Accessed or activated using:

cs_function_t * cs_function_define_boundary_nusselt(void)
Define function for computation of boundary layer Nusselt.
Definition cs_function_default.cpp:976

◆ boundary_stress

char* boundary_stress

Stress exerted by fluid forces over boundary. Activating this function also leads to the creation of the "boundary_stress" field, used to store and update the boundary stress vector.

Accessed or activated using:

cs_function_define_boundary_stress();

◆ boundary_stress_normal

char* boundary_stress_normal

Normal component of the stress exerted by fluid forces over boundary. Activating this function also leads to the creation of the "boundary_stress" field, used to store and update the boundary stress vector.

Accessed or activated using:

cs_function_t * cs_function_define_boundary_stress_normal(void)
Define function object for computation of normal boundary stress.
Definition cs_function_default.cpp:854

◆ boundary_stress_tangential

char* boundary_stress_tangential

Tangential component of the stress exerted by fluid forces over boundary. Activating this function also leads to the creation of the "boundary_stress" field, used to store and update the boundary stresses.

Accessed or activated using:

cs_function_t * cs_function_define_boundary_stress_tangential(void)
Define function object for computation of tangential boundary stress.
Definition cs_function_default.cpp:888

◆ boundary_thermal_flux

char* boundary_thermal_flux

Thermal flux density over the boundary. Incoming thermal flux leads to a positive sign; outgoing thermal flux to a negative sign.

Accessed or activated using:

cs_function_t * cs_function_define_boundary_thermal_flux(void)
Define function object for computation of boundary thermal flux.
Definition cs_function_default.cpp:922

◆ boundary_zone_class_id

char* boundary_zone_class_id

Optional boundary face class or zone ids. If no face classes have been defined by cs_boundary_zone_face_class_id, the boundary face zone id is used instead.

Activated by default.

◆ elec_current_gradient_im

char* elec_current_gradient_im

For Joule Heating by direct conduction, imaginary component of the current density

Automatically activated when Joule Heating by direct conduction is active cs_glob_physical_model_flag[CS_JOULE_EFFECT] == 2 or 4.

◆ elec_pot_arg

char* elec_pot_arg

For Joule Heating by direct conduction, argument of the complexe potential.

Automatically activated when Joule Heating by direct conduction is active cs_glob_physical_model_flag[CS_JOULE_EFFECT] == 4.

◆ elec_pot_gradient_im

char* elec_pot_gradient_im

For Joule Heating by direct conduction, gradient of the imaginary component of the potential.

Automatically activated when Joule Heating by direct conduction is active cs_glob_physical_model_flag[CS_JOULE_EFFECT] == 2 or 4.

◆ elec_pot_module

char* elec_pot_module

For Joule Heating by direct conduction, module of the complexe potential.

Automatically activated when Joule Heating by direct conduction is active cs_glob_physical_model_flag[CS_JOULE_EFFECT] == 4.

◆ mpi_rank_id_boundary_faces

char* mpi_rank_id_boundary_faces

MPI rank id to which boundary faces are assigned. This rank is always the same as the adjacent cell.

Accessed or activated using:

cs_function_t * cs_function_define_mpi_rank_id(cs_mesh_location_type_t location_id)
Create or access a function for evaluation of element's MPI rank id.
Definition cs_function_default.cpp:736
@ CS_MESH_LOCATION_BOUNDARY_FACES
Definition cs_mesh_location.h:65

◆ mpi_rank_id_cells

char* mpi_rank_id_cells

MPI rank id to which a cell is assigned.

Accessed or activated using:

@ CS_MESH_LOCATION_CELLS
Definition cs_mesh_location.h:63

◆ mpi_rank_id_interior_faces

char* mpi_rank_id_interior_faces

MPI rank id to which interior faces are assigned. Interior faces at parallel boundaries are seen from 2 domains, but may be assigned specifically to one domain when range sets (cs_range_set_t) are used. If no range set has already been assigned to interior faces, a default one (ignoring periodicity) is used. Otherwise (such as when using CDO face-based schemes), the one actually used for computation is used.

Accessed or activated using:

@ CS_MESH_LOCATION_INTERIOR_FACES
Definition cs_mesh_location.h:64

◆ mpi_rank_id_vertices

char* mpi_rank_id_vertices

MPI rank id to which vertices are assigned. Vertices at parallel boundaries are seen from multiple, but may be assigned specifically to one domain when range sets (cs_range_set_t) are used. If no range set has already been assigned to vertices, a default one (ignoring periodicity) is used. Otherwise (such as when using CDO vertex-based schemes), the one actually used for computation is used.

Accessed or activated using:

@ CS_MESH_LOCATION_VERTICES
Definition cs_mesh_location.h:66

◆ q_criterion

char* q_criterion

Compute the Q criterion from Hunt et. al.

\[  Q = \tens{\Omega}:\tens{\Omega} -
  \deviator{ \left(\tens{S} \right)}:\deviator{ \left(\tens{S} \right)}
\]

where $\tens{\Omega}$ is the vorticity tensor and $\deviator{ \left(\tens{S} \right)}$ the deviatoric of the rate of strain tensor.

Accessed or activated using:

cs_function_t * cs_function_define_q_criterion(void)
Define function for computation of cell Q criterion.
Definition cs_function_default.cpp:1036

◆ r_gen_boundary_faces

char* r_gen_boundary_faces

Refinement generation of boundary faces. This should always be that of the adjacent cell.

Accessed or activated using:

cs_function_t * cs_function_define_refinement_generation(cs_mesh_location_type_t location_id)
Create or access a function for evaluation of mesh element's refinement generation (i....
Definition cs_function_default.cpp:799

◆ r_gen_cells

char* r_gen_cells

Refinement generation of mesh cells. This is considered to be the highest refinement level of adjacent interior faces.

Accessed or activated using:

◆ r_gen_interior_faces

char* r_gen_interior_faces

Refinement generation of interior faces. This is determined and stored when refining or coarsening a mesh. A refined face's sub-faces have the same refinement generation as their parent. Faces added in the course of refinement (i.e. faces separating sub-cells) have a refinement level one higher than the parent cell.

Accessed or activated using:

◆ r_gen_vertices

char* r_gen_vertices

Refinement generation of vertices. This is determined and stored when refining or coarsening a mesh.

Accessed or activated using:

◆ relative_pressure

char* relative_pressure

Relative pressure (at cells) for turbomachinery computations.

Automatically activated for turbomachinery computations.

◆ relative_velocity

char* relative_velocity

Relative velocity (at cells) for turbomachinery computations.

Automatically activated for turbomachinery computations.