Scotch domain decomposition. When run in parallel will collect the whole graph on to the master, decompose and send back. Run ptscotchDecomp for proper distributed decomposition. More...

Inheritance diagram for scotchDecomp:

[legend]

Collaboration diagram for scotchDecomp:

[legend]

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

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

virtual	~scotchDecomp ()
	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)

label	decomposeOneProc (const fileName &meshPath, const List< label > &adjncy, const List< label > &xadj, const scalarField &cWeights, List< label > &finalDecomp)
	Decompose non-parallel. More...

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

	scotchDecomp (const scotchDecomp &)

Static Private Member Functions
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

Scotch domain decomposition. When run in parallel will collect the whole graph on to the master, decompose and send back. Run ptscotchDecomp for proper distributed decomposition.

Source files

Definition at line 49 of file scotchDecomp.H.

Constructor & Destructor Documentation

◆ scotchDecomp() [1/2]

scotchDecomp ( const scotchDecomp & )

private

◆ scotchDecomp() [2/2]

scotchDecomp ( const dictionary & decompositionDict )

Construct given the decomposition dictionary and mesh.

Definition at line 80 of file dummyScotchDecomp.C.

◆ ~scotchDecomp()

virtual ~scotchDecomp ( )

inlinevirtual

Destructor.

Definition at line 95 of file scotchDecomp.H.

Member Function Documentation

◆ check()

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

staticprivate

Check and print error message.

Definition at line 56 of file dummyScotchDecomp.C.

◆ decompose() [1/14]

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

private

Definition at line 61 of file dummyScotchDecomp.C.

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

Here is the call graph for this function:

◆ decomposeOneProc()

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

private

Decompose non-parallel.

Hack to test clustering. Note that finalDecomp is non-compact

numbers!

Set up variable sizes architecture check ( SCOTCH_archVcmplt(&archdat), "SCOTCH_archVcmplt" );
Stategy flags: go for quality or load balance (or leave default) SCOTCH_Num straval = 0; straval |= SCOTCH_STRATQUALITY; straval |= SCOTCH_STRATQUALITY;
Number of cells per agglomeration SCOTCH_Num agglomSize = SCOTCH_archSize(&archdat); SCOTCH_Num agglomSize = 3;
Build strategy for agglomeration check ( SCOTCH_stratGraphClusterBuild ( &stradat, // strategy to build straval, // strategy flags agglomSize, // cells per cluster 1.0, // weight? 0.01 // max load imbalance ), "SCOTCH_stratGraphClusterBuild" );

Definition at line 304 of file scotchDecomp.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::Info, Foam::labelMax, dictionary::lookupOrDefault(), Foam::min(), OFstream::name(), Foam::nl, dictionary::readIfPresent(), List::setSize(), List::size(), dictionary::subDict(), Foam::sum(), and WarningInFunction.

Here is the call graph for this function:

◆ operator=()

void operator= ( const scotchDecomp & )

private

Disallow default bitwise copy construct and assignment.

◆ TypeName()

TypeName ( "scotch" )

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 101 of file scotchDecomp.H.

◆ decompose() [2/14]

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) Weights get normalised with minimum weight and truncated to convert into integer so e.g. 3.5 is seen as 3. The overall sum of weights might otherwise overflow.

Implements decompositionMethod.

Definition at line 91 of file dummyScotchDecomp.C.

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

Here is the call graph for this function:

◆ decompose() [3/14]

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 above.

Reimplemented from decompositionMethod.

Definition at line 105 of file dummyScotchDecomp.C.

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

Here is the call graph for this function:

◆ decompose() [4/14]

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 above.

Implements decompositionMethod.

Definition at line 120 of file dummyScotchDecomp.C.

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

Here is the call graph for this function:

◆ decompose() [5/14]

virtual labelList decompose

inline

Inherit decompose from decompositionMethod.

Definition at line 126 of file decompositionMethod.H.

◆ decompose() [6/14]

virtual labelList decompose

inline

Inherit decompose from decompositionMethod.

Definition at line 136 of file decompositionMethod.H.

◆ decompose() [7/14]

virtual labelList decompose

Inherit decompose from decompositionMethod.

◆ decompose() [8/14]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 205 of file decompositionMethod.C.

◆ decompose() [9/14]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 217 of file decompositionMethod.C.

◆ decompose() [10/14]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 258 of file decompositionMethod.C.

◆ decompose() [11/14]

virtual labelList decompose

Inherit decompose from decompositionMethod.

◆ decompose() [12/14]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 277 of file decompositionMethod.C.

◆ decompose() [13/14]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 1073 of file decompositionMethod.C.

◆ decompose() [14/14]

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/scotchDecomp/scotchDecomp.H
src/dummyThirdParty/scotchDecomp/dummyScotchDecomp.C
src/parallel/decompose/scotchDecomp/scotchDecomp.C

Public Member Functions

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ scotchDecomp() [1/2]

◆ scotchDecomp() [2/2]

◆ ~scotchDecomp()

Member Function Documentation

◆ check()

◆ decompose() [1/14]

◆ decomposeOneProc()

◆ operator=()

◆ TypeName()

◆ parallelAware()

◆ decompose() [2/14]

◆ decompose() [3/14]

◆ decompose() [4/14]

◆ decompose() [5/14]

◆ decompose() [6/14]

◆ decompose() [7/14]

◆ decompose() [8/14]

◆ decompose() [9/14]

◆ decompose() [10/14]

◆ decompose() [11/14]

◆ decompose() [12/14]

◆ decompose() [13/14]

◆ decompose() [14/14]