PTScotch domain decomposition. For the main details about how to define the strategies, see scotchDecomp. More...

Inheritance diagram for ptscotch:

Collaboration diagram for ptscotch:

Public Member Functions
	TypeName ("ptscotch")
	Runtime type information. More...

	ptscotch (const dictionary &decompositionDict)
	Construct given the decomposition dictionary. More...

	ptscotch (const ptscotch &)=delete
	Disallow default bitwise copy construction. More...

virtual	~ptscotch ()
	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 &cellCentres, const scalarField &cellWeights)
	Return for every coordinate the wanted processor number. Explicitly. More...

void	operator= (const ptscotch &)=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 &cellCentres, const scalarField &cellWeights)=0
	Inherit decompose from decompositionMethod. More...

virtual labelList	decompose (const labelListList &globalCellCells, const pointField &cellCentres)
	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 &cellWeights)
	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 &cellCentres)
	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)
	Decompose a mesh with constraints. More...

labelList	decompose (const polyMesh &mesh, const scalarField &cellWeights)
	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 IOdictionary	decomposeParDict (const Time &time)
	Read and return the decomposeParDict. More...

static labelList	scaleWeights (const scalarField &weights, label &nWeights, const bool distributed=true)
	Convert the given scalar weights to labels. 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 Member Functions inherited from decompositionMethod
label	nWeights (const pointField &points, const scalarField &pointWeights) const
	Return the number of weights per point. More...

label	checkWeights (const pointField &points, const scalarField &pointWeights) const
	Check the weights against the points. More...

Protected Attributes inherited from decompositionMethod
dictionary	decompositionDict_

label	nProcessors_

PtrList< decompositionConstraint >	constraints_
	Optional constraints. More...

Detailed Description

PTScotch domain decomposition. For the main details about how to define the strategies, see scotchDecomp.

Nonetheless, when decomposing in parallel, using writeGraph=true will write out .dgr files for debugging. For example, use these files with dgpart as follows:

mpirun -np 4 dgpart 2 'region0_%r.dgr'

where:

r gets replaced by current processor rank
it will decompose into 2 domains

See also: Foam::decompositionMethods::scotch

Source files

Definition at line 64 of file ptscotch.H.

Constructor & Destructor Documentation

◆ ptscotch() [1/2]

ptscotch ( const dictionary & decompositionDict )

Construct given the decomposition dictionary.

Definition at line 106 of file dummyPtscotch.C.

◆ ptscotch() [2/2]

ptscotch ( const ptscotch & )

delete

Disallow default bitwise copy construction.

◆ ~ptscotch()

virtual ~ptscotch ( )

inlinevirtual

Destructor.

Definition at line 112 of file ptscotch.H.

Member Function Documentation

◆ TypeName()

TypeName ( "ptscotch" )

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 scotch.H

Implements decompositionMethod.

Definition at line 117 of file dummyPtscotch.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, notImplementedMessage, and List< label >::null().

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 scotch.H

Reimplemented from decompositionMethod.

Definition at line 131 of file dummyPtscotch.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, notImplementedMessage, and List< label >::null().

Here is the call graph for this function:

◆ decompose() [3/13]

Foam::labelList decompose	(	const labelListList &	globalCellCells,
		const pointField &	cellCentres,
		const scalarField &	cellWeights
	)

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 scotch.H

Implements decompositionMethod.

Definition at line 146 of file dummyPtscotch.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, notImplementedMessage, and List< label >::null().

Here is the call graph for this function:

◆ operator=()

void operator= ( const ptscotch & )

delete

Disallow default bitwise assignment.

◆ decompose() [4/13]

virtual labelList decompose

inline

Inherit decompose from decompositionMethod.

Definition at line 155 of file decompositionMethod.H.

◆ decompose() [5/13]

virtual labelList decompose

inline

Inherit decompose from decompositionMethod.

Definition at line 166 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 185 of file decompositionMethod.C.

◆ decompose() [8/13]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 193 of file decompositionMethod.C.

◆ decompose() [9/13]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 202 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 227 of file decompositionMethod.C.

◆ decompose() [12/13]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 313 of file decompositionMethod.C.

◆ decompose() [13/13]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 331 of file decompositionMethod.C.

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

src/parallel/decompose/ptscotch/ptscotch.H
src/dummyThirdParty/ptscotch/dummyPtscotch.C
src/parallel/decompose/ptscotch/ptscotch.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ptscotch() [1/2]

◆ ptscotch() [2/2]

◆ ~ptscotch()

Member Function Documentation

◆ TypeName()

◆ decompose() [1/13]

◆ decompose() [2/13]

◆ decompose() [3/13]

◆ operator=()

◆ decompose() [4/13]

◆ decompose() [5/13]

◆ decompose() [6/13]

◆ decompose() [7/13]

◆ decompose() [8/13]

◆ decompose() [9/13]

◆ decompose() [10/13]

◆ decompose() [11/13]

◆ decompose() [12/13]

◆ decompose() [13/13]