#include "base/cs_base.h"
#include "base/cs_field.h"
#include "base/cs_restart.h"
#include "base/cs_function.h"

Include dependency graph for cs_time_moment.h:

Typedefs
typedef void	cs_time_moment_data_t(const void input, cs_real_t vals)

Enumerations
enum	cs_time_moment_type_t { CS_TIME_MOMENT_MEAN , CS_TIME_MOMENT_VARIANCE }
enum	cs_time_moment_restart_t { CS_TIME_MOMENT_RESTART_RESET , CS_TIME_MOMENT_RESTART_AUTO , CS_TIME_MOMENT_RESTART_EXACT }

Functions
void	cs_time_moment_destroy_all (void)
	Destroy all moments management metadata.
void	cs_time_moment_map_cell_dt (const cs_real_t *dt)
	Map time step values array for temporal moments.
void	cs_time_moment_update_all (void)
	Update all moment accumulators.
int	cs_time_moment_is_active (int moment_id)
	Return 1 if moment is active, 0 if it is not active yet.
int	cs_time_moment_define_by_field_ids (const char name, int n_fields, const int field_id[], const int component_id[], cs_time_moment_type_t type, int nt_start, double t_start, cs_time_moment_restart_t restart_mode, const char restart_name)
	Define a moment of a product of existing fields components.
int	cs_time_moment_define_by_field (const char name, const cs_field_t f, cs_time_moment_type_t type, int nt_start, double t_start, cs_time_moment_restart_t restart_mode, const char *restart_name)
	Define a time moment of an existing field.
int	cs_time_moment_define_by_function (const char name, cs_function_t f, cs_time_moment_type_t type, int nt_start, double t_start, cs_time_moment_restart_t restart_mode, const char *restart_name)
	Define a time moment based on an evaluation function.
int	cs_time_moment_define_by_func (const char name, int location_id, int dim, bool is_intensive, cs_time_moment_data_t data_func, const void data_input, cs_time_moment_data_t w_data_func, void w_data_input, cs_time_moment_type_t type, int nt_start, double t_start, cs_time_moment_restart_t restart_mode, const char restart_name)
	Define a moment whose data values will be computed using a specified function.
int	cs_time_moment_n_moments (void)
	Return the number of defined time moments.
int	cs_time_moment_n_moments_restart (void)
	Return the number of time moments in the restart file, if any.
void	cs_time_moment_restart_options_by_id (int restart_id, cs_time_moment_restart_t restart_mode, const char *restart_name)
	Define a moment restart mode and name by an id.
const char *	cs_time_moment_restart_name (int restart_id)
	Return name of a given time moments in the restart file, if any (check also cs_time_moment_n_moments_restart).
cs_field_t *	cs_time_moment_get_field (int moment_id)
	Return pointer to field associated with a given moment.
void	cs_time_moment_reset (int moment_id)
	Set current iteration as starting time step of selected moment.
void	cs_time_moment_log_setup (void)
	Log moment definition setup information.
void	cs_time_moment_log_iteration (void)
	Log moment definition information for a given iteration.
void	cs_time_moment_restart_use_main (int use_main)
	Indicate if restart API should use "main" instead of "auxiliary" file.
void	cs_time_moment_restart_read (cs_restart_t *restart)
	Read restart moment data.
void	cs_time_moment_restart_write (cs_restart_t *restart)
	Checkpoint moment data.

Variables
const char *	cs_time_moment_type_name []

Typedef Documentation

◆ cs_time_moment_data_t

typedef void cs_time_moment_data_t(const void *input, cs_real_t *vals)

Enumeration Type Documentation

◆ cs_time_moment_restart_t

enum cs_time_moment_restart_t

Enumerator
CS_TIME_MOMENT_RESTART_RESET	Moment is reset in case of a restart file: starting time step will be no older than the restart time step.
CS_TIME_MOMENT_RESTART_AUTO	Moment uses restart information if available: if the requested time step is older than the restart time step, restart information will be used, though the starting time step is not guaranteed.
CS_TIME_MOMENT_RESTART_EXACT	If the requested time step is older than the restart time step, restart information will be used, and if the start time step or time does not match the one available, an error is thrown.

◆ cs_time_moment_type_t

enum cs_time_moment_type_t

Enumerator
CS_TIME_MOMENT_MEAN	Moment is a mean
CS_TIME_MOMENT_VARIANCE	Moment is a variance

Function Documentation

◆ cs_time_moment_define_by_field()

