cs_navsto_param.h File Reference

#include "cs_param.h"

Include dependency graph for cs_navsto_param.h:

Go to the source code of this file.

Data Structures
struct	cs_navsto_param_t
	Structure storing the parameters related to the resolution of the Navier-Stokes system. More...

Enumerations
enum	cs_navsto_param_model_t { CS_NAVSTO_MODEL_STOKES, CS_NAVSTO_MODEL_INCOMPRESSIBLE_NAVIER_STOKES, CS_NAVSTO_MODEL_BOUSSINESQ_NAVIER_STOKES, CS_NAVSTO_N_MODELS }
	Modelling related to the Navier-Stokes system of equations. More...
enum	cs_navsto_param_time_state_t { CS_NAVSTO_TIME_STATE_FULL_STEADY, CS_NAVSTO_TIME_STATE_LIMIT_STEADY, CS_NAVSTO_TIME_STATE_UNSTEADY, CS_NAVSTO_N_TIME_STATES }
	Status of the time for the Navier-Stokes system of equations. More...
enum	cs_navsto_param_coupling_t {   CS_NAVSTO_COUPLING_UZAWA, CS_NAVSTO_COUPLING_ARTIFICIAL_COMPRESSIBILITY, CS_NAVSTO_COUPLING_ARTIFICIAL_COMPRESSIBILITY_VPP, CS_NAVSTO_COUPLING_PROJECTION,   CS_NAVSTO_N_COUPLINGS }
	Choice of algorithm for solving the system. More...
enum	cs_navsto_key_t {   CS_NSKEY_AC_ZETA_COEF, CS_NSKEY_DOF_REDUCTION, CS_NSKEY_SPACE_SCHEME, CS_NSKEY_TIME_SCHEME,   CS_NSKEY_TIME_THETA, CS_NSKEY_VERBOSITY, CS_NSKEY_N_KEYS }
	List of available keys for setting the parameters of the Navier-Stokes system. More...

Functions
static bool	cs_navsto_param_is_steady (cs_navsto_param_t *nsp)
	Create a new structure to store all numerical parameters related to the resolution of the Navier-Stokes (NS) system. More...
cs_navsto_param_t *	cs_navsto_param_create (cs_navsto_param_model_t model, cs_navsto_param_time_state_t time_state, cs_navsto_param_coupling_t algo_coupling)
	Create a new structure to store all numerical parameters related to the resolution of the Navier-Stokes (NS) system. More...
cs_navsto_param_t *	cs_navsto_param_free (cs_navsto_param_t *param)
	Free a cs_navsto_param_t structure. More...
void	cs_navsto_param_set (cs_navsto_param_t *nsp, cs_navsto_key_t key, const char *keyval)
	Set a parameter attached to a keyname in a cs_navsto_param_t structure. More...
void	cs_navsto_param_log (const cs_navsto_param_t *nsp)
	Summary of the main cs_navsto_param_t structure. More...

Enumeration Type Documentation

cs_navsto_key_t

enum cs_navsto_key_t

List of available keys for setting the parameters of the Navier-Stokes system.

Enumerator
CS_NSKEY_AC_ZETA_COEF	Set the zeta coefficient (in front of the grad-div term) when an artificial coefficient algorithm is used
CS_NSKEY_DOF_REDUCTION	Set how the DoFs are defined (similar to CS_EQKEY_DOF_REDUCTION) Enable to set this type of DoFs definition for all related equations
CS_NSKEY_SPACE_SCHEME	Numerical scheme for the space discretization
CS_NSKEY_TIME_SCHEME	Numerical scheme for the time discretization
CS_NSKEY_TIME_THETA	Set the value of theta. Only useful if CS_NSKEY_TIME_SCHEME is set to "theta_scheme" Example: "0.75" (keyval must be between 0 and 1)
CS_NSKEY_VERBOSITY	Set the level of details for the specific part related to the Navier-Stokes system
CS_NSKEY_N_KEYS

cs_navsto_param_coupling_t

