PTScotch domain decomposition. 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...

virtual	~ptscotchDecomp ()
	Destructor. More...

virtual bool	parallelAware () const
	Is method parallel aware (i.e. does it synchronize domains across. 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...

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, dictionary,(const dictionary &decompositionDict),(decompositionDict))

	decompositionMethod (const dictionary &decompositionDict)
	Construct given the decomposition dictionary. 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...

Private Member Functions
label	decompose (const fileName &meshPath, const List< label > &adjncy, const List< label > &xadj, const scalarField &cWeights, List< label > &finalDecomp) const
	Decompose. Handles size 0 arrays. More...

label	decompose (const fileName &meshPath, const label adjncySize, const label adjncy[], const label xadjSize, const label xadj[], const scalarField &cWeights, List< label > &finalDecomp) const
	Low level decompose. More...

void	operator= (const ptscotchDecomp &)
	Disallow default bitwise copy construct and assignment. More...

	ptscotchDecomp (const ptscotchDecomp &)

Static Private Member Functions
template<class Type >
static void	prepend (const UList< Type > &, List< Type > &)
	Insert list in front of list. More...

template<class Type >
static void	append (const UList< Type > &, List< Type > &)
	Insert list at end of list. More...

static void	check (const int, const char *)
	Check and print error message. More...

Additional Inherited Members
Static Public Member Functions inherited from decompositionMethod
static autoPtr< decompositionMethod >	New (const dictionary &decompositionDict)
	Return a reference to the selected decomposition method. 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
const dictionary &	decompositionDict_

label	nProcessors_

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

Detailed Description

PTScotch domain decomposition.

Source files

Definition at line 46 of file ptscotchDecomp.H.

Constructor & Destructor Documentation

◆ ptscotchDecomp() [1/2]

ptscotchDecomp ( const ptscotchDecomp & )

private

◆ ptscotchDecomp() [2/2]

ptscotchDecomp ( const dictionary & decompositionDict )

Construct given the decomposition dictionary and mesh.

Definition at line 99 of file dummyPtscotchDecomp.C.

◆ ~ptscotchDecomp()

virtual ~ptscotchDecomp ( )

inlinevirtual

Destructor.

Definition at line 102 of file ptscotchDecomp.H.

Member Function Documentation

◆ prepend()

void prepend	(	const UList< Type > &	extraLst,
		List< Type > &	lst
	)

staticprivate

Insert list in front of list.

Definition at line 33 of file ptscotchDecompTemplates.C.

References forAll, List::setSize(), List::size(), and UList::size().

Here is the call graph for this function:

◆ append()

void append	(	const UList< Type > &	extraLst,
		List< Type > &	lst
	)

staticprivate

Insert list at end of list.

Definition at line 58 of file ptscotchDecompTemplates.C.

References forAll, List::setSize(), List::size(), and UList::size().

Here is the call graph for this function:

◆ check()

void check	(	const int	retVal,
		const char *	str
	)

staticprivate

Check and print error message.

Definition at line 57 of file dummyPtscotchDecomp.C.

◆ decompose() [1/15]

Foam::label decompose	(	const fileName &	meshPath,
		const List< label > &	adjncy,
		const List< label > &	xadj,
		const scalarField &	cWeights,
		List< label > &	finalDecomp
	)		const

private

Decompose. Handles size 0 arrays.

Definition at line 62 of file dummyPtscotchDecomp.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and notImplementedMessage.

Here is the call graph for this function:

◆ decompose() [2/15]

Foam::label decompose	(	const fileName &	meshPath,
		const label	adjncySize,
		const label	adjncy[],
		const label	xadjSize,
		const label	xadj[],
		const scalarField &	cWeights,
		List< label > &	finalDecomp
	)		const

private

Low level decompose.

Definition at line 79 of file dummyPtscotchDecomp.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and notImplementedMessage.

Here is the call graph for this function:

◆ operator=()

void operator= ( const ptscotchDecomp & )

private

Disallow default bitwise copy construct and assignment.

◆ TypeName()

TypeName ( "ptscotch" )

Runtime type information.

◆ parallelAware()

virtual bool parallelAware ( ) const

inlinevirtual

Is method parallel aware (i.e. does it synchronize domains across.

proc boundaries)

Implements decompositionMethod.

Definition at line 108 of file ptscotchDecomp.H.

◆ decompose() [3/15]

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

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

Here is the call graph for this function:

◆ decompose() [4/15]

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

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

Here is the call graph for this function:

◆ decompose() [5/15]

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

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

Here is the call graph for this function:

◆ decompose() [6/15]

virtual labelList decompose

inline

Inherit decompose from decompositionMethod.

Definition at line 126 of file decompositionMethod.H.

◆ decompose() [7/15]

virtual labelList decompose

inline

Inherit decompose from decompositionMethod.

Definition at line 136 of file decompositionMethod.H.

◆ decompose() [8/15]

virtual labelList decompose

Inherit decompose from decompositionMethod.

◆ decompose() [9/15]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 205 of file decompositionMethod.C.

◆ decompose() [10/15]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 217 of file decompositionMethod.C.

◆ decompose() [11/15]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 258 of file decompositionMethod.C.

◆ decompose() [12/15]

virtual labelList decompose

Inherit decompose from decompositionMethod.

◆ decompose() [13/15]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 277 of file decompositionMethod.C.

◆ decompose() [14/15]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 1073 of file decompositionMethod.C.

◆ decompose() [15/15]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 1475 of file decompositionMethod.C.

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

src/parallel/decompose/ptscotchDecomp/ptscotchDecomp.H
src/dummyThirdParty/ptscotchDecomp/dummyPtscotchDecomp.C
src/parallel/decompose/ptscotchDecomp/ptscotchDecomp.C
src/parallel/decompose/ptscotchDecomp/ptscotchDecompTemplates.C

Public Member Functions

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ptscotchDecomp() [1/2]

◆ ptscotchDecomp() [2/2]

◆ ~ptscotchDecomp()

Member Function Documentation

◆ prepend()

◆ append()

◆ check()

◆ decompose() [1/15]

◆ decompose() [2/15]

◆ operator=()

◆ TypeName()

◆ parallelAware()

◆ decompose() [3/15]

◆ decompose() [4/15]

◆ decompose() [5/15]

◆ decompose() [6/15]

◆ decompose() [7/15]

◆ decompose() [8/15]

◆ decompose() [9/15]

◆ decompose() [10/15]

◆ decompose() [11/15]

◆ decompose() [12/15]

◆ decompose() [13/15]

◆ decompose() [14/15]

◆ decompose() [15/15]