Does hierarchical decomposition of points, selectable as hierarchical. More...

Inheritance diagram for hierarchGeomDecomp:

Collaboration diagram for hierarchGeomDecomp:

Public Member Functions
	hierarchGeomDecomp (const hierarchGeomDecomp &)=delete
	No copy construct. More...

void	operator= (const hierarchGeomDecomp &)=delete
	No copy assignment. More...

	TypeName ("hierarchical")
	Runtime type information. More...

	hierarchGeomDecomp (const dictionary &decompDict, const word &regionName="")
	Construct given decomposition dictionary and optional region name. More...

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

virtual bool	parallelAware () const
	Hierarchical is aware of processor boundaries. More...

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

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

virtual labelList	decompose (const polyMesh &mesh, const pointField &cc, const scalarField &cWeights) const
	Return for every coordinate the wanted processor number. More...

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

virtual labelList	decompose (const labelListList &globalCellCells, const pointField &cc, const scalarField &cWeights) const
	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...

Public Member Functions inherited from geomDecomp
	geomDecomp (const word &derivedType, const dictionary &decompDict, int select=selectionType::DEFAULT)
	Construct for derived type name and decomposition dictionary. More...

	geomDecomp (const word &derivedType, const dictionary &decompDict, const word &regionName, int select=selectionType::DEFAULT)
	Construct for derived type name, decomposition dictionary and region name. More...

Public Member Functions inherited from decompositionMethod
	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="")
	Construct given the decomposition dictionary, optionally region-specific. More...

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

label	nDomains () const noexcept
	Number of domains. 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...

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

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

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

static autoPtr< decompositionMethod >	New (const dictionary &decompDict, const word &regionName="")
	Return a reference to the selected decomposition method, optionally region-specific. 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 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 geomDecomp
tmp< pointField >	adjustPoints (const pointField &) const
	Apply delta (jitter) or rotation to coordinates. More...

void	checkDecompositionDirections (const Vector< label > &) const
	Check that mesh directions are compatible with decomposition. More...

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

Static Protected Member Functions inherited from decompositionMethod
static 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. More...

Protected Attributes inherited from geomDecomp
Vector< label >	n_
	The divisions. More...

Vector< direction >	order_
	Decomposition order in terms of components (optional) More...

const dictionary &	coeffsDict_
	Coefficients for all derived methods. More...

Protected Attributes inherited from decompositionMethod
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

Does hierarchical decomposition of points, selectable as hierarchical.

Works by first sorting the points in x direction into equal sized bins, then in y direction and finally in z direction.

Uses single array to hold decomposition which is indexed as if it is a 3 dimensional array:

finalDecomp[i,j,k] is indexed as

i*n[0]*n[1] + j*n[1] + k

E.g. if we're sorting 'xyz': the first sort (over the x-component) determines in which x-domain the point goes. Then for each of the x-domains the points are sorted in y direction and each individual x-domain gets split into three y-domains. And similar for the z-direction.

Since the domains are of equal size the maximum difference in size is n[0]*n[1] (or n[1]*n[2]?) (small anyway)

Method coefficients:

Property	Description	Required	Default
`n`	(nx ny nz)	yes
`order`	order of operation	no	xyz
`delta`	delta (jitter) for rotation matrix	no	0.001
`transform`	cartesian coordinate transformation	no

Source files

Definition at line 97 of file hierarchGeomDecomp.H.

Constructor & Destructor Documentation

◆ hierarchGeomDecomp() [1/2]

hierarchGeomDecomp ( const hierarchGeomDecomp & )

delete

No copy construct.

◆ hierarchGeomDecomp() [2/2]

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

explicit

Construct given decomposition dictionary and optional region name.

Definition at line 671 of file hierarchGeomDecomp.C.

◆ ~hierarchGeomDecomp()

virtual ~hierarchGeomDecomp ( )

virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const hierarchGeomDecomp & )

delete

No copy assignment.

◆ TypeName()

TypeName ( "hierarchical" )

Runtime type information.

◆ parallelAware()

virtual bool parallelAware ( ) const

inlinevirtual

Hierarchical is aware of processor boundaries.

Implements decompositionMethod.

Definition at line 241 of file hierarchGeomDecomp.H.

◆ decompose() [1/6]

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

virtual

Return for every coordinate the wanted processor number.

Implements geomDecomp.

Definition at line 724 of file hierarchGeomDecomp.C.

References Foam::constant::electromagnetic::e, Foam::endl(), Foam::identity(), Foam::max(), points, Foam::returnReduce(), UList< T >::size(), WarningInFunction, and Foam::Zero.

Referenced by hierarchGeomDecomp::decompose().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ decompose() [2/6]

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

virtual

Decompose with uniform weights.

Code for weighted decomposition is a bit complex, so kept separate for now.

Implements geomDecomp.

Definition at line 683 of file hierarchGeomDecomp.C.

References Foam::constant::electromagnetic::e, Foam::endl(), Foam::identity(), Foam::max(), points, Foam::returnReduce(), UList< T >::size(), WarningInFunction, and Foam::Zero.

Here is the call graph for this function:

◆ decompose() [3/6]

virtual labelList decompose	(	const polyMesh &	mesh,
		const pointField &	cc,
		const scalarField &	cWeights
	)		const

inlinevirtual

Return for every coordinate the wanted processor number.

Use the mesh connectivity (if needed).

Implements decompositionMethod.

Definition at line 270 of file hierarchGeomDecomp.H.

References geomDecomp::checkDecompositionDirections(), hierarchGeomDecomp::decompose(), and mesh.

Here is the call graph for this function:

◆ decompose() [4/6]

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

inlinevirtual

Decompose with uniform weights.

Code for weighted decomposition is a bit complex, so kept separate for now.

Reimplemented from decompositionMethod.

Definition at line 287 of file hierarchGeomDecomp.H.

References geomDecomp::checkDecompositionDirections(), hierarchGeomDecomp::decompose(), and mesh.

Here is the call graph for this function:

◆ decompose() [5/6]

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

inlinevirtual

Return for every coordinate the wanted processor number.

Explicitly provided connectivity - does not use mesh_. 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

Implements decompositionMethod.

Definition at line 307 of file hierarchGeomDecomp.H.

References hierarchGeomDecomp::decompose().

Here is the call graph for this function:

◆ decompose() [6/6]

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

inlinevirtual

Like decompose but with uniform weights on the cells.

Reimplemented from decompositionMethod.

Definition at line 317 of file hierarchGeomDecomp.H.

References hierarchGeomDecomp::decompose().

Here is the call graph for this function:

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ hierarchGeomDecomp() [1/2]

◆ hierarchGeomDecomp() [2/2]

◆ ~hierarchGeomDecomp()

Member Function Documentation

◆ operator=()

◆ TypeName()

◆ parallelAware()

◆ decompose() [1/6]

◆ decompose() [2/6]

◆ decompose() [3/6]

◆ decompose() [4/6]

◆ decompose() [5/6]

◆ decompose() [6/6]