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

Go to the source code of this file.

Data Structures

struct  cs_xdef_t
 
struct  cs_xdef_array_input_t
 
struct  cs_xdef_analytic_input_t
 
struct  cs_xdef_timestep_input_t
 

Enumerations

enum  cs_xdef_type_t {
  CS_XDEF_BY_ANALYTIC_FUNCTION, CS_XDEF_BY_ARRAY, CS_XDEF_BY_FIELD, CS_XDEF_BY_FUNCTION,
  CS_XDEF_BY_QOV, CS_XDEF_BY_TIME_FUNCTION, CS_XDEF_BY_VALUE, CS_N_XDEF_TYPES
}
 
enum  cs_xdef_support_t { CS_XDEF_SUPPORT_TIME, CS_XDEF_SUPPORT_BOUNDARY, CS_XDEF_SUPPORT_VOLUME, CS_N_XDEF_SUPPORTS }
 

Functions

cs_xdef_tcs_xdef_volume_create (cs_xdef_type_t type, int dim, int z_id, cs_flag_t state, cs_flag_t meta, void *input)
 Allocate and initialize a new cs_xdef_t structure based on volumic elements. More...
 
cs_xdef_tcs_xdef_boundary_create (cs_xdef_type_t type, int dim, int z_id, cs_flag_t state, cs_flag_t meta, void *input)
 Allocate and initialize a new cs_xdef_t structure based on boundary elements. More...
 
cs_xdef_tcs_xdef_timestep_create (cs_xdef_type_t type, cs_flag_t state, cs_flag_t meta, void *input)
 Allocate and initialize a new cs_xdef_t structure for setting the time step. More...
 
cs_xdef_tcs_xdef_free (cs_xdef_t *d)
 Free a cs_xdef_t structure. More...
 
void cs_xdef_set_quadrature (cs_xdef_t *d, cs_quadrature_type_t qtype)
 Set the type of quadrature to use for evaluating the given description. More...
 
cs_quadrature_type_t cs_xdef_get_quadrature (cs_xdef_t *d)
 Get the type of quadrature to use for evaluating the given description. More...
 
cs_xdef_type_t cs_xdef_get_type (const cs_xdef_t *d)
 Retrieve the flag dedicated to the state. More...
 
cs_flag_t cs_xdef_get_state_flag (const cs_xdef_t *d)
 Retrieve the flag dedicated to the state. More...
 
void cs_xdef_log (cs_xdef_t *d)
 Output the settings related to a a cs_xdef_t structure. More...
 

Enumeration Type Documentation

Enumerator
CS_XDEF_SUPPORT_TIME 
CS_XDEF_SUPPORT_BOUNDARY 
CS_XDEF_SUPPORT_VOLUME 
CS_N_XDEF_SUPPORTS 
Enumerator
CS_XDEF_BY_ANALYTIC_FUNCTION 
CS_XDEF_BY_ARRAY 
CS_XDEF_BY_FIELD 
CS_XDEF_BY_FUNCTION 
CS_XDEF_BY_QOV 
CS_XDEF_BY_TIME_FUNCTION 
CS_XDEF_BY_VALUE 
CS_N_XDEF_TYPES 

Function Documentation

cs_xdef_t* cs_xdef_boundary_create ( cs_xdef_type_t  type,
int  dim,
int  z_id,
cs_flag_t  state,
cs_flag_t  meta,
void *  input 
)

Allocate and initialize a new cs_xdef_t structure based on boundary elements.

Parameters
[in]typetype of definition
[in]dimdimension of the values to define
[in]z_idvolume zone id
[in]stateflag to know if this uniform, cellwise, steady...
[in]metametadata associated to this description
[in]inputpointer to a structure
Returns
a pointer to the new cs_xdef_t structure
cs_xdef_t* cs_xdef_free ( cs_xdef_t d)

Free a cs_xdef_t structure.

Parameters
[in,out]dpointer to a cs_xdef_t structure
Returns
NULL
cs_quadrature_type_t cs_xdef_get_quadrature ( cs_xdef_t d)

Get the type of quadrature to use for evaluating the given description.

Parameters
[in]dpointer to a cs_xdef_t structure
Returns
the type of quadrature
cs_flag_t cs_xdef_get_state_flag ( const cs_xdef_t d)

Retrieve the flag dedicated to the state.

Parameters
[in]dpointer to a cs_xdef_t structure
Returns
the value of the flag
cs_xdef_type_t cs_xdef_get_type ( const cs_xdef_t d)

Retrieve the flag dedicated to the state.

Parameters
[in]dpointer to a cs_xdef_t structure
Returns
the value of the flag
void cs_xdef_log ( cs_xdef_t d)

Output the settings related to a a cs_xdef_t structure.

Parameters
[in]dpointer to a cs_xdef_t structure
void cs_xdef_set_quadrature ( cs_xdef_t d,
cs_quadrature_type_t  qtype 
)

Set the type of quadrature to use for evaluating the given description.

Parameters
[in,out]dpointer to a cs_xdef_t structure
[in]qtypetype of quadrature
cs_xdef_t* cs_xdef_timestep_create ( cs_xdef_type_t  type,
cs_flag_t  state,
cs_flag_t  meta,
void *  input 
)

Allocate and initialize a new cs_xdef_t structure for setting the time step.

Parameters
[in]typetype of definition
[in]dimdimension of the values to define
[in]z_idvolume zone id
[in]stateflag to know if this uniform, cellwise, steady...
[in]metametadata associated to this description
[in]inputpointer to a structure storing the parameters (cast on-the-fly according to the type of definition)
Returns
a pointer to the new cs_xdef_t structure
cs_xdef_t* cs_xdef_volume_create ( cs_xdef_type_t  type,
int  dim,
int  z_id,
cs_flag_t  state,
cs_flag_t  meta,
void *  input 
)

Allocate and initialize a new cs_xdef_t structure based on volumic elements.

Parameters
[in]typetype of definition
[in]dimdimension of the values to define
[in]z_idvolume zone id
[in]stateflag to know if this uniform, cellwise, steady...
[in]metametadata associated to this description
[in]inputpointer to a structure
Returns
a pointer to the new cs_xdef_t structure