multiLevelDecomp Class Reference

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

Inheritance diagram for multiLevelDecomp:
[legend]
Collaboration diagram for multiLevelDecomp:
[legend]

Public Member Functions

 TypeName ("multiLevel")
 Runtime type information. More...
 
 multiLevelDecomp (const dictionary &decompDict, const word &regionName="")
 Construct given decomposition dictionary and optional region name. More...
 
virtual ~multiLevelDecomp ()=default
 Destructor. More...
 
virtual bool parallelAware () const
 Is method parallel aware? More...
 
virtual labelList decompose (const polyMesh &mesh, const pointField &points, const scalarField &pointWeights) const
 Return for every coordinate the wanted processor number. 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 pointField &points, const scalarField &pointWeights) const
 Inherit decompose from decompositionMethod. More...
 
virtual labelList decompose (const pointField &points) const
 Inherit decompose from decompositionMethod. More...
 
virtual labelList decompose (const polyMesh &mesh, const pointField &points, const scalarField &pointWeights) const=0
 Inherit decompose from decompositionMethod. More...
 
virtual labelList decompose (const polyMesh &mesh, const pointField &points) const
 Inherit decompose from decompositionMethod. More...
 
virtual labelList decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField &regionPoints, const scalarField &regionWeights) const
 Inherit decompose from decompositionMethod. More...
 
virtual labelList decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField &regionPoints) const
 Inherit decompose from decompositionMethod. More...
 
virtual labelList decompose (const labelListList &globalCellCells, const pointField &cc, const scalarField &cWeights) const=0
 Inherit decompose from decompositionMethod. More...
 
virtual labelList decompose (const labelListList &globalCellCells, const pointField &cc) const
 Inherit decompose from decompositionMethod. 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
 Inherit decompose from decompositionMethod. More...
 
labelList decompose (const polyMesh &mesh, const scalarField &cWeights) const
 Inherit decompose from decompositionMethod. 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="")
 
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...
 

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)
 
static autoPtr< decompositionMethodNew (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 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
const dictionaryfindCoeffsDict (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 dictionaryfindCoeffsDict (const dictionary &dict, const word &coeffsName, int select=selectionType::DEFAULT)
 
- 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

Decompose given using consecutive application of decomposers.

Source files

Definition at line 49 of file multiLevelDecomp.H.

Constructor & Destructor Documentation

◆ multiLevelDecomp()

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

Construct given decomposition dictionary and optional region name.

Definition at line 567 of file multiLevelDecomp.C.

◆ ~multiLevelDecomp()

virtual ~multiLevelDecomp ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "multiLevel"  )

Runtime type information.

◆ parallelAware()

bool parallelAware ( ) const
virtual

Is method parallel aware?

i.e. does it synchronize domains across proc boundaries

Implements decompositionMethod.

Definition at line 592 of file multiLevelDecomp.C.

◆ decompose() [1/12]

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

Return for every coordinate the wanted processor number.

Use the mesh connectivity (if needed)

Implements decompositionMethod.

Definition at line 606 of file multiLevelDecomp.C.

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

Here is the call graph for this function:

◆ decompose() [2/12]

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

Return for every coordinate the wanted processor number.

Explicitly provided connectivity - does not use mesh_.

Implements decompositionMethod.

Definition at line 635 of file multiLevelDecomp.C.

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

Here is the call graph for this function:

◆ decompose() [3/12]

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

Inherit decompose from decompositionMethod.

Reimplemented from decompositionMethod.

Definition at line 222 of file decompositionMethod.C.

◆ decompose() [4/12]

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

Inherit decompose from decompositionMethod.

Reimplemented from decompositionMethod.

Definition at line 229 of file decompositionMethod.C.

◆ decompose() [5/12]

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

Inherit decompose from decompositionMethod.

Implements decompositionMethod.

◆ decompose() [6/12]

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

Inherit decompose from decompositionMethod.

Reimplemented from decompositionMethod.

Definition at line 244 of file decompositionMethod.C.

◆ decompose() [7/12]

Foam::labelList decompose ( const polyMesh mesh,
const labelList cellToRegion,
const pointField regionPoints,
const scalarField regionWeights 
) const
virtual

Inherit decompose from decompositionMethod.

Reimplemented from decompositionMethod.

Definition at line 258 of file decompositionMethod.C.

◆ decompose() [8/12]

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

Inherit decompose from decompositionMethod.

Reimplemented from decompositionMethod.

Definition at line 267 of file decompositionMethod.C.

◆ decompose() [9/12]

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

Inherit decompose from decompositionMethod.

Implements decompositionMethod.

◆ decompose() [10/12]

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

Inherit decompose from decompositionMethod.

Reimplemented from decompositionMethod.

Definition at line 292 of file decompositionMethod.C.

◆ decompose() [11/12]

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
blockedFaceWhether owner and neighbour should be on same processor (takes priority over explicitConnections)
specifiedProcessorFacesWhether whole sets of faces (and point neighbours) need to be kept on single processor
explicitConnectionsAdditional connections between boundary faces

Reimplemented from decompositionMethod.

Definition at line 367 of file decompositionMethod.C.

◆ decompose() [12/12]

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

Inherit decompose from decompositionMethod.

Definition at line 387 of file decompositionMethod.C.


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