programmer's documentation
Functions | Variables
cs_equation_param.c File Reference
#include "cs_defs.h"
#include <assert.h>
#include <bft_error.h>
#include <bft_printf.h>
#include <bft_mem.h>
#include "cs_mesh_location.h"
#include "cs_multigrid.h"
#include "cs_equation_param.h"
Include dependency graph for cs_equation_param.c:

Functions

cs_equation_param_tcs_equation_param_create (cs_equation_type_t type, cs_param_var_type_t var_type, cs_param_bc_type_t default_bc)
 Create a cs_equation_param_t. More...
 
cs_equation_param_tcs_equation_param_free (cs_equation_param_t *eqp)
 Free a cs_equation_param_t. More...
 
void cs_equation_param_summary (const char *eqname, const cs_equation_param_t *eqp)
 Summary of a cs_equation_param_t structure. More...
 
void cs_equation_param_init_sles (const char *eqname, const cs_equation_param_t *eqp, int field_id)
 Initialize SLES structure for the resolution of the linear system according to the settings related to this equation. More...
 

Variables

static cs_equation_algo_t _algo_info_by_default
 
static cs_param_itsol_t _itsol_info_by_default
 

Function Documentation

§ cs_equation_param_create()

cs_equation_param_t* cs_equation_param_create ( cs_equation_type_t  type,
cs_param_var_type_t  var_type,
cs_param_bc_type_t  default_bc 
)

Create a cs_equation_param_t.

Parameters
[in]typetype of equation
[in]var_typetype of variable (scalar, vector, tensor...)
[in]default_bctype of boundary condition set by default
Returns
a pointer to a new allocated cs_equation_param_t structure

§ cs_equation_param_free()

cs_equation_param_t* cs_equation_param_free ( cs_equation_param_t eqp)

Free a cs_equation_param_t.

Parameters
[in,out]eqppointer to a cs_equation_param_t
Returns
a NULL pointer

§ cs_equation_param_init_sles()

void cs_equation_param_init_sles ( const char *  eqname,
const cs_equation_param_t eqp,
int  field_id 
)

Initialize SLES structure for the resolution of the linear system according to the settings related to this equation.

Parameters
[in]eqnamepointer to an cs_equation_t structure
[in]eqppointer to a cs_equation_param_t struct.
[in]field_idid of the cs_field_t struct. for this equation

§ cs_equation_param_summary()

void cs_equation_param_summary ( const char *  eqname,
const cs_equation_param_t eqp 
)

Summary of a cs_equation_param_t structure.

Parameters
[in]eqnamename of the related equation
[in]eqppointer to a cs_equation_param_t structure

Variable Documentation

§ _algo_info_by_default

cs_equation_algo_t _algo_info_by_default
static
Initial value:
= {
0,
50,
0,
10000,
1e-6
}
Definition: cs_equation_param.h:75

§ _itsol_info_by_default

cs_param_itsol_t _itsol_info_by_default
static
Initial value:
= {
2500,
1e-12,
150,
false
}
Definition: cs_param.h:338
Definition: cs_param.h:323