8.3
general documentation
cs_navsto_param_t Struct Reference

Structure storing the parameters related to the resolution of the Navier-Stokes system. More...

#include <cs_navsto_param.h>

+ Collaboration diagram for cs_navsto_param_t:

Data Fields

cs_real_t delta_thermal_tolerance
 
int n_max_outer_iter
 
Physical modelling

Which equations to solve ? Properties and their related fields are allocated according to the choice of model for Navier-Stokes

cs_navsto_param_model_t model
 
cs_navsto_param_model_flag_t model_flag
 
cs_turbulence_param_tturbulence
 
Properties and fields related to the Navier-Stokes module
cs_physical_constants_tphys_constants
 
cs_property_tmass_density
 
cs_property_ttot_viscosity
 
cs_property_tlam_viscosity
 
Numerical options

Set of numerical options to build the linear system and how to solve it

cs_param_dof_reduction_t dof_reduction_mode
 
cs_navsto_param_coupling_t coupling
 
cs_param_space_scheme_t space_scheme
 
int n_boussinesq_terms
 
cs_navsto_param_boussinesq_tboussinesq_param
 
Non-linear algorithm

Set of parameters to drive the resolution of the non-linearity arising from the Navier–Stokes system

cs_param_nl_algo_t nl_algo_type
 
cs_param_convergence_t nl_cvg_param
 
cs_iter_algo_param_aac_t anderson_param
 
Output
int verbosity
 
cs_navsto_param_post_flag_t post_flag
 
Initial conditions (IC)

Set of parameters used to take into account the initial condition on the pressure and/or the velocity. CAUTION: so far, there is no check if the different IC are compatible with the boundary conditions for instance

bool velocity_ic_is_owner
 
int n_velocity_ic_defs
 
cs_xdef_t ** velocity_ic_defs
 
bool pressure_ic_is_owner
 
int n_pressure_ic_defs
 
cs_xdef_t ** pressure_ic_defs
 
Boundary conditions (BC)

Set of parameters used to take into account the boundary conditions on the pressure and/or the velocity.

const cs_boundary_tboundaries
 
bool velocity_bc_is_owner
 
int n_velocity_bc_defs
 
cs_xdef_t ** velocity_bc_defs
 
bool pressure_bc_is_owner
 
int n_pressure_bc_defs
 
cs_xdef_t ** pressure_bc_defs
 
Other conditions
cs_real_t reference_pressure
 

Detailed Description

Structure storing the parameters related to the resolution of the Navier-Stokes system.

Field Documentation

◆ anderson_param

anderson_param

Set of parameters to drive the Anderson acceleration (useful if the type of non-linear algorithm is set to Anderson acceleration).

◆ boundaries

const cs_boundary_t* boundaries

True if the definitions are stored inside this structure, otherwise the definitions are stored inside a dedicated cs_equation_param_t Most of the time this should be false since an equation is associated to to the resolution of the velocity field (the momentum equation).

◆ boussinesq_param

cs_navsto_param_boussinesq_t* boussinesq_param

How are defined the Degrees of freedom

◆ coupling

coupling

Choice of algorithm for solving the system

◆ delta_thermal_tolerance

delta_thermal_tolerance

Value under which one considers that the thermal equation is converged $ max_{c \in Cells} |T_c - T_{ref}|/|T_{ref}| < \epsilon$ Then stop iteration

◆ dof_reduction_mode

dof_reduction_mode

How are defined the Degrees of freedom

◆ lam_viscosity

lam_viscosity

Laminar viscosity

◆ mass_density

mass_density

Mass_density of the fluid, pointer to cs_property_t used in several terms in the Navier-Stokes equations

◆ model

model

Modelling related to the Navier-Stokes system of equations

◆ model_flag

model_flag

Flag storing high-level option related to the Navier-Stokes system

◆ n_boussinesq_terms

int n_boussinesq_terms

How are defined the Degrees of freedom

◆ n_max_outer_iter

n_max_outer_iter

Stopping criterion related to the maximum number of outer iterations allowed. This outer iteration encompasses the Navier-Stokes system, and (according to the case settings) the turbulence system and/or the thermal system.

◆ n_pressure_bc_defs

n_pressure_bc_defs

Number of boundary conditions associated to the pressure field.

◆ n_pressure_ic_defs

n_pressure_ic_defs

Number of initial conditions associated to the pressure

◆ n_velocity_bc_defs

n_velocity_bc_defs

Number of definitions related to the settings of the boundary conditions for the velocity field.

◆ n_velocity_ic_defs

n_velocity_ic_defs

Number of initial conditions associated to the velocity

◆ nl_algo_type

nl_algo_type

Type of algorithm used to tackle the non-linearity arising from the advection term

◆ nl_cvg_param

nl_cvg_param

Structure storing several tolerances and metadata to drive the convergence of the non-linear iterative algorithm used to solve te Navier-Stokes when the advection term is implicit and non linearized.

◆ phys_constants

phys_constants

Main physical constants (gravity vector and Coriolis source term). This structure is shared with the legacy part.

◆ post_flag

post_flag

Flag storing which predefined post-processing has to be done

◆ pressure_bc_defs

pressure_bc_defs

Pointers to the definitions of the boundary conditions associated to the pressure field.

◆ pressure_bc_is_owner

pressure_bc_is_owner

True if the definitions are stored inside this structure, otherwise the definitions are stored inside a dedicated cs_equation_param_t if an equation solves the pressure field.

◆ pressure_ic_defs

pressure_ic_defs

Pointers to the definitions of the initial conditions associated to the pressure. In order to force a zero-mean pressure, the code can compute the average of the resulting pressure and subtract it

◆ pressure_ic_is_owner

pressure_ic_is_owner

True if the definitions are stored inside this structure, otherwise the definitions are stored inside a dedicated cs_equation_param_t

◆ reference_pressure

reference_pressure

Value of the reference pressure p0 (used for rescaling or during update of physical quantities). By default: 0.

◆ space_scheme

space_scheme

Discretization scheme for space

◆ tot_viscosity

tot_viscosity

Laminar viscosity + if needed the turbulent viscosity Pointer to cs_property_t associated to the diffusion term for the momentum equation

◆ turbulence

turbulence

Structure storing all information needed to set the turbulence modelling

◆ velocity_bc_defs

velocity_bc_defs

Array of pointers to the definition of boundary conditions for the velocity field

◆ velocity_bc_is_owner

velocity_bc_is_owner

True if the definitions are stored inside this structure, otherwise the definitions are stored inside a dedicated cs_equation_param_t Most of the time this should be false since an equation is associated to to the resolution of the velocity field (the momentum equation).

◆ velocity_ic_defs

velocity_ic_defs

Pointers to the definitions of the initial conditions associated to the velocity. The code does not check if the resulting initial velocity satisfies the divergence constraint.

◆ velocity_ic_is_owner

velocity_ic_is_owner

True if the definitions are stored inside this structure, otherwise the definitions are stored inside a cs_equation_param_t structure dedicated to the momentum equation.

◆ verbosity

verbosity

Level of display of the information related to the Navier-Stokes system


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