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

Inheritance diagram for ptscotchDecomp:

Collaboration diagram for ptscotchDecomp:

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

	ptscotchDecomp (const dictionary &decompositionDict)
	Construct given the decomposition dictionary and mesh. More...

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

virtual	~ptscotchDecomp ()
	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 ptscotchDecomp &)=delete
	Disallow default bitwise assignment. 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

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::scotchDecomp

Source files

Definition at line 62 of file ptscotchDecomp.H.

Constructor & Destructor Documentation

◆ ptscotchDecomp() [1/2]

ptscotchDecomp ( const dictionary & decompositionDict )

Construct given the decomposition dictionary and mesh.

Definition at line 100 of file dummyPtscotchDecomp.C.

◆ ptscotchDecomp() [2/2]

ptscotchDecomp ( const ptscotchDecomp & )

delete

Disallow default bitwise copy construction.

◆ ~ptscotchDecomp()

virtual ~ptscotchDecomp ( )

inlinevirtual

Destructor.

Definition at line 110 of file ptscotchDecomp.H.

References decompositionMethod::decompose(), mesh, ptscotchDecomp::operator=(), and points.

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "ptscotch" )

Runtime type information.

◆ decompose() [1/3]

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 111 of file dummyPtscotchDecomp.C.

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

Here is the call graph for this function:

◆ decompose() [2/3]

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 125 of file dummyPtscotchDecomp.C.

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

Here is the call graph for this function:

◆ decompose() [3/3]

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 140 of file dummyPtscotchDecomp.C.

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

Here is the call graph for this function: