programmer's documentation
Data Structures | Macros | Enumerations | Functions
cs_equation_param.h File Reference
#include "cs_param.h"
#include "cs_property.h"
#include "cs_advection_field.h"
#include "cs_source_term.h"
Include dependency graph for cs_equation_param.h:

Go to the source code of this file.

Data Structures

struct  cs_equation_algo_t
 
struct  cs_equation_param_t
 

Macros

#define CS_EQUATION_LOCKED   (1 << 0)
 
#define CS_EQUATION_UNSTEADY   (1 << 1)
 
#define CS_EQUATION_CONVECTION   (1 << 2)
 
#define CS_EQUATION_DIFFUSION   (1 << 3)
 
#define CS_EQUATION_REACTION   (1 << 4)
 
#define CS_EQUATION_POST_PECLET   (1 << 0)
 
#define CS_EQUATION_POST_COURANT   (1 << 1)
 
#define CS_EQUATION_POST_FOURIER   (1 << 2)
 
#define CS_EQUATION_POST_UPWIND_COEF   (1 << 3)
 

Enumerations

enum  cs_equation_type_t { CS_EQUATION_TYPE_USER, CS_EQUATION_TYPE_GROUNDWATER, CS_EQUATION_TYPE_PREDEFINED, CS_EQUATION_N_TYPES }
 
enum  cs_equation_algo_type_t {
  CS_EQUATION_ALGO_CS_ITSOL, CS_EQUATION_ALGO_PETSC_ITSOL, CS_EQUATION_ALGO_UZAWA, CS_EQUATION_ALGO_NEWTON,
  CS_EQUATION_ALGO_PICARD, CS_EQUATION_N_ALGOS
}
 

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

Macro Definition Documentation

◆ CS_EQUATION_CONVECTION

#define CS_EQUATION_CONVECTION   (1 << 2)

◆ CS_EQUATION_DIFFUSION

#define CS_EQUATION_DIFFUSION   (1 << 3)

◆ CS_EQUATION_LOCKED

#define CS_EQUATION_LOCKED   (1 << 0)

◆ CS_EQUATION_POST_COURANT

#define CS_EQUATION_POST_COURANT   (1 << 1)

◆ CS_EQUATION_POST_FOURIER

#define CS_EQUATION_POST_FOURIER   (1 << 2)

◆ CS_EQUATION_POST_PECLET

#define CS_EQUATION_POST_PECLET   (1 << 0)

◆ CS_EQUATION_POST_UPWIND_COEF

#define CS_EQUATION_POST_UPWIND_COEF   (1 << 3)

◆ CS_EQUATION_REACTION

#define CS_EQUATION_REACTION   (1 << 4)

◆ CS_EQUATION_UNSTEADY

#define CS_EQUATION_UNSTEADY   (1 << 1)

Enumeration Type Documentation

◆ cs_equation_algo_type_t

Enumerator
CS_EQUATION_ALGO_CS_ITSOL 
CS_EQUATION_ALGO_PETSC_ITSOL 
CS_EQUATION_ALGO_UZAWA 
CS_EQUATION_ALGO_NEWTON 
CS_EQUATION_ALGO_PICARD 
CS_EQUATION_N_ALGOS 

◆ cs_equation_type_t

Enumerator
CS_EQUATION_TYPE_USER 
CS_EQUATION_TYPE_GROUNDWATER 
CS_EQUATION_TYPE_PREDEFINED 
CS_EQUATION_N_TYPES 

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]eqppointer to a cs_equation_param_t
Returns
a NULL pointer
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]eqpointer to a cs_equation_param_t structure
[in]eqnamename of the related equation
[in]eqppointer to a cs_equation_param_t structure