domainDecomposition Class Reference

Automatic domain decomposition class for finite-volume meshes. More...

Public Member Functions

 TypeName ("domainDecomposition")
 Runtime type information. More...
 
 domainDecomposition (const processorRunTimes &procRunTimes, const word &regionName)
 Construct from processor run times and region name. More...
 
virtual ~domainDecomposition ()
 Destructor. More...
 
const fvMeshcompleteMesh () const
 Access the global mesh. More...
 
const PtrList< fvMesh > & procMeshes () const
 Access the processor meshes. More...
 
label nProcs () const
 Return the number of processors in the decomposition. More...
 
bool readDecompose (const bool doSets)
 Read in the complete mesh. Read the processor meshes if they are. More...
 
bool readReconstruct (const bool doSets)
 Read in the processor meshes. Read the complete mesh if it is. More...
 
fvMesh::readUpdateState readUpdateDecompose ()
 Read-update for decomposition. More...
 
fvMesh::readUpdateState readUpdateReconstruct ()
 Read-update for reconstruction. More...
 
const labelListcellProc () const
 Return the distribution as an FV field for writing. More...
 
const labelListListprocPointAddressing () const
 Access the labels of points for each processor. More...
 
const labelListListprocFaceAddressing () const
 Access the labels of faces for each processor (see notes above) More...
 
const labelListListprocCellAddressing () const
 Access the labels of cells for each processor. More...
 
const PtrList< surfaceLabelField::Boundary > & procFaceAddressingBf () const
 Access the labels of faces for each processor (see notes above) More...
 
void writeComplete (const bool doSets) const
 Write the decomposed meshes and associated data. More...
 
void writeProcs (const bool doSets) const
 Write the decomposed meshes and associated data. More...
 

Detailed Description

Automatic domain decomposition class for finite-volume meshes.

Source files

Definition at line 53 of file domainDecomposition.H.

Constructor & Destructor Documentation

◆ domainDecomposition()

domainDecomposition ( const processorRunTimes procRunTimes,
const word regionName 
)

Construct from processor run times and region name.

Definition at line 881 of file domainDecomposition.C.

◆ ~domainDecomposition()

~domainDecomposition ( )
virtual

Destructor.

Definition at line 901 of file domainDecomposition.C.

Member Function Documentation

◆ TypeName()

TypeName ( "domainDecomposition"  )

Runtime type information.

◆ completeMesh()

const fvMesh& completeMesh ( ) const
inline

Access the global mesh.

Definition at line 247 of file domainDecomposition.H.

◆ procMeshes()

const PtrList<fvMesh>& procMeshes ( ) const
inline

Access the processor meshes.

Definition at line 254 of file domainDecomposition.H.

◆ nProcs()

label nProcs ( ) const
inline

Return the number of processors in the decomposition.

Definition at line 261 of file domainDecomposition.H.

References processorRunTimes::nProcs().

Here is the call graph for this function:

◆ readDecompose()

bool readDecompose ( const bool  doSets)

Read in the complete mesh. Read the processor meshes if they are.

available and up to date relative to the complete mesh, or decompose if not. Return whether or not decomposition happened.

Definition at line 907 of file domainDecomposition.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, IOobject::headerOk(), typeIOobject< Type >::headerOk(), polyMesh::meshSubDir, Foam::nl, and IOobject::relativePath().

Here is the call graph for this function:

◆ readReconstruct()

bool readReconstruct ( const bool  doSets)

Read in the processor meshes. Read the complete mesh if it is.

available and up to date relative to the processor meshes, or reconstruct if not. Return whether or not reconstruction happened.

Definition at line 1000 of file domainDecomposition.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOobject::headerOk(), typeIOobject< Type >::headerOk(), polyMesh::meshSubDir, IOobject::name(), Foam::nl, Foam::fvc::reconstruct(), IOobject::relativePath(), and WarningInFunction.

Here is the call graph for this function:

◆ readUpdateDecompose()

Foam::fvMesh::readUpdateState readUpdateDecompose ( )

Read-update for decomposition.

Definition at line 1119 of file domainDecomposition.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, polyMesh::TOPO_CHANGE, and polyMesh::UNCHANGED.

Here is the call graph for this function:

◆ readUpdateReconstruct()

Foam::fvMesh::readUpdateState readUpdateReconstruct ( )

Read-update for reconstruction.

Definition at line 1199 of file domainDecomposition.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::fvc::reconstruct(), polyMesh::TOPO_CHANGE, and polyMesh::UNCHANGED.

Here is the call graph for this function:

◆ cellProc()

const labelList& cellProc ( ) const
inline

Return the distribution as an FV field for writing.

Definition at line 283 of file domainDecomposition.H.

◆ procPointAddressing()

const labelListList& procPointAddressing ( ) const
inline

Access the labels of points for each processor.

Definition at line 289 of file domainDecomposition.H.

◆ procFaceAddressing()

const labelListList& procFaceAddressing ( ) const
inline

Access the labels of faces for each processor (see notes above)

Definition at line 296 of file domainDecomposition.H.

◆ procCellAddressing()

const labelListList& procCellAddressing ( ) const
inline

Access the labels of cells for each processor.

Definition at line 303 of file domainDecomposition.H.

◆ procFaceAddressingBf()

◆ writeComplete()

◆ writeProcs()


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