PTScotch domain decomposition. More...

#include <ptscotchDecomp.H>

Inheritance diagram for ptscotchDecomp:

Collaboration diagram for ptscotchDecomp:

Public Member Functions
	ptscotchDecomp (const ptscotchDecomp &)=delete
	No copy construct.
void	operator= (const ptscotchDecomp &)=delete
	No copy assignment.
	TypeName ("ptscotch")
	Runtime type information.
	ptscotchDecomp (const label numDomains)
	Construct with number of domains (no coefficients or constraints).
	ptscotchDecomp (const dictionary &decompDict, const word &regionName="")
	Construct given decomposition dictionary and optional region name.
virtual	~ptscotchDecomp ()=default
	Destructor.
virtual bool	parallelAware () const
	Knows about coupled boundaries.
virtual labelList	decompose (const polyMesh &mesh, const pointField &points=pointField::null(), const scalarField &pointWeights=scalarField::null()) const
	Return for every coordinate the wanted processor number.
virtual labelList	decompose (const polyMesh &mesh, const labelList &agglom, const pointField &agglomPoints, const scalarField &agglomWeights=scalarField::null()) const
	Return for every coordinate the wanted processor number.
virtual labelList	decompose (const CompactListList< label > &globalCellCells, const pointField &cc=pointField::null(), const scalarField &cWeights=scalarField::null()) const
	Return for every coordinate the wanted processor number.
virtual labelList	decompose (const labelListList &globalCellCells, const pointField &cc=pointField::null(), const scalarField &cWeights=scalarField::null()) const
	Return for every coordinate the wanted processor number.
virtual labelList	decompose (const pointField &points, const scalarField &pointWeights=scalarField::null()) const
	Inherit decompose from decompositionMethod.
virtual labelList	decompose (const polyMesh &mesh, const scalarField &cellWeights, const boolList &blockedFace, const PtrList< labelList > &specifiedProcessorFaces, const labelList &specifiedProcessor, const List< labelPair > &explicitConnections) const
	Inherit decompose from decompositionMethod.
labelList	decompose (const polyMesh &mesh, const scalarField &cWeights) const
	Inherit decompose from decompositionMethod.
Public Member Functions inherited from decompositionMethod
	decompositionMethod (const decompositionMethod &)=delete
	No copy construct.
void	operator= (const decompositionMethod &)=delete
	No copy assignment.
	TypeName ("decompositionMethod")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, decompositionMethod, dictionary,(const dictionary &decompDict, const word &regionName),(decompDict, regionName))
	decompositionMethod (const dictionary &decompDict, const word &regionName="")
	Construct given the decomposition dictionary, optionally region-specific.
virtual	~decompositionMethod ()=default
	Destructor.
label	nDomains () const noexcept
	Number of domains.
label	nDomains (const label n)
	Set number of domains. Return old value.
virtual bool	geometric () const
	True if the method is purely geometric, often using cell centre points.
void	setConstraints (const polyMesh &mesh, boolList &blockedFace, PtrList< labelList > &specifiedProcessorFaces, labelList &specifiedProcessor, List< labelPair > &explicitConnections) const
	Helper: extract constraints:
void	applyConstraints (const polyMesh &mesh, const boolList &blockedFace, const PtrList< labelList > &specifiedProcessorFaces, const labelList &specifiedProcessor, const List< labelPair > &explicitConnections, labelList &finalDecomp) const
	Helper: apply constraints to a decomposition.
labelList	decompose (const polyMesh &mesh, const scalarField &cWeights) const
	Decompose a mesh.

Additional Inherited Members
Static Public Member Functions inherited from decompositionMethod
static label	nDomains (const dictionary &decompDict, const word &regionName="")
	Return region-specific or top-level `numberOfSubdomains` entry.
static const dictionary &	optionalRegionDict (const dictionary &decompDict, const word &regionName)
	Return an optional region-specific dictionary from "regions" sub-dictionary, or dictionary::null on failure.
static autoPtr< decompositionMethod >	New (const dictionary &decompDict, const word &regionName="")
	Return a reference to the selected decomposition method, optionally region-specific.
static void	calcCellCells (const polyMesh &mesh, const labelList &agglom, const label nLocalCoarse, const bool parallel, CompactListList< label > &cellCells)
	Determine (local or global) cellCells from mesh agglomeration.
static void	calcCellCells (const polyMesh &mesh, const labelList &agglom, const label nLocalCoarse, const bool parallel, CompactListList< label > &cellCells, CompactListList< scalar > &cellCellWeights)
	Determine (local or global) cellCells and face weights from mesh agglomeration.
Protected Types inherited from decompositionMethod
enum	selectionType { DEFAULT = 0 , EXACT = 1 , MANDATORY = 2 , NULL_DICT = 4 }
	Selection type when handling the coefficients dictionary. More...
Protected Member Functions inherited from decompositionMethod
FOAM_NO_DANGLING_REFERENCE const dictionary &	findCoeffsDict (const word &coeffsName, int select=selectionType::DEFAULT) const
	Locate coeffsName dictionary or the fallback "coeffs" dictionary.
	decompositionMethod (const label numDomains)
	Construct with specified number of domains, no coefficients or constraints.
Static Protected Member Functions inherited from decompositionMethod
static FOAM_NO_DANGLING_REFERENCE const dictionary &	findCoeffsDict (const dictionary &dict, const word &coeffsName, int select=selectionType::DEFAULT)
	Locate coeffsName dictionary or the fallback "coeffs" dictionary within an enclosing dictionary.
