#include <arcane/core/PreciseOutputChecker.h>

Collaboration diagram for Arcane::PreciseOutputChecker:

Public Member Functions
void	initializeOutputPhysicalTime (double output_period)
void	initializeOutputPhysicalTime (ICaseFunction *output_period)
void	initializeOutputIteration (Integer output_period)
void	initializeOutputIteration (ICaseFunction *output_period)
bool	checkIfOutput (double old_time, double current_time, Integer current_iteration)
	Indicates whether or not an output should be made.

Private Member Functions
bool	_compareTime (Real current_time, Real compar_time)
	Internal method for comparing times.
bool	_checkTime (Real old_time, Real current_time, Real output_period)
	Method to control a fixed output.
bool	_checkOldTime (Real old_time, Real output_period, Integer curr_number_of_outputs)
	Method to check if a previous time does not trigger an output.
bool	_checkTimeInterval (Real output_period, Real current_time, Real period)
	Method to control an output by interval.

Private Attributes
double	m_output_period_physical_time = 0.0
ICaseFunction *	m_table_values_physical_time = nullptr
Integer	m_output_period_iteration = -1
ICaseFunction *	m_table_values_iteration = nullptr

Detailed Description

Service for controlling the execution of file outputs. This service is a singleton that must be initialized when the application starts.

Definition at line 33 of file PreciseOutputChecker.h.

Member Function Documentation

◆ _checkOldTime()

bool Arcane::PreciseOutputChecker::_checkOldTime	(	Real	old_time,
		Real	output_period,
		Integer	curr_number_of_outputs )

private

Method to check if a previous time does not trigger an output.

Definition at line 122 of file PreciseOutputChecker.cc.

References _compareTime().

Referenced by _checkTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _checkTime()

bool Arcane::PreciseOutputChecker::_checkTime	(	Real	old_time,
		Real	current_time,
		Real	output_period )

private

Method to control a fixed output.

Definition at line 158 of file PreciseOutputChecker.cc.

References _checkOldTime(), and _compareTime().

Referenced by checkIfOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _checkTimeInterval()

bool Arcane::PreciseOutputChecker::_checkTimeInterval	(	Real	output_period,
		Real	current_time,
		Real	period )

private

Method to control an output by interval.

Definition at line 97 of file PreciseOutputChecker.cc.

Referenced by checkIfOutput().

Here is the caller graph for this function:

◆ _compareTime()

bool Arcane::PreciseOutputChecker::_compareTime	(	Real	current_time,
		Real	compar_time )

private

Internal method for comparing times.

Definition at line 203 of file PreciseOutputChecker.cc.

Referenced by _checkOldTime(), and _checkTime().

Here is the caller graph for this function:

◆ checkIfOutput()

bool Arcane::PreciseOutputChecker::checkIfOutput	(	double	old_time,
		double	current_time,
		Integer	current_iteration )

Indicates whether or not an output should be made.

Definition at line 60 of file PreciseOutputChecker.cc.

References _checkTime(), and _checkTimeInterval().

Here is the call graph for this function:

◆ initializeOutputIteration() [1/2]

void Arcane::PreciseOutputChecker::initializeOutputIteration ( ICaseFunction * output_period )

Definition at line 51 of file PreciseOutputChecker.cc.

◆ initializeOutputIteration() [2/2]

void Arcane::PreciseOutputChecker::initializeOutputIteration ( Integer output_period )

Definition at line 42 of file PreciseOutputChecker.cc.

◆ initializeOutputPhysicalTime() [1/2]

void Arcane::PreciseOutputChecker::initializeOutputPhysicalTime ( double output_period )

Initialization based on the user data set.

Definition at line 24 of file PreciseOutputChecker.cc.

◆ initializeOutputPhysicalTime() [2/2]

void Arcane::PreciseOutputChecker::initializeOutputPhysicalTime ( ICaseFunction * output_period )

Definition at line 33 of file PreciseOutputChecker.cc.

Member Data Documentation

◆ m_output_period_iteration

Integer Arcane::PreciseOutputChecker::m_output_period_iteration = -1

private

Definition at line 65 of file PreciseOutputChecker.h.

◆ m_output_period_physical_time

double Arcane::PreciseOutputChecker::m_output_period_physical_time = 0.0

private

Definition at line 63 of file PreciseOutputChecker.h.

◆ m_table_values_iteration

ICaseFunction* Arcane::PreciseOutputChecker::m_table_values_iteration = nullptr

private

Definition at line 66 of file PreciseOutputChecker.h.

◆ m_table_values_physical_time

ICaseFunction* Arcane::PreciseOutputChecker::m_table_values_physical_time = nullptr

private

Definition at line 64 of file PreciseOutputChecker.h.

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ _checkOldTime()

◆ _checkTime()

◆ _checkTimeInterval()

◆ _compareTime()

◆ checkIfOutput()

◆ initializeOutputIteration() [1/2]

◆ initializeOutputIteration() [2/2]

◆ initializeOutputPhysicalTime() [1/2]

◆ initializeOutputPhysicalTime() [2/2]

Member Data Documentation

◆ m_output_period_iteration

◆ m_output_period_physical_time

◆ m_table_values_iteration

◆ m_table_values_physical_time