programmer's documentation
Macros | Functions | Variables
cs_navsto_param.c File Reference
#include "cs_defs.h"
#include <assert.h>
#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <bft_mem.h>
#include "cs_base.h"
#include "cs_log.h"
#include "cs_navsto_param.h"
Include dependency graph for cs_navsto_param.c:

Macros

#define CS_NAVSTO_PARAM_DBG   0
 

Functions

cs_navsto_param_tcs_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_tcs_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...
 

Variables

static const char cs_navsto_param_model_name [CS_NAVSTO_N_MODELS][CS_BASE_STRING_LEN]
 
static const char cs_navsto_param_time_state_name [CS_NAVSTO_N_TIME_STATES][CS_BASE_STRING_LEN]
 
static const char cs_navsto_param_coupling_name [CS_NAVSTO_N_COUPLINGS][CS_BASE_STRING_LEN]
 
static const char _err_empty_nsp []
 

Macro Definition Documentation

◆ CS_NAVSTO_PARAM_DBG

#define CS_NAVSTO_PARAM_DBG   0

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]modelmodel related to the NS system to solve
[in]time_statestate of the time for the NS equations
[in]algo_couplingalgorithm 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]parampointer to a cs_navsto_param_t structure
Returns
a NULL pointer

◆ 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]nsppointer 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]nsppointer to a cs_navsto_param_t structure to set
[in]keykey related to the member of eq to set
[in]keyvalaccessor to the value to set

Variable Documentation

◆ _err_empty_nsp

const char _err_empty_nsp[]
static
Initial value:
=
N_(" Stop setting an empty cs_navsto_param_t structure.\n"
" Please check your settings.\n")
#define N_(String)
Definition: cs_defs.h:56

◆ cs_navsto_param_coupling_name

const char cs_navsto_param_coupling_name[CS_NAVSTO_N_COUPLINGS][CS_BASE_STRING_LEN]
static
Initial value:
=
{ N_("Uzawa-Augmented Lagrangian coupling"),
N_("Artificial compressibility algorithm"),
N_("Artificial compressibility solved with the VPP_eps algorithm"),
N_("Incremental projection algorithm")
}
#define N_(String)
Definition: cs_defs.h:56

◆ cs_navsto_param_model_name

const char cs_navsto_param_model_name[CS_NAVSTO_N_MODELS][CS_BASE_STRING_LEN]
static
Initial value:
=
{ N_("Stokes velocity-pressure system"),
N_("Incompressible Navier-Stokes velocity-pressure system")
}
#define N_(String)
Definition: cs_defs.h:56

◆ cs_navsto_param_time_state_name

const char cs_navsto_param_time_state_name[CS_NAVSTO_N_TIME_STATES][CS_BASE_STRING_LEN]
static
Initial value:
=
{ N_("Fully steady"),
N_("Steaty-state as the limit of an unsteady computation"),
N_("Fully unsteady")
}
#define N_(String)
Definition: cs_defs.h:56