![]() |
programmer's documentation
|
#include "cs_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... | |
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... | |
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"
|
CS_NSKEY_VERBOSITY | Set the level of details for the specific part related to the Navier-Stokes system |
CS_NSKEY_N_KEYS |
Choice of algorithm for solving the system.
Modelling related to the Navier-Stokes system of equations.
Status of the time for the Navier-Stokes system of equations.
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.
[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 |
cs_navsto_param_t* cs_navsto_param_free | ( | cs_navsto_param_t * | param | ) |
Free a cs_navsto_param_t structure.
[in,out] | param | pointer to a cs_navsto_param_t structure |
|
inlinestatic |
Create a new structure to store all numerical parameters related to the resolution of the Navier-Stokes (NS) system.
[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 |
void cs_navsto_param_log | ( | const cs_navsto_param_t * | nsp | ) |
Summary of the main cs_navsto_param_t structure.
[in] | nsp | pointer to a cs_navsto_param_t structure |
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.
[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 |