programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Data Structures | Enumerations | Functions
cs_param.h File Reference
#include "cs_mesh.h"
#include "cs_cdo.h"
#include "cs_quadrature.h"
Include dependency graph for cs_param.h:

Go to the source code of this file.

Data Structures

struct  cs_param_hodge_t
 
struct  cs_param_advection_t
 
struct  cs_param_itsol_t
 

Enumerations

enum  cs_param_hodge_type_t {
  CS_PARAM_HODGE_TYPE_VPCD, CS_PARAM_HODGE_TYPE_EPFD, CS_PARAM_HODGE_TYPE_FPED, CS_PARAM_HODGE_TYPE_EDFP,
  CS_PARAM_HODGE_TYPE_CPVD, CS_PARAM_HODGE_TYPE_VC, CS_PARAM_N_HODGE_TYPES
}
 
enum  cs_param_hodge_algo_t {
  CS_PARAM_HODGE_ALGO_VORONOI, CS_PARAM_HODGE_ALGO_WBS, CS_PARAM_HODGE_ALGO_COST, CS_PARAM_HODGE_ALGO_AUTO,
  CS_PARAM_N_HODGE_ALGOS
}
 
enum  cs_time_scheme_t {
  CS_TIME_SCHEME_IMPLICIT, CS_TIME_SCHEME_EXPLICIT, CS_TIME_SCHEME_CRANKNICO, CS_TIME_SCHEME_THETA,
  CS_TIME_N_SCHEMES
}
 
enum  cs_param_advection_form_t { CS_PARAM_ADVECTION_FORM_CONSERV, CS_PARAM_ADVECTION_FORM_NONCONS, CS_PARAM_N_ADVECTION_FORMULATIONS }
 
enum  cs_param_advection_scheme_t {
  CS_PARAM_ADVECTION_SCHEME_CENTERED, CS_PARAM_ADVECTION_SCHEME_CIP, CS_PARAM_ADVECTION_SCHEME_UPWIND, CS_PARAM_ADVECTION_SCHEME_SAMARSKII,
  CS_PARAM_ADVECTION_SCHEME_SG, CS_PARAM_N_ADVECTION_SCHEMES
}
 
enum  cs_param_advection_weight_t { CS_PARAM_ADVECTION_WEIGHT_FLUX, CS_PARAM_ADVECTION_WEIGHT_XEXC, CS_PARAM_N_ADVECTION_WEIGHTS }
 
enum  cs_param_boundary_type_t {
  CS_PARAM_BOUNDARY_WALL, CS_PARAM_BOUNDARY_INLET, CS_PARAM_BOUNDARY_OUTLET, CS_PARAM_BOUNDARY_SYMMETRY,
  CS_PARAM_N_BOUNDARY_TYPES
}
 
enum  cs_param_bc_type_t {
  CS_PARAM_BC_HMG_DIRICHLET, CS_PARAM_BC_DIRICHLET, CS_PARAM_BC_HMG_NEUMANN, CS_PARAM_BC_NEUMANN,
  CS_PARAM_BC_ROBIN, CS_PARAM_N_BC_TYPES
}
 
enum  cs_param_bc_enforce_t {
  CS_PARAM_BC_ENFORCE_STRONG, CS_PARAM_BC_ENFORCE_WEAK_PENA, CS_PARAM_BC_ENFORCE_WEAK_NITSCHE, CS_PARAM_BC_ENFORCE_WEAK_SYM,
  CS_PARAM_N_BC_ENFORCEMENTS
}
 
enum  cs_param_precond_type_t {
  CS_PARAM_PRECOND_NONE, CS_PARAM_PRECOND_DIAG, CS_PARAM_PRECOND_BJACOB, CS_PARAM_PRECOND_POLY1,
  CS_PARAM_PRECOND_SSOR, CS_PARAM_PRECOND_ILU0, CS_PARAM_PRECOND_ICC0, CS_PARAM_PRECOND_AMG,
  CS_PARAM_PRECOND_AS, CS_PARAM_N_PRECOND_TYPES
}
 
enum  cs_param_itsol_type_t {
  CS_PARAM_ITSOL_JACOBI, CS_PARAM_ITSOL_CG, CS_PARAM_ITSOL_BICG, CS_PARAM_ITSOL_BICGSTAB2,
  CS_PARAM_ITSOL_CR3, CS_PARAM_ITSOL_GMRES, CS_PARAM_ITSOL_AMG, CS_PARAM_N_ITSOL_TYPES
}
 

Functions

const char * cs_param_hodge_get_algo_name (const cs_param_hodge_t h_info)
 Get the name of algorithm related to a discrete Hdoge operator. More...
 
const char * cs_param_hodge_get_type_name (const cs_param_hodge_t h_info)
 Get the type of discrete Hodge operator. 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_bc_name (cs_param_bc_type_t bc)
 Get the name of the type of boundary condition. More...
 