int cs_time_moment_define_by_field	(	const char *	name,
		const cs_field_t *	f,
		cs_time_moment_type_t	type,
		int	nt_start,
		double	t_start,
		cs_time_moment_restart_t	restart_mode,
		const char *	restart_name )

Define a time moment of an existing field.

Moments will involve the tensor products of their component fields, and only scalar, vector, or rank-2 tensors are handled (for post-processing output reasons), so a 1st-order moment (i.e. mean) may involve a scalar, vector, or tensor, while a second-order moment (i.e. variance) may only involve a scalar or vector.

Parameters

[in]	name	name of associated moment
[in]	f	pointer to associated field
[in]	type	moment type
[in]	nt_start	starting time step (or -1 to use t_start)
[in]	t_start	starting time
[in]	restart_mode	behavior in case of restart (reset, automatic, or strict)
[in]	restart_name	if non-null, previous name in case of restart

Returns: id of new moment in case of success, -1 in case of error.

◆ cs_time_moment_define_by_field_ids()

int cs_time_moment_define_by_field_ids	(	const char *	name,
		int	n_fields,
		const int	field_id[],
		const int	component_id[],
		cs_time_moment_type_t	type,
		int	nt_start,
		double	t_start,
		cs_time_moment_restart_t	restart_mode,
		const char *	restart_name )

Define a moment of a product of existing fields components.

Moments will involve the tensor products of their component fields, and only scalar, vector, or rank-2 tensors are handled (for post-processing output reasons), so a moment may not involve more than 2 vectors or 1 tensor, unless single components are specified.

Parameters

[in]	name	name of associated moment
[in]	n_fields	number of associated fields
[in]	field_id	ids of associated fields
[in]	component_id	ids of matching field components (-1 for all)
[in]	type	moment type
[in]	nt_start	starting time step (or -1 to use t_start)
[in]	t_start	starting time
[in]	restart_mode	behavior in case of restart (reset, automatic, or strict)
[in]	restart_name	if non-null, previous name in case of restart

Returns: id of new moment in case of success, -1 in case of error.

◆ cs_time_moment_define_by_func()

int cs_time_moment_define_by_func	(	const char *	name,
		int	location_id,
		int	dim,
		bool	is_intensive,
		cs_time_moment_data_t *	data_func,
		const void *	data_input,
		cs_time_moment_data_t *	w_data_func,
		void *	w_data_input,
		cs_time_moment_type_t	type,
		int	nt_start,
		double	t_start,
		cs_time_moment_restart_t	restart_mode,
		const char *	restart_name )

Define a moment whose data values will be computed using a specified function.

Parameters

[in]	name	name of associated moment
[in]	location_id	id of associated mesh location
[in]	dim	dimension associated with element data
[in]	is_intensive	is the time moment intensive?
[in]	data_func	function used to define data values
[in]	data_input	pointer to optional (untyped) value or structure to be used by data_func
[in]	w_data_func	function used to define weight values
[in]	w_data_input	pointer to optional (untyped) value or structure to be used by w_data_func
[in]	type	moment type
[in]	nt_start	starting time step (or -1 to use t_start)
[in]	t_start	starting time
[in]	restart_mode	behavior in case of restart (reset, automatic, or strict)
[in]	restart_name	if non-null, previous name in case of restart

Returns: id of new moment in case of success, -1 in case of error.

◆ cs_time_moment_define_by_function()

int cs_time_moment_define_by_function	(	const char *	name,
		cs_function_t *	f,
		cs_time_moment_type_t	type,
		int	nt_start,
		double	t_start,
		cs_time_moment_restart_t	restart_mode,
		const char *	restart_name )

Define a time moment based on an evaluation function.

Moments will involve the tensor products of their component fields, and only scalar, vector, or rank-2 tensors are handled (for post-processing output reasons), so a 1st-order moment (i.e. mean) may involve a scalar, vector, or tensor, while a second-order moment (i.e. variance) may only involve a scalar or vector.

Parameters

[in]	name	name of associated moment
[in]	f	pointer to function object
[in]	type	moment type
[in]	nt_start	starting time step (or -1 to use t_start)
[in]	t_start	starting time
[in]	restart_mode	behavior in case of restart (reset, automatic, or strict)
[in]	restart_name	if non-null, previous name in case of restart

Returns: id of new moment in case of success, -1 in case of error.

◆ cs_time_moment_destroy_all()

void cs_time_moment_destroy_all ( void )

Destroy all moments management metadata.

