#include <cs_equation_common.h>

Collaboration diagram for cs_equation_builder_t:

Data Fields
bool	init_step

Flags to know what to build and how to build such terms
cs_eflag_t	msh_flag

cs_eflag_t	bd_msh_flag

cs_eflag_t	st_msh_flag

cs_flag_t	sys_flag

Metadata related to associated physical properties
bool	diff_pty_uniform

bool	curlcurl_pty_uniform

bool	graddiv_pty_uniform

bool	time_pty_uniform

bool	reac_pty_uniform [CS_CDO_N_MAX_REACTIONS]

Source terms
cs_mask_t *	source_mask

cs_source_term_cellwise_t *	compute_source [CS_N_MAX_SOURCE_TERMS]

User hook
void *	user_hook_context

cs_equation_user_hook_t *	user_hook_function

Boundary conditions
cs_cdo_bc_face_t *	face_bc

Performance monitoring
Monitoring the efficiency of the algorithm used to manipulate/build an equation.
cs_timer_counter_t	tcb

cs_timer_counter_t	tcs

cs_timer_counter_t	tce

Field Documentation

◆ bd_msh_flag

cs_eflag_t bd_msh_flag

Information related to what to build in a cs_cell_mesh_t structure for a cell close to the boundary

◆ compute_source

compute_source

Pointer to functions which compute the value of the source term

◆ curlcurl_pty_uniform

bool curlcurl_pty_uniform

Is curl-curl property uniform ?

◆ diff_pty_uniform

bool diff_pty_uniform

Is diffusion property uniform ?

◆ face_bc

face_bc

Information about boundary conditions applied to faces

face_bc should not change during the simulation. The case of a definition of the BCs which changes of type during the simulation is possible but not implemented. You just have to call the initialization step each time the type of BCs is modified to define an updated cs_cdo_bc_face_t structure.

◆ graddiv_pty_uniform

bool graddiv_pty_uniform

Is grad-div property uniform ?

◆ init_step

bool init_step

true if this is the initialization step

◆ msh_flag

cs_eflag_t msh_flag

Information related to what to build in a cs_cell_mesh_t structure for a generic cell

◆ reac_pty_uniform

bool reac_pty_uniform[CS_CDO_N_MAX_REACTIONS]

Is each reaction property uniform ?

◆ source_mask

cs_mask_t* source_mask

NULL if no source term or one source term is defined. Allocated to n_cells in order to know in each cell which source term has to be computed

◆ st_msh_flag

cs_eflag_t st_msh_flag

Information related to what to build in a cs_cell_mesh_t structure when only the source term has to be built

◆ sys_flag

cs_flag_t sys_flag

Information related to the sytem

◆ tcb

cs_timer_counter_t tcb

Cumulated elapsed time for building the current system

◆ tce

cs_timer_counter_t tce

Cumulated elapsed time for computing all extra operations (post, balance, fluxes...)

◆ tcs

cs_timer_counter_t tcs

Cumulated elapsed time for solving the current system

◆ time_pty_uniform

bool time_pty_uniform

Is time property uniform ?

◆ user_hook_context

user_hook_context

Pointer to a shared structure (the lifecycle of this structure is not managed by the current cs_equation_builder_t structure)

◆ user_hook_function

user_hook_function

Function pointer associated to a predefined prototype This function enables a user to modify the cellwise system (matrix and rhs) before applying the time scheme, the static condensation if needed or the strong/penalized enforcement of boundary conditions. This is useful to add a term in the equation like an advanced source term without the need to allocate an array and with an access to the local structure such as the local cell mesh, the cell builder and the high-level structures related to an equation

The documentation for this struct was generated from the following file:

src/cdo/cs_equation_common.h

Data Fields