enum cs_navsto_param_coupling_t

Choice of algorithm for solving the system.

Enumerator
CS_NAVSTO_COUPLING_UZAWA	The system is solved without decoupling the equations using a Uzawa algorithm and an Augmented Lagrangian approach inside each sub-iteration.
CS_NAVSTO_COUPLING_ARTIFICIAL_COMPRESSIBILITY	The system is solved using an artificial compressibility algorithm. One vectorial equation is solved followed by a pressure update.
CS_NAVSTO_COUPLING_ARTIFICIAL_COMPRESSIBILITY_VPP
CS_NAVSTO_COUPLING_PROJECTION	The system is solved using an incremental projection algorithm
CS_NAVSTO_N_COUPLINGS

cs_navsto_param_model_t

enum cs_navsto_param_model_t

Modelling related to the Navier-Stokes system of equations.

Enumerator
CS_NAVSTO_MODEL_STOKES	Stokes equations (mass and momentum) with the classical choice of variables i.e. velocity and pressure
CS_NAVSTO_MODEL_INCOMPRESSIBLE_NAVIER_STOKES	Navier-Stokes equations: mass and momentum with a constant mass density
CS_NAVSTO_MODEL_BOUSSINESQ_NAVIER_STOKES	Navier-Stokes equations: mass and momentum with a constant mass density The gradient of temperature is assumed to have a small norm and the mass density variates in a small range. In this case, an additional equation related to the energy is considered.
CS_NAVSTO_N_MODELS

cs_navsto_param_time_state_t

enum cs_navsto_param_time_state_t

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

Enumerator
CS_NAVSTO_TIME_STATE_FULL_STEADY	The Navier-Stokes system of equations is solved without taking into account the time effect
CS_NAVSTO_TIME_STATE_LIMIT_STEADY	The Navier-Stokes system of equations is solved as a limit of a unsteady process
CS_NAVSTO_TIME_STATE_UNSTEADY	The Navier-Stokes system of equations is time-dependent
CS_NAVSTO_N_TIME_STATES

Function Documentation

cs_navsto_param_create()

cs_navsto_param_t* cs_navsto_param_create	(	cs_navsto_param_model_t	model,
		cs_navsto_param_time_state_t	time_state,
		cs_navsto_param_coupling_t	algo_coupling
	)

Create a new structure to store all numerical parameters related to the resolution of the Navier-Stokes (NS) system.

Parameters

[in]	model	model related to the NS system to solve
[in]	time_state	state of the time for the NS equations
[in]	algo_coupling	algorithm used for solving the NS system

Returns

a pointer to a new allocated structure

cs_navsto_param_free()

cs_navsto_param_t* cs_navsto_param_free

(

cs_navsto_param_t *

param

)

Free a cs_navsto_param_t structure.

Parameters

[in,out]

param

pointer to a cs_navsto_param_t structure

Returns

a NULL pointer

cs_navsto_param_is_steady()

static bool cs_navsto_param_is_steady ( cs_navsto_param_t *  nsp )

inlinestatic

Create a new structure to store all numerical parameters related to the resolution of the Navier-Stokes (NS) system.

Parameters

[in]	model	model related to the NS system to solve
[in]	time_state	state of the time for the NS equations
[in]	algo_coupling	algorithm used for solving the NS system

Returns

a pointer to a new allocated structure

cs_navsto_param_log()

void cs_navsto_param_log

(

const cs_navsto_param_t *

nsp

)

Summary of the main cs_navsto_param_t structure.

Parameters

[in]

nsp

pointer to a cs_navsto_param_t structure

cs_navsto_param_set()

void cs_navsto_param_set	(	cs_navsto_param_t *	nsp,
		cs_navsto_key_t	key,
		const char *	keyval
	)

Set a parameter attached to a keyname in a cs_navsto_param_t structure.

Parameters

[in,out]	nsp	pointer to a cs_navsto_param_t structure to set
[in]	key	key related to the member of eq to set
[in]	keyval	accessor to the value to set