Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::CommonVariables Class Reference
Variable

Common variables of a case. More...

#include <arcane/core/CommonVariables.h>

Inheritance diagram for Arcane::CommonVariables:
Collaboration diagram for Arcane::CommonVariables:

Public Member Functions

 CommonVariables (IModule *c)
 Constructs the references of the common variables for the module c.
 CommonVariables (IVariableMng *variable_mng)
 Constructs the references of the common variables for the manager variable_mng.
 CommonVariables (ISubDomain *sd)
 Constructs the references of the common variables for the subdomain sd.
virtual ~CommonVariables ()
 Releases resources.
Int32 globalIteration () const
 Current iteration number.
Real globalTime () const
 Current time.
Real globalOldTime () const
 Previous current time.
Real globalFinalTime () const
 Final time of the simulation.
Real globalDeltaT () const
 Current Delta T.
Real globalCPUTime () const
 CPU time used (in seconds).
Real globalOldCPUTime () const
 Previous CPU time used (in seconds).
Real globalElapsedTime () const
 Clock time (elapsed) used (in seconds).
Real globalOldElapsedTime () const
 Previous clock time (elapsed) used (in seconds).

Public Attributes

VariableScalarInt32 m_global_iteration
 Current iteration.
VariableScalarReal m_global_time
 Current time.
VariableScalarReal m_global_deltat
 Global Delta T.
VariableScalarReal m_global_old_time
 Time previous to the current time.
VariableScalarReal m_global_old_deltat
 Delta T at the time previous to the global time.
VariableScalarReal m_global_final_time
 Final time of the case.
VariableScalarReal m_global_old_cpu_time
 Previous CPU time used (in seconds).
VariableScalarReal m_global_cpu_time
 CPU time used (in seconds).
VariableScalarReal m_global_old_elapsed_time
 Previous clock time used (in seconds).
VariableScalarReal m_global_elapsed_time
 Clock time used (in seconds).

Friends

class ModuleMaster

Detailed Description

Common variables of a case.

Definition at line 39 of file CommonVariables.h.

Constructor & Destructor Documentation

◆ CommonVariables() [1/3]

Arcane::CommonVariables::CommonVariables ( IModule * c)

Constructs the references of the common variables for the module c.

Definition at line 27 of file CommonVariables.cc.

References CommonVariables().

Referenced by Arcane::BasicModule::BasicModule(), CommonVariables(), CommonVariables(), Arcane::ModuleMaster::commonVariables(), and Arcane::ModuleMaster::ModuleMaster().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ CommonVariables() [2/3]

Arcane::CommonVariables::CommonVariables ( IVariableMng * variable_mng)

Constructs the references of the common variables for the manager variable_mng.

Definition at line 45 of file CommonVariables.cc.

References m_global_cpu_time, m_global_deltat, m_global_elapsed_time, m_global_final_time, m_global_iteration, m_global_old_cpu_time, m_global_old_deltat, m_global_old_elapsed_time, m_global_old_time, and m_global_time.

◆ CommonVariables() [3/3]

Arcane::CommonVariables::CommonVariables ( ISubDomain * sd)

Constructs the references of the common variables for the subdomain sd.

Definition at line 36 of file CommonVariables.cc.

References CommonVariables().

Here is the call graph for this function:

◆ ~CommonVariables()

virtual Arcane::CommonVariables::~CommonVariables ( )
inlinevirtual

Releases resources.

Definition at line 54 of file CommonVariables.h.

Member Function Documentation

◆ globalCPUTime()

Real Arcane::CommonVariables::globalCPUTime ( ) const

CPU time used (in seconds).

Definition at line 99 of file CommonVariables.cc.

References m_global_cpu_time.

◆ globalDeltaT()

Real Arcane::CommonVariables::globalDeltaT ( ) const

Current Delta T.

Definition at line 87 of file CommonVariables.cc.

References m_global_deltat.

◆ globalElapsedTime()

Real Arcane::CommonVariables::globalElapsedTime ( ) const

Clock time (elapsed) used (in seconds).

Definition at line 111 of file CommonVariables.cc.

References m_global_elapsed_time.

◆ globalFinalTime()

Real Arcane::CommonVariables::globalFinalTime ( ) const

Final time of the simulation.

Definition at line 81 of file CommonVariables.cc.

References m_global_final_time.

◆ globalIteration()

Integer Arcane::CommonVariables::globalIteration ( ) const

Current iteration number.

Definition at line 63 of file CommonVariables.cc.

References m_global_iteration.

Referenced by Arcane::TimeLoopMng::_doMeshPartition(), Arcane::MetisMeshPartitioner::_partitionMesh(), Arcane::ArcaneLoadBalanceModule::checkLoadBalance(), Arcane::TimeLoopMng::doComputeLoop(), Arcane::TimeLoopMng::doOneIteration(), Arcane::ArcanePostProcessingModule::exportDataStart(), and Arcane::MeshPartitionerTester::partitionMesh().

Here is the caller graph for this function:

◆ globalOldCPUTime()

Real Arcane::CommonVariables::globalOldCPUTime ( ) const

Previous CPU time used (in seconds).

Definition at line 93 of file CommonVariables.cc.

References m_global_old_cpu_time.

◆ globalOldElapsedTime()

Real Arcane::CommonVariables::globalOldElapsedTime ( ) const

