Arcane::ICriteriaLoadBalanceMng Class Reference

Class interface allowing criteria to be added to adjust the load balance. More...

#include <arcane/core/ICriteriaLoadBalanceMng.h>

Public Member Functions
virtual	~ICriteriaLoadBalanceMng ()=default
	Frees resources.
virtual void	addCriterion (VariableCellInt32 &count)=0
	Method allowing a criterion to be added for each cell.
virtual void	addCriterion (VariableCellReal &count)=0
	Method allowing a criterion to be added for each cell.
virtual void	addMass (VariableCellInt32 &count, const String &entity)=0
	Method allowing a criterion to be added for each cell.
virtual void	addCommCost (VariableFaceInt32 &count, const String &entity)=0
	Method allowing a criterion to be added for each face.
virtual void	reset ()=0
	Method allowing the criteria already added to be cleared.
virtual void	setMassAsCriterion (bool active)=0
	Method allowing to specify if the data mass of each cell is a criterion for load balance.
virtual void	setNbCellsAsCriterion (bool active)=0
	Method allowing to specify if the number of cells in a subdomain must be a criterion for load balance.
virtual void	setCellCommContrib (bool active)=0
	Method allowing to specify if the mass of communications between cells must be a criterion for load balance.
virtual void	setComputeComm (bool active)=0
virtual Integer	nbCriteria ()=0
	Method allowing to retrieve the number of criteria already registered.

Detailed Description

Class interface allowing criteria to be added to adjust the load balance.

Definition at line 33 of file ICriteriaLoadBalanceMng.h.

Member Function Documentation

addCommCost()

virtual void Arcane::ICriteriaLoadBalanceMng::addCommCost ( VariableFaceInt32 & count, const String & entity )

pure virtual

Method allowing a criterion to be added for each face.

Parameters

count	A face variable with a weight per face.
entity	The entity type linked to this criterion.

Implemented in Arcane::MeshCriteriaLoadBalanceMng.

addCriterion() [1/2]

virtual void Arcane::ICriteriaLoadBalanceMng::addCriterion ( VariableCellInt32 & count )

pure virtual

Method allowing a criterion to be added for each cell.

Parameters

count

A cell variable with a weight per cell.

Implemented in Arcane::MeshCriteriaLoadBalanceMng.

addCriterion() [2/2]

virtual void Arcane::ICriteriaLoadBalanceMng::addCriterion ( VariableCellReal & count )

pure virtual

Method allowing a criterion to be added for each cell.

Parameters

count

A cell variable with a weight per cell.

Implemented in Arcane::MeshCriteriaLoadBalanceMng.

addMass()

virtual void Arcane::ICriteriaLoadBalanceMng::addMass ( VariableCellInt32 & count, const String & entity )

pure virtual

Method allowing a criterion to be added for each cell.

Parameters

count	A cell variable with a weight per cell.
entity	The entity type linked to this criterion.

Implemented in Arcane::MeshCriteriaLoadBalanceMng.

nbCriteria()

virtual Integer Arcane::ICriteriaLoadBalanceMng::nbCriteria ( )

pure virtual

Method allowing to retrieve the number of criteria already registered.

Returns

The number of criteria.

Implemented in Arcane::MeshCriteriaLoadBalanceMng.

reset()

virtual void Arcane::ICriteriaLoadBalanceMng::reset ( )

pure virtual

Method allowing the criteria already added to be cleared.

Implemented in Arcane::MeshCriteriaLoadBalanceMng.

setCellCommContrib()

virtual void Arcane::ICriteriaLoadBalanceMng::setCellCommContrib ( bool active )

pure virtual

Method allowing to specify if the mass of communications between cells must be a criterion for load balance.

Parameters

active

true if the mass of communications must be a criterion.

Implemented in Arcane::MeshCriteriaLoadBalanceMng.

setComputeComm()

virtual void Arcane::ICriteriaLoadBalanceMng::setComputeComm ( bool active )

pure virtual

Parameters

active

Implemented in Arcane::MeshCriteriaLoadBalanceMng.

setMassAsCriterion()

virtual void Arcane::ICriteriaLoadBalanceMng::setMassAsCriterion ( bool active )

pure virtual

Method allowing to specify if the data mass of each cell is a criterion for load balance.

Parameters

active

true if the data mass must be a criterion.

Implemented in Arcane::MeshCriteriaLoadBalanceMng.

setNbCellsAsCriterion()

virtual void Arcane::ICriteriaLoadBalanceMng::setNbCellsAsCriterion ( bool active )

pure virtual

Method allowing to specify if the number of cells in a subdomain must be a criterion for load balance.

Parameters

active

true if the number of cells must be a criterion.

Implemented in Arcane::MeshCriteriaLoadBalanceMng.

---

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

• ICriteriaLoadBalanceMng.h