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

Interface of a class for parallel operations on variables. More...

#include <arcane/core/IVariableParallelOperation.h>

Inheritance diagram for Arcane::IVariableParallelOperation:
Collaboration diagram for Arcane::IVariableParallelOperation:

Public Member Functions

virtual ~IVariableParallelOperation ()=default
 Releases resources.
virtual void build ()=0
 Constructs the instance.
virtual void setItemFamily (IItemFamily *family)=0
 Positions the entity family on which the operation is to be performed.
virtual IItemFamilyitemFamily ()=0
 Entity family on which the operation is performed.
virtual void addVariable (IVariable *variable)=0
 Adds a variable to the list of variables concerned by the operation.
virtual void applyOperation (IDataOperation *operation)=0
 Applies the operation.

Detailed Description

Interface of a class for parallel operations on variables.

These operations are collective.

Before performing the operation, the entity family must be positioned (setItemFamily()), then add the list of variables on which the operations will be performed.

Definition at line 38 of file IVariableParallelOperation.h.

Member Function Documentation

◆ addVariable()

virtual void Arcane::IVariableParallelOperation::addVariable ( IVariable * variable)
pure virtual

Adds a variable to the list of variables concerned by the operation.

Implemented in Arcane::Parallel::VariableParallelOperationBase.

◆ applyOperation()

virtual void Arcane::IVariableParallelOperation::applyOperation ( IDataOperation * operation)
pure virtual

Applies the operation.

Implemented in Arcane::Parallel::VariableParallelOperationBase.

◆ build()

virtual void Arcane::IVariableParallelOperation::build ( )
pure virtual

Constructs the instance.

Implemented in Arcane::Parallel::VariableParallelOperationBase.

◆ itemFamily()

virtual IItemFamily * Arcane::IVariableParallelOperation::itemFamily ( )
pure virtual

Entity family on which the operation is performed.

Implemented in Arcane::Parallel::VariableParallelOperationBase.

◆ setItemFamily()

virtual void Arcane::IVariableParallelOperation::setItemFamily ( IItemFamily * family)
pure virtual

Positions the entity family on which the operation is to be performed.

The family must be positioned before adding variables. It can only be done once.

Implemented in Arcane::Parallel::VariableParallelOperationBase.


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