Abstract base class for domain decomposition. More...

Inheritance diagram for decompositionMethod:

Collaboration diagram for decompositionMethod:

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

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

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

virtual	~decompositionMethod ()=default
	Destructor. More...

label	nDomains () const noexcept
	Number of domains. More...

virtual bool	parallelAware () const =0
	Is method parallel aware? More...

virtual labelList	decompose (const pointField &points, const scalarField &pointWeights) const
	Return the wanted processor number for every coordinate. More...

virtual labelList	decompose (const pointField &points) const
	Decompose with uniform weights on the points. More...

virtual labelList	decompose (const polyMesh &mesh, const pointField &points, const scalarField &pointWeights) const =0
	Return for every coordinate the wanted processor number. More...

virtual labelList	decompose (const polyMesh &mesh, const pointField &points) const
	Decompose with uniform weights on the points. More...

virtual labelList	decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField &regionPoints, const scalarField &regionWeights) const
	Return for every coordinate the wanted processor number. Gets. More...

virtual labelList	decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField &regionPoints) const
	Like decompose but with uniform weights on the regions. More...

virtual labelList	decompose (const labelListList &globalCellCells, const pointField &cc, const scalarField &cWeights) const =0
	Return for every coordinate the wanted processor number. More...

virtual labelList	decompose (const labelListList &globalCellCells, const pointField &cc) const
	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) const
	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) const
	Helper: apply constraints to a decomposition. More...

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
	Decompose a mesh. More...

Static Public Member Functions
static label	nDomains (const dictionary &decompDict, const word &regionName="")
	Return region-specific or top-level `numberOfSubdomains` entry. More...

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)
	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 Types
enum	selectionType { DEFAULT = 0 , EXACT = 1 , MANDATORY = 2 , NULL_DICT = 4 }
	Selection type when handling the coefficients dictionary. More...

Protected Member Functions
const dictionary &	findCoeffsDict (const word &coeffsName, int select=selectionType::DEFAULT) const
	Locate coeffsName dictionary or the fallback "coeffs" dictionary. More...

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

Protected Attributes
const dictionary &	decompDict_
	Top-level decomposition dictionary (eg, decomposeParDict) More...

const dictionary &	decompRegionDict_
	Region-specific decomposition dictionary information. More...

label	nDomains_
	Number of domains for the decomposition. More...

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

Detailed Description

Abstract base class for domain decomposition.

Source files

Definition at line 51 of file decompositionMethod.H.

Member Enumeration Documentation

◆ selectionType

enum selectionType

protected

Selection type when handling the coefficients dictionary.

To be used as a bit-mask for findCoeffsDict

Enumerator
DEFAULT	Default request.
EXACT	No fallback to "coeffs" if main name not found.
MANDATORY	Fatal if dictionary could not be found.
NULL_DICT	On failure, return dictionary::null instead of the top-level enclosing dictionary.

Definition at line 76 of file decompositionMethod.H.

Constructor & Destructor Documentation

◆ decompositionMethod()

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

explicit

Construct given the decomposition dictionary, optionally region-specific

Definition at line 323 of file decompositionMethod.C.

◆ ~decompositionMethod()

virtual ~decompositionMethod ( )

virtualdefault

Destructor.

Member Function Documentation

◆ findCoeffsDict() [1/2]

const Foam::dictionary & findCoeffsDict	(	const dictionary &	dict,
		const word &	coeffsName,
		int	select = `selectionType::DEFAULT`
	)

staticprotected

Locate coeffsName dictionary or the fallback "coeffs" dictionary within an enclosing dictionary.

Parameters

select choose to include "coeffs" in the search, make failure a FatalError, return dictionary::null instead on failure.

Returns: the coefficients dictionary found. If nothing was found, return the enclosing dictionary or dictionary::null (depending on the select parameter).

Definition at line 242 of file decompositionMethod.C.

Referenced by randomDecomp::randomDecomp().

Here is the caller graph for this function:

◆ findCoeffsDict() [2/2]

const Foam::dictionary & findCoeffsDict	(	const word &	coeffsName,
		int	select = `selectionType::DEFAULT`
	)		const

