GAMGAgglomeration Class Reference

Geometric agglomerated algebraic multigrid agglomeration class. More...

Inheritance diagram for GAMGAgglomeration:
Collaboration diagram for GAMGAgglomeration:

Public Member Functions

 TypeName ("GAMGAgglomeration")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, GAMGAgglomeration, lduMesh,(const lduMesh &mesh, const dictionary &controlDict),(mesh, controlDict))
 Runtime selection table for pure geometric agglomerators. More...
 
 declareRunTimeSelectionTable (autoPtr, GAMGAgglomeration, lduMatrix,(const lduMatrix &matrix, const dictionary &controlDict),(matrix, controlDict))
 Runtime selection table for matrix or mixed geometric/matrix. More...
 
 declareRunTimeSelectionTable (autoPtr, GAMGAgglomeration, geometry,(const lduMesh &mesh, const scalarField &cellVolumes, const vectorField &faceAreas, const dictionary &controlDict),(mesh, cellVolumes, faceAreas, controlDict))
 Runtime selection table for matrix or mixed geometric/matrix. More...
 
 GAMGAgglomeration (const lduMesh &mesh, const dictionary &controlDict)
 Construct given mesh and controls. More...
 
 GAMGAgglomeration (const GAMGAgglomeration &)=delete
 Disallow default bitwise copy construction. More...
 
 ~GAMGAgglomeration ()
 Destructor. More...
 
label size () const
 
const lduMeshmeshLevel (const label leveli) const
 Return LDU mesh of given level. More...
 
bool hasMeshLevel (const label leveli) const
 Do we have mesh for given level? More...
 
const lduInterfacePtrsListinterfaceLevel (const label leveli) const
 Return LDU interface addressing of given level. More...
 
const labelFieldrestrictAddressing (const label leveli) const
 Return cell restrict addressing of given level. More...
 
const labelListfaceRestrictAddressing (const label leveli) const
 Return face restrict addressing of given level. More...
 
const labelListListpatchFaceRestrictAddressing (const label leveli) const
 
const boolListfaceFlipMap (const label leveli) const
 Return face flip map of given level. More...
 
label nCells (const label leveli) const
 Return number of coarse cells (before processor agglomeration) More...
 
label nFaces (const label leveli) const
 Return number of coarse faces (before processor agglomeration) More...
 
