randomDecomp Class Reference

Decomposition according to pseudo-random number generator, which is useful for development and stress testing implementations but obviously sub-optimal for normal uses. Can optionally specify the number of consecutive cells to assign to the same processor (agglomeration). More...

Inheritance diagram for randomDecomp:
Collaboration diagram for randomDecomp:

Public Member Functions

 randomDecomp (const randomDecomp &)=delete
 No copy construct. More...
 
void operator= (const randomDecomp &)=delete
 No copy assignment. More...
 
 TypeNameNoDebug ("random")
 Runtime type information. More...
 
 randomDecomp (const label numDomains)
 Construct with number of domains (no coefficients or constraints) More...
 
 randomDecomp (const dictionary &decompDict, const word &regionName="", int select=selectionType::DEFAULT)
 Construct for decomposition dictionary and optional region name. More...
 
virtual ~randomDecomp ()=default
 Destructor. More...
 
virtual bool parallelAware () const
 Does not care about proc boundaries. More...
 
virtual labelList decompose (const pointField &points, const scalarField &pointWeights_unused=scalarField::null()) const
 Return for every coordinate the wanted processor number. More...
 
virtual labelList decompose (const polyMesh &mesh, const pointField &cc_unused=pointField::null(), const scalarField &cWeights_unused=scalarField::null()) const
 Return for every coordinate the wanted processor number. More...
 
virtual labelList decompose (const CompactListList< label > &globalCellCells, const pointField &cc_unused=pointField::null(), const scalarField &cWeights_unused=scalarField::null()) const
 Return for every coordinate the wanted processor number. More...
 
virtual labelList decompose (const labelListList &globalCellCells, const pointField &cc_unused=pointField::null(), const scalarField &cWeights_unused=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 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

Decomposition according to pseudo-random number generator, which is useful for development and stress testing implementations but obviously sub-optimal for normal uses. Can optionally specify the number of consecutive cells to assign to the same processor (agglomeration).

Coefficients:

Property Description Required Default
agglom Number of cells to agglomerate no 0
Source files

Definition at line 64 of file randomDecomp.H.

Constructor & Destructor Documentation

◆ randomDecomp() [1/3]

randomDecomp ( const randomDecomp )
delete

No copy construct.

◆ randomDecomp() [2/3]

randomDecomp ( const label  numDomains)
explicit

Construct with number of domains (no coefficients or constraints)

Definition at line 78 of file randomDecomp.C.

◆ randomDecomp() [3/3]

randomDecomp ( const dictionary decompDict,
const word regionName = "",
int  select = selectionType::DEFAULT 
)
explicit

Construct for decomposition dictionary and optional region name.

Definition at line 86 of file randomDecomp.C.

References dictionary::readIfPresent(), and Foam::BitOps::select().

Here is the call graph for this function:

◆ ~randomDecomp()

virtual ~randomDecomp ( )
virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const randomDecomp )
delete

No copy assignment.

◆ TypeNameNoDebug()

TypeNameNoDebug ( "random"  )

Runtime type information.

◆ parallelAware()

virtual bool parallelAware ( ) const
inlinevirtual

Does not care about proc boundaries.

Implements decompositionMethod.

Definition at line 133 of file randomDecomp.H.

◆ decompose() [1/4]

Foam::labelList decompose ( const pointField points,
const scalarField pointWeights_unused = scalarField::null() 
) const
virtual

Return for every coordinate the wanted processor number.

Reimplemented from decompositionMethod.

Definition at line 105 of file randomDecomp.C.

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

Here is the call graph for this function:

◆ decompose() [2/4]

Foam::labelList decompose ( const polyMesh mesh,
const pointField cc_unused = pointField::null(),
const scalarField cWeights_unused = scalarField::null() 
) const
virtual

Return for every coordinate the wanted processor number.

Implements decompositionMethod.

Definition at line 115 of file randomDecomp.C.

References mesh, and primitiveMesh::nCells().

Here is the call graph for this function:

◆ decompose() [3/4]

Foam::labelList decompose ( const CompactListList< label > &  globalCellCells,
const pointField cc_unused = pointField::null(),
const scalarField cWeights_unused = scalarField::null() 
) const
virtual

Return for every coordinate the wanted processor number.

Explicitly provided connectivity - does not use mesh_.

Implements decompositionMethod.

Definition at line 126 of file randomDecomp.C.

References CompactListList< T >::size().

Here is the call graph for this function:

◆ decompose() [4/4]

Foam::labelList decompose ( const labelListList globalCellCells,
const pointField cc_unused = pointField::null(),
const scalarField cWeights_unused = scalarField::null() 
) const
virtual

Return for every coordinate the wanted processor number.

Explicitly provided connectivity - does not use mesh_.

Implements decompositionMethod.

Definition at line 137 of file randomDecomp.C.

References UList< T >::size().

Here is the call graph for this function:

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