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

Go to the source code of this file.

Data Structures

struct  cs_nvec3_t
 
union  cs_get_t
 

Macros

#define CS_CDO_LEN_NAME   64
 

Typedefs

typedef unsigned short int cs_flag_t
 
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)
 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...
 

Enumerations

enum  cs_space_scheme_t { CS_SPACE_SCHEME_CDOVB, CS_SPACE_SCHEME_CDOFB, CS_SPACE_N_SCHEMES }
 

Functions

const char * cs_base_strtf (bool boolean)
 Return a string "true" or "false" according to the boolean. More...
 
void cs_set_eps_machine (void)
 Compute epsilon which is the machine precision. More...
 
double cs_get_eps_machine (void)
 Get the machine precision. More...
 
double cs_get_zero_threshold (void)
 Get the threshold under which one considers it's zero. 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 []
 

Macro Definition Documentation

#define CS_CDO_LEN_NAME   64

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 unsigned short int cs_flag_t
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 cs_real_t( cs_timestep_func_t) (int time_iter)

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

Parameters
[in]time_itercurrent number of iterations
Returns
the value of the time step

Enumeration Type Documentation

Enumerator
CS_SPACE_SCHEME_CDOVB 
CS_SPACE_SCHEME_CDOFB 
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"
double cs_get_eps_machine ( void  )

Get the machine precision.

double cs_get_zero_threshold ( void  )

Get the threshold under which one considers it's zero.

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
void cs_set_eps_machine ( void  )

Compute epsilon which is the machine precision.

Variable Documentation

const char lsepline[]
const char msepline[]
const char ssepline[]