Arcane::MeshCriteriaLoadBalanceMng Class Reference

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

#include <arcane/core/MeshCriteriaLoadBalanceMng.h>

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

Detailed Description

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

Definition at line 34 of file MeshCriteriaLoadBalanceMng.h.

Constructor & Destructor Documentation

MeshCriteriaLoadBalanceMng()

Arcane::MeshCriteriaLoadBalanceMng::MeshCriteriaLoadBalanceMng	(	ISubDomain *	sd,
		const MeshHandle &	mesh_handle )

Constructor.

Parameters

sd	The subdomain where the ILoadBalanceMng instance is located.
mesh_handle	The mesh on which the criteria will be defined.

Definition at line 31 of file MeshCriteriaLoadBalanceMng.cc.

Member Function Documentation

addCommCost()

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

overridevirtual

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.

Implements Arcane::ICriteriaLoadBalanceMng.

Definition at line 77 of file MeshCriteriaLoadBalanceMng.cc.

addCriterion() [1/2]

void Arcane::MeshCriteriaLoadBalanceMng::addCriterion ( VariableCellInt32 & count )

overridevirtual

Method allowing a criterion to be added for each cell.

Parameters

count

A cell variable with a weight per cell.

Implements Arcane::ICriteriaLoadBalanceMng.

Definition at line 50 of file MeshCriteriaLoadBalanceMng.cc.

addCriterion() [2/2]

void Arcane::MeshCriteriaLoadBalanceMng::addCriterion ( VariableCellReal & count )

overridevirtual

Method allowing a criterion to be added for each cell.

Parameters

count

A cell variable with a weight per cell.

Implements Arcane::ICriteriaLoadBalanceMng.

Definition at line 59 of file MeshCriteriaLoadBalanceMng.cc.

addMass()

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

overridevirtual

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.

Implements Arcane::ICriteriaLoadBalanceMng.

Definition at line 68 of file MeshCriteriaLoadBalanceMng.cc.

nbCriteria()

Integer Arcane::MeshCriteriaLoadBalanceMng::nbCriteria ( )

overridevirtual

Method allowing to retrieve the number of criteria already registered.

Returns

The number of criteria.

Implements Arcane::ICriteriaLoadBalanceMng.

Definition at line 122 of file MeshCriteriaLoadBalanceMng.cc.

reset()

void Arcane::MeshCriteriaLoadBalanceMng::reset ( )

overridevirtual

Method allowing the criteria already added to be cleared.

Implements Arcane::ICriteriaLoadBalanceMng.

Definition at line 41 of file MeshCriteriaLoadBalanceMng.cc.

setCellCommContrib()

void Arcane::MeshCriteriaLoadBalanceMng::setCellCommContrib ( bool active )

overridevirtual

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.

Implements Arcane::ICriteriaLoadBalanceMng.

Definition at line 104 of file MeshCriteriaLoadBalanceMng.cc.

setComputeComm()

void Arcane::MeshCriteriaLoadBalanceMng::setComputeComm ( bool active )

overridevirtual

Parameters

active

Implements Arcane::ICriteriaLoadBalanceMng.

Definition at line 113 of file MeshCriteriaLoadBalanceMng.cc.

setMassAsCriterion()

void Arcane::MeshCriteriaLoadBalanceMng::setMassAsCriterion ( bool active )

overridevirtual

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.

Implements Arcane::ICriteriaLoadBalanceMng.

Definition at line 86 of file MeshCriteriaLoadBalanceMng.cc.

setNbCellsAsCriterion()

void Arcane::MeshCriteriaLoadBalanceMng::setNbCellsAsCriterion ( bool active )

overridevirtual

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.

Implements Arcane::ICriteriaLoadBalanceMng.

Definition at line 95 of file MeshCriteriaLoadBalanceMng.cc.

---

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

• MeshCriteriaLoadBalanceMng.h
• MeshCriteriaLoadBalanceMng.cc