zoltanDecomp Class Reference

Zoltan redistribution in parallel. More...

Inheritance diagram for zoltanDecomp:

Collaboration diagram for zoltanDecomp:

Public Member Functions
	TypeName ("zoltan")
	Runtime type information. More...
	zoltanDecomp (const dictionary &decompositionDict)
	Construct given the decomposition dictionary and mesh. More...
	zoltanDecomp (const zoltanDecomp &)=delete
	Disallow default bitwise copy construction. More...
virtual	~zoltanDecomp ()
	Destructor. More...
virtual labelList	decompose (const polyMesh &mesh, const pointField &points, const scalarField &pointWeights)
	Return for every coordinate the wanted processor number. Use the. More...
virtual labelList	decompose (const polyMesh &mesh, const labelList &agglom, const pointField &regionPoints, const scalarField &regionWeights)
	Return for every coordinate the wanted processor number. Gets. More...
virtual labelList	decompose (const labelListList &globalCellCells, const pointField &cc, const scalarField &cWeights)
	Return for every coordinate the wanted processor number. Explicitly. More...
void	operator= (const zoltanDecomp &)=delete
	Disallow default bitwise assignment. More...
virtual labelList	decompose (const pointField &points, const scalarField &pointWeights)
	Inherit decompose from decompositionMethod. More...
virtual labelList	decompose (const pointField &)
	Inherit decompose from decompositionMethod. More...
virtual labelList	decompose (const polyMesh &mesh, const pointField &points, const scalarField &pointWeights)=0
	Inherit decompose from decompositionMethod. More...
virtual labelList	decompose (const polyMesh &, const pointField &)
	Inherit decompose from decompositionMethod. More...
virtual labelList	decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField &regionPoints, const scalarField &regionWeights)
	Inherit decompose from decompositionMethod. More...
virtual labelList	decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField &regionPoints)
	Inherit decompose from decompositionMethod. More...
virtual labelList	decompose (const labelListList &globalCellCells, const pointField &cc, const scalarField &cWeights)=0
	Inherit decompose from decompositionMethod. More...
virtual labelList	decompose (const labelListList &globalCellCells, const pointField &cc)
	Inherit decompose from decompositionMethod. More...
virtual labelList	decompose (const polyMesh &mesh, const scalarField &cellWeights, const boolList &blockedFace, const PtrList< labelList > &specifiedProcessorFaces, const labelList &specifiedProcessor, const List< labelPair > &explicitConnections)
	Inherit decompose from decompositionMethod. More...
labelList	decompose (const polyMesh &mesh, const scalarField &cWeights)
	Inherit decompose from decompositionMethod. More...
Public Member Functions inherited from decompositionMethod
	TypeName ("decompositionMethod")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, decompositionMethod, decomposer,(const dictionary &decompositionDict),(decompositionDict))
	declareRunTimeSelectionTable (autoPtr, decompositionMethod, distributor,(const dictionary &decompositionDict),(decompositionDict))
	decompositionMethod (const dictionary &decompositionDict)
	Construct given the decomposition dictionary. More...
	decompositionMethod (const decompositionMethod &)=delete
	Disallow default bitwise copy construction. More...
virtual	~decompositionMethod ()
	Destructor. More...
label	nDomains () const
virtual labelList	decompose (const pointField &points, const scalarField &pointWeights)
	Return for every coordinate the wanted processor number. More...
virtual labelList	decompose (const pointField &)
	Like decompose but with uniform weights on the points. More...
virtual labelList	decompose (const polyMesh &, const pointField &)
	Like decompose but with uniform weights on the points. More...
virtual labelList	decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField &regionPoints)
	Like decompose but with uniform weights on the regions. More...
virtual labelList	decompose (const labelListList &globalCellCells, const pointField &cc)
	Like decompose but with uniform weights on the cells. More...
void	setConstraints (const polyMesh &mesh, boolList &blockedFace, PtrList< labelList > &specifiedProcessorFaces, labelList &specifiedProcessor, List< labelPair > &explicitConnections)
	Helper: extract constraints: More...
void	applyConstraints (const polyMesh &mesh, const boolList &blockedFace, const PtrList< labelList > &specifiedProcessorFaces, const labelList &specifiedProcessor, const List< labelPair > &explicitConnections, labelList &finalDecomp)
	Helper: apply constraints to a decomposition. This gives. More...
virtual labelList	decompose (const polyMesh &mesh, const scalarField &cellWeights, const boolList &blockedFace, const PtrList< labelList > &specifiedProcessorFaces, const labelList &specifiedProcessor, const List< labelPair > &explicitConnections)
labelList	decompose (const polyMesh &mesh, const scalarField &cWeights)
	Decompose a mesh. Apply all constraints from decomposeParDict. More...
void	operator= (const decompositionMethod &)=delete
	Disallow default bitwise assignment. More...

Additional Inherited Members
Static Public Member Functions inherited from decompositionMethod
static autoPtr< decompositionMethod >	NewDecomposer (const dictionary &decompositionDict)
	Return a reference to the selected decomposition method. More...
static autoPtr< decompositionMethod >	NewDistributor (const dictionary &decompositionDict)
	Return a reference to the selected decomposition method. More...
static dictionary	decomposeParDict (const Time &time)
	Read and return the decomposeParDict. More...
static void	calcCellCells (const polyMesh &mesh, const labelList &agglom, const label nLocalCoarse, const bool global, CompactListList< label > &cellCells)
	Helper: determine (local or global) cellCells from mesh. More...
