Public Member Functions | List of all members
ptscotchDecomp Class Reference

PTScotch domain decomposition. More...

Inheritance diagram for ptscotchDecomp:
Inheritance graph
[legend]
Collaboration diagram for ptscotchDecomp:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("ptscotch")
 
 ptscotchDecomp (const dictionary &decompDict, const word &regionName="")
 
virtual ~ptscotchDecomp ()=default
 
virtual bool parallelAware () const
 
virtual labelList decompose (const polyMesh &mesh, const pointField &points, const scalarField &pointWeights) const
 
virtual labelList decompose (const polyMesh &mesh, const labelList &agglom, const pointField &regionPoints, const scalarField &regionWeights) const
 
virtual labelList decompose (const labelListList &globalCellCells, const pointField &cc, const scalarField &cWeights) const
 
virtual labelList decompose (const pointField &points, const scalarField &pointWeights) const
 
virtual labelList decompose (const pointField &points) const
 
virtual labelList decompose (const polyMesh &mesh, const pointField &points, const scalarField &pointWeights) const=0
 
virtual labelList decompose (const polyMesh &mesh, const pointField &points) const
 
virtual labelList decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField &regionPoints, const scalarField &regionWeights) const
 
virtual labelList decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField &regionPoints) const
 
virtual labelList decompose (const labelListList &globalCellCells, const pointField &cc, const scalarField &cWeights) const=0
 
virtual labelList decompose (const labelListList &globalCellCells, const pointField &cc) const
 
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
 
- Public Member Functions inherited from decompositionMethod
 TypeName ("decompositionMethod")
 
 declareRunTimeSelectionTable (autoPtr, decompositionMethod, dictionary,(const dictionary &decompDict, const word &regionName),(decompDict, regionName))
 
 decompositionMethod (const dictionary &decompDict, const word &regionName="")
 
virtual ~decompositionMethod ()=default
 
label nDomains () const noexcept
 
virtual labelList decompose (const pointField &points, const scalarField &pointWeights) const
 
virtual labelList decompose (const pointField &points) const
 
virtual labelList decompose (const polyMesh &mesh, const pointField &points) const
 
virtual labelList decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField &regionPoints) const
 
virtual labelList decompose (const labelListList &globalCellCells, const pointField &cc) const
 
void setConstraints (const polyMesh &mesh, boolList &blockedFace, PtrList< labelList > &specifiedProcessorFaces, labelList &specifiedProcessor, List< labelPair > &explicitConnections) const
 
void applyConstraints (const polyMesh &mesh, const boolList &blockedFace, const PtrList< labelList > &specifiedProcessorFaces, const labelList &specifiedProcessor, const List< labelPair > &explicitConnections, labelList &finalDecomp) const
 
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
 

Additional Inherited Members

- Static Public Member Functions inherited from decompositionMethod
static label nDomains (const dictionary &decompDict, const word &regionName="")
 
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)
 
static void calcCellCells (const polyMesh &mesh, const labelList &agglom, const label nLocalCoarse, const bool parallel, CompactListList< label > &cellCells, CompactListList< scalar > &cellCellWeights)
 
- Protected Types inherited from decompositionMethod
enum  selectionType { DEFAULT = 0, EXACT = 1, MANDATORY = 2, NULL_DICT = 4 }
 
- Protected Member Functions inherited from decompositionMethod
const dictionaryfindCoeffsDict (const word &coeffsName, int select=selectionType::DEFAULT) const
 
- 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_
 
const dictionarydecompRegionDict_
 
label nDomains_
 
PtrList< decompositionConstraintconstraints_
 

Detailed Description

PTScotch domain decomposition.

For the main details about how to define the strategies, see scotchDecomp.

Coefficients dictionary: scotchCoeffs, coeffs.

Nonetheless, when decomposing in parallel, using writeGraph=true will write out .dgr files for debugging. For example, use these files with dgpart as follows:

mpirun -np 4 dgpart 2 'region0_%r.dgr'

where:

See also
Foam::scotchDecomp
Source files

Definition at line 64 of file ptscotchDecomp.H.

Constructor & Destructor Documentation

◆ ptscotchDecomp()

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

Definition at line 70 of file dummyPtscotchDecomp.C.

◆ ~ptscotchDecomp()

virtual ~ptscotchDecomp ( )
virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "ptscotch"  )

◆ parallelAware()

virtual bool parallelAware ( ) const
inlinevirtual

Implements decompositionMethod.

Definition at line 117 of file ptscotchDecomp.H.

◆ decompose() [1/13]

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

Implements decompositionMethod.

Definition at line 83 of file dummyPtscotchDecomp.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and notImplementedMessage.

Here is the call graph for this function:

◆ decompose() [2/13]

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

Reimplemented from decompositionMethod.

Definition at line 97 of file dummyPtscotchDecomp.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and notImplementedMessage.

Here is the call graph for this function:

◆ decompose() [3/13]

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

Implements decompositionMethod.

Definition at line 112 of file dummyPtscotchDecomp.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and notImplementedMessage.

Here is the call graph for this function:

◆ decompose() [4/13]

Foam::labelList decompose

Definition at line 1318 of file decompositionMethod.C.

◆ decompose() [5/13]

Foam::labelList decompose

Definition at line 1329 of file decompositionMethod.C.

◆ decompose() [6/13]

virtual labelList decompose

◆ decompose() [7/13]

Foam::labelList decompose

Definition at line 377 of file decompositionMethod.C.

◆ decompose() [8/13]

Foam::labelList decompose

Definition at line 389 of file decompositionMethod.C.

◆ decompose() [9/13]

Foam::labelList decompose

Definition at line 430 of file decompositionMethod.C.

◆ decompose() [10/13]

virtual labelList decompose

◆ decompose() [11/13]

Foam::labelList decompose

Definition at line 449 of file decompositionMethod.C.

◆ decompose() [12/13]

Foam::labelList decompose

Definition at line 860 of file decompositionMethod.C.

◆ decompose() [13/13]

Foam::labelList decompose

Definition at line 1264 of file decompositionMethod.C.


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