7.1
general documentation
cs_param_types.c File Reference
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <assert.h>
#include "bft_mem.h"
#include "cs_base.h"
#include "cs_log.h"
#include "cs_param_types.h"
+ Include dependency graph for cs_param_types.c:

Macros

#define CS_PARAM_TYPES_DBG   0
 

Functions

bool cs_param_space_scheme_is_face_based (cs_param_space_scheme_t scheme)
 Return true if the space scheme has degrees of freedom on faces, otherwise false. More...
 
const char * cs_param_get_space_scheme_name (cs_param_space_scheme_t scheme)
 Get the name of the space discretization scheme. More...
 
const char * cs_param_get_time_scheme_name (cs_param_time_scheme_t scheme)
 Get the name of the time discretization scheme. More...
 
const char * cs_param_get_advection_form_name (cs_param_advection_form_t adv_form)
 Get the label associated to the advection formulation. More...
 
const char * cs_param_get_advection_scheme_name (cs_param_advection_scheme_t scheme)
 Get the label of the advection scheme. More...
 
const char * cs_param_get_advection_strategy_name (cs_param_advection_strategy_t adv_stra)
 Get the label associated to the advection strategy. More...
 
const char * cs_param_get_advection_extrapol_name (cs_param_advection_extrapol_t extrapol)
 Get the label associated to the extrapolation used for the advection field. More...
 
const char * cs_param_get_bc_name (cs_param_bc_type_t type)
 Get the name of the type of boundary condition. More...
 
const char * cs_param_get_bc_enforcement_name (cs_param_bc_enforce_t type)
 Get the name of the type of enforcement of the boundary condition. More...
 
const char * cs_param_get_nl_algo_name (cs_param_nl_algo_t algo)
 Get the name of the non-linear algorithm. More...
 
const char * cs_param_get_dotprod_type_name (cs_param_dotprod_type_t dp_type)
 Get the name of the type of dot product to apply. More...
 
const char * cs_param_get_solver_name (cs_param_itsol_type_t solver)
 Get the name of the solver. More...
 
const char * cs_param_get_precond_name (cs_param_precond_type_t precond)
 Get the name of the preconditioner. More...
 
const char * cs_param_get_precond_block_name (cs_param_precond_block_t type)
 Get the name of the type of block preconditioning. More...
 
const char * cs_param_get_schur_approx_name (cs_param_schur_approx_t type)
 Get the name of the type of Schur complement approximation. More...
 
const char * cs_param_get_amg_type_name (cs_param_amg_type_t type)
 Get the name of the type of algebraic multigrid (AMG) More...
 

Variables

const char cs_sep_h1 [80]
 
const char cs_sep_h2 [80]
 
const char cs_sepline [80]
 
const char cs_med_sepline [50]
 

Macro Definition Documentation

◆ CS_PARAM_TYPES_DBG

#define CS_PARAM_TYPES_DBG   0

Function Documentation

◆ cs_param_get_advection_extrapol_name()

const char* cs_param_get_advection_extrapol_name ( cs_param_advection_extrapol_t  extrapol)

Get the label associated to the extrapolation used for the advection field.

Parameters
[in]adv_stratype of extrapolation for the advection field
Returns
the associated label

◆ cs_param_get_advection_form_name()

const char* cs_param_get_advection_form_name ( cs_param_advection_form_t  adv_form)

Get the label associated to the advection formulation.

Parameters
[in]adv_formtype of advection formulation
Returns
the associated label

◆ cs_param_get_advection_scheme_name()

const char* cs_param_get_advection_scheme_name ( cs_param_advection_scheme_t  scheme)

Get the label of the advection scheme.

Parameters
[in]schemetype of advection scheme
Returns
the associated advection scheme label

◆ cs_param_get_advection_strategy_name()

const char* cs_param_get_advection_strategy_name ( cs_param_advection_strategy_t  adv_stra)

Get the label associated to the advection strategy.

Parameters
[in]adv_stratype of advection strategy
Returns
the associated label

◆ cs_param_get_amg_type_name()

const char* cs_param_get_amg_type_name ( cs_param_amg_type_t  type)

Get the name of the type of algebraic multigrid (AMG)

Parameters
[in]typetype of AMG
Returns
the associated type name

◆ cs_param_get_bc_enforcement_name()

const char* cs_param_get_bc_enforcement_name ( cs_param_bc_enforce_t  type)

Get the name of the type of enforcement of the boundary condition.

Parameters
[in]typetype of enforcement of boundary conditions
Returns
the associated name

◆ cs_param_get_bc_name()

const char* cs_param_get_bc_name ( cs_param_bc_type_t  type)

Get the name of the type of boundary condition.

Parameters
[in]typetype of boundary condition
Returns
the associated bc name

◆ cs_param_get_dotprod_type_name()

const char* cs_param_get_dotprod_type_name ( cs_param_dotprod_type_t  dp_type)

Get the name of the type of dot product to apply.

Parameters
[in]dp_typetype of dot product
Returns
the associated type name

◆ cs_param_get_nl_algo_name()

const char* cs_param_get_nl_algo_name ( cs_param_nl_algo_t  algo)

Get the name of the non-linear algorithm.

Parameters
[in]algotype of algorithm
Returns
the associated algorithm name

◆ cs_param_get_precond_block_name()

const char* cs_param_get_precond_block_name ( cs_param_precond_block_t  type)

Get the name of the type of block preconditioning.

Parameters
[in]typetype of block preconditioning
Returns
the associated type name

◆ cs_param_get_precond_name()

const char* cs_param_get_precond_name ( cs_param_precond_type_t  precond)

Get the name of the preconditioner.

Parameters
[in]precondtype of preconditioner
Returns
the associated preconditioner name

◆ cs_param_get_schur_approx_name()

const char* cs_param_get_schur_approx_name ( cs_param_schur_approx_t  type)

Get the name of the type of Schur complement approximation.

Parameters
[in]typetype of Schur complement approximation
Returns
the associated type name

◆ cs_param_get_solver_name()

const char* cs_param_get_solver_name ( cs_param_itsol_type_t  solver)

Get the name of the solver.

Parameters
[in]solvertype of iterative solver
Returns
the associated solver name

◆ cs_param_get_space_scheme_name()

const char* cs_param_get_space_scheme_name ( cs_param_space_scheme_t  scheme)

Get the name of the space discretization scheme.

Parameters
[in]schemetype of space scheme
Returns
the associated space scheme name

◆ cs_param_get_time_scheme_name()

const char* cs_param_get_time_scheme_name ( cs_param_time_scheme_t  scheme)

Get the name of the time discretization scheme.

Parameters
[in]schemetype of time scheme
Returns
the associated time scheme name

◆ cs_param_space_scheme_is_face_based()

bool cs_param_space_scheme_is_face_based ( cs_param_space_scheme_t  scheme)

Return true if the space scheme has degrees of freedom on faces, otherwise false.

Parameters
[in]schemetype of space scheme
Returns
true or false

Variable Documentation

◆ cs_med_sepline

const char cs_med_sepline[50]
Initial value:
=
"# ========================================\n"

◆ cs_sep_h1

const char cs_sep_h1[80]
Initial value:
=
"=======================================================================\n"

◆ cs_sep_h2

const char cs_sep_h2[80]
Initial value:
=
"-----------------------------------------------------------------------\n"

◆ cs_sepline

const char cs_sepline[80]
Initial value:
=
"# =====================================================================\n"