8.1
general documentation
cs_meg_xdef_wrapper.h File Reference
#include "cs_base.h"
+ Include dependency graph for cs_meg_xdef_wrapper.h:

Go to the source code of this file.

Data Structures

struct  cs_meg_xdef_input_t
 

Enumerations

enum  cs_meg_function_type_t {
  CS_MEG_BOUNDARY_FUNC , CS_MEG_VOLUME_FUNC , CS_MEG_INITIALIZATION_FUNC , CS_MEG_SOURCE_TERM_FUNC ,
  CS_MEG_IBM_FUNC , CS_MEG_FSI_STRUCT_FUNC , CS_MEG_POST_ACTIVATE_FUNC , CS_MEG_POST_PROFILES_FUNC ,
  CS_MEG_N_FUNC_TYPES
}
 

Functions

cs_meg_xdef_input_tcs_meg_xdef_wrapper_add_input (const cs_meg_function_type_t type, const int z_id, const int stride, const char *name, const char *additional_data)
 Add a MEG function xdef wrapper input data. Allocated memory is deleted by cs_meg_xdef_wrapper_finalize. More...
 
void cs_meg_xdef_wrapper (cs_real_t time, cs_lnum_t n_elts, const cs_lnum_t *elt_ids, const cs_real_t *coords, bool dense_output, void *input, cs_real_t *retval)
 Wrapper function allowing to call MEG functions by xdef structres. This is done by using the cs_xdef_analytic_function type. More...
 

Enumeration Type Documentation

◆ cs_meg_function_type_t

Enum for MEG function type

Enumerator
CS_MEG_BOUNDARY_FUNC 
CS_MEG_VOLUME_FUNC 
CS_MEG_INITIALIZATION_FUNC 
CS_MEG_SOURCE_TERM_FUNC 
CS_MEG_IBM_FUNC 
CS_MEG_FSI_STRUCT_FUNC 
CS_MEG_POST_ACTIVATE_FUNC 
CS_MEG_POST_PROFILES_FUNC 
CS_MEG_N_FUNC_TYPES 

Function Documentation

◆ cs_meg_xdef_wrapper()

void cs_meg_xdef_wrapper ( cs_real_t  time,
cs_lnum_t  n_elts,
const cs_lnum_t elt_ids,
const cs_real_t coords,
bool  dense_output,
void *  input,
cs_real_t retval 
)

Wrapper function allowing to call MEG functions by xdef structres. This is done by using the cs_xdef_analytic_function type.

Parameters
[in]timewhen ?
[in]n_eltsnumber of elements to consider
[in]elt_idslist of elements ids (in coords and retval)
[in]coordswhere ?
[in]dense_outputperform an indirection in retval or not
[in]inputpointer to cs_meg_xdef_input_t
[in]retvalresultint value(s). Must be allocated

◆ cs_meg_xdef_wrapper_add_input()

cs_meg_xdef_input_t* cs_meg_xdef_wrapper_add_input ( const cs_meg_function_type_t  type,
const int  z_id,
const int  stride,
const char *  name,
const char *  additional_data 
)

Add a MEG function xdef wrapper input data. Allocated memory is deleted by cs_meg_xdef_wrapper_finalize.

Parameters
[in]typetype of meg function linked to this input
[in]z_idid of zone on which this function is defined
[in]stridestride of data
[in]namename related to function
[in]additional_dataadditional data (char *) provided to function, such as condition or source type
Returns
pointer to newly allocated input data structure