Metis domain decomposition. More...

Inheritance diagram for metisDecomp:

Collaboration diagram for metisDecomp:

Public Member Functions
	TypeName ("metis")

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

virtual	~metisDecomp ()=default

virtual bool	parallelAware () const

Public Member Functions inherited from metisLikeDecomp
virtual	~metisLikeDecomp ()=default

virtual labelList	decompose (const polyMesh &mesh, const pointField &points, const scalarField &pointWeights) const

virtual labelList	decompose (const polyMesh &mesh, const labelList &agglom, const pointField &regionPoints, const scalarField &regionWeights) const

virtual labelList	decompose (const labelListList &globalCellCells, const pointField &cellCentres, const scalarField &cellWeights) const

virtual labelList	decompose (const pointField &points, const scalarField &pointWeights) const

virtual labelList	decompose (const pointField &points) const

virtual labelList	decompose (const polyMesh &mesh, const pointField &points, const scalarField &pointWeights) const=0

virtual labelList	decompose (const polyMesh &mesh, const pointField &points) const

virtual labelList	decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField &regionPoints, const scalarField &regionWeights) const

virtual labelList	decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField &regionPoints) const

virtual labelList	decompose (const labelListList &globalCellCells, const pointField &cc, const scalarField &cWeights) const=0

virtual labelList	decompose (const labelListList &globalCellCells, const pointField &cc) const

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

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

Public Member Functions inherited from decompositionMethod
	TypeName ("decompositionMethod")

	declareRunTimeSelectionTable (autoPtr, decompositionMethod, dictionary,(const dictionary &decompDict, const word &regionName),(decompDict, regionName))

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

virtual	~decompositionMethod ()=default

label	nDomains () const noexcept

virtual labelList	decompose (const pointField &points, const scalarField &pointWeights) const

virtual labelList	decompose (const pointField &points) const

virtual labelList	decompose (const polyMesh &mesh, const pointField &points) const

virtual labelList	decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField &regionPoints) const

virtual labelList	decompose (const labelListList &globalCellCells, const pointField &cc) const

void	setConstraints (const polyMesh &mesh, boolList &blockedFace, PtrList< labelList > &specifiedProcessorFaces, labelList &specifiedProcessor, List< labelPair > &explicitConnections) const

void	applyConstraints (const polyMesh &mesh, const boolList &blockedFace, const PtrList< labelList > &specifiedProcessorFaces, const labelList &specifiedProcessor, const List< labelPair > &explicitConnections, labelList &finalDecomp) const

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

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

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

	metisDecomp (const metisDecomp &)=delete

void	operator= (const metisDecomp &)=delete

Protected Member Functions inherited from metisLikeDecomp
virtual label	decomposeGeneral (const labelList &adjncy, const labelList &xadj, const List< scalar > &cellWeights, labelList &decomp) const

	metisLikeDecomp (const metisLikeDecomp &)=delete

void	operator= (const metisLikeDecomp &)=delete

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

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

Protected Member Functions inherited from decompositionMethod
const dictionary &	findCoeffsDict (const word &coeffsName, int select=selectionType::DEFAULT) const

Additional Inherited Members
Static Public Member Functions inherited from decompositionMethod
static label	nDomains (const dictionary &decompDict, const word &regionName="")

static const dictionary &	optionalRegionDict (const dictionary &decompDict, const word &regionName)

static autoPtr< decompositionMethod >	New (const dictionary &decompDict, const word &regionName="")

static void	calcCellCells (const polyMesh &mesh, const labelList &agglom, const label nLocalCoarse, const bool global, CompactListList< label > &cellCells)

static void	calcCellCells (const polyMesh &mesh, const labelList &agglom, const label nLocalCoarse, const bool parallel, CompactListList< label > &cellCells, CompactListList< scalar > &cellCellWeights)

Protected Types inherited from decompositionMethod
enum	selectionType { DEFAULT = 0, EXACT = 1, MANDATORY = 2, NULL_DICT = 4 }

Static Protected Member Functions inherited from decompositionMethod
static const dictionary &	findCoeffsDict (const dictionary &dict, const word &coeffsName, int select=selectionType::DEFAULT)

Protected Attributes inherited from metisLikeDecomp
const dictionary &	coeffsDict_

Protected Attributes inherited from decompositionMethod
const dictionary &	decompDict_

const dictionary &	decompRegionDict_

label	nDomains_

PtrList< decompositionConstraint >	constraints_

Detailed Description

Metis domain decomposition.

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

Coefficients dictionary: metisCoeffs, coeffs.

numberOfSubdomains   N;
method               metis;

metisCoeffs
{
    method           recursive;  // k-way
    options          ( ...);
    processorWeights ( ... );
}

Method coefficients:

Property	Description	Required	Default
`method`	recursive / k-way	no	recursive
`options`	metis options	no
`processorWeights`	list of weighting per partition	no

Source files

Definition at line 88 of file metisDecomp.H.

Constructor & Destructor Documentation

◆ metisDecomp() [1/2]

metisDecomp ( const metisDecomp & )

protecteddelete

◆ metisDecomp() [2/2]

metisDecomp	(	const dictionary &	decompDict,
		const word &	regionName = `""`
	)

explicit

Definition at line 68 of file dummyMetisDecomp.C.

◆ ~metisDecomp()

virtual ~metisDecomp ( )

virtualdefault

Member Function Documentation

◆ decomposeSerial()

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

protectedvirtual

Implements metisLikeDecomp.

Definition at line 51 of file dummyMetisDecomp.C.

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

Here is the call graph for this function:

◆ operator=()

void operator= ( const metisDecomp & )

protecteddelete

◆ TypeName()

TypeName ( "metis" )

◆ parallelAware()

virtual bool parallelAware ( ) const

inlinevirtual

Implements decompositionMethod.

Definition at line 135 of file metisDecomp.H.

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

src/parallel/decompose/metisDecomp/metisDecomp.H
src/dummyThirdParty/metisDecomp/dummyMetisDecomp.C
src/parallel/decompose/metisDecomp/metisDecomp.C

Public Member Functions

Protected Member Functions

Additional Inherited Members