const char * cs_param_get_boundary_domain_name (cs_param_boundary_type_t type)
 Get the name of the domain boundary condition This name is also used as a name for zone definition. 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...
 

Enumeration Type Documentation

Enumerator
CS_PARAM_ADVECTION_FORM_CONSERV 
CS_PARAM_ADVECTION_FORM_NONCONS 
CS_PARAM_N_ADVECTION_FORMULATIONS 
Enumerator
CS_PARAM_ADVECTION_SCHEME_CENTERED 
CS_PARAM_ADVECTION_SCHEME_CIP 
CS_PARAM_ADVECTION_SCHEME_UPWIND 
CS_PARAM_ADVECTION_SCHEME_SAMARSKII 
CS_PARAM_ADVECTION_SCHEME_SG 
CS_PARAM_N_ADVECTION_SCHEMES 
Enumerator
CS_PARAM_ADVECTION_WEIGHT_FLUX 
CS_PARAM_ADVECTION_WEIGHT_XEXC 
CS_PARAM_N_ADVECTION_WEIGHTS 
Enumerator
CS_PARAM_BC_ENFORCE_STRONG 
CS_PARAM_BC_ENFORCE_WEAK_PENA 
CS_PARAM_BC_ENFORCE_WEAK_NITSCHE 
CS_PARAM_BC_ENFORCE_WEAK_SYM 
CS_PARAM_N_BC_ENFORCEMENTS 
Enumerator
CS_PARAM_BC_HMG_DIRICHLET 
CS_PARAM_BC_DIRICHLET 
CS_PARAM_BC_HMG_NEUMANN 
CS_PARAM_BC_NEUMANN 
CS_PARAM_BC_ROBIN 
CS_PARAM_N_BC_TYPES 
Enumerator
CS_PARAM_BOUNDARY_WALL 
CS_PARAM_BOUNDARY_INLET 
CS_PARAM_BOUNDARY_OUTLET 
CS_PARAM_BOUNDARY_SYMMETRY 
CS_PARAM_N_BOUNDARY_TYPES 
Enumerator
CS_PARAM_HODGE_ALGO_VORONOI 
CS_PARAM_HODGE_ALGO_WBS 
CS_PARAM_HODGE_ALGO_COST 
CS_PARAM_HODGE_ALGO_AUTO 
CS_PARAM_N_HODGE_ALGOS 
Enumerator
CS_PARAM_HODGE_TYPE_VPCD 
CS_PARAM_HODGE_TYPE_EPFD 
CS_PARAM_HODGE_TYPE_FPED 
CS_PARAM_HODGE_TYPE_EDFP 
CS_PARAM_HODGE_TYPE_CPVD 
CS_PARAM_HODGE_TYPE_VC 
CS_PARAM_N_HODGE_TYPES 
Enumerator
CS_PARAM_ITSOL_JACOBI 
CS_PARAM_ITSOL_CG 
CS_PARAM_ITSOL_BICG 
CS_PARAM_ITSOL_BICGSTAB2 
CS_PARAM_ITSOL_CR3 
CS_PARAM_ITSOL_GMRES 
CS_PARAM_ITSOL_AMG 
CS_PARAM_N_ITSOL_TYPES 
Enumerator
CS_PARAM_PRECOND_NONE 
CS_PARAM_PRECOND_DIAG 
CS_PARAM_PRECOND_BJACOB 
CS_PARAM_PRECOND_POLY1 
CS_PARAM_PRECOND_SSOR 
CS_PARAM_PRECOND_ILU0 
CS_PARAM_PRECOND_ICC0 
CS_PARAM_PRECOND_AMG 
CS_PARAM_PRECOND_AS 
CS_PARAM_N_PRECOND_TYPES 
Enumerator
CS_TIME_SCHEME_IMPLICIT 
CS_TIME_SCHEME_EXPLICIT 
CS_TIME_SCHEME_CRANKNICO 
CS_TIME_SCHEME_THETA 
CS_TIME_N_SCHEMES 

Function Documentation

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
const char* cs_param_get_bc_name ( cs_param_bc_type_t  type)

Get the name of the type of boundary condition.

Parameters
[in]bctype of boundary condition
Returns
the associated bc name
Parameters
[in]typetype of boundary condition
Returns
the associated bc name
const char* cs_param_get_boundary_domain_name ( cs_param_boundary_type_t  type)

Get the name of the domain boundary condition This name is also used as a name for zone definition.

Parameters
[in]typetype of boundary
Returns
the associated boundary 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
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
const char* cs_param_hodge_get_algo_name ( const cs_param_hodge_t  h_info)

Get the name of algorithm related to a discrete Hdoge operator.

Parameters
[in]h_infocs_param_hodge_t structure
Returns
the name of the algorithm
const char* cs_param_hodge_get_type_name ( const cs_param_hodge_t  h_info)

Get the type of discrete Hodge operator.

Parameters
[in]h_infocs_param_hodge_t structure
Returns
the name of the type