FreeFOAM The Cross-Platform CFD Toolkit
scotchDecomp Class Reference

Scotch domain decomposition. More...

#include <scotchDecomp/scotchDecomp.H>


Detailed Description

+ Inheritance diagram for scotchDecomp:
+ Collaboration diagram for scotchDecomp:

List of all members.

Public Member Functions

 TypeName ("scotch")
 Runtime type information.
 scotchDecomp (const dictionary &decompositionDict, const polyMesh &mesh)
 Construct given the decomposition dictionary and mesh.
virtual ~scotchDecomp ()
virtual bool parallelAware () const
 Is method parallel aware (i.e. does it synchronize domains across.
virtual labelList decompose (const pointField &points, const scalarField &pointWeights)
 Return for every coordinate the wanted processor number. Use the.
virtual labelList decompose (const labelList &agglom, const pointField &regionPoints, const scalarField &regionWeights)
 Return for every coordinate the wanted processor number. Gets.
virtual labelList decompose (const labelList &agglom, const pointField &regionPoints)
 Same but with uniform weights.
virtual labelList decompose (const labelListList &globalCellCells, const pointField &cc, const scalarField &cWeights)
 Return for every coordinate the wanted processor number. Explicitly.
- Public Member Functions inherited from decompositionMethod
 TypeName ("decompositionMethod")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, decompositionMethod, dictionary,(const dictionary &decompositionDict),(decompositionDict))
 declareRunTimeSelectionTable (autoPtr, decompositionMethod, dictionaryMesh,(const dictionary &decompositionDict, const polyMesh &mesh),(decompositionDict, mesh))
 decompositionMethod (const dictionary &decompositionDict)
 Construct given the decomposition dictionary.
virtual ~decompositionMethod ()
virtual labelList decompose (const pointField &)
 Like decompose but with uniform weights on the points.
virtual labelList decompose (const labelListList &globalCellCells, const pointField &cc)
 Like decompose but with uniform weights on the cells.

Static Public Member Functions

static void calcCSR (const polyMesh &mesh, List< int > &adjncy, List< int > &xadj)
 Helper to convert local connectivity (supplied as owner,neighbour)
static void calcCSR (const labelListList &globalCellCells, List< int > &adjncy, List< int > &xadj)
 Helper to convert connectivity (supplied as cellcells) into.
- Static Public Member Functions inherited from decompositionMethod
static autoPtr
< decompositionMethod
New (const dictionary &decompositionDict)
 Return a reference to the selected decomposition method.
static autoPtr
< decompositionMethod
New (const dictionary &decompositionDict, const polyMesh &mesh)
 Return a reference to the selected decomposition method.

Additional Inherited Members

- Static Protected Member Functions inherited from decompositionMethod
static void calcCellCells (const polyMesh &mesh, const labelList &agglom, const label nCoarse, labelListList &cellCells)
 Helper: determine (non-parallel) cellCells from mesh agglomeration.
- Protected Attributes inherited from decompositionMethod
const dictionarydecompositionDict_
label nProcessors_

Constructor & Destructor Documentation

scotchDecomp ( const dictionary decompositionDict,
const polyMesh mesh 
)

Construct given the decomposition dictionary and mesh.

Definition at line 409 of file scotchDecomp.C.

virtual ~scotchDecomp ( )
inlinevirtual

Definition at line 92 of file scotchDecomp.H.


Member Function Documentation

TypeName ( "scotch"  )

Runtime type information.

virtual bool parallelAware ( ) const
inlinevirtual

Is method parallel aware (i.e. does it synchronize domains across.

proc boundaries)

Implements decompositionMethod.

Definition at line 98 of file scotchDecomp.H.

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

Return for every coordinate the wanted processor number. Use the.

mesh connectivity (if needed) Weights get normalised so the minimum value is 1 before truncation to an integer so the weights should be multiples of the minimum value. The overall sum of weights might otherwise overflow.

Implements decompositionMethod.

Definition at line 422 of file scotchDecomp.C.

References Foam::exit(), Foam::FatalError, FatalErrorIn, forAll, and List< T >::size().

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

Return for every coordinate the wanted processor number. Gets.

passed agglomeration map (from fine to coarse cells) and coarse cell location. Can be overridden by decomposers that provide this functionality natively. See note on weights above.

Reimplemented from decompositionMethod.

Definition at line 463 of file scotchDecomp.C.

References Foam::exit(), Foam::FatalError, FatalErrorIn, forAll, and List< T >::size().

virtual labelList decompose ( const labelList agglom,
const pointField regionPoints 
)
inlinevirtual

Same but with uniform weights.

Reimplemented from decompositionMethod.

Definition at line 129 of file scotchDecomp.H.

References List< T >::size().

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

Return for every coordinate the wanted processor number. Explicitly.

provided mesh connectivity. The connectivity is equal to mesh.cellCells() except for

  • in parallel the cell numbers are global cell numbers (starting from 0 at processor0 and then incrementing all through the processors)
  • the connections are across coupled patches See note on weights above.

Implements decompositionMethod.

Definition at line 515 of file scotchDecomp.C.

References Foam::exit(), Foam::FatalError, FatalErrorIn, forAll, and List< T >::size().

void calcCSR ( const polyMesh mesh,
List< int > &  adjncy,
List< int > &  xadj 
)
static

Helper to convert local connectivity (supplied as owner,neighbour)

into CSR (Metis,scotch) storage. Does cyclics but not processor patches

Definition at line 556 of file scotchDecomp.C.

References polyMesh::boundaryMesh(), primitiveMesh::cells(), polyMesh::faceNeighbour(), polyMesh::faceOwner(), forAll, primitiveMesh::isInternalFace(), primitiveMesh::nCells(), primitiveMesh::nInternalFaces(), patchi, List< T >::setSize(), PtrList< T >::size(), UList< T >::size(), and polyBoundaryMesh::whichPatch().

void calcCSR ( const labelListList globalCellCells,
List< int > &  adjncy,
List< int > &  xadj 
)
static

Helper to convert connectivity (supplied as cellcells) into.

CSR (Metis,scotch) storage

Definition at line 654 of file scotchDecomp.C.

References forAll, List< T >::setSize(), and List< T >::size().


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