simpleGeomDecomp Class Reference

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

Inheritance diagram for simpleGeomDecomp:
Collaboration diagram for simpleGeomDecomp:

Public Member Functions

 simpleGeomDecomp (const simpleGeomDecomp &)=delete
 No copy construct. More...
 
void operator= (const simpleGeomDecomp &)=delete
 No copy assignment. More...
 
 TypeName ("simple")
 Runtime type information. More...
 
 simpleGeomDecomp (const Vector< label > &divisions)
 Construct with number of x/y/z division (no coefficients or constraints) More...
 
 simpleGeomDecomp (const dictionary &decompDict, const word &regionName="")
 Construct given decomposition dictionary and optional region name. More...
 
virtual ~simpleGeomDecomp ()=default
 Destructor. More...
 
virtual bool parallelAware () const
 Sends all points to the master for decomposition. More...
 
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. More...
 
virtual labelList decompose (const polyMesh &mesh, const pointField &points, const scalarField &pointWeights=scalarField::null()) const
 Decompose with uniform or specified point weights. More...
 
virtual labelList decompose (const CompactListList< label > &globalCellCells, const pointField &cc, const scalarField &cWeights=scalarField::null()) const
 Explicitly provided connectivity. More...
 
virtual labelList decompose (const labelListList &globalCellCells, const pointField &cc, const scalarField &cWeights=scalarField::null()) const
 Explicitly provided connectivity. More...
 
- Public Member Functions inherited from geomDecomp
 geomDecomp (const Vector< label > &divisions)
 Construct with number of x/y/z division (no coefficients or constraints) More...
 
 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...
 
virtual bool geometric () const
 Purely geometric methods. More...
 
- Public Member Functions inherited from decompositionMethod
 decompositionMethod (const decompositionMethod &)=delete
 No copy construct. More...
 
void operator= (const decompositionMethod &)=delete
 No copy assignment. More...
 
 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=scalarField::null()) const
 Return for every coordinate the wanted processor number. 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 dictionaryoptionalRegionDict (const dictionary &decompDict, const word &regionName)
 Return an optional region-specific dictionary from "regions" sub-dictionary, or dictionary::null on failure. More...
 
static autoPtr< decompositionMethodNew (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 parallel, CompactListList< label > &cellCells)
 Determine (local or global) cellCells from mesh agglomeration. More...
 
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. 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< pointFieldadjustPoints (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 dictionaryfindCoeffsDict (const word &coeffsName, int select=selectionType::DEFAULT) const
 Locate coeffsName dictionary or the fallback "coeffs" dictionary. More...
 
 decompositionMethod (const label numDomains)
 Construct with specified number of domains, no coefficients or constraints. More...
 
- Static Protected Member Functions inherited from decompositionMethod
static const dictionaryfindCoeffsDict (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< directionorder_
 Decomposition order in terms of components (optional) More...
 
const dictionarycoeffsDict_
 Coefficients for all derived methods. More...
 
- Protected Attributes inherited from decompositionMethod
const dictionarydecompDict_
 Top-level decomposition dictionary (eg, decomposeParDict) More...
 
const dictionarydecompRegionDict_
 Region-specific decomposition dictionary information. More...
 
label nDomains_
 Number of domains for the decomposition. More...
 
PtrList< decompositionConstraintconstraints_
 Optional constraints. More...
 

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.

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

◆ simpleGeomDecomp() [3/3]

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

Construct given decomposition dictionary and optional region name.

Definition at line 330 of file simpleGeomDecomp.C.

◆ ~simpleGeomDecomp()

virtual ~simpleGeomDecomp ( )
virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const simpleGeomDecomp )
delete

No copy assignment.

◆ TypeName()

TypeName ( "simple"  )

Runtime type information.

◆ 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 342 of file simpleGeomDecomp.C.

References Foam::DelaunayMeshTools::allPoints(), UPstream::master(), UPstream::parRun(), points, Foam::returnReduceAnd(), and UList< T >::size().

Referenced by simpleGeomDecomp::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
meshTo check mesh dimensions

Implements decompositionMethod.

Definition at line 163 of file simpleGeomDecomp.H.

References geomDecomp::checkDecompositionDirections(), simpleGeomDecomp::decompose(), mesh, 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
inlinevirtual

Explicitly provided connectivity.

Parameters
globalCellCellsunused

Implements decompositionMethod.

Definition at line 177 of file simpleGeomDecomp.H.

References simpleGeomDecomp::decompose().

Here is the call graph for this function:

◆ decompose() [4/4]

virtual labelList decompose ( const labelListList globalCellCells,
const pointField cc,
const scalarField cWeights = scalarField::null() 
) const
inlinevirtual

Explicitly provided connectivity.

Parameters
globalCellCellsunused

Implements decompositionMethod.

Definition at line 190 of file simpleGeomDecomp.H.

References simpleGeomDecomp::decompose().

Here is the call graph for this function:

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