cs_equation_t Struct Reference

#include <cs_equation_priv.h>

Collaboration diagram for cs_equation_t:

Data Fields
Metadata
int	id
char *restrict	varname
int	field_id
int	boundary_flux_id
int	main_ts_id
cs_equation_param_t *	param
Generic pointers to manage a cs_equation_t structure
Since each space discretization has its specificities, an operation is associated to a function pointer which is set during the setup phase according to the space discretization and then one calls this operation without the need to test in which case we are.
cs_equation_builder_t *	builder
void *	scheme_context
cs_equation_init_context_t *	init_context
cs_equation_free_context_t *	free_context
cs_equation_init_values_t *	init_field_values
cs_equation_solve_t *	solve_steady_state
cs_equation_solve_t *	solve
cs_equation_get_balance_t *	compute_balance
cs_equation_apply_sitffness_t *	apply_stiffness
cs_equation_extra_op_t *	postprocess
cs_equation_extra_op_t *	current_to_previous
cs_equation_restart_t *	read_restart
cs_equation_restart_t *	write_restart
cs_equation_get_values_t *	get_cell_values
cs_equation_get_values_t *	get_face_values
cs_equation_get_values_t *	get_edge_values
cs_equation_get_values_t *	get_vertex_values
cs_equation_get_builders_t *	get_cw_build_structures
cs_equation_set_dir_bc_t *	set_dir_bc
cs_equation_build_system_t *	build_system
cs_equation_prepare_solve_t *	prepare_solving
cs_equation_update_field_t *	update_field

Field Documentation

apply_stiffness

cs_equation_apply_sitffness_t* apply_stiffness

Pointer of function given by the prototype cs_equation_apply_sitffness_t

boundary_flux_id

int boundary_flux_id

Id to the field storing the boundary flux asociated to variable field

build_system

cs_equation_build_system_t* build_system

Common members for building the algebraic system between the numerical schemes

builder

cs_equation_builder_t* builder

Common members for building the algebraic system between the numerical schemes

compute_balance

cs_equation_get_balance_t* compute_balance

Pointer of function given by the prototype cs_equation_get_balance_t

current_to_previous

cs_equation_extra_op_t* current_to_previous

Pointer of function given by the prototype cs_equation_extra_op_t

field_id

int field_id

Id of the variable field related to this equation (cf. cs_field_t)

free_context

cs_equation_free_context_t* free_context

Pointer of function given by the prototype cs_equation_free_context_t

get_cell_values

cs_equation_get_values_t* get_cell_values

Pointer of function given by the prototype cs_equation_get_values_t

get_cw_build_structures

cs_equation_get_builders_t* get_cw_build_structures

Retrieve local structures used to build the algebraic system. Pointer of function given by the prototype cs_equation_get_builders_t

get_edge_values

cs_equation_get_values_t* get_edge_values

Pointer of function given by the prototype cs_equation_get_values_t

get_face_values

cs_equation_get_values_t* get_face_values

Pointer of function given by the prototype cs_equation_get_values_t

get_vertex_values

cs_equation_get_values_t* get_vertex_values

Pointer of function given by the prototype cs_equation_get_values_t

id

int id

Id of the current equation

init_context

cs_equation_init_context_t* init_context

Pointer of function given by the prototype cs_equation_init_context_t

init_field_values

cs_equation_init_values_t* init_field_values

Pointer of function given by the prototype cs_equation_init_values_t

main_ts_id

int main_ts_id

Id of the main timer stats for this equation

param

cs_equation_param_t* param

Set of parameters related to an equation

postprocess

cs_equation_extra_op_t* postprocess

Additional predefined post-processing. Pointer of function given by the prototype cs_equation_extra_op_t

prepare_solving

cs_equation_prepare_solve_t* prepare_solving

Common members for building the algebraic system between the numerical schemes

read_restart

cs_equation_restart_t* read_restart

Pointer of function given by the prototype cs_equation_restart_t

scheme_context

void* scheme_context

Data depending on the numerical scheme (cast on-the-fly)

set_dir_bc

cs_equation_set_dir_bc_t* set_dir_bc

Common members for building the algebraic system between the numerical schemes

solve

cs_equation_solve_t* solve

Pointer to a function given by the generic prototype cs_equation_solve_t Case of an unsteady solution

solve_steady_state

cs_equation_solve_t* solve_steady_state

Case of steady-state solution. Pointer of function given by the prototype cs_equation_solve_t

update_field

cs_equation_update_field_t* update_field

Common members for building the algebraic system between the numerical schemes

varname

char* restrict varname

Name of the field of type variable associated to this equation

write_restart

cs_equation_restart_t* write_restart

Pointer of function given by the prototype cs_equation_restart_t

---

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

• src/cdo/cs_equation_priv.h