programmer's documentation
cs_equation_param_t Struct Reference

Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources. More...

#include <cs_equation_param.h>

Collaboration diagram for cs_equation_param_t:
Collaboration graph

Data Fields

General settings
cs_equation_type_t type
 
int dim
 
int verbosity
 
int sles_verbosity
 
cs_flag_t flag
 
cs_flag_t process_flag
 
cs_param_space_scheme_t space_scheme
 
cs_param_dof_reduction_t dof_reduction
 
int space_poly_degree
 
Settings for the boundary conditions
cs_param_bc_type_t default_bc
 
cs_param_bc_enforce_t enforcement
 
int n_bc_defs
 
cs_xdef_t ** bc_defs
 
Settings related to the resolution of the algebraic system
cs_equation_solver_class_t solver_class
 
cs_param_itsol_t itsol_info
 
Numerical settings for the time-dependent parameters
cs_param_hodge_t time_hodge
 
cs_property_ttime_property
 
cs_param_time_scheme_t time_scheme
 
cs_real_t theta
 
bool do_lumping
 
int n_ic_defs
 
cs_xdef_t ** ic_defs
 
Numerical settings for the diffusion term
cs_param_hodge_t diffusion_hodge
 
cs_property_tdiffusion_property
 
Numerical settings for the advection term
cs_param_advection_form_t adv_formulation
 
cs_param_advection_scheme_t adv_scheme
 
cs_adv_field_tadv_field
 
Numerical settings for the reaction term

The contribution of a reaction term to the algebraic system is either at the left-hand and/or right-hand side according to the choice of time scheme

cs_param_hodge_t reaction_hodge
 
int n_reaction_terms
 
cs_property_t ** reaction_properties
 
Definition of the related source terms

The contribution of a source term to the algebraic system is always at right-hand side whatever is the choice of time scheme

int n_source_terms
 
cs_xdef_t ** source_terms
 

Detailed Description

Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources.

Field Documentation

◆ adv_field

adv_field

Pointer to the structure associated to the advection term

◆ adv_formulation

adv_formulation

Type of formulation (conservative, non-conservative...) for the advective term

◆ adv_scheme

adv_scheme

Numerical scheme used for the discretization of the advection term

◆ bc_defs

bc_defs

Pointers to the definitions of the boundary conditions

◆ default_bc

default_bc

Default boundary condition related to this equation. Valid choices:

◆ diffusion_hodge

diffusion_hodge

Set of parameters for the discrete Hodge operator related to the diffusion

◆ diffusion_property

diffusion_property

Pointer to the property related to the diffusion term

◆ dim

int dim

Dimension of the unknown

◆ do_lumping

do_lumping

Perform a mass lumping on the matrix related to the time discretization.

  • true or false

◆ dof_reduction

cs_param_dof_reduction_t dof_reduction

How is defined DoF

◆ enforcement

enforcement

Type of enforcement for the Dirichlet boundary conditions. See cs_param_bc_enforce_t for more details.

◆ flag

flag

Flag to know if unsteady or diffusion or convection or reaction or source term are activated or not

◆ ic_defs

ic_defs

List of pointers to the definition of the inititial condition

◆ itsol_info

itsol_info

Set of parameters to specify how to to solve the algebraic

  • iterative solver
  • preconditionner
  • tolerance...

◆ n_bc_defs

n_bc_defs

Number of boundary conditions which are defined for this equation

◆ n_ic_defs

n_ic_defs

Number of definitions for setting the intial condition

◆ n_reaction_terms

n_reaction_terms

Number of reaction terms to consider.

◆ n_source_terms

n_source_terms

Number of source terms to consider.

◆ process_flag

process_flag

Flag to known if predefined post-treatments such as Peclet, are requested

◆ reaction_hodge

reaction_hodge

Set of parameters for the discrete Hodge operator related to the reaction terms

◆ reaction_properties

reaction_properties

List of properties associated to each reaction term

◆ sles_verbosity

int sles_verbosity

Level of detail for SLES output

◆ solver_class

solver_class

Class of solver available to solve the algebraic system

◆ source_terms

source_terms

List of definition of each source term

◆ space_poly_degree

space_poly_degree

Maximum degree of the polynomial basis

◆ space_scheme

Space discretization scheme

◆ theta

theta

Value of the coefficient for a theta scheme (between 0 and 1)

◆ time_hodge

time_hodge

Set of parameters for the discrete Hodge operator related to the unsteady term

◆ time_property

time_property

Pointer to the cs_property_t structure related to the unsteady term

◆ time_scheme

time_scheme

Type of numerical scheme used for the time discretization

◆ type

type of equation: predefined...

◆ verbosity

int verbosity

Level of detail for output


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