protected

Locate coeffsName dictionary or the fallback "coeffs" dictionary.

Searches both the region-specific decomposition dictionary and the top-level decomposition dictionary.

Parameters

select choose to include "coeffs" in the search, make failure a FatalError, return dictionary::null instead on failure.

Returns: the coefficients dictionary found. If nothing was found, return the top-level (non-region) dictionary or dictionary::null (depending on the select parameter).

Definition at line 277 of file decompositionMethod.C.

References Foam::cfindCoeffsDict().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "decompositionMethod" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ nDomains() [1/2]

Foam::label nDomains	(	const dictionary &	decompDict,
		const word &	regionName = `""`
	)

static

Return region-specific or top-level numberOfSubdomains entry.

The region-specific version is found within the "regions" sub-dictionary.

Definition at line 81 of file decompositionMethod.C.

References Foam::endl(), dictionary::get(), Foam::nl, decompositionMethod::optionalRegionDict(), dictionary::readIfPresent(), regionName, and WarningInFunction.

Here is the call graph for this function:

◆ optionalRegionDict()

const Foam::dictionary & optionalRegionDict	(	const dictionary &	decompDict,
		const word &	regionName
	)

static

Return an optional region-specific dictionary from "regions" sub-dictionary, or dictionary::null on failure

Definition at line 114 of file decompositionMethod.C.

References dictionary::findDict(), and regionName.

Referenced by decompositionMethod::nDomains().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ New()

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

static

Return a reference to the selected decomposition method, optionally region-specific

Definition at line 342 of file decompositionMethod.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, dictionary::get(), dictionary::readIfPresent(), and regionName.

Here is the call graph for this function:

◆ nDomains() [2/2]

label nDomains ( ) const

inlinenoexcept

Number of domains.

Definition at line 209 of file decompositionMethod.H.

References decompositionMethod::nDomains_.

Referenced by structuredDecomp::structuredDecomp().

Here is the caller graph for this function:

◆ parallelAware()

virtual bool parallelAware ( ) const

pure virtual

Is method parallel aware?

(i.e. does it synchronize domains across proc boundaries)

Implemented in hierarchGeomDecomp, manualDecomp, multiLevelDecomp, noDecomp, randomDecomp, simpleGeomDecomp, structuredDecomp, kahipDecomp, metisDecomp, ptscotchDecomp, and scotchDecomp.

◆ decompose() [1/10]

Foam::labelList decompose	(	const pointField &	points,
		const scalarField &	pointWeights
	)		const

virtual

Return the wanted processor number for every coordinate.

Reimplemented in hierarchGeomDecomp, metisLikeDecomp, multiLevelDecomp, randomDecomp, ptscotchDecomp, scotchDecomp, geomDecomp, and simpleGeomDecomp.

Definition at line 1311 of file decompositionMethod.C.

References NotImplemented.

Referenced by meshRefinement::balance().

Here is the caller graph for this function:

◆ decompose() [2/10]

Foam::labelList decompose ( const pointField & points ) const

virtual

Decompose with uniform weights on the points.

Reimplemented in hierarchGeomDecomp, metisLikeDecomp, multiLevelDecomp, randomDecomp, simpleGeomDecomp, ptscotchDecomp, scotchDecomp, and geomDecomp.

Definition at line 1322 of file decompositionMethod.C.

References NotImplemented.

◆ decompose() [3/10]

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

pure virtual

Return for every coordinate the wanted processor number.

Use the mesh connectivity (if needed)

Implemented in hierarchGeomDecomp, manualDecomp, noDecomp, randomDecomp, metisLikeDecomp, multiLevelDecomp, structuredDecomp, ptscotchDecomp, scotchDecomp, metisLikeDecomp, multiLevelDecomp, ptscotchDecomp, scotchDecomp, and simpleGeomDecomp.

◆ decompose() [4/10]

Foam::labelList decompose	(	const polyMesh &	mesh,
		const pointField &	points
	)		const

virtual

Decompose with uniform weights on the points.

Reimplemented in hierarchGeomDecomp, metisLikeDecomp, multiLevelDecomp, simpleGeomDecomp, ptscotchDecomp, and scotchDecomp.

