Simple geometric decomposition, selectable as simple. More...

#include <simpleGeomDecomp.H>

Inheritance diagram for simpleGeomDecomp:

Collaboration diagram for simpleGeomDecomp:

Public Member Functions
	simpleGeomDecomp (const simpleGeomDecomp &)=delete
	No copy construct.
void	operator= (const simpleGeomDecomp &)=delete
	No copy assignment.
	TypeName ("simple")
	Runtime type information.
	simpleGeomDecomp (const Vector< label > &divisions)
	Construct with number of x/y/z division (no coefficients or constraints).
	simpleGeomDecomp (const dictionary &decompDict, const word &regionName="")
	Construct given decomposition dictionary and optional region name.
virtual	~simpleGeomDecomp ()=default
	Destructor.
virtual bool	parallelAware () const
	Sends all points to the master for decomposition.
virtual labelList	decompose (const pointField &points, const scalarField &weights=scalarField::null()) const
	Return for every coordinate the wanted processor number. using uniform or specified point weights.
virtual labelList	decompose (const polyMesh &mesh, const pointField &points, const scalarField &pointWeights=scalarField::null()) const
	Decompose with uniform or specified point weights.
virtual labelList	decompose (const CompactListList< label > &globalCellCells, const pointField &cc, const scalarField &cWeights=scalarField::null()) const
	Explicitly provided connectivity.
virtual labelList	decompose (const labelListList &globalCellCells, const pointField &cc, const scalarField &cWeights=scalarField::null()) const
	Explicitly provided connectivity.
Public Member Functions inherited from geomDecomp
	geomDecomp (const Vector< label > &divisions)
	Construct with number of x/y/z division (no coefficients or constraints).
	geomDecomp (const word &derivedType, const dictionary &decompDict, int select=selectionType::DEFAULT)
	Construct for derived type name and decomposition dictionary.
	geomDecomp (const word &derivedType, const dictionary &decompDict, const word &regionName, int select=selectionType::DEFAULT)
	Construct for derived type name, decomposition dictionary and region name.
virtual bool	geometric () const
	Purely geometric methods.
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 labelList	decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField &regionPoints, const scalarField &regionWeights=scalarField::null()) const
	Return for every coordinate the wanted processor number.
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.
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.

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 geomDecomp
tmp< pointField >	adjustPoints (const pointField &) const
	Apply delta (jitter) or rotation to coordinates.
void	checkDecompositionDirections (const Vector< label > &) const
	Check that mesh directions are compatible with decomposition.
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 geomDecomp
Vector< label >	n_
	The divisions.
Vector< direction >	order_
	Decomposition order in terms of components (optional).
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.

Detailed Description

Simple geometric decomposition, selectable as simple.

Method coefficients:

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

Source files

Definition at line 79 of file simpleGeomDecomp.H.

Constructor & Destructor Documentation

◆ simpleGeomDecomp() [1/3]

simpleGeomDecomp ( const simpleGeomDecomp & )

delete

No copy construct.

References simpleGeomDecomp().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ simpleGeomDecomp() [2/3]

simpleGeomDecomp ( const Vector< label > & divisions )

explicit

Construct with number of x/y/z division (no coefficients or constraints).

Definition at line 323 of file simpleGeomDecomp.C.

References geomDecomp::geomDecomp().

Here is the call graph for this function:

◆ simpleGeomDecomp() [3/3]

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

explicit

Construct given decomposition dictionary and optional region name.

Definition at line 329 of file simpleGeomDecomp.C.

References geomDecomp::geomDecomp(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, and regionName.

Here is the call graph for this function:

◆ ~simpleGeomDecomp()

virtual ~simpleGeomDecomp ( )

virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const simpleGeomDecomp & )

delete

No copy assignment.

References simpleGeomDecomp().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "simple" )

Runtime type information.

References regionName.

◆ parallelAware()

virtual bool parallelAware ( ) const

inlinevirtual

Sends all points to the master for decomposition.

Implements decompositionMethod.

Definition at line 144 of file simpleGeomDecomp.H.

◆ decompose() [1/4]

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

virtual

Return for every coordinate the wanted processor number. using uniform or specified point weights.

Implements geomDecomp.

Definition at line 341 of file simpleGeomDecomp.C.

References List< T >::clear(), globalIndex::gather(), UPstream::master(), UPstream::parRun(), points, Foam::returnReduceAnd(), globalIndex::scatter(), and UList< T >::size().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ decompose() [2/4]

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

inlinevirtual

Decompose with uniform or specified point weights.

Parameters

mesh	To check mesh dimensions

Implements decompositionMethod.

Definition at line 162 of file simpleGeomDecomp.H.

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

Here is the call graph for this function:

◆ decompose() [3/4]

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