Référence de la classe Arcane::OutputChecker

Gère les sorties basées sur un temps physique, temps CPU ou un nombre d'itération. Plus de détails...

#include <arcane/core/OutputChecker.h>

Graphe de collaboration de Arcane::OutputChecker:

Types publics
enum	eOutType { OutTypeNone , OutTypeGlobalTime , OutTypeCPUTime , OutTypeIteration }
	Type de sortie. Plus de détails...

Fonctions membres publiques
	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())
	Vérifie s'il faut effectuer une sortie.
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

Fonctions membres privées
void	_recomputeTypeGlobalTime ()
void	_recomputeTypeCPUTime ()
void	_recomputeTypeIteration ()

Attributs privés
ISubDomain *	m_sub_domain
String	m_name
eOutType	m_out_type
VariableScalarInteger *	m_next_iteration
	Itération de la prochaine sauvegarde.
VariableScalarReal *	m_next_global_time
	Temps physique de la prochaine sauvegarde.
VariableScalarInteger *	m_next_cpu_time
	Temps CPU de la prochaine sauvegarde.
const CaseOptionInteger *	m_step_iteration
const CaseOptionReal *	m_step_global_time
const CaseOptionInteger *	m_step_cpu_time

Description détaillée

Gère les sorties basées sur un temps physique, temps CPU ou un nombre d'itération.

Le temps CPU est exprimé en minutes.

Définition à la ligne 37 du fichier OutputChecker.h.

Documentation des énumérations membres

eOutType

enum Arcane::OutputChecker::eOutType

Type de sortie.

Valeurs énumérées
OutTypeNone	Pas de sorties.
OutTypeGlobalTime	Sortie basée sur le temps physique.
OutTypeCPUTime	Sortie basée sur le temps CPU consommé
OutTypeIteration	Sortie basée sur le nombre d'itérations.

Définition à la ligne 42 du fichier OutputChecker.h.

Documentation des constructeurs et destructeur

OutputChecker()

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

Définition à la ligne 33 du fichier OutputChecker.cc.

Documentation des fonctions membres

_recomputeTypeCPUTime()

void Arcane::OutputChecker::_recomputeTypeCPUTime ( )

private

Définition à la ligne 235 du fichier OutputChecker.cc.

_recomputeTypeGlobalTime()

void Arcane::OutputChecker::_recomputeTypeGlobalTime ( )

private

Définition à la ligne 212 du fichier OutputChecker.cc.

_recomputeTypeIteration()

void Arcane::OutputChecker::_recomputeTypeIteration ( )

private

Définition à la ligne 261 du fichier OutputChecker.cc.

assignCPUTime()

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

Définition à la ligne 53 du fichier OutputChecker.cc.

assignGlobalTime()

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

Définition à la ligne 46 du fichier OutputChecker.cc.

assignIteration()

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

Définition à la ligne 60 du fichier 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()
	)

Vérifie s'il faut effectuer une sortie.

• old_time et current_time sont utilisés pour les sorties en temps physique.
• current_iteration est utilisé pour les sorties en nombre d'itérations
• cpu_time_used est utilisé pour les sorties en temps CPU.

Lorsqu'un type de sortie n'est pas disponible, la ou les valeurs associées ne sont pas utilisées et peuvent être quelconques.

Paramètres

old_time	temps physique de l'itération précédente.
current_time	temps physique courant.
current_iteration	itération courante.
cpu_time_used	temps cpu utilisé

Définition à la ligne 85 du fichier OutputChecker.cc.

Références Arccore::ITraceMng::debug().

Référencé par Arcane::ArcanePostProcessingModule::exportData(), et Arcane::ArcanePostProcessingModule::exportDataStart().

hasOutput()

bool Arcane::OutputChecker::hasOutput ( ) const

inline

Définition à la ligne 58 du fichier OutputChecker.h.

initialize() [1/2]

void Arcane::OutputChecker::initialize

(

)

Définition à la ligne 288 du fichier OutputChecker.cc.

initialize() [2/2]

void Arcane::OutputChecker::initialize

(

bool

recompute_next_value

)

Définition à la ligne 297 du fichier OutputChecker.cc.

nextCPUTime()

Integer Arcane::OutputChecker::nextCPUTime

(

)

const

Définition à la ligne 367 du fichier OutputChecker.cc.

nextGlobalTime()

Real Arcane::OutputChecker::nextGlobalTime

(

)

const

Définition à la ligne 343 du fichier OutputChecker.cc.

nextIteration()

Integer Arcane::OutputChecker::nextIteration

(

)

const

Définition à la ligne 355 du fichier OutputChecker.cc.

Documentation des données membres

m_name

String Arcane::OutputChecker::m_name

private

Définition à la ligne 71 du fichier OutputChecker.h.

m_next_cpu_time

VariableScalarInteger* Arcane::OutputChecker::m_next_cpu_time

private

Temps CPU de la prochaine sauvegarde.

Définition à la ligne 75 du fichier OutputChecker.h.

m_next_global_time

VariableScalarReal* Arcane::OutputChecker::m_next_global_time

private

Temps physique de la prochaine sauvegarde.

Définition à la ligne 74 du fichier OutputChecker.h.

m_next_iteration

VariableScalarInteger* Arcane::OutputChecker::m_next_iteration

private

Itération de la prochaine sauvegarde.

Définition à la ligne 73 du fichier OutputChecker.h.

m_out_type

eOutType Arcane::OutputChecker::m_out_type

private

Définition à la ligne 72 du fichier OutputChecker.h.

m_step_cpu_time

const CaseOptionInteger* Arcane::OutputChecker::m_step_cpu_time

private

Définition à la ligne 78 du fichier OutputChecker.h.

m_step_global_time

const CaseOptionReal* Arcane::OutputChecker::m_step_global_time

private

Définition à la ligne 77 du fichier OutputChecker.h.

m_step_iteration

const CaseOptionInteger* Arcane::OutputChecker::m_step_iteration

private

Définition à la ligne 76 du fichier OutputChecker.h.

m_sub_domain

ISubDomain* Arcane::OutputChecker::m_sub_domain

private

Définition à la ligne 70 du fichier OutputChecker.h.

---

La documentation de cette classe a été générée à partir des fichiers suivants :

• OutputChecker.h
• OutputChecker.cc