static void	calcCellCells (const polyMesh &mesh, const labelList &agglom, const label nLocalCoarse, const bool parallel, CompactListList< label > &cellCells, CompactListList< scalar > &cellCellWeights)
	Helper: determine (local or global) cellCells and face weights. More...
Protected Attributes inherited from decompositionMethod
dictionary	decompositionDict_
label	nProcessors_
PtrList< decompositionConstraint >	constraints_
	Optional constraints. More...

Detailed Description

Zoltan redistribution in parallel.

Note: Zoltan methods do not support serial operation.

Parameters

• lb_method : The load-balancing algorithm
  • block : block partitioning
  • random : random partitioning
  • rcb : recursive coordinate bisection
  • rib : ecursive inertial bisection
  • hsfc : Hilbert space-filling curve partitioning
  • reftree : refinement tree based partitioning
  • graph : choose from collection of methods for graphs
  • hypergraph : choose from a collection of methods for hypergraphs

• lb_approach The desired load balancing approach. Only lb_method = hypergraph or graph uses the lb_approach parameter. Valid values are

  • partition : Partition without reference to the current distribution, recommended for static load balancing.
  • repartition : Partition starting from the current data distribution to keep data migration low, recommended for dynamic load balancing.
  • refine : Quickly improve the current data distribution

  Default values

  • debug_level 0
  • imbalance_tol 1.05
  • lb_method graph
  • lb_approach repartition

Usage

To select the Zoltan graph repartition method add the following entries to decomposeParDict:

distributor zoltan; libs ("libzoltanRenumber.so");

The Zoltan lb_method and lb_approach can be changed by adding the corresponding entries to the optional zoltanCeoffs sub-dictionary, e.g.:

zoltanCoeffs { lb_method hypergraph; lb_approach partition; }

Source files

• zoltanDecomp.H
• zoltanDecomp.C

Definition at line 92 of file zoltanDecomp.H.

Constructor & Destructor Documentation

zoltanDecomp() [1/2]

zoltanDecomp

(

const dictionary &

decompositionDict

)

Construct given the decomposition dictionary and mesh.

Definition at line 416 of file zoltanDecomp.C.

zoltanDecomp() [2/2]

zoltanDecomp ( const zoltanDecomp &  )

delete

Disallow default bitwise copy construction.

~zoltanDecomp()

virtual ~zoltanDecomp ( )

inlinevirtual

Destructor.

Definition at line 124 of file zoltanDecomp.H.

Member Function Documentation

TypeName()

TypeName

(

"zoltan"

)

Runtime type information.

decompose() [1/13]

Foam::labelList decompose ( const polyMesh &  mesh, const pointField &  points, const scalarField &  pointWeights  )

virtual

Return for every coordinate the wanted processor number. Use the.

mesh connectivity (if needed). See note on weights in scotchDecomp.H

Implements decompositionMethod.

Definition at line 424 of file zoltanDecomp.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::identityMap(), primitiveMesh::nCells(), and List< T >::size().

Here is the call graph for this function:

decompose() [2/13]

Foam::labelList decompose ( const polyMesh &  mesh, const labelList &  agglom, const pointField &  regionPoints, const scalarField &  regionWeights  )

virtual

Return for every coordinate the wanted processor number. Gets.

passed agglomeration map (from fine to coarse cells) and coarse cell location. Can be overridden by decomposers that provide this functionality natively. See note on weights in scotchDecomp.H

Reimplemented from decompositionMethod.

Definition at line 474 of file zoltanDecomp.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, primitiveMesh::nCells(), and List< T >::size().

Here is the call graph for this function:

decompose() [3/13]

Foam::labelList decompose ( const labelListList &  globalCellCells, const pointField &  cc, const scalarField &  cWeights  )

virtual

Return for every coordinate the wanted processor number. Explicitly.

provided mesh connectivity. The connectivity is equal to mesh.cellCells() except for

• in parallel the cell numbers are global cell numbers (starting from 0 at processor0 and then incrementing all through the processors)
• the connections are across coupled patches See note on weights in scotchDecomp.H

Implements decompositionMethod.

Definition at line 523 of file zoltanDecomp.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, points, and List< T >::size().

Here is the call graph for this function:

operator=()

void operator= ( const zoltanDecomp &  )

delete

Disallow default bitwise assignment.

decompose() [4/13]

virtual labelList decompose

inline

Inherit decompose from decompositionMethod.

Definition at line 135 of file decompositionMethod.H.

decompose() [5/13]

virtual labelList decompose

inline

Inherit decompose from decompositionMethod.

Definition at line 146 of file decompositionMethod.H.

decompose() [6/13]

virtual labelList decompose

Inherit decompose from decompositionMethod.

decompose() [7/13]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 165 of file decompositionMethod.C.

decompose() [8/13]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 174 of file decompositionMethod.C.

decompose() [9/13]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 183 of file decompositionMethod.C.

decompose() [10/13]

virtual labelList decompose

Inherit decompose from decompositionMethod.

decompose() [11/13]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 208 of file decompositionMethod.C.

decompose() [12/13]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 283 of file decompositionMethod.C.

decompose() [13/13]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 301 of file decompositionMethod.C.

---

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

• src/parallel/decompose/zoltanDecomp/zoltanDecomp.H
• src/parallel/decompose/zoltanDecomp/zoltanDecomp.C