Definition at line 382 of file decompositionMethod.C.

◆ decompose() [5/10]

Foam::labelList decompose	(	const polyMesh &	mesh,
		const labelList &	cellToRegion,
		const pointField &	regionPoints,
		const scalarField &	regionWeights
	)		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. Coarse cells are local to the processor (if in parallel). If you want to have coarse cells spanning processors use the globalCellCells instead.

Reimplemented in metisLikeDecomp, ptscotchDecomp, scotchDecomp, metisLikeDecomp, multiLevelDecomp, ptscotchDecomp, and scotchDecomp.

Definition at line 394 of file decompositionMethod.C.

References forAll, mesh, UList< T >::size(), and CompactListList< T >::unpack().

Here is the call graph for this function:

◆ decompose() [6/10]

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

virtual

Like decompose but with uniform weights on the regions.

Reimplemented in metisLikeDecomp, multiLevelDecomp, ptscotchDecomp, and scotchDecomp.

Definition at line 435 of file decompositionMethod.C.

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

Here is the call graph for this function:

◆ decompose() [7/10]

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

pure virtual

Return for every coordinate the wanted processor number.

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

Implemented in hierarchGeomDecomp, manualDecomp, multiLevelDecomp, noDecomp, randomDecomp, simpleGeomDecomp, structuredDecomp, ptscotchDecomp, scotchDecomp, metisLikeDecomp, multiLevelDecomp, ptscotchDecomp, scotchDecomp, and metisLikeDecomp.

◆ decompose() [8/10]

Foam::labelList decompose	(	const labelListList &	globalCellCells,
		const pointField &	cc
	)		const

virtual

Like decompose but with uniform weights on the cells.

Reimplemented in hierarchGeomDecomp, metisLikeDecomp, multiLevelDecomp, ptscotchDecomp, and scotchDecomp.

Definition at line 454 of file decompositionMethod.C.

References UList< T >::size().

Here is the call graph for this function:

◆ calcCellCells() [1/2]

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

static

Helper: determine (local or global) cellCells from mesh.

agglomeration. Agglomeration is local to the processor. local : connections are in local indices. Coupled across cyclics but not processor patches. global : connections are in global indices. Coupled across cyclics and processor patches.

Definition at line 466 of file decompositionMethod.C.

References polyMesh::boundaryMesh(), decompositionMethod::calcCellCells(), HashTable< T, Key, Hash >::clear(), polyMesh::faceNeighbour(), polyMesh::faceOwner(), forAll, HashSet< Key, Hash >::insert(), globalIndex::isLocal(), CompactListList< T >::m(), mesh, primitiveMesh::nBoundaryFaces(), primitiveMesh::nInternalFaces(), CompactListList< T >::offsets(), patches, CompactListList< T >::setSize(), CompactListList< T >::size(), syncTools::swapBoundaryFaceList(), globalIndex::toGlobal(), globalIndex::toLocal(), UPstream::worldComm, and Foam::Zero.

Referenced by decompositionMethod::calcCellCells().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calcCellCells() [2/2]

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

static

Helper: determine (local or global) cellCells and face weights.

from mesh agglomeration. Uses mag of faceArea as weights

Definition at line 658 of file decompositionMethod.C.

References polyMesh::boundaryMesh(), decompositionMethod::calcCellCells(), HashTable< T, Key, Hash >::clear(), primitiveMesh::faceAreas(), polyMesh::faceNeighbour(), polyMesh::faceOwner(), forAll, HashSet< Key, Hash >::insert(), globalIndex::isLocal(), CompactListList< T >::m(), Foam::mag(), mesh, primitiveMesh::nBoundaryFaces(), primitiveMesh::nInternalFaces(), CompactListList< T >::offsets(), patches, CompactListList< T >::setSize(), CompactListList< T >::size(), syncTools::swapBoundaryFaceList(), globalIndex::toGlobal(), globalIndex::toLocal(), UPstream::worldComm, and Foam::Zero.

Here is the call graph for this function:

◆ setConstraints()

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

Helper: extract constraints:

