![]() |
programmer's documentation
|
#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"
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] |
#define CS_PARAM_DBG 0 |
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.
[in] | default_bc | default boundary condition |
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.
[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.
[in] | bc_enforce | type of enforcement of boundary conditions |
const char* cs_param_get_bc_name | ( | cs_param_bc_type_t | bc | ) |
Get the name of the type of boundary condition.
[in] | bc_type | type of boundary condition |
const char* cs_param_get_def_type_name | ( | const cs_param_def_type_t | type | ) |
Get the name related to a type of definition.
[in] | type | cs_param_def_type_t |
const char* cs_param_get_precond_name | ( | cs_param_precond_type_t | precond | ) |
Get the name of the preconditioner.
[in] | precond | type of preconditioner |
const char* cs_param_get_solver_name | ( | cs_param_itsol_type_t | solver | ) |
Get the name of the solver.
[in] | solver | type of iterative solver |
const char* cs_param_get_var_type_name | ( | const cs_param_var_type_t | type | ) |
Get the name related to a type of variable.
[in] | type | cs_param_var_type_t |
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.
[in] | h_info | cs_param_hodge_t structure |
const char* cs_param_hodge_get_type_name | ( | const cs_param_hodge_t | h_info | ) |
Get the type of discrete Hodge operator.
[in] | h_info | cs_param_hodge_t structure |
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.
[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.
[in] | r_info | cs_param_reaction_t structure |
const char* cs_param_reaction_get_type_name | ( | cs_param_reaction_t | r_info | ) |
Get the name of the type of reaction term.
[in] | r_info | set of parameters related to a 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 | ||
) |
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.
[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.
[in] | st_info | cs_param_source_term_t structure |
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.
[in] | st_info | cs_param_source_term_t structure |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |