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

Go to the source code of this file.

Data Structures

struct  cs_desc_t
 
struct  cs_nvec3_t
 
union  cs_get_t
 

Macros

#define CDO_DIFFUSION   0
 
#define CDO_ADVECTION   1
 
#define CDO_REACTION   2
 
#define CDO_TIME   3
 
#define CDO_SOURCETERM   4
 
#define N_CDO_TERMS   5
 
#define CS_CDO_BUILD_HCONF   (1 << 0)
 
#define CS_CDO_BUILD_LOC_HCONF   (1 << 1)
 
#define CS_CDO_PRIMAL_SOURCE   (1 << 2)
 
#define CS_CDO_DUAL_SOURCE   (1 << 3)
 
#define CS_FLAG_STATE_UNIFORM   (1 << 0)
 
#define CS_FLAG_STATE_CELLWISE   (1 << 1)
 
#define CS_FLAG_STATE_UNSTEADY   (1 << 2)
 
#define CS_FLAG_STATE_POTENTIAL   (1 << 3)
 
#define CS_FLAG_STATE_CIRCULATION   (1 << 4)
 
#define CS_FLAG_STATE_FLUX   (1 << 5)
 
#define CS_FLAG_STATE_DENSITY   (1 << 6)
 
#define CS_FLAG_STATE_OWNER   (1 << 7)
 
#define CS_FLAG_PRIMAL   (1 << 0)
 
#define CS_FLAG_DUAL   (1 << 1)
 
#define CS_FLAG_VERTEX   (1 << 2)
 
#define CS_FLAG_EDGE   (1 << 3)
 
#define CS_FLAG_FACE   (1 << 4)
 
#define CS_FLAG_CELL   (1 << 5)
 
#define CS_FLAG_BORDER   (1 << 6)
 
#define CS_FLAG_SCAL   (1 << 7)
 
#define CS_FLAG_VECT   (1 << 8)
 
#define CS_FLAG_TENS   (1 << 9)
 
#define CS_FLAG_SCAN_BY_CELL   (1 << 10)
 
#define CS_SCHEME_FLAG_CDOVB   (1 << 0)
 
#define CS_SCHEME_FLAG_CDOVCB   (1 << 1)
 
#define CS_SCHEME_FLAG_CDOFB   (1 << 2)
 
#define CS_SCHEME_FLAG_HHO   (1 << 3)
 
#define CS_SCHEME_FLAG_SCALAR   (1 << 4)
 
#define CS_SCHEME_FLAG_VECTOR   (1 << 5)
 

Typedefs

typedef void( cs_analytic_func_t )(cs_real_t time, const cs_real_3_t xyz, cs_get_t *retval)
 Generic analytic function. More...
 
typedef cs_real_tcs_timestep_func_t )(int time_iter, double time)
 Simple function to define the time step according to the number of iteration already done. More...
 
typedef void( cs_onevar_law_func_t )(double var_value, const void *law_param, cs_get_t *retval)
 Compute the value of a quantity according to a law depending only on one variable. This law is described by a set of parameters stored in a structure. result = law(var_value) More...
 
typedef void( cs_twovar_law_func_t )(double var1_value, double var2_value, const void *law_param, cs_get_t *retval)
 Compute the value of a quantity according to a law depending only on two variables. This law is described by a set of parameters stored in a structure. result = law(var1_value, var2_value) More...
 
typedef void( cs_scavec_law_func_t )(double var1_value, const double var2_vect[], const void *law_param, cs_get_t *retval)
 Compute the value of a quantity according to a law depending only on two variables (the first one is a scalar and the second one a vector) This law is described by a set of parameters stored in a structure. result = law(var1_value, var2_value) More...
 

Enumerations

enum  cs_space_scheme_t {
  CS_SPACE_SCHEME_CDOVB, CS_SPACE_SCHEME_CDOVCB, CS_SPACE_SCHEME_CDOFB, CS_SPACE_SCHEME_HHO,
  CS_SPACE_N_SCHEMES
}
 

Functions

static bool cs_cdo_same_support (cs_flag_t location, cs_flag_t reference)
 Check if a location matches a referenced support. More...
 
const char * cs_base_strtf (bool boolean)
 Return a string "true" or "false" according to the boolean. More...
 
void cs_nvec3 (const cs_real_3_t v, cs_nvec3_t *qv)
 Define a cs_nvec3_t structure from a cs_real_3_t. More...
 

Variables

const char lsepline []
 
const char msepline []
 
const char ssepline []
 
const cs_flag_t cs_cdo_primal_vtx
 
const cs_flag_t cs_cdo_primal_face
 
const cs_flag_t cs_cdo_primal_cell
 
const cs_flag_t cs_cdo_dual_vtx
 
const cs_flag_t cs_cdo_dual_face
 
const cs_flag_t cs_cdo_dual_cell
 
const cs_flag_t cs_cdo_dual_face_byc
 

Macro Definition Documentation

