Domain decomposition using METIS-like data structures. More...

#include <metisLikeDecomp.H>

Inheritance diagram for metisLikeDecomp:

[legend]

Collaboration diagram for metisLikeDecomp:

[legend]

Public Member Functions
virtual	~metisLikeDecomp ()=default
	Destructor.
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 &cellCentres=pointField::null(), const scalarField &cellWeights=scalarField::null()) const
	Return for every coordinate the wanted processor number.
virtual labelList	decompose (const labelListList &globalCellCells, const pointField &cellCentres=pointField::null(), const scalarField &cellWeights=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.
virtual bool	parallelAware () const =0
	Is method parallel aware?
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.

Protected Member Functions
virtual label	decomposeGeneral (const labelList &adjncy, const labelList &xadj, const List< scalar > &cellWeights, labelList &decomp) const
	Serial and/or collect/distribute for parallel operation.
virtual label	decomposeSerial (const labelList &adjncy, const labelList &xadj, const List< scalar > &cellWeights, labelList &decomp) const =0
	Decomposition with metis-like parameters.
	metisLikeDecomp (const metisLikeDecomp &)=delete
	No copy construct.
void	operator= (const metisLikeDecomp &)=delete
	No copy assignment.
	metisLikeDecomp (const label numDomains)
	Construct with number of domains (no coefficients or constraints).
	metisLikeDecomp (const word &derivedType, const dictionary &decompDict, int select=selectionType::NULL_DICT)
	Construct for derived type name and decomposition dictionary.
	metisLikeDecomp (const word &derivedType, const dictionary &decompDict, const word &regionName, int select=selectionType::NULL_DICT)
	Construct for derived type name, decomposition dictionary and (optional) region name.
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.

Protected Attributes
const dictionary &	coeffsDict_
	Coefficients for all derived methods.
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.

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

Detailed Description

Domain decomposition using METIS-like data structures.

When run in parallel will collect the entire graph on to the master, decompose and send back.

Source files

Definition at line 47 of file metisLikeDecomp.H.

Constructor & Destructor Documentation

◆ metisLikeDecomp() [1/4]

metisLikeDecomp ( const metisLikeDecomp & )

protecteddelete

No copy construct.

References metisLikeDecomp().

Referenced by kahipDecomp::kahipDecomp(), kahipDecomp::kahipDecomp(), metisDecomp::metisDecomp(), metisDecomp::metisDecomp(), metisLikeDecomp(), metisLikeDecomp(), operator=(), scotchDecomp::scotchDecomp(), and scotchDecomp::scotchDecomp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ metisLikeDecomp() [2/4]

metisLikeDecomp ( const label numDomains )

explicitprotected

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

Definition at line 181 of file metisLikeDecomp.C.

References coeffsDict_, and decompositionMethod::decompositionMethod().

Here is the call graph for this function:

◆ metisLikeDecomp() [3/4]

metisLikeDecomp	(	const word &	derivedType,
		const dictionary &	decompDict,
		int	select = selectionType::NULL_DICT )

inlineprotected

Construct for derived type name and decomposition dictionary.

Definition at line 107 of file metisLikeDecomp.H.

References metisLikeDecomp(), and decompositionMethod::NULL_DICT.

Here is the call graph for this function:

◆ metisLikeDecomp() [4/4]

metisLikeDecomp	(	const word &	derivedType,
		const dictionary &	decompDict,
		const word &	regionName,
		int	select = selectionType::NULL_DICT )

protected

Construct for derived type name, decomposition dictionary and (optional) region name.

The default search for the coefficients will return dictionary::null on failure. This avoids a name clash of a metis "method" with the top level.

Definition at line 188 of file metisLikeDecomp.C.

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

Here is the call graph for this function:

◆ ~metisLikeDecomp()

virtual ~metisLikeDecomp ( )

virtualdefault

Destructor.

References decompositionMethod::decompose(), mesh, Field< scalar >::null(), Field< vector >::null(), and points.

Here is the call graph for this function:

Member Function Documentation

◆ decomposeGeneral()

Foam::label decomposeGeneral	(	const labelList &	adjncy,
		const labelList &	xadj,
		const List< scalar > &	cellWeights,
		labelList &	decomp ) const

protectedvirtual

Serial and/or collect/distribute for parallel operation.

Definition at line 28 of file metisLikeDecomp.C.

References UList< T >::back(), List< T >::clear(), decomposeSerial(), UList< T >::empty(), Foam::endl(), globalIndex::gather(), Foam::Info, globalIndex::inplaceToGlobal(), globalIndex::localSize(), UPstream::master(), UPstream::masterNo(), Foam::max(), UPstream::msgType(), UPstream::nonBlocking, UPstream::nRequests(), UPstream::parRun(), globalIndex::range(), UIPstream::read(), List< T >::resize(), List< T >::resize_nocopy(), Foam::returnReduceAnd(), globalIndex::scatter(), UList< T >::size(), globalIndex::subProcs(), globalIndex::totalSize(), Foam::type(), UPstream::waitRequests(), UPstream::worldComm, and UOPstream::write().

Referenced by decompose(), decompose(), decompose(), and decompose().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ decomposeSerial()

virtual label decomposeSerial	(	const labelList &	adjncy,
		const labelList &	xadj,
		const List< scalar > &	cellWeights,
		labelList &	decomp ) const

protectedpure virtual

Decomposition with metis-like parameters.

Implemented in kahipDecomp, metisDecomp, and scotchDecomp.

Referenced by decomposeGeneral().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const metisLikeDecomp & )

