My Project
programmer's documentation
Data Fields
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:
Collaboration graph

Data Fields

int verbosity
 
Algorithm properties

Set of properties: properties and their related fields are allocated according to the choice of model for Navier-Stokes

cs_param_dof_reduction_t dof_reduction_mode
 
cs_param_time_scheme_t time_scheme
 
cs_real_t theta
 
cs_param_space_scheme_t space_scheme
 
cs_navsto_param_model_t model
 
bool has_gravity
 
cs_real_3_t gravity
 
cs_navsto_param_time_state_t time_state
 
cs_navsto_param_sles_t sles_strategy
 
cs_navsto_param_coupling_t coupling
 
cs_real_t gd_scale_coef
 
cs_quadrature_type_t qtype
 
cs_real_t residual_tolerance
 
int max_algo_iter
 
cs_param_advection_form_t adv_form
 
cs_param_advection_scheme_t adv_scheme
 
Physical properties

Set of properties: properties and their related fields are allocated according to the choice of model for Navier-Stokes

cs_property_tdensity
 
cs_property_tlami_viscosity
 
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
 

Detailed Description

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

Field Documentation

◆ adv_form

adv_form

Type of formulation for the advection term

◆ adv_scheme

adv_scheme

Type of scheme for the advection term

◆ boundaries

const cs_boundary_t* boundaries

◆ coupling

coupling

Choice of algorithm for solving the system

◆ density

density

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

◆ dof_reduction_mode

dof_reduction_mode

How are defined the Degrees of freedom

◆ gd_scale_coef

gd_scale_coef

Default value to set the scaling of the grad-div term when an artificial compressibility algorithm or an Uzawa-Augmented Lagrangian method is used

◆ gravity

gravity

Vector related to the gravity effect

◆ has_gravity

has_gravity

Take into account the gravity effect: true or false

◆ lami_viscosity

lami_viscosity

Laminar viscosity, pointer to cs_property_t associated to the diffusion term for the momentum equation

◆ max_algo_iter

max_algo_iter

Maximal number of iteration of the coupling algorithm. Not useful for a monolithic approach. In this case, only the maximal number of iterations for the iterative solver is taken into account

◆ model

model

Modelling related to the Navier-Stokes system of equations

◆ 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

◆ 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

◆ qtype

qtype

A cs_quadrature_type_t indicating the type of quadrature to use in all routines involving quadratures

◆ residual_tolerance

residual_tolerance

Tolerance at which the Navier–Stokes is resolved (apply to the residual of the coupling algorithm chosen to solve the Navier–Stokes system)

◆ sles_strategy

sles_strategy

Choice of strategy for solving the SLES system

◆ space_scheme

space_scheme

Discretization scheme for space

◆ theta

theta

Value of the parameter for the time scheme when a theta-scheme is used

◆ time_scheme

time_scheme

Discretization scheme for time

◆ time_state

time_state

Status of the time for the Navier-Stokes system of equations

◆ 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 the 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: