Go to the source code of this file.
Data Structures | |
struct | cs_lagr_event_attribute_map_t |
struct | cs_lagr_event_set_t |
Macros | |
#define | CS_EVENT_INFLOW (1 << 0) |
#define | CS_EVENT_OUTFLOW (1 << 1) |
#define | CS_EVENT_REBOUND (1 << 2) |
#define | CS_EVENT_DEPOSITION (1 << 3) |
#define | CS_EVENT_RESUSPENSION (1 << 4) |
#define | CS_EVENT_ROLL_OFF (1 << 5) |
#define | CS_EVENT_ROLL_ON (1 << 6) |
#define | CS_EVENT_FOULING (1 << 7) |
Enumerations | |
enum | cs_lagr_event_attribute_t { CS_LAGR_E_FLAG = CS_LAGR_N_ATTRIBUTES, CS_LAGR_E_CELL_ID, CS_LAGR_E_FACE_ID, CS_LAGR_E_VELOCITY, CS_LAGR_N_E_ATTRIBUTES } |
#define CS_EVENT_DEPOSITION (1 << 3) |
deposistion event
#define CS_EVENT_FOULING (1 << 7) |
fouling
#define CS_EVENT_INFLOW (1 << 0) |
Flags specifying general event attributes
inflow event
#define CS_EVENT_OUTFLOW (1 << 1) |
outflow event
#define CS_EVENT_REBOUND (1 << 2) |
rebound on wall
#define CS_EVENT_RESUSPENSION (1 << 4) |
resuspension event
#define CS_EVENT_ROLL_OFF (1 << 5) |
roll off
#define CS_EVENT_ROLL_ON (1 << 6) |
roll on
void cs_lagr_event_attr_in_range | ( | int | attr | ) |
Check if an event attribute is in a valid range.
If this is not the case, a fatal error is provoked.
[in] | attr | event attribute |
void cs_lagr_event_finalize | ( | void | ) |
Destroy event set map if it exists.
Destroy event set map if it exists.
void cs_lagr_event_get_attr_info | ( | const cs_lagr_event_set_t * | events, |
cs_lagr_event_attribute_t | attr, | ||
size_t * | extents, | ||
size_t * | size, | ||
ptrdiff_t * | displ, | ||
cs_datatype_t * | datatype, | ||
int * | count | ||
) |
Get data extents for a given event attribute.
For attributes not currently present, the displacement and data size should be -1 and 0 respectively.
[in] | events | associated event set |
[in] | attr | event attribute |
[out] | extents | size (in bytes) of event structure, or NULL |
[out] | size | size (in bytes) of attribute in event structure, or NULL |
[out] | displ | displacement (in bytes) in event structure, or NULL |
[out] | datatype | datatype of associated attribute, or NULL |
[out] | count | number of type values associated with attribute, or NULL |
Get data extents for a given event attribute.
For attributes not currently present, the displacement and data size should be -1 and 0 respectively.
[in] | events | associated event set |
[in] | attr | event attribute |
[out] | extents | size (in bytes) of event structure, or NULL |
[out] | size | size (in bytes) of attribute in event structure, or NULL |
[out] | displ | displacement (in bytes) in event structure, or NULL |
[out] | datatype | datatype of associated attribute, or NULL |
[out] | count | number of type values associated with attribute, or NULL |
const cs_lagr_event_attribute_map_t* cs_lagr_event_get_attr_map | ( | void | ) |
Return const pointer to the main event attribute map structure.
Return const pointer to the main event attribute map structure.
const char* cs_lagr_event_get_attr_name | ( | cs_lagr_event_attribute_t | attr | ) |
Return name associated with a given attribute.
[in] | attr | event attribute |
void cs_lagr_event_init_from_particle | ( | cs_lagr_event_set_t * | events, |
cs_lagr_particle_set_t * | particles, | ||
cs_lnum_t | event_id, | ||
cs_lnum_t | particle_id | ||
) |
void cs_lagr_event_initialize | ( | void | ) |
Define event map based on defined options.
This function should only be called after cs_lagr_particle_attr_initialize, as it may use elements from the main particle attributes map.
Define event map based on defined options.
This function should only be called after cs_lagr_particle_attr_initialize, as it may use elements from the main particle attributes map.
cs_lagr_event_set_t* cs_lagr_event_set_boundary_interaction | ( | void | ) |
Return a cs_lagr_event_set_t structure for particle/boundary interactions.
The event set is created if not present yet.
This event set is automatically freed and destroyed at the end of the computation.
cs_lagr_event_set_t* cs_lagr_event_set_create | ( | void | ) |
Create a cs_lagr_event_set_t structure.
void cs_lagr_event_set_destroy | ( | cs_lagr_event_set_t ** | events | ) |
Destroy a cs_lagr_event_set_t structure.
[in,out] | events | pointer to pointer to event set to destroy |
void cs_lagr_event_set_dump | ( | const cs_lagr_event_set_t * | events | ) |
Dump a cs_lagr_event_set_t structure.
[in] | events | cs_lagr_event_t structure to dump |
[in] | events | cs_lagr_event_set_t structure to dump |
void cs_lagr_event_set_resize | ( | cs_lagr_event_set_t * | event_set, |
cs_lnum_t | min_size | ||
) |