◆ cs_time_moment_get_field()

cs_field_t * cs_time_moment_get_field ( int moment_id )

Return pointer to field associated with a given moment.

For moments defined automatically to assist computation of higher order moments, which do not have an associated field, a null pointer is returned.

Parameters

[in] moment_id id of associated moment

Returns: pointer to field associated with given moment, or null

◆ cs_time_moment_is_active()

int cs_time_moment_is_active ( int moment_id )

Return 1 if moment is active, 0 if it is not active yet.

Parameters

[in] moment_id id of associated moment

Returns: 1 if moment is active, 0 if it is not active yet

◆ cs_time_moment_log_iteration()

void cs_time_moment_log_iteration ( void )

Log moment definition information for a given iteration.

◆ cs_time_moment_log_setup()

void cs_time_moment_log_setup ( void )

Log moment definition setup information.

◆ cs_time_moment_map_cell_dt()

void cs_time_moment_map_cell_dt ( const cs_real_t * dt )

Map time step values array for temporal moments.

If this function is not called, the field referenced by field pointer CS_F_(dt) will be used instead.

Parameters

[in] dt pointer to time step values array

◆ cs_time_moment_n_moments()

int cs_time_moment_n_moments ( void )

Return the number of defined time moments.

Returns: number of defined time moments

◆ cs_time_moment_n_moments_restart()

int cs_time_moment_n_moments_restart ( void )

Return the number of time moments in the restart file, if any.

Returns: number of defined moments in restart file, or 0

◆ cs_time_moment_reset()

void cs_time_moment_reset ( int moment_id )

Set current iteration as starting time step of selected moment.

All other time moments sharing the same start time should also be reset.

Parameters

[in] moment_id id of associated moment

◆ cs_time_moment_restart_name()

const char * cs_time_moment_restart_name ( int restart_id )

Return name of a given time moments in the restart file, if any (check also cs_time_moment_n_moments_restart).

Parameters

[in] restart_id id of time moment in restart data

Returns: name of defined moment in restart file, or null

◆ cs_time_moment_restart_options_by_id()

void cs_time_moment_restart_options_by_id	(	int	restart_id,
		cs_time_moment_restart_t *	restart_mode,
		const char **	restart_name )

Define a moment restart mode and name by an id.

This is a utility function, to allow simplification of automatic setups. It must be called just before defining a moment to work properly if restart_id < -1 (automatic mode).

Parameters

[in]	restart_id	-2: automatic, -1: reset, >= 0: id of matching moment in restart data
[out]	restart_mode	matching restart mode
[out]	restart_name	matching restart name

◆ cs_time_moment_restart_read()

void cs_time_moment_restart_read ( cs_restart_t * restart )

Read restart moment data.

Parameters

[in] restart associated restart file pointer

◆ cs_time_moment_restart_use_main()

void cs_time_moment_restart_use_main ( int use_main )

Indicate if restart API should use "main" instead of "auxiliary" file.

Parameters

[in] use_main use "main" restart if nonzero, "auxiliary" otherwise

◆ cs_time_moment_restart_write()

void cs_time_moment_restart_write ( cs_restart_t * restart )

Checkpoint moment data.

Parameters

[in] restart associated restart file pointer

◆ cs_time_moment_update_all()

void cs_time_moment_update_all ( void )

Update all moment accumulators.

Variable Documentation

◆ cs_time_moment_type_name

const char* cs_time_moment_type_name[]

extern

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ cs_time_moment_data_t

Enumeration Type Documentation

◆ cs_time_moment_restart_t

◆ cs_time_moment_type_t

Function Documentation

◆ cs_time_moment_define_by_field()

◆ cs_time_moment_define_by_field_ids()

◆ cs_time_moment_define_by_func()

◆ cs_time_moment_define_by_function()

◆ cs_time_moment_destroy_all()

◆ cs_time_moment_get_field()

◆ cs_time_moment_is_active()

◆ cs_time_moment_log_iteration()

◆ cs_time_moment_log_setup()

◆ cs_time_moment_map_cell_dt()

◆ cs_time_moment_n_moments()

◆ cs_time_moment_n_moments_restart()

◆ cs_time_moment_reset()

◆ cs_time_moment_restart_name()

◆ cs_time_moment_restart_options_by_id()

◆ cs_time_moment_restart_read()

◆ cs_time_moment_restart_use_main()

◆ cs_time_moment_restart_write()

◆ cs_time_moment_update_all()

Variable Documentation

◆ cs_time_moment_type_name