Decompose given using consecutive application of decomposers. More...

#include <multiLevelDecomp.H>

Inheritance diagram for multiLevelDecomp:

Collaboration diagram for multiLevelDecomp:

Public Member Functions
	multiLevelDecomp (const multiLevelDecomp &)=delete
	No copy construct.
void	operator= (const multiLevelDecomp &)=delete
	No copy assignment.
	TypeName ("multiLevel")
	Runtime type information.
	multiLevelDecomp (const dictionary &decompDict, const word &regionName="")
	Construct given decomposition dictionary and optional region name.
virtual	~multiLevelDecomp ()=default
	Destructor.
virtual bool	parallelAware () const
	Is parallel aware when all sub-methods are also parallel-aware.
virtual labelList	decompose (const polyMesh &mesh, const pointField &points, const scalarField &pointWeights=scalarField::null()) const
	Return for every coordinate the wanted processor number.
virtual labelList	decompose (const CompactListList< label > &globalCellCells, const pointField &cc, const scalarField &cWeights=scalarField::null()) const
	Return for every coordinate the wanted processor number.
virtual labelList	decompose (const labelListList &globalCellCells, const pointField &cc, 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 labelList &cellToRegion, const pointField &regionPoints, const scalarField &regionWeights=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

Decompose given using consecutive application of decomposers.

Source files

Definition at line 45 of file multiLevelDecomp.H.

Constructor & Destructor Documentation

◆ multiLevelDecomp() [1/2]

multiLevelDecomp ( const multiLevelDecomp & )

delete

No copy construct.

References multiLevelDecomp().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ multiLevelDecomp() [2/2]

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

explicit

Construct given decomposition dictionary and optional region name.

Definition at line 554 of file multiLevelDecomp.C.

References decompositionMethod::decompositionMethod(), decompositionMethod::EXACT, decompositionMethod::findCoeffsDict(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, decompositionMethod::MANDATORY, and regionName.

Here is the call graph for this function:

◆ ~multiLevelDecomp()

virtual ~multiLevelDecomp ( )

virtualdefault

Destructor.

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

Here is the call graph for this function:

Member Function Documentation

◆ operator=()

void operator= ( const multiLevelDecomp & )

delete

No copy assignment.

References multiLevelDecomp().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "multiLevel" )

Runtime type information.

References regionName.

◆ parallelAware()

bool parallelAware ( ) const

virtual

Is parallel aware when all sub-methods are also parallel-aware.

Implements decompositionMethod.

Definition at line 579 of file multiLevelDecomp.C.

References decompositionMethod::decompositionMethod().

Here is the call graph for this function:

◆ decompose() [1/7]

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

virtual

Return for every coordinate the wanted processor number.

Use the mesh connectivity (if needed)

Implements decompositionMethod.

Definition at line 593 of file multiLevelDecomp.C.

References globalMeshData::calcCellCells(), Foam::identity(), mesh, UList< T >::size(), and CompactListList< T >::unpack().

Here is the call graph for this function:

◆ decompose() [2/7]

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

virtual

Return for every coordinate the wanted processor number.

Explicitly provided connectivity - does not use mesh_.

Implements decompositionMethod.

Definition at line 629 of file multiLevelDecomp.C.

References Foam::identity(), UList< T >::size(), and CompactListList< T >::unpack().

Here is the call graph for this function:

◆ decompose() [3/7]

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

virtual

Return for every coordinate the wanted processor number.

Explicitly provided connectivity - does not use mesh_.

Implements decompositionMethod.

Definition at line 655 of file multiLevelDecomp.C.

References Foam::identity(), and UList< T >::size().

Here is the call graph for this function:

◆ decompose() [4/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() [5/7]

Foam::labelList decompose	(	const polyMesh &	mesh,
		const labelList &	cellToRegion,
		const pointField &	regionPoints,
		const scalarField &	regionWeights = scalarField::null() ) const

virtual

Inherit decompose from decompositionMethod.

Reimplemented from decompositionMethod.

Definition at line 330 of file decompositionMethod.C.

References decompositionMethod::decompDict_, decompositionMethod::decompRegionDict_, and decompositionMethod::nDomains_.

◆ 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/decompositionMethods/multiLevelDecomp/multiLevelDecomp.H
src/parallel/decompose/decompositionMethods/multiLevelDecomp/multiLevelDecomp.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ multiLevelDecomp() [1/2]

◆ multiLevelDecomp() [2/2]

◆ ~multiLevelDecomp()

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]