#define CDO_ADVECTION   1
#define CDO_DIFFUSION   0
#define CDO_REACTION   2
#define CDO_SOURCETERM   4
#define CDO_TIME   3
#define CS_CDO_BUILD_HCONF   (1 << 0)
#define CS_CDO_BUILD_LOC_HCONF   (1 << 1)
#define CS_CDO_DUAL_SOURCE   (1 << 3)
#define CS_CDO_PRIMAL_SOURCE   (1 << 2)
#define CS_FLAG_BORDER   (1 << 6)
#define CS_FLAG_CELL   (1 << 5)
#define CS_FLAG_DUAL   (1 << 1)
#define CS_FLAG_EDGE   (1 << 3)
#define CS_FLAG_FACE   (1 << 4)
#define CS_FLAG_PRIMAL   (1 << 0)
#define CS_FLAG_SCAL   (1 << 7)
#define CS_FLAG_SCAN_BY_CELL   (1 << 10)
#define CS_FLAG_STATE_CELLWISE   (1 << 1)
#define CS_FLAG_STATE_CIRCULATION   (1 << 4)
#define CS_FLAG_STATE_DENSITY   (1 << 6)
#define CS_FLAG_STATE_FLUX   (1 << 5)
#define CS_FLAG_STATE_OWNER   (1 << 7)
#define CS_FLAG_STATE_POTENTIAL   (1 << 3)
#define CS_FLAG_STATE_UNIFORM   (1 << 0)
#define CS_FLAG_STATE_UNSTEADY   (1 << 2)
#define CS_FLAG_TENS   (1 << 9)
#define CS_FLAG_VECT   (1 << 8)
#define CS_FLAG_VERTEX   (1 << 2)
#define CS_SCHEME_FLAG_CDOFB   (1 << 2)
#define CS_SCHEME_FLAG_CDOVB   (1 << 0)
#define CS_SCHEME_FLAG_CDOVCB   (1 << 1)
#define CS_SCHEME_FLAG_HHO   (1 << 3)
#define CS_SCHEME_FLAG_SCALAR   (1 << 4)
#define CS_SCHEME_FLAG_VECTOR   (1 << 5)
#define N_CDO_TERMS   5

Typedef Documentation

typedef void( cs_analytic_func_t)(cs_real_t time, const cs_real_3_t xyz, cs_get_t *retval)

Generic analytic function.

Parameters
[in]timewhen ?
[in]xyzwhere ?
[in,out]retvalresult of the function
typedef void( cs_onevar_law_func_t)(double var_value, const void *law_param, cs_get_t *retval)

Compute the value of a quantity according to a law depending only on one variable. This law is described by a set of parameters stored in a structure. result = law(var_value)

Parameters
[in]var_valuevalue of the variable attached to this law
[in]law_paramset of paramters related to the current law
[in,out]retvalresult of the function
typedef void( cs_scavec_law_func_t)(double var1_value, const double var2_vect[], const void *law_param, cs_get_t *retval)

Compute the value of a quantity according to a law depending only on two variables (the first one is a scalar and the second one a vector) This law is described by a set of parameters stored in a structure. result = law(var1_value, var2_value)

Parameters
[in]var1_valuevalue of the first variable attached to this law
[in]var2_valuevalue of the second variable attached to this law
[in]law_paramset of paramters related to the current law
[in,out]retvalresult of the function
typedef cs_real_t( cs_timestep_func_t)(int time_iter, double time)

Simple function to define the time step according to the number of iteration already done.

Parameters
[in]time_itercurrent number of iterations
[in]timevalue of the time at the end of the last iteration
Returns
the value of the time step
typedef void( cs_twovar_law_func_t)(double var1_value, double var2_value, const void *law_param, cs_get_t *retval)

Compute the value of a quantity according to a law depending only on two variables. This law is described by a set of parameters stored in a structure. result = law(var1_value, var2_value)

Parameters
[in]var1_valuevalue of the first variable attached to this law
[in]var2_valuevalue of the second variable attached to this law
[in]law_paramset of paramters related to the current law
[in,out]retvalresult of the function

Enumeration Type Documentation

Enumerator
CS_SPACE_SCHEME_CDOVB 
CS_SPACE_SCHEME_CDOVCB 
CS_SPACE_SCHEME_CDOFB 
CS_SPACE_SCHEME_HHO 
CS_SPACE_N_SCHEMES 

Function Documentation

const char* cs_base_strtf ( bool  boolean)

Return a string "true" or "false" according to the boolean.

Parameters
[in]booleanbool type
Returns
a string "true" or "false"
static bool cs_cdo_same_support ( cs_flag_t  location,
cs_flag_t  reference 
)
inlinestatic

Check if a location matches a referenced support.

Parameters
[in]locationflag corresponding to the location to check
[in]referenceflag corresponding to the referenced support
Returns
true or false
void cs_nvec3 ( const cs_real_3_t  v,
cs_nvec3_t qv 
)

Define a cs_nvec3_t structure from a cs_real_3_t.

Parameters
[in]vvector of size 3
[out]qvpointer to a cs_nvec3_t structure

Variable Documentation

const cs_flag_t cs_cdo_dual_cell
const cs_flag_t cs_cdo_dual_face
const cs_flag_t cs_cdo_dual_face_byc
const cs_flag_t cs_cdo_dual_vtx
const cs_flag_t cs_cdo_primal_cell
const cs_flag_t cs_cdo_primal_face
const cs_flag_t cs_cdo_primal_vtx
const char lsepline[]
const char msepline[]
const char ssepline[]