manualDecomp Class Reference

Decompose based on cell-to-processor association in a file. More...

Inheritance diagram for manualDecomp:
Collaboration diagram for manualDecomp:

Public Member Functions

 manualDecomp (const manualDecomp &)=delete
 No copy construct. More...
 
void operator= (const manualDecomp &)=delete
 No copy assignment. More...
 
 TypeName ("manual")
 Runtime type information. More...
 
 manualDecomp (const dictionary &decompDict, const word &regionName="")
 Construct given decomposition dictionary and optional region name. More...
 
virtual ~manualDecomp ()=default
 Destructor. More...
 
virtual bool parallelAware () const
 Manual decompose does not care about proc boundaries. Is all up to the user. More...
 
virtual labelList decompose (const polyMesh &mesh, const pointField &cc, const scalarField &cWeights=scalarField::null()) const
 Return for every coordinate the wanted processor number. More...
 
virtual labelList decompose (const CompactListList< label > &globalCellCells, const pointField &cc, const scalarField &cWeights=scalarField::null()) const
 Return for every coordinate the wanted processor number. More...
 
virtual labelList decompose (const labelListList &globalCellCells, const pointField &cc, const scalarField &cWeights=scalarField::null()) const
 Return for every coordinate the wanted processor number. 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 bool geometric () const
 True if the method is purely geometric, often using cell centre points. More...
 
virtual labelList decompose (const pointField &points, const scalarField &pointWeights=scalarField::null()) const
 Return the wanted processor number for every coordinate, using uniform or specified point weights. 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 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 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 based on cell-to-processor association in a file.

Method coefficients:

Property Description Required Default
dataFile filename of cell decomposition data yes
Source files

Definition at line 61 of file manualDecomp.H.

Constructor & Destructor Documentation

◆ manualDecomp() [1/2]

manualDecomp ( const manualDecomp )
delete

No copy construct.

◆ manualDecomp() [2/2]

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

Construct given decomposition dictionary and optional region name.

Definition at line 43 of file manualDecomp.C.

◆ ~manualDecomp()

virtual ~manualDecomp ( )
virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const manualDecomp )
delete

No copy assignment.

◆ TypeName()

TypeName ( "manual"  )

Runtime type information.

◆ parallelAware()

virtual bool parallelAware ( ) const
inlinevirtual

Manual decompose does not care about proc boundaries. Is all up to the user.

Implements decompositionMethod.

Definition at line 114 of file manualDecomp.H.

◆ decompose() [1/3]

Foam::labelList decompose ( const polyMesh mesh,
const pointField cc,
const scalarField cWeights = scalarField::null() 
) const
virtual

Return for every coordinate the wanted processor number.

Use the mesh connectivity (if needed)

Implements decompositionMethod.

Definition at line 59 of file manualDecomp.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, mesh, Foam::minMax(), points, and range.

Here is the call graph for this function:

◆ decompose() [2/3]

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

Return for every coordinate the wanted processor number.

Explicitly provided connectivity - does not use mesh_.

Implements decompositionMethod.

Definition at line 137 of file manualDecomp.H.

References NotImplemented.

◆ decompose() [3/3]

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

Return for every coordinate the wanted processor number.

Explicitly provided connectivity - does not use mesh_.

Implements decompositionMethod.

Definition at line 153 of file manualDecomp.H.

References NotImplemented.


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