|
int | cs_lagr_stat_define (const char *name, int location_id, int stat_type, cs_lagr_stat_moment_t m_type, int class_id, int dim, int component_id, cs_lagr_moment_p_data_t *data_func, void *data_input, cs_lagr_moment_p_data_t *w_data_func, void *w_data_input, int nt_start, double t_start, cs_lagr_stat_restart_t restart_mode) |
| Define a particle statistic. More...
|
|
int | cs_lagr_stat_accumulator_define (const char *name, int location_id, int class_id, cs_lagr_moment_p_data_t *w_data_func, void *w_data_input, int nt_start, double t_start, cs_lagr_stat_restart_t restart_mode) |
| Define a particle weight type statistic. More...
|
|
int | cs_lagr_stat_time_moment_define (const char *name, int location_id, int stat_type, cs_lagr_stat_moment_t m_type, int class_id, int dim, int component_id, cs_lagr_moment_m_data_t *data_func, void *data_input, cs_lagr_moment_m_data_t *w_data_func, void *w_data_input, int nt_start, double t_start, cs_lagr_stat_restart_t restart_mode) |
| Define a time moment associated to particle statistics. More...
|
|
void | cs_lagr_stat_activate (int stat_type) |
| Activate Lagrangian statistics for a given statistics type. More...
|
|
void | cs_lagr_stat_deactivate (int stat_type) |
| Deactivate Lagrangian statistics for a given statistics type. More...
|
|
void | cs_lagr_stat_activate_attr (int attr_id) |
| Activate Lagrangian statistics for a given particle attribute. More...
|
|
void | cs_lagr_stat_deactivate_attr (int attr_id) |
| Deactivate Lagrangian statistics for a given particle attribute. More...
|
|
int | cs_lagr_stat_type_from_attr_id (int attr_id) |
| Return statistics type associated with a given particle attribute id. More...
|
|
int | cs_lagr_stat_type_to_attr_id (int stat_type) |
| Return attribute id associated with a given statistics type. More...
|
|
void | cs_lagr_stat_map_cell_dt (const cs_real_t *dt) |
| Map time step values array for Lagrangian statistics. More...
|
|
void | cs_lagr_stat_initialize (void) |
| Lagrangian statistics initialization. More...
|
|
void | cs_lagr_stat_update (void) |
| Update particle statistics for a given time step. More...
|
|
void | cs_lagr_stat_finalize (void) |
| Destroy all moments management metadata. More...
|
|
void | cs_lagr_stat_log_iteration (void) |
| Log moment definition information for a given iteration. More...
|
|
void | cs_lagr_stat_restart_write (cs_restart_t *restart) |
| Checkpoint moment data. More...
|
|
cs_field_t * | cs_lagr_stat_get_moment (int stat_type, cs_lagr_stat_moment_t m_type, int class_id, int component_id) |
| Return field associated with a given Lagrangian statistic, given a statistics type (i.e. variable), moment order, statistical class, and component id. More...
|
|
cs_field_t * | cs_lagr_stat_get_stat_weight (int class_id) |
| Return statistical weight. More...
|
|
cs_real_t | cs_lagr_stat_get_age (void) |
| Return global volume statistics age. More...
|
|
cs_real_t | cs_lagr_stat_get_moment_age (cs_field_t *f) |
| Return statistics age for a given moment. More...
|
|
int cs_lagr_stat_define |
( |
const char * |
name, |
|
|
int |
location_id, |
|
|
int |
stat_type, |
|
|
cs_lagr_stat_moment_t |
m_type, |
|
|
int |
class_id, |
|
|
int |
dim, |
|
|
int |
component_id, |
|
|
cs_lagr_moment_p_data_t * |
data_func, |
|
|
void * |
data_input, |
|
|
cs_lagr_moment_p_data_t * |
w_data_func, |
|
|
void * |
w_data_input, |
|
|
int |
nt_start, |
|
|
double |
t_start, |
|
|
cs_lagr_stat_restart_t |
restart_mode |
|
) |
| |
Define a particle statistic.
If dimension > 1, the val array is interleaved
- Parameters
-
[in] | name | statistics base name |
[in] | location_id | id of associated mesh location |
[in] | stat_type | predefined statistics type, or -1 |
[in] | m_type | moment type |
[in] | class_id | particle class id, or 0 for all |
[in] | dim | dimension associated with element data |
[in] | component_id | attribute component id, or < 0 for all |
[in] | data_func | pointer to function to compute statistics (if stat_type < 0) |
[in] | data_input | associated input |
[in] | w_data_func | pointer to function to compute weight (if NULL, statistic weight assumed) |
[in] | w_data_input | associated input for w_data_func |
[in] | nt_start | starting time step (or -1 to use t_start, 0 to use idstnt) |
[in] | t_start | starting time |
[in] | restart_mode | behavior in case of restart (reset, automatic, or strict) |
- Returns
- id of new moment in case of success, -1 in case of error.
(DOXYGEN_SHOULD_SKIP_THIS)
If dimension > 1, the val array is interleaved
- Parameters
-
[in] | name | statistics base name |
[in] | location_id | id of associated mesh location |
[in] | stat_type | predefined statistics type, or -1 |
[in] | m_type | moment type |
[in] | class | particle class id, or 0 for all |
[in] | dim | dimension associated with element data |
[in] | component_id | attribute component id, or < 0 for all |
[in] | data_func | pointer to function to compute statistics (if stat_type < 0) |
[in] | data_input | associated input |
[in] | w_data_func | pointer to function to compute weight (if NULL, statistic weight assumed) |
[in] | w_data_input | associated input for w_data_func |
[in] | nt_start | starting time step (or -1 to use t_start, 0 to use idstnt) |
[in] | t_start | starting time |
[in] | restart_mode | behavior in case of restart (reset, automatic, or strict) |
- Returns
- id of new moment in case of success, -1 in case of error.
Return field associated with a given Lagrangian statistic, given a statistics type (i.e. variable), moment order, statistical class, and component id.
- Parameters
-
[in] | stat_type | statistics type |
[in] | m_type | moment type (mean or variance) |
[in] | class_id | particle statistical class |
[in] | component_id | component id, or -1 for all |
- Returns
- pointer to the field associated to the corresponding moment
Return field associated with a given Lagrangian statistic, given a statistics type (i.e. variable), moment order, statistical class, and component id.
- Parameters
-
[in] | stat_type | statistics type |
[in] | m_type | moment type (mean or variance) |
[in] | class_id | particle statistical class |
[in] | component_id | component id, or -1 for all |
- Returns
- pointer to the field associated to the corresponding moment
int cs_lagr_stat_time_moment_define |
( |
const char * |
name, |
|
|
int |
location_id, |
|
|
int |
stat_type, |
|
|
cs_lagr_stat_moment_t |
m_type, |
|
|
int |
class_id, |
|
|
int |
dim, |
|
|
int |
component_id, |
|
|
cs_lagr_moment_m_data_t * |
data_func, |
|
|
void * |
data_input, |
|
|
cs_lagr_moment_m_data_t * |
w_data_func, |
|
|
void * |
w_data_input, |
|
|
int |
nt_start, |
|
|
double |
t_start, |
|
|
cs_lagr_stat_restart_t |
restart_mode |
|
) |
| |
Define a time moment associated to particle statistics.
This is similar to general time moments (see cs_time_moment.c), with restart, logging, and unsteady reinitialization behavior similar to other particle statistics.
If dimension > 1, the val array is interleaved
- Parameters
-
[in] | name | statistics base name |
[in] | location_id | id of associated mesh location |
[in] | stat_type | predefined statistics type, or -1 |
[in] | m_type | moment type |
[in] | class_id | particle class id, or 0 for all |
[in] | dim | dimension associated with element data |
[in] | component_id | attribute component id, or < 0 for all |
[in] | data_func | pointer to function to compute statistics (if stat_type < 0) |
[in] | data_input | associated input |
[in] | w_data_func | pointer to function to compute weight (if NULL, statistic weight assumed) |
[in] | w_data_input | associated input for w_data_func |
[in] | nt_start | starting time step (or -1 to use t_start, 0 to use idstnt) |
[in] | t_start | starting time |
[in] | restart_mode | behavior in case of restart (reset, automatic, or strict) |
- Returns
- id of new moment in case of success, -1 in case of error.