My Project
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
char *restrict name
 
cs_equation_type_t type
 
int dim
 
int 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
 
int n_bc_defs
 
cs_xdef_t ** bc_defs
 
cs_param_bc_enforce_t default_enforcement
 
cs_real_t strong_pena_bc_coeff
 
cs_real_t weak_pena_bc_coeff
 
Numerical settings for the time-dependent parameters
int n_ic_defs
 
cs_xdef_t ** ic_defs
 
bool do_lumping
 
cs_param_hodge_t time_hodge
 
cs_property_ttime_property
 
cs_param_time_scheme_t time_scheme
 
cs_real_t theta
 
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_real_t upwind_portion
 
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
 
Enforcement of values in the computational domain

Assign a values to a selection of degrees of freedom inside the domain This is different from the enforcement of boundary conditions but rely on the same algebraic manipulation.

cs_lnum_t n_enforced_dofs
 
cs_lnum_tenforced_dof_ids
 
cs_real_tenforced_dof_values
 
Settings related to the resolution of the algebraic system
cs_param_sles_t sles_param
 
Settings related to the optimization of the performance
cs_param_assemble_omp_strategy_t omp_assembly_choice
 

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 cs_adv_field_t 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:

◆ default_enforcement

default_enforcement

Type of strategy to enforce an essential boundary conditions (Dirichlet for instance) when no predefined strategy is prescribed. See cs_param_bc_enforce_t for more details.

◆ 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

Set to true or false. Activate several actions: Perform a mass lumping of the matrices related to the time and reaction discretization. All source terms are evaluated using a barycentric quadrature.

◆ dof_reduction

cs_param_dof_reduction_t dof_reduction

How is defined DoF

◆ enforced_dof_ids

enforced_dof_ids

List of related DoF ids

◆ enforced_dof_values

enforced_dof_values

List of related values to enforce

◆ 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

◆ n_bc_defs

n_bc_defs

Number of boundary conditions which are defined for this equation

◆ n_enforced_dofs

n_enforced_dofs

Number of degrees of freedom (DoFs) to enforce

◆ 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.

◆ name

char* restrict name

name of the equation

◆ omp_assembly_choice

omp_assembly_choice

When OpenMP is active, choice of parallel reduction for the assembly

◆ 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_param

sles_param

Set of parameters to specify how to to solve the algebraic

  • iterative solver
  • preconditionner
  • tolerance...

◆ 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

◆ strong_pena_bc_coeff

strong_pena_bc_coeff

Value of the penalization coefficient used to enforce the Dirichlet boundary conditions when CS_PARAM_BC_ENFORCE_PENALIZED is set. This value should be sufficiently large in order to neglect off-diagonal terms.

◆ 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...

◆ upwind_portion

upwind_portion

Value between 0. and 1. (0: centered scheme, 1: pure upwind scheme) Introduce a constant portion of upwinding in a centered scheme Only useful if the advection scheme is set to

◆ verbosity

int verbosity

Level of detail for output

◆ weak_pena_bc_coeff

weak_pena_bc_coeff

Value of the penalization coefficient used to enforce the Dirichlet boundary condition when CS_PARAM_BC_ENFORCE_WEAK_NITSCHE or CS_PARAM_BC_ENFORCE_WEAK_SYM is set. This two latter strategies have a lesser influence on the conditioning number of the linear system than the choice CS_PARAM_BC_ENFORCE_PENALIZED


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