const labelListnPatchFaces (const label leveli) const
 Return number of coarse patch faces (before processor. More...
 
template<class Type >
void restrictField (Field< Type > &cf, const Field< Type > &ff, const label fineLevelIndex, const bool procAgglom) const
 Restrict (integrate by summation) cell field. More...
 
template<class Type >
void restrictFaceField (Field< Type > &cf, const Field< Type > &ff, const label fineLevelIndex) const
 Restrict (integrate by summation) face field. More...
 
template<class Type >
void restrictField (Field< Type > &cf, const Field< Type > &ff, const labelList &fineToCoarse) const
 Restrict (integrate by summation) cell field. More...
 
template<class Type >
void prolongField (Field< Type > &ff, const Field< Type > &cf, const label coarseLevelIndex, const bool procAgglom) const
 Prolong (interpolate by injection) cell field. More...
 
bool processorAgglomerate () const
 Whether to agglomerate across processors. More...
 
const labelListprocAgglomMap (const label fineLeveli) const
 Mapping from processor to agglomerated processor (global, all. More...
 
const labelListagglomProcIDs (const label fineLeveli) const
 Set of processors to agglomerate. Element 0 is the. More...
 
bool hasProcMesh (const label fineLeveli) const
 Check that level has combined mesh. More...
 
label procCommunicator (const label fineLeveli) const
 Communicator for current level or -1. More...
 
const labelListcellOffsets (const label fineLeveli) const
 Mapping from processor to procMesh cells. More...
 
const labelListListfaceMap (const label fineLeveli) const
 Mapping from processor to procMesh face. More...
 
const labelListListboundaryMap (const label fineLeveli) const
 Mapping from processor to procMesh boundary. More...
 
const labelListListListboundaryFaceMap (const label fineLeveli) const
 Mapping from processor to procMesh boundary face. More...
 
void operator= (const GAMGAgglomeration &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from DemandDrivenMeshObject< lduMesh, DeletableMeshObject, GAMGAgglomeration >
virtual const wordtype () const
 Runtime type information. More...
 
virtual ~DemandDrivenMeshObject ()
 
const lduMeshmesh () const
 
virtual bool writeData (Foam::Ostream &) const
 Pure virtual writaData function. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the. More...
 
 regIOobject (const regIOobject &)
 Copy constructor. More...
 
 regIOobject (const regIOobject &&)
 Move constructor. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Copy constructor, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Copy constructor with new name, transferring registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Copy constructor with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
virtual bool global () const
 Return true if object is global, i.e. same for all processors. More...
 
virtual bool globalFile () const
 Return true if object is global, i.e. same for all processors. More...
 
const fileNamecaseName () const
 
fileName path () const
 Return complete path. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool registered () const
 Is this object registered with the registry? More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
void store ()
 Transfer ownership of this object to its registry. More...
 
void release ()
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
labeleventNo ()
 Event number at last update. More...
 
bool upToDate (const regIOobject &) const
 Return true if up-to-date with respect to given object. More...
 
bool upToDate (const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
void setUpToDate ()
 Set up to date (obviously) More...
 
virtual void rename (const word &newName)
 Rename. More...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool read=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual bool readData (Istream &)
 Virtual readData function. More...
 
virtual bool read ()
 Read object. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool dependenciesModified () const
 Return true if the object's dependencies have been modified. More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
 Write using given format, version and compression. More...
 
virtual bool write (const bool write=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 Assign to IOobject. More...
 
void operator= (const regIOobject &)=delete
 Disallow default assignment. More...
 
const fileNamecaseName (const bool global) const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName filePath (const word &typeName, const bool global) const
 Return complete path + object name if the file exists. More...
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Construct from copy resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct from copy resetting name. More...
 
 IOobject (const IOobject &io)=default
 Copy constructor. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
bool & registerObject ()
 Register object created from this IOobject with registry if true. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName (const bool global) const
 
fileNameinstance () const
 Return the instance directory, constant, system, <time> etc. More...
 
void updateInstance () const
 If the instance is a time directory update to the current time. More...
 
const fileNamelocal () const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName relativePath () const
 Return the path relative to the case directory. More...
 
fileName relativeObjectPath () const
 Return complete relativePath + object name. More...
 
fileName filePath (const word &typeName, const bool global) const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read header of local object without type-checking. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
- Public Member Functions inherited from DeletableMeshObject< Mesh >
template<class Type >
 DeletableMeshObject (Type &mo)
 
virtual ~DeletableMeshObject ()=default
 Virtual destructor to make class polymorphic. More...
 

Static Public Member Functions

static const GAMGAgglomerationNew (const lduMesh &mesh, const dictionary &controlDict)
 Return the selected geometric agglomerator. More...
 
static const GAMGAgglomerationNew (const lduMatrix &matrix, const dictionary &controlDict)
 Return the selected matrix agglomerator. More...
 
static autoPtr< GAMGAgglomerationNew (const lduMesh &mesh, const scalarField &cellVolumes, const vectorField &faceAreas, const dictionary &controlDict)
 Return the selected geometric agglomerator. More...
 
static void calculateRegionMaster (const label comm, const labelList &procAgglomMap, labelList &masterProcs, List< label > &agglomProcIDs)
 Given fine to coarse processor map determine: More...
 
static bool checkRestriction (labelList &newRestrict, label &nNewCoarse, const lduAddressing &fineAddressing, const labelUList &restrict, const label nCoarse)
 Given restriction determines if coarse cells are connected. More...
 
- Static Public Member Functions inherited from DemandDrivenMeshObject< lduMesh, DeletableMeshObject, GAMGAgglomeration >
static GAMGAgglomerationNew (const word &name, const lduMesh &mesh)
 Construct and return the named DemandDrivenMeshObject. More...
 
static GAMGAgglomerationNew (const lduMesh &mesh)
 Construct and return the DemandDrivenMeshObject named Type::typeName. More...
 
static GAMGAgglomerationNew (const word &name, const lduMesh &mesh, const Args &... args)
 Construct and return the named DemandDrivenMeshObject. More...
 
static GAMGAgglomerationNew (const lduMesh &mesh, const Args &... args)
 Construct and return the DemandDrivenMeshObject named Type::typeName. More...
 
static bool found (const word &name, const lduMesh &mesh)
 Return true if the DemandDrivenMeshObject with the given name. More...
 
static bool found (const lduMesh &mesh)
 Return true if the DemandDrivenMeshObject named Type::typeName. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class Name >
static word groupName (Name name, const word &group)
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 

Protected Member Functions

void agglomerateLduAddressing (const label fineLevelIndex)
 Assemble coarse mesh addressing. More...
 
void combineLevels (const label curLevel)
 Combine a level with the previous one. More...
 
void compactLevels (const label nCreatedLevels)
 Shrink the number of levels to that specified. More...
 
bool continueAgglomerating (const label nCells, const label nCoarseCells) const
 Check the need for further agglomeration. More...
 
void clearLevel (const label leveli)
 
void procAgglomerateLduAddressing (const label comm, const labelList &procAgglomMap, const labelList &procIDs, const label allMeshComm, const label levelIndex)
 Collect and combine processor meshes into allMesh: More...
 
void procAgglomerateRestrictAddressing (const label comm, const labelList &procIDs, const label levelIndex)
 Collect and combine basic restriction addressing: More...
 
- Protected Member Functions inherited from DemandDrivenMeshObject< lduMesh, DeletableMeshObject, GAMGAgglomeration >
 DemandDrivenMeshObject (const IOobject &io, const lduMesh &mesh)
 Construct from mesh and IOobject. More...
 
 DemandDrivenMeshObject (const word &name, const lduMesh &mesh)
 Construct from mesh and name. More...
 
 DemandDrivenMeshObject (const lduMesh &mesh)
 Construct from mesh, the name is set to Type::typeName. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
 Read header, check readOpt flags and read data if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &)
 Set the object state to bad. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType)
 Read header using typeGlobalFile to find file. More...
 

Static Protected Member Functions

template<class Type >
static void gatherList (const label comm, const labelList &procIDs, const Type &myVal, List< Type > &allVals, const int tag=Pstream::msgType())
 Gather value from all procIDs onto procIDs[0]. More...
 

Protected Attributes

const label maxLevels_
 Max number of levels. More...
 
const label nCellsInCoarsestLevel_
 Number of cells in coarsest level. More...
 
const lduInterfacePtrsList meshInterfaces_
 Cached mesh interfaces. More...
 
autoPtr< GAMGProcAgglomerationprocAgglomeratorPtr_
 
labelList nCells_
 The number of cells in each level. More...
 
PtrList< labelFieldrestrictAddressing_
 Cell restriction addressing array. More...
 
labelList nFaces_
 The number of (coarse) faces in each level. More...
 
PtrList< labelListfaceRestrictAddressing_
 Face restriction addressing array. More...
 
PtrList< boolListfaceFlipMap_
 Face flip: for faces mapped to internal faces stores whether. More...
 
PtrList< labelListnPatchFaces_
 The number of (coarse) patch faces in each level. More...
 
PtrList< labelListListpatchFaceRestrictAddressing_
 Patch-local face restriction addressing array. More...
 
PtrList< lduPrimitiveMeshmeshLevels_
 Hierarchy of mesh addressing. More...
 
PtrList< labelListprocAgglomMap_
 Per level, per processor the processor it agglomerates into. More...
 
PtrList< labelListagglomProcIndices_
 Per level the set of processors to agglomerate. Element 0 is. More...
 
labelList procCommunicator_
 Communicator for given level. More...
 
PtrList< labelListprocCellOffsets_
 Mapping from processor to procMeshLevel cells. More...
 
PtrList< labelListListprocFaceMap_
 Mapping from processor to procMeshLevel face. More...
 
PtrList< labelListListprocBoundaryMap_
 Mapping from processor to procMeshLevel boundary. More...
 
PtrList< labelListListListprocBoundaryFaceMap_
 Mapping from processor to procMeshLevel boundary face. More...
 

Friends

class GAMGProcAgglomeration
 Declare friendship with GAMGProcAgglomeration. More...
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState { GOOD , BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption { MUST_READ , MUST_READ_IF_MODIFIED , READ_IF_PRESENT , NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption { AUTO_WRITE = 0 , NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
enum  fileCheckTypes { timeStamp , timeStampMaster , inotify , inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Static Public Attributes inherited from regIOobject
static float fileModificationSkew
 
- Static Public Attributes inherited from IOobject
static constexpr const char * foamFile = "FoamFile"
 Keyword for the FoamFile header sub-dictionary. More...
 
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 

Detailed Description

Geometric agglomerated algebraic multigrid agglomeration class.

Source files

Definition at line 61 of file GAMGAgglomeration.H.

Constructor & Destructor Documentation

◆ GAMGAgglomeration() [1/2]

◆ GAMGAgglomeration() [2/2]

GAMGAgglomeration ( const GAMGAgglomeration )
delete

Disallow default bitwise copy construction.

◆ ~GAMGAgglomeration()

Destructor.

Definition at line 441 of file GAMGAgglomeration.C.

Member Function Documentation

◆ agglomerateLduAddressing()

◆ combineLevels()

void combineLevels ( const label  curLevel)
protected

Combine a level with the previous one.

Definition at line 514 of file GAMGAgglomerateLduAddressing.C.

References GAMGInterface::combine(), forAll, and UPtrList< T >::set().

Referenced by pairGAMGAgglomeration::agglomerate().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ compactLevels()

void compactLevels ( const label  nCreatedLevels)
protected

◆ continueAgglomerating()

bool continueAgglomerating ( const label  nCells,
const label  nCoarseCells 
) const
protected

Check the need for further agglomeration.

Definition at line 207 of file GAMGAgglomeration.C.

References UPstream::nProcs(), and Foam::returnReduce().

Referenced by pairGAMGAgglomeration::agglomerate(), and MGridGenGAMGAgglomeration::MGridGenGAMGAgglomeration().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ gatherList()

void gatherList ( const label  comm,
const labelList procIDs,
const Type &  myVal,
List< Type > &  allVals,
const int  tag = Pstream::msgType() 
)
staticprotected

Gather value from all procIDs onto procIDs[0].

Definition at line 33 of file GAMGAgglomerationTemplates.C.

References UPstream::myProcNo(), UPstream::scheduled, List< T >::setSize(), and List< T >::size().

Here is the call graph for this function:

◆ clearLevel()

void clearLevel ( const label  leveli)
protected

Definition at line 492 of file GAMGAgglomeration.C.

◆ procAgglomerateLduAddressing()

void procAgglomerateLduAddressing ( const label  comm,
const labelList procAgglomMap,
const labelList procIDs,
const label  allMeshComm,
const label  levelIndex 
)
protected

Collect and combine processor meshes into allMesh:

  • allMeshComm : communicator for combined mesh.
  • procAgglomMap : per processor the new agglomerated processor (rank in allMeshComm!). Global information.
  • procIDs : local information: same for all in agglomerated processor.

Definition at line 356 of file GAMGAgglomerateLduAddressing.C.

References lduPrimitiveMesh::gather(), and UPstream::myProcNo().

Here is the call graph for this function:

◆ procAgglomerateRestrictAddressing()

void procAgglomerateRestrictAddressing ( const label  comm,
const labelList procIDs,
const label  levelIndex 
)
protected

Collect and combine basic restriction addressing:

  • nCells_
  • restrictAddressing_

Definition at line 429 of file GAMGAgglomerateLduAddressing.C.

References forAll, globalIndex::gather(), UList< T >::last(), UPstream::msgType(), UPstream::myProcNo(), UPstream::nonBlocking, List< T >::size(), and List< T >::transfer().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "GAMGAgglomeration"  )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/3]

declareRunTimeSelectionTable ( autoPtr  ,
GAMGAgglomeration  ,
lduMesh  ,
(const lduMesh &mesh, const dictionary &controlDict ,
(mesh, controlDict  
)

Runtime selection table for pure geometric agglomerators.

◆ declareRunTimeSelectionTable() [2/3]

declareRunTimeSelectionTable ( autoPtr  ,
GAMGAgglomeration  ,
lduMatrix  ,
(const lduMatrix &matrix, const dictionary &controlDict ,
(matrix, controlDict  
)

Runtime selection table for matrix or mixed geometric/matrix.

agglomerators

◆ declareRunTimeSelectionTable() [3/3]

declareRunTimeSelectionTable ( autoPtr  ,
GAMGAgglomeration  ,
geometry  ,
(const lduMesh &mesh, const scalarField &cellVolumes, const vectorField &faceAreas, const dictionary &controlDict ,
(mesh, cellVolumes, faceAreas, controlDict  
)

Runtime selection table for matrix or mixed geometric/matrix.

agglomerators

◆ New() [1/3]

const Foam::GAMGAgglomeration & New ( const lduMesh mesh,
const dictionary controlDict 
)
static

Return the selected geometric agglomerator.

Definition at line 286 of file GAMGAgglomeration.C.

References controlDict(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, objectRegistry::foundObject(), Foam::libs, objectRegistry::lookupObject(), dlLibraryTable::open(), and lduMesh::thisDb().

Here is the call graph for this function:

◆ New() [2/3]

const Foam::GAMGAgglomeration & New ( const lduMatrix matrix,
const dictionary controlDict 
)
static

Return the selected matrix agglomerator.

Definition at line 339 of file GAMGAgglomeration.C.

References controlDict(), objectRegistry::foundObject(), Foam::libs, objectRegistry::lookupObject(), lduMatrix::mesh(), Foam::New(), dlLibraryTable::open(), and lduMesh::thisDb().

Here is the call graph for this function:

◆ New() [3/3]

Foam::autoPtr< Foam::GAMGAgglomeration > New ( const lduMesh mesh,
const scalarField cellVolumes,
const vectorField faceAreas,
const dictionary controlDict 
)
static

Return the selected geometric agglomerator.

Definition at line 393 of file GAMGAgglomeration.C.

References controlDict(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::libs, and dlLibraryTable::open().

Here is the call graph for this function:

◆ size()

◆ meshLevel()

const Foam::lduMesh & meshLevel ( const label  leveli) const

◆ hasMeshLevel()

bool hasMeshLevel ( const label  leveli) const

Do we have mesh for given level?

Definition at line 463 of file GAMGAgglomeration.C.

Referenced by GAMGAgglomeration::compactLevels(), GAMGSolver::GAMGSolver(), and GAMGProcAgglomeration::printStats().

Here is the caller graph for this function:

◆ interfaceLevel()

const Foam::lduInterfacePtrsList & interfaceLevel ( const label  leveli) const

Return LDU interface addressing of given level.

Definition at line 476 of file GAMGAgglomeration.C.

Referenced by GAMGAgglomeration::agglomerateLduAddressing(), and GAMGSolver::GAMGSolver().

Here is the caller graph for this function:

◆ restrictAddressing()

const labelField& restrictAddressing ( const label  leveli) const
inline

Return cell restrict addressing of given level.

Definition at line 341 of file GAMGAgglomeration.H.

References GAMGAgglomeration::restrictAddressing_.

Referenced by GAMGAgglomeration::agglomerateLduAddressing(), and GAMGProcAgglomeration::printStats().

Here is the caller graph for this function:

◆ faceRestrictAddressing()

const labelList& faceRestrictAddressing ( const label  leveli) const
inline

Return face restrict addressing of given level.

Definition at line 347 of file GAMGAgglomeration.H.

References GAMGAgglomeration::faceRestrictAddressing_.

Referenced by GAMGProcAgglomeration::printStats().

Here is the caller graph for this function:

◆ patchFaceRestrictAddressing()

const labelListList& patchFaceRestrictAddressing ( const label  leveli) const
inline

Definition at line 352 of file GAMGAgglomeration.H.

References GAMGAgglomeration::patchFaceRestrictAddressing_.

Referenced by GAMGProcAgglomeration::printStats().

Here is the caller graph for this function:

◆ faceFlipMap()

const boolList& faceFlipMap ( const label  leveli) const
inline

Return face flip map of given level.

Definition at line 359 of file GAMGAgglomeration.H.

References GAMGAgglomeration::faceFlipMap_.

Referenced by GAMGAgglomeration::agglomerateLduAddressing().

Here is the caller graph for this function:

◆ nCells()

label nCells ( const label  leveli) const
inline

Return number of coarse cells (before processor agglomeration)

Definition at line 365 of file GAMGAgglomeration.H.

References GAMGAgglomeration::nCells_.

Referenced by GAMGAgglomeration::compactLevels(), and GAMGProcAgglomeration::printStats().

Here is the caller graph for this function:

◆ nFaces()

label nFaces ( const label  leveli) const
inline

Return number of coarse faces (before processor agglomeration)

Definition at line 371 of file GAMGAgglomeration.H.

References GAMGAgglomeration::nFaces_.

Referenced by GAMGProcAgglomeration::printStats().

Here is the caller graph for this function:

◆ nPatchFaces()

const labelList& nPatchFaces ( const label  leveli) const
inline

Return number of coarse patch faces (before processor.

agglomeration)

Definition at line 378 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration::agglomerateLduAddressing().

Here is the caller graph for this function:

◆ restrictField() [1/2]

void restrictField ( Field< Type > &  cf,
const Field< Type > &  ff,
const label  fineLevelIndex,
const bool  procAgglom 
) const

Restrict (integrate by summation) cell field.

Definition at line 94 of file GAMGAgglomerationTemplates.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::fv::ff(), globalIndex::gather(), UPstream::msgType(), UPstream::nonBlocking, UPstream::parent(), and List< T >::size().

Referenced by MGridGenGAMGAgglomeration::MGridGenGAMGAgglomeration().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ restrictFaceField()

void restrictFaceField ( Field< Type > &  cf,
const Field< Type > &  ff,
const label  fineLevelIndex 
) const

Restrict (integrate by summation) face field.

Definition at line 138 of file GAMGAgglomerationTemplates.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::fv::ff(), forAll, List< T >::size(), and Foam::Zero.

Referenced by pairGAMGAgglomeration::agglomerate(), and MGridGenGAMGAgglomeration::MGridGenGAMGAgglomeration().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ restrictField() [2/2]

void restrictField ( Field< Type > &  cf,
const Field< Type > &  ff,
const labelList fineToCoarse 
) const

Restrict (integrate by summation) cell field.

Definition at line 77 of file GAMGAgglomerationTemplates.C.

References Foam::fv::ff(), forAll, and Foam::Zero.

Here is the call graph for this function:

◆ prolongField()

void prolongField ( Field< Type > &  ff,
const Field< Type > &  cf,
const label  coarseLevelIndex,
const bool  procAgglom 
) const

Prolong (interpolate by injection) cell field.

Definition at line 171 of file GAMGAgglomerationTemplates.C.

References Foam::fv::ff(), forAll, UPstream::msgType(), UPstream::nonBlocking, UPstream::parent(), and globalIndex::scatter().

Here is the call graph for this function:

◆ calculateRegionMaster()

void calculateRegionMaster ( const label  comm,
const labelList procAgglomMap,
labelList masterProcs,
List< label > &  agglomProcIDs 
)
static

Given fine to coarse processor map determine:

  • for each coarse processor a master (minimum of the fine processors)
  • for each coarse processor the set of fine processors (element 0 is the master processor)

Definition at line 658 of file GAMGAgglomerateLduAddressing.C.

References HashTableCore::end(), HashTable< T, Key, Hash >::find(), Foam::findIndex(), Foam::findIndices(), forAll, forAllConstIter, HashTable< T, Key, Hash >::insert(), Foam::min(), UPstream::myProcNo(), List< T >::setSize(), HashTable< T, Key, Hash >::size(), List< T >::size(), and Foam::Swap().

Referenced by eagerGAMGProcAgglomeration::agglomerate(), masterCoarsestGAMGProcAgglomeration::agglomerate(), and procFacesGAMGProcAgglomeration::agglomerate().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ processorAgglomerate()

bool processorAgglomerate ( ) const
inline

Whether to agglomerate across processors.

Definition at line 445 of file GAMGAgglomeration.H.

References GAMGAgglomeration::procAgglomeratorPtr_.

Referenced by GAMGAgglomeration::compactLevels(), GAMGAgglomeration::GAMGAgglomeration(), and GAMGSolver::GAMGSolver().

Here is the caller graph for this function:

◆ procAgglomMap()

const Foam::labelList & procAgglomMap ( const label  fineLeveli) const

Mapping from processor to agglomerated processor (global, all.

processors have the same information). Note that level is the fine, not the coarse, level index. This is to be consistent with the way the restriction is stored

Definition at line 512 of file GAMGAgglomeration.C.

Referenced by GAMGSolver::GAMGSolver().

Here is the caller graph for this function:

◆ agglomProcIDs()

const Foam::labelList & agglomProcIDs ( const label  fineLeveli) const

Set of processors to agglomerate. Element 0 is the.

master processor. (local, same only on those processors that agglomerate)

Definition at line 521 of file GAMGAgglomeration.C.

Referenced by GAMGSolver::GAMGSolver().

Here is the caller graph for this function:

◆ hasProcMesh()

bool hasProcMesh ( const label  fineLeveli) const

Check that level has combined mesh.

Definition at line 530 of file GAMGAgglomeration.C.

Referenced by GAMGSolver::GAMGSolver().

Here is the caller graph for this function:

◆ procCommunicator()

Foam::label procCommunicator ( const label  fineLeveli) const

Communicator for current level or -1.

Definition at line 536 of file GAMGAgglomeration.C.

◆ cellOffsets()

const Foam::labelList & cellOffsets ( const label  fineLeveli) const

Mapping from processor to procMesh cells.

Definition at line 542 of file GAMGAgglomeration.C.

◆ faceMap()

const Foam::labelListList & faceMap ( const label  fineLeveli) const

Mapping from processor to procMesh face.

Definition at line 551 of file GAMGAgglomeration.C.

◆ boundaryMap()

const Foam::labelListList & boundaryMap ( const label  fineLeveli) const

Mapping from processor to procMesh boundary.

Definition at line 560 of file GAMGAgglomeration.C.

◆ boundaryFaceMap()

const Foam::labelListListList & boundaryFaceMap ( const label  fineLeveli) const

Mapping from processor to procMesh boundary face.

Definition at line 569 of file GAMGAgglomeration.C.

◆ checkRestriction()

bool checkRestriction ( labelList newRestrict,
label nNewCoarse,
const lduAddressing fineAddressing,
const labelUList restrict,
const label  nCoarse 
)
static

Given restriction determines if coarse cells are connected.

Return ok is so, otherwise creates new restriction that is

Definition at line 578 of file GAMGAgglomeration.C.

References Foam::abort(), List< T >::append(), Foam::FatalError, FatalErrorInFunction, Foam::findIndex(), forAll, Foam::identityMap(), lduAddressing::lowerAddr(), Foam::reduce(), List< T >::setSize(), UList< T >::size(), lduAddressing::size(), List< T >::size(), and lduAddressing::upperAddr().

Here is the call graph for this function:

◆ operator=()

void operator= ( const GAMGAgglomeration )
delete

Disallow default bitwise assignment.

Friends And Related Function Documentation

◆ GAMGProcAgglomeration

friend class GAMGProcAgglomeration
friend

Declare friendship with GAMGProcAgglomeration.

Definition at line 213 of file GAMGAgglomeration.H.

Member Data Documentation

◆ maxLevels_

const label maxLevels_
protected

◆ nCellsInCoarsestLevel_

const label nCellsInCoarsestLevel_
protected

Number of cells in coarsest level.

Definition at line 78 of file GAMGAgglomeration.H.

◆ meshInterfaces_

const lduInterfacePtrsList meshInterfaces_
protected

Cached mesh interfaces.

Definition at line 81 of file GAMGAgglomeration.H.

◆ procAgglomeratorPtr_

autoPtr<GAMGProcAgglomeration> procAgglomeratorPtr_
protected

◆ nCells_

◆ restrictAddressing_

◆ nFaces_

labelList nFaces_
protected

The number of (coarse) faces in each level.

max(faceRestrictAddressing)+1.

Definition at line 94 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration::agglomerateLduAddressing(), GAMGAgglomeration::compactLevels(), and GAMGAgglomeration::nFaces().

◆ faceRestrictAddressing_

PtrList<labelList> faceRestrictAddressing_
protected

Face restriction addressing array.

Maps from the finer to the coarser level. Positive indices map the finer faces which form part of the boundary of the coarser cells to the corresponding coarser cell face. Negative indices map the finer faces which are internal to the coarser cells to minus the corresponding coarser cell index minus 1.

Definition at line 102 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration::agglomerateLduAddressing(), GAMGAgglomeration::compactLevels(), and GAMGAgglomeration::faceRestrictAddressing().

◆ faceFlipMap_

PtrList<boolList> faceFlipMap_
protected

Face flip: for faces mapped to internal faces stores whether.

the face is reversed or not. This is used to avoid having to access the coarse mesh at all when mapping

Definition at line 107 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration::agglomerateLduAddressing(), GAMGAgglomeration::compactLevels(), and GAMGAgglomeration::faceFlipMap().

◆ nPatchFaces_

PtrList<labelList> nPatchFaces_
protected

The number of (coarse) patch faces in each level.

max(patchFaceRestrictAddressing_)+1.

Definition at line 111 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration::agglomerateLduAddressing(), and GAMGAgglomeration::compactLevels().

◆ patchFaceRestrictAddressing_

PtrList<labelListList> patchFaceRestrictAddressing_
protected

Patch-local face restriction addressing array.

Maps from the finer to the coarser level. Always positive. Extracted from GAMGInterfaces after agglomeration.

Definition at line 116 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration::agglomerateLduAddressing(), GAMGAgglomeration::compactLevels(), and GAMGAgglomeration::patchFaceRestrictAddressing().

◆ meshLevels_

◆ procAgglomMap_

PtrList<labelList> procAgglomMap_
mutableprotected

Per level, per processor the processor it agglomerates into.

Definition at line 125 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration::compactLevels(), GAMGAgglomeration::GAMGAgglomeration(), and GAMGProcAgglomeration::printStats().

◆ agglomProcIndices_

PtrList<labelList> agglomProcIndices_
mutableprotected

Per level the set of processors to agglomerate. Element 0 is.

the 'master' of the cluster.

Definition at line 129 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration::compactLevels(), GAMGAgglomeration::GAMGAgglomeration(), and GAMGProcAgglomeration::printStats().

◆ procCommunicator_

labelList procCommunicator_
mutableprotected

◆ procCellOffsets_

PtrList<labelList> procCellOffsets_
mutableprotected

Mapping from processor to procMeshLevel cells.

Definition at line 135 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration::compactLevels(), GAMGAgglomeration::GAMGAgglomeration(), and GAMGProcAgglomeration::printStats().

◆ procFaceMap_

PtrList<labelListList> procFaceMap_
mutableprotected

Mapping from processor to procMeshLevel face.

Definition at line 138 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration::compactLevels(), and GAMGAgglomeration::GAMGAgglomeration().

◆ procBoundaryMap_

PtrList<labelListList> procBoundaryMap_
mutableprotected

Mapping from processor to procMeshLevel boundary.

Definition at line 141 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration::compactLevels(), and GAMGAgglomeration::GAMGAgglomeration().

◆ procBoundaryFaceMap_

PtrList<labelListListList> procBoundaryFaceMap_
mutableprotected

Mapping from processor to procMeshLevel boundary face.

Definition at line 144 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration::compactLevels(), and GAMGAgglomeration::GAMGAgglomeration().


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