Previous clock time (elapsed) used (in seconds).

Definition at line 105 of file CommonVariables.cc.

References m_global_old_elapsed_time.

◆ globalOldTime()

Real Arcane::CommonVariables::globalOldTime ( ) const

Previous current time.

Definition at line 75 of file CommonVariables.cc.

References m_global_old_time.

Referenced by Arcane::ArcanePostProcessingModule::exportDataStart().

Here is the caller graph for this function:

◆ globalTime()

Real Arcane::CommonVariables::globalTime ( ) const

Current time.

Definition at line 69 of file CommonVariables.cc.

References m_global_time.

Referenced by Arcane::TimeLoopMng::doOneIteration(), Arcane::ArcanePostProcessingModule::exportData(), Arcane::ArcanePostProcessingModule::exportDataStart(), Arcane::ArcanePostProcessingModule::postProcessingExit(), and Arcane::Variable::setUpToDate().

Here is the caller graph for this function:

◆ ModuleMaster

friend class ModuleMaster
friend

Definition at line 43 of file CommonVariables.h.

Member Data Documentation

◆ m_global_cpu_time

VariableScalarReal Arcane::CommonVariables::m_global_cpu_time

CPU time used (in seconds).

Definition at line 87 of file CommonVariables.h.

Referenced by CommonVariables(), Arcane::ModuleMaster::dumpStandardCurves(), globalCPUTime(), Arcane::ModuleMaster::masterStartInit(), and Arcane::ModuleMaster::timeLoopBegin().

◆ m_global_deltat

VariableScalarReal Arcane::CommonVariables::m_global_deltat

Global Delta T.

Definition at line 82 of file CommonVariables.h.

Referenced by CommonVariables(), globalDeltaT(), ArcaneTest::AlephIndexTest::init(), ArcaneTest::AlephMultiTest::init(), ArcaneTest::AlephTestModule::init(), Arcane::ModuleMaster::timeIncrementation(), Arcane::ModuleMaster::timeLoopBegin(), and Arcane::ModuleMaster::timeStepInformation().

◆ m_global_elapsed_time

VariableScalarReal Arcane::CommonVariables::m_global_elapsed_time

Clock time used (in seconds).

Definition at line 89 of file CommonVariables.h.

Referenced by CommonVariables(), Arcane::ModuleMaster::dumpStandardCurves(), globalElapsedTime(), Arcane::ModuleMaster::masterStartInit(), and Arcane::ModuleMaster::timeLoopBegin().

◆ m_global_final_time

VariableScalarReal Arcane::CommonVariables::m_global_final_time

Final time of the case.

Definition at line 85 of file CommonVariables.h.

Referenced by CommonVariables(), and globalFinalTime().

◆ m_global_iteration

VariableScalarInt32 Arcane::CommonVariables::m_global_iteration

Current iteration.

Definition at line 80 of file CommonVariables.h.

Referenced by CommonVariables(), Arcane::TimeLoopMng::doOneIteration(), globalIteration(), Arcane::ModuleMaster::masterContinueInit(), Arcane::ModuleMaster::masterStartInit(), Arcane::ModuleMaster::timeLoopBegin(), Arcane::ModuleMaster::timeLoopEnd(), and Arcane::ModuleMaster::timeStepInformation().

◆ m_global_old_cpu_time

VariableScalarReal Arcane::CommonVariables::m_global_old_cpu_time

Previous CPU time used (in seconds).

Definition at line 86 of file CommonVariables.h.

Referenced by CommonVariables(), globalOldCPUTime(), Arcane::ModuleMaster::masterStartInit(), and Arcane::ModuleMaster::timeLoopBegin().

◆ m_global_old_deltat

VariableScalarReal Arcane::CommonVariables::m_global_old_deltat

Delta T at the time previous to the global time.

Definition at line 84 of file CommonVariables.h.

Referenced by CommonVariables(), Arcane::ModuleMaster::masterContinueInit(), and Arcane::ModuleMaster::masterStartInit().

◆ m_global_old_elapsed_time

VariableScalarReal Arcane::CommonVariables::m_global_old_elapsed_time

Previous clock time used (in seconds).

Definition at line 88 of file CommonVariables.h.

Referenced by CommonVariables(), globalOldElapsedTime(), Arcane::ModuleMaster::masterStartInit(), and Arcane::ModuleMaster::timeLoopBegin().

◆ m_global_old_time

VariableScalarReal Arcane::CommonVariables::m_global_old_time

Time previous to the current time.

Definition at line 83 of file CommonVariables.h.

Referenced by CommonVariables(), globalOldTime(), Arcane::ModuleMaster::masterContinueInit(), Arcane::ModuleMaster::masterStartInit(), and Arcane::ModuleMaster::timeLoopBegin().

◆ m_global_time

VariableScalarReal Arcane::CommonVariables::m_global_time

Current time.

Definition at line 81 of file CommonVariables.h.

Referenced by Arcane::ArcaneCheckpointModule::_doCheckpoint(), CommonVariables(), Arcane::ModuleMaster::dumpStandardCurves(), globalTime(), Arcane::ModuleMaster::masterStartInit(), Arcane::ModuleMaster::timeIncrementation(), Arcane::ModuleMaster::timeLoopBegin(), and Arcane::ModuleMaster::timeStepInformation().

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