blockedface: existing faces where owner and neighbour on same proc explicitConnections: sets of boundary faces ,, ,, specifiedProcessorFaces: groups of faces with all cells on same processor.

Definition at line 1203 of file decompositionMethod.C.

References List< T >::clear(), PtrList< T >::clear(), mesh, primitiveMesh::nFaces(), and List< T >::setSize().

Referenced by meshRefinement::balance().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyConstraints()

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.

This gives constraints opportunity to modify decomposition in case the native decomposition method has not obeyed all constraints

Definition at line 1232 of file decompositionMethod.C.

References mesh.

◆ decompose() [9/10]

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

Parameters

blockedFace	Whether owner and neighbour should be on same processor (takes priority over explicitConnections)
specifiedProcessorFaces	Whether whole sets of faces (and point neighbours) need to be kept on single processor
explicitConnections	Additional connections between boundary faces

Reimplemented in metisLikeDecomp, multiLevelDecomp, ptscotchDecomp, and scotchDecomp.

Definition at line 853 of file decompositionMethod.C.

References Foam::BitOps::all(), polyMesh::boundaryMesh(), primitiveMesh::cellCentres(), Foam::BitOps::count(), FaceCellWave< Type, TrackingData >::data(), UList< T >::data(), UList< T >::empty(), Foam::endl(), Foam::exit(), f(), primitiveMesh::faceCentres(), polyMesh::faceNeighbour(), polyMesh::faceOwner(), polyMesh::faces(), Foam::FatalError, FatalErrorInFunction, forAll, polyMesh::globalData(), Foam::Info, primitiveMesh::isInternalFace(), pTraits< complex >::max, mesh, primitiveMesh::nCells(), primitiveMesh::nFaces(), primitiveMesh::nInternalFaces(), Foam::nl, regionSplit::nLocalRegions(), globalMeshData::nTotalCells(), UPstream::parRun(), patches, pFaces, primitiveMesh::pointFaces(), Foam::reduce(), Foam::returnReduce(), UList< T >::size(), syncTools::swapBoundaryCellList(), and Foam::Zero.

Here is the call graph for this function:

◆ decompose() [10/10]

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

Decompose a mesh.

Apply all constraints from decomposeParDict ('preserveFaceZones' etc). Calls either

no constraints, empty weights: decompose(mesh, cellCentres())
no constraints, set weights: decompose(mesh, cellCentres(), cellWeights)
valid constraints: decompose(mesh, cellToRegion, regionPoints, regionWeights)

Definition at line 1257 of file decompositionMethod.C.

References mesh.

Member Data Documentation

◆ decompDict_

const dictionary& decompDict_

protected

Top-level decomposition dictionary (eg, decomposeParDict)

Definition at line 89 of file decompositionMethod.H.

◆ decompRegionDict_

const dictionary& decompRegionDict_

protected

Region-specific decomposition dictionary information.

Definition at line 92 of file decompositionMethod.H.

◆ nDomains_

label nDomains_

protected

Number of domains for the decomposition.

Definition at line 95 of file decompositionMethod.H.

Referenced by decompositionMethod::nDomains().

◆ constraints_

PtrList<decompositionConstraint> constraints_

protected

Optional constraints.

Definition at line 98 of file decompositionMethod.H.

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

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

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ selectionType

Constructor & Destructor Documentation

◆ decompositionMethod()

◆ ~decompositionMethod()

Member Function Documentation

◆ findCoeffsDict() [1/2]

◆ findCoeffsDict() [2/2]

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ nDomains() [1/2]

◆ optionalRegionDict()

◆ New()

◆ nDomains() [2/2]

◆ parallelAware()

◆ decompose() [1/10]

◆ decompose() [2/10]

◆ decompose() [3/10]

◆ decompose() [4/10]

◆ decompose() [5/10]

◆ decompose() [6/10]

◆ decompose() [7/10]

◆ decompose() [8/10]

◆ calcCellCells() [1/2]

◆ calcCellCells() [2/2]

◆ setConstraints()

◆ applyConstraints()

◆ decompose() [9/10]

◆ decompose() [10/10]

Member Data Documentation

◆ decompDict_

◆ decompRegionDict_

◆ nDomains_

◆ constraints_