protecteddelete

No copy assignment.

References metisLikeDecomp().

Here is the call graph for this function:

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

Uses the mesh connectivity (if needed). Weights get normalised so the minimum value is 1 before truncation to an integer so the weights should be multiples of the minimum value. The overall sum of weights might otherwise overflow.

Implements decompositionMethod.

Reimplemented in scotchDecomp.

Definition at line 203 of file metisLikeDecomp.C.

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

Referenced by scotchDecomp::decompose(), scotchDecomp::decompose(), scotchDecomp::decompose(), and scotchDecomp::decompose().

Here is the call graph for this function:

Here is the caller 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 above.

Reimplemented from decompositionMethod.

Reimplemented in scotchDecomp.

Definition at line 235 of file metisLikeDecomp.C.

References globalMeshData::calcCellCells(), decomposeGeneral(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, 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 &	cellCentres = pointField::null(),
		const scalarField &	cellWeights = 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 above.

Implements decompositionMethod.

Reimplemented in scotchDecomp.

Definition at line 279 of file metisLikeDecomp.C.

References decomposeGeneral(), 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 &	cellCentres = pointField::null(),
		const scalarField &	cellWeights = 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 above.

Implements decompositionMethod.

Reimplemented in scotchDecomp.

Definition at line 312 of file metisLikeDecomp.C.

References decomposeGeneral(), 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.

Reimplemented in scotchDecomp.

Definition at line 298 of file decompositionMethod.C.

References Foam::cfindCoeffsDict(), and decompositionMethod::decompDict_.

Here is the call graph for this function:

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

Reimplemented in scotchDecomp.

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.

Member Data Documentation

◆ coeffsDict_

const dictionary& coeffsDict_

protected

Coefficients for all derived methods.

Definition at line 58 of file metisLikeDecomp.H.

Referenced by kahipDecomp::decomposeSerial(), scotchDecomp::decomposeSerial(), metisLikeDecomp(), and metisLikeDecomp().

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

src/parallel/decompose/decompositionMethods/metisLikeDecomp/metisLikeDecomp.H
src/parallel/decompose/decompositionMethods/metisLikeDecomp/metisLikeDecomp.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ metisLikeDecomp() [1/4]

◆ metisLikeDecomp() [2/4]

◆ metisLikeDecomp() [3/4]

◆ metisLikeDecomp() [4/4]

◆ ~metisLikeDecomp()

Member Function Documentation

◆ decomposeGeneral()

◆ decomposeSerial()

◆ operator=()

◆ decompose() [1/7]

◆ decompose() [2/7]

◆ decompose() [3/7]

◆ decompose() [4/7]

◆ decompose() [5/7]

◆ decompose() [6/7]

◆ decompose() [7/7]

Member Data Documentation

◆ coeffsDict_