Protected Attributes inherited from decompositionMethod
const dictionary &	decompDict_
	Top-level decomposition dictionary (eg, decomposeParDict).
const dictionary &	decompRegionDict_
	Region-specific decomposition dictionary information.
label	nDomains_
	Number of domains for the decomposition.
PtrList< decompositionConstraint >	constraints_
	Optional constraints.

Detailed Description

PTScotch domain decomposition.

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

Coefficients dictionary: scotchCoeffs, coeffs.

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 64 of file ptscotchDecomp.H.

Constructor & Destructor Documentation

◆ ptscotchDecomp() [1/3]

ptscotchDecomp ( const ptscotchDecomp & )

delete

No copy construct.

References ptscotchDecomp().

Referenced by operator=(), and ptscotchDecomp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ptscotchDecomp() [2/3]

ptscotchDecomp ( const label numDomains )

explicit

Construct with number of domains (no coefficients or constraints).

Definition at line 513 of file ptscotchDecomp.C.

References decompositionMethod::decompositionMethod().

Here is the call graph for this function:

◆ ptscotchDecomp() [3/3]

ptscotchDecomp	(	const dictionary &	decompDict,
		const word &	regionName = "" )

explicit

Construct given decomposition dictionary and optional region name.

Definition at line 520 of file ptscotchDecomp.C.

References decompositionMethod::decompositionMethod(), decompositionMethod::findCoeffsDict(), decompositionMethod::NULL_DICT, and regionName.

Here is the call graph for this function:

◆ ~ptscotchDecomp()

virtual ~ptscotchDecomp ( )

virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const ptscotchDecomp & )

delete

No copy assignment.

References ptscotchDecomp().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "ptscotch" )

Runtime type information.

References regionName.

◆ parallelAware()

virtual bool parallelAware ( ) const

inlinevirtual

Knows about coupled boundaries.

Implements decompositionMethod.

Definition at line 143 of file ptscotchDecomp.H.

◆ decompose() [1/7]

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

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 533 of file ptscotchDecomp.C.

References globalMeshData::calcCellCells(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::getGraphPathBase(), mesh, CompactListList< T >::offsets(), points, and CompactListList< T >::values().

Here is the call graph for this function:

◆ decompose() [2/7]

Foam::labelList decompose	(	const polyMesh &	mesh,
		const labelList &	agglom,
		const pointField &	agglomPoints,
		const scalarField &	agglomWeights = scalarField::null() ) const

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 572 of file ptscotchDecomp.C.

References globalMeshData::calcCellCells(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::getGraphPathBase(), mesh, CompactListList< T >::offsets(), UList< T >::size(), and CompactListList< T >::values().

Here is the call graph for this function:

◆ decompose() [3/7]

Foam::labelList decompose	(	const CompactListList< label > &	globalCellCells,
		const pointField &	cc = pointField::null(),
		const scalarField &	cWeights = scalarField::null() ) const

virtual

Return for every coordinate the wanted processor number.

Implements decompositionMethod.

Definition at line 621 of file ptscotchDecomp.C.

References UList< T >::empty(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, CompactListList< T >::offsets(), CompactListList< T >::size(), UList< T >::size(), and CompactListList< T >::values().

Here is the call graph for this function:

◆ decompose() [4/7]

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

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 657 of file ptscotchDecomp.C.

References UList< T >::empty(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, CompactListList< T >::pack(), and UList< T >::size().

Here is the call graph for this function:

◆ decompose() [5/7]

Foam::labelList decompose	(	const pointField &	points,
		const scalarField &	pointWeights = scalarField::null() ) const

virtual

Inherit decompose from decompositionMethod.

Reimplemented from decompositionMethod.

Definition at line 298 of file decompositionMethod.C.

◆ decompose() [6/7]

Foam::labelList decompose	(	const polyMesh &	mesh,
		const scalarField &	cellWeights,
		const boolList &	blockedFace,
		const PtrList< labelList > &	specifiedProcessorFaces,
		const labelList &	specifiedProcessor,
		const List< labelPair > &	explicitConnections ) const

virtual

Inherit decompose from decompositionMethod.

Parameters

blockedFace Whether owner and neighbour should be on same processor

(takes priority over explicitConnections)

Parameters

specifiedProcessorFaces Whether whole sets of faces (and point neighbours) need to be kept

on single processor

Parameters

explicitConnections Additional connections between boundary faces

Reimplemented from decompositionMethod.

Definition at line 422 of file decompositionMethod.C.

◆ decompose() [7/7]

Foam::labelList decompose	(	const polyMesh &	mesh,
		const scalarField &	cWeights ) const

Inherit decompose from decompositionMethod.

Definition at line 445 of file decompositionMethod.C.

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

src/parallel/decompose/ptscotchDecomp/ptscotchDecomp.H
src/parallel/decompose/ptscotchDecomp/ptscotchDecomp.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ptscotchDecomp() [1/3]

◆ ptscotchDecomp() [2/3]

◆ ptscotchDecomp() [3/3]

◆ ~ptscotchDecomp()

Member Function Documentation

◆ operator=()

◆ TypeName()

◆ parallelAware()

◆ decompose() [1/7]

◆ decompose() [2/7]

◆ decompose() [3/7]

◆ decompose() [4/7]

◆ decompose() [5/7]

◆ decompose() [6/7]

◆ decompose() [7/7]