#include "cs_defs.h"
#include <stdlib.h>
#include <string.h>
#include <assert.h>
#include "bft_mem.h"
#include "bft_printf.h"
#include "cs_mesh_location.h"
#include "cs_field.h"
#include "cs_cdo.h"
#include "cs_cdo_toolbox.h"
#include "cs_param.h"

Include dependency graph for cs_param.c:

Macros
#define	CS_PARAM_DBG 0

Functions
const char *	cs_param_get_var_type_name (const cs_param_var_type_t type)
	Get the name related to a type of variable. More...

const char *	cs_param_get_def_type_name (const cs_param_def_type_t type)
	Get the name related to a type of definition. More...

void	cs_param_set_def (cs_param_def_type_t def_type, cs_param_var_type_t var_type, const void val, cs_def_t def)
	Set a cs_def_t structure. More...

cs_param_bc_t *	cs_param_bc_create (cs_param_bc_type_t default_bc)
	Allocate and initialize a new cs_param_bc_t structure. More...

void	cs_param_bc_def_set (cs_param_bc_def_t bcpd, int loc_id, cs_param_bc_type_t bc_type, cs_param_var_type_t var_type, cs_param_def_type_t def_type, const void coef1, const void *coef2)
	Set a cs_param_bc_def_t structure. 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_bc_enforcement_name (cs_param_bc_enforce_t type)
	Get the name of the type of enforcement of the boundary condition. More...

void	cs_param_reaction_add (cs_param_reaction_t rp, const char r_name, cs_param_hodge_type_t h_type, cs_param_hodge_algo_t h_algo, cs_param_source_term_type_t r_type)
	Define a new reaction term. The structure related to this reaction term has already been allocated among the list of reaction terms associated to an equation. More...

const char *	cs_param_reaction_get_name (const cs_param_reaction_t r_info)
	Get the name related to a reaction term. More...

const char *	cs_param_reaction_get_type_name (cs_param_reaction_t r_info)
	Get the name of the type of reaction term. More...

void	cs_param_source_term_add (cs_param_source_term_t stp, const char st_name, int ml_id, cs_param_source_term_type_t type, cs_param_var_type_t var_type, cs_quadra_type_t quad_type, cs_param_def_type_t def_type, const void *val)
	Define a source term. This source term is added to the list of source terms associated to an equation. More...

const char *	cs_param_source_term_get_name (const cs_param_source_term_t st_info)
	Get the name related to a source term. More...

const char *	cs_param_source_term_get_type_name (const cs_param_source_term_t st_info)
	Get the name of type of a given source term structure. More...

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

Variables
static const char	cs_param_def_type_name [CS_PARAM_N_DEF_TYPES][CS_CDO_LEN_NAME]

static const char	cs_param_var_type_name [CS_PARAM_N_VAR_TYPES][CS_CDO_LEN_NAME]

static const char	cs_param_bc_type_name [CS_PARAM_N_BC_TYPES][CS_CDO_LEN_NAME]

static const char	cs_param_boundary_type_name [CS_PARAM_N_BOUNDARY_TYPES][CS_CDO_LEN_NAME]

static const char	cs_param_hodge_type_desc [CS_PARAM_N_HODGE_TYPES][CS_CDO_LEN_NAME]

static const char	cs_param_hodge_algo_desc [CS_PARAM_N_HODGE_ALGOS][CS_CDO_LEN_NAME]

static const char	cs_param_source_term_type_name [CS_PARAM_N_SOURCE_TERM_TYPES][CS_CDO_LEN_NAME]

Macro Definition Documentation

#define CS_PARAM_DBG 0

Function Documentation

cs_param_bc_t* cs_param_bc_create ( cs_param_bc_type_t default_bc )

Allocate and initialize a new cs_param_bc_t structure.

Parameters

[in] default_bc default boundary condition

Returns: a pointer to the new structure (free with cs_equation_param_t)

void cs_param_bc_def_set	(	cs_param_bc_def_t *	bcpd,
		int	loc_id,
		cs_param_bc_type_t	bc_type,
		cs_param_var_type_t	var_type,
		cs_param_def_type_t	def_type,
		const void *	coef1,
		const void *	coef2
	)

Set a cs_param_bc_def_t structure.

Parameters

[in,out]	bcpd	pointer to cs_param_bc_def_t struct. to set
[in]	loc_id	id related to a cs_mesh_location_t
[in]	bc_type	generic type of admissible boundary conditions
[in]	var_type	type of variables (scalar, vector, tensor...)
[in]	def_type	by value, function...
[in]	coef1	access to the value of the first coef
[in]	coef2	access to the value of the second coef (optional)

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] bc_enforce type of enforcement of boundary conditions

Returns: the associated name

const char* cs_param_get_bc_name ( cs_param_bc_type_t bc )

Get the name of the type of boundary condition.

Parameters

[in] bc_type type of boundary condition

Returns: the associated bc name

const char* cs_param_get_def_type_name ( const cs_param_def_type_t type )

Get the name related to a type of definition.

Parameters

[in] type cs_param_def_type_t

Returns: the name associated to this type

const char* cs_param_get_precond_name ( cs_param_precond_type_t precond )

Get the name of the preconditioner.

Parameters

[in] precond type 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] solver type of iterative solver

Returns: the associated solver name

const char* cs_param_get_var_type_name ( const cs_param_var_type_t type )

Get the name related to a type of variable.

Parameters

[in] type cs_param_var_type_t

Returns: the name associated to this type

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_info cs_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_info cs_param_hodge_t structure

Returns: the name of the type

void cs_param_reaction_add	(	cs_param_reaction_t *	rp,
		const char *	r_name,
		cs_param_hodge_type_t	h_type,
		cs_param_hodge_algo_t	h_algo,
		cs_param_source_term_type_t	r_type
	)

Define a new reaction term. The structure related to this reaction term has already been allocated among the list of reaction terms associated to an equation.

Parameters

[in,out]	rp	pointer to cs_param_reaction_t structure
[in]	r_name	name of the reaction term
[in]	h_type	type of discrete Hodge op. associated to this term
[in]	h_algo	algorithm used to build the discrete Hodge op.
[in]	r_type	type of reaction term

const char* cs_param_reaction_get_name ( const cs_param_reaction_t r_info )

Get the name related to a reaction term.

Parameters

[in] r_info cs_param_reaction_t structure

Returns: the name of the reaction term

const char* cs_param_reaction_get_type_name ( cs_param_reaction_t r_info )

Get the name of the type of reaction term.

Parameters

[in] r_info set of parameters related to a reaction term

Returns: the name associated with this type of reaction term

void cs_param_set_def	(	cs_param_def_type_t	def_type,
		cs_param_var_type_t	var_type,
		const void *	val,
		cs_def_t *	def
	)

Set a cs_def_t structure.

Parameters

[in]	def_type	type of definition (by value, function...)
[in]	var_type	type of variables (scalar, vector, tensor...)
[in]	val	value to set
[in,out]	def	pointer to cs_def_t structure

void cs_param_source_term_add	(	cs_param_source_term_t *	stp,
		const char *	st_name,
		int	ml_id,
		cs_param_source_term_type_t	type,
		cs_param_var_type_t	var_type,
		cs_quadra_type_t	quad_type,
		cs_param_def_type_t	def_type,
		const void *	val
	)

Define a source term. This source term is added to the list of source terms associated to an equation.

Parameters

[in,out]	stp	pointer to cs_param_source_term_t structure
[in]	st_name	name of the source term
[in]	ml_id	id of the related to a cs_mesh_location_t struct.
[in]	type	type of source term
[in]	var_type	type of variables (scalar, vector, tensor...)
[in]	quad_type	type of quadrature rule to use
[in]	def_type	type of definition (by value, function...)
[in]	val	access to the definition of the source term

const char* cs_param_source_term_get_name ( const cs_param_source_term_t st_info )

Get the name related to a source term.

Parameters

[in] st_info cs_param_source_term_t structure

Returns: the name of the source term

const char* cs_param_source_term_get_type_name ( const cs_param_source_term_t st_info )

Get the name of type of a given source term structure.

Parameters

[in] st_info cs_param_source_term_t structure

Returns: the name of the type

Variable Documentation

const char cs_param_bc_type_name[CS_PARAM_N_BC_TYPES][CS_CDO_LEN_NAME]

static

Initial value:

=
  { N_("Homogeneous Dirichlet"),
    N_("Dirichlet"),
    N_("Homogeneous Neumann"),
    N_("Neumann"),
    N_("Robin") }

const char cs_param_boundary_type_name[CS_PARAM_N_BOUNDARY_TYPES][CS_CDO_LEN_NAME]

static

Initial value:

=
  { N_("Wall"),
    N_("Inlet"),
    N_("Outlet"),
    N_("Symmetry") }

const char cs_param_def_type_name[CS_PARAM_N_DEF_TYPES][CS_CDO_LEN_NAME]

static

Initial value:

=
  { N_("by analytic function"),
    N_("by array"),
    N_("by field"),
    N_("by law (one argument)"),
    N_("by time function"),
    N_("by user function"),
    N_("by value") }

const char cs_param_hodge_algo_desc[CS_PARAM_N_HODGE_ALGOS][CS_CDO_LEN_NAME]

static

Initial value:

=
  { "Voronoi",
    "Whitney on the Barycentric Subdivision (WBS)",
    "COnsistency-STabilization splitting (COST)" }

const char cs_param_hodge_type_desc[CS_PARAM_N_HODGE_TYPES][CS_CDO_LEN_NAME]

static

Initial value:

=
  { "VpCd",
    "EpFd",
    "FpEd",
    "EdFp",
    "CpVd"  }

const char cs_param_source_term_type_name[CS_PARAM_N_SOURCE_TERM_TYPES][CS_CDO_LEN_NAME]

static

Initial value:

=
  { N_("user"),
    N_("mass"),
    N_("head loss") }

const char cs_param_var_type_name[CS_PARAM_N_VAR_TYPES][CS_CDO_LEN_NAME]

static

Initial value:

=
  { N_("scalar"),
    N_("vector"),
    N_("tensor") }

Macros

Functions

Variables

Macro Definition Documentation

Function Documentation

Variable Documentation