Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::IVariableSynchronizerMng Class Referenceabstract

Interface of the variable synchronization manager. More...

#include <arcane/core/IVariableSynchronizerMng.h>

Inheritance diagram for Arcane::IVariableSynchronizerMng:
Collaboration diagram for Arcane::IVariableSynchronizerMng:

Public Member Functions

virtual IParallelMngparallelMng () const =0
 Associated parallelism manager.
virtual EventObservable< const VariableSynchronizerEventArgs & > & onSynchronized ()=0
 Event sent at the beginning and end of synchronization.
virtual void setSynchronizationCompareLevel (Int32 v)=0
 Sets the comparison level between values before and after synchronization.
virtual Int32 synchronizationCompareLevel () const =0
 Comparison level of values before and after synchronization.
virtual bool isSynchronizationComparisonEnabled () const =0
 Indicates whether comparisons of values before and after synchronization are performed.
virtual void dumpStats (std::ostream &ostr) const =0
 Prints statistics to the stream ostr.
virtual void flushPendingStats ()=0
 Processes pending statistics.
virtual IVariableSynchronizerMngInternal_internalApi ()=0

Detailed Description

Interface of the variable synchronization manager.

Definition at line 33 of file IVariableSynchronizerMng.h.

Member Function Documentation

◆ dumpStats()

virtual void Arcane::IVariableSynchronizerMng::dumpStats ( std::ostream & ostr) const
pure virtual

Prints statistics to the stream ostr.

Statistics must be processed via the call to flushPendingStats() before calling this method.

Implemented in Arcane::VariableSynchronizerMng.

◆ flushPendingStats()

virtual void Arcane::IVariableSynchronizerMng::flushPendingStats ( )
pure virtual

Processes pending statistics.

This method does nothing if isComparisonEnabled() is false.

This method is collective on parallelMng().

Implemented in Arcane::VariableSynchronizerMng.

Referenced by Arcane::TimeLoopMng::doComputeLoop().

Here is the caller graph for this function:

◆ isSynchronizationComparisonEnabled()

virtual bool Arcane::IVariableSynchronizerMng::isSynchronizationComparisonEnabled ( ) const
pure virtual

Indicates whether comparisons of values before and after synchronization are performed.

Implemented in Arcane::VariableSynchronizerMng.

◆ onSynchronized()

virtual EventObservable< const VariableSynchronizerEventArgs & > & Arcane::IVariableSynchronizerMng::onSynchronized ( )
pure virtual

Event sent at the beginning and end of synchronization.

This event is sent when calling the methods IVariableSynchronizer::synchronize(IVariable* var) and IVariableSynchronizer::synchronize(VariableCollection vars) for all instances of IVariableSynchronizer.

Implemented in Arcane::VariableSynchronizerMng.

◆ parallelMng()

virtual IParallelMng * Arcane::IVariableSynchronizerMng::parallelMng ( ) const
pure virtual

Associated parallelism manager.

Implemented in Arcane::VariableSynchronizerMng.

◆ setSynchronizationCompareLevel()

virtual void Arcane::IVariableSynchronizerMng::setSynchronizationCompareLevel ( Int32 v)
pure virtual

Sets the comparison level between values before and after synchronization.

The level must be the same across all ranks of parallelMng().

Implemented in Arcane::VariableSynchronizerMng.

◆ synchronizationCompareLevel()

virtual Int32 Arcane::IVariableSynchronizerMng::synchronizationCompareLevel ( ) const
pure virtual

Comparison level of values before and after synchronization.

Implemented in Arcane::VariableSynchronizerMng.


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