Manages outputs based on physical time, CPU time, or a number of iterations. More...

#include <arcane/core/OutputChecker.h>

Public Types
enum	eOutType { OutTypeNone , OutTypeGlobalTime , OutTypeCPUTime , OutTypeIteration }
	Output type. More...

Public Member Functions
	OutputChecker (ISubDomain *sd, const String &name)
void	initialize ()
void	initialize (bool recompute_next_value)
bool	hasOutput () const
bool	check (Real old_time, Real current_time, Integer current_iteration, Integer current_cpu_time, const String &from_function=String())
	Checks whether an output should be performed.
void	assignGlobalTime (VariableScalarReal variable, const CaseOptionReal option)
void	assignCPUTime (VariableScalarInteger variable, const CaseOptionInteger option)
void	assignIteration (VariableScalarInteger variable, const CaseOptionInteger option)
Real	nextGlobalTime () const
Integer	nextIteration () const
Integer	nextCPUTime () const

Detailed Description

Manages outputs based on physical time, CPU time, or a number of iterations.

CPU time is expressed in minutes.

Definition at line 37 of file OutputChecker.h.

Member Enumeration Documentation

◆ eOutType

enum Arcane::OutputChecker::eOutType

Output type.

Enumerator
OutTypeNone	No outputs.
OutTypeGlobalTime	Output based on physical time.
OutTypeCPUTime	Output based on consumed CPU time.
OutTypeIteration	Output based on number of iterations.

Definition at line 42 of file OutputChecker.h.

Constructor & Destructor Documentation

◆ OutputChecker()

Arcane::OutputChecker::OutputChecker	(	ISubDomain *	sd,
		const String &	name )

Definition at line 34 of file OutputChecker.cc.

Member Function Documentation

◆ assignCPUTime()

void Arcane::OutputChecker::assignCPUTime	(	VariableScalarInteger *	variable,
		const CaseOptionInteger *	option )

Definition at line 54 of file OutputChecker.cc.

◆ assignGlobalTime()

void Arcane::OutputChecker::assignGlobalTime	(	VariableScalarReal *	variable,
		const CaseOptionReal *	option )

Definition at line 47 of file OutputChecker.cc.

◆ assignIteration()

void Arcane::OutputChecker::assignIteration	(	VariableScalarInteger *	variable,
		const CaseOptionInteger *	option )

Definition at line 61 of file OutputChecker.cc.

◆ check()

bool Arcane::OutputChecker::check	(	Real	old_time,
		Real	current_time,
		Integer	current_iteration,
		Integer	cpu_time_used,
		const String &	from_function = String() )

Checks whether an output should be performed.

old_time and current_time are used for physical time outputs.
current_iteration is used for iteration count outputs.
cpu_time_used is used for CPU time outputs.

When an output type is not available, the associated value(s) are not used and may be arbitrary.

Parameters

old_time	physical time of the previous iteration.
current_time	current physical time.
current_iteration	current iteration.
cpu_time_used	CPU time used

Definition at line 86 of file OutputChecker.cc.

References Arcane::ITraceMng::debug(), Arcane::math::floor(), Arcane::math::isEqual(), Arcane::math::isZero(), OutTypeCPUTime, OutTypeGlobalTime, OutTypeIteration, and OutTypeNone.

◆ hasOutput()

bool Arcane::OutputChecker::hasOutput ( ) const

inline

Definition at line 58 of file OutputChecker.h.

◆ initialize() [1/2]

void Arcane::OutputChecker::initialize ( )

Definition at line 286 of file OutputChecker.cc.

◆ initialize() [2/2]

void Arcane::OutputChecker::initialize ( bool recompute_next_value )

Definition at line 295 of file OutputChecker.cc.

◆ nextCPUTime()

Integer Arcane::OutputChecker::nextCPUTime ( ) const

Definition at line 365 of file OutputChecker.cc.

◆ nextGlobalTime()

Real Arcane::OutputChecker::nextGlobalTime ( ) const

Definition at line 341 of file OutputChecker.cc.

◆ nextIteration()

Integer Arcane::OutputChecker::nextIteration ( ) const

Definition at line 353 of file OutputChecker.cc.

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

Public Types

Public Member Functions