pairGAMGAgglomeration Class Reference

Agglomerate using the pair algorithm. More...

Inheritance diagram for pairGAMGAgglomeration:
[legend]
Collaboration diagram for pairGAMGAgglomeration:
[legend]

Public Member Functions

 TypeName ("pair")
 Runtime type information. More...
 
 pairGAMGAgglomeration (const lduMesh &mesh, const dictionary &controlDict)
 Construct given mesh and controls. More...
 
- Public Member Functions inherited from GAMGAgglomeration
 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))
 
 declareRunTimeSelectionTable (autoPtr, GAMGAgglomeration, geometry,(const lduMesh &mesh, const scalarField &cellVolumes, const vectorField &faceAreas, const dictionary &controlDict),(mesh, cellVolumes, faceAreas, controlDict))
 
 GAMGAgglomeration (const lduMesh &mesh, const dictionary &controlDict)
 Construct given mesh and controls. 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
 
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
 
const labelListagglomProcIDs (const label fineLeveli) const
 
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...
 
- Public Member Functions inherited from MeshObject< lduMesh, GeometricMeshObject, GAMGAgglomeration >
 MeshObject (const lduMesh &mesh)
 Construct on Mesh type. More...
 
virtual ~MeshObject ()=default
 Destructor. More...
 
const lduMeshmesh () const
 
virtual bool writeData (Ostream &os) const
 
- Public Member Functions inherited from GeometricMeshObject< lduMesh >
 GeometricMeshObject (const word &typeName, const objectRegistry &obr)
 Construct from name and instance on registry. More...
 
- Public Member Functions inherited from TopologicalMeshObject< lduMesh >
 TopologicalMeshObject (const word &typeName, const objectRegistry &obr)
 Construct from name and instance on registry. More...
 
- Public Member Functions inherited from meshObject
 ClassName ("meshObject")
 
 meshObject (const word &typeName, const objectRegistry &obr)
 Construct from name and instance on registry. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &io, const bool isTimeObject=false)
 
 regIOobject (const regIOobject &rio)
 Copy construct. More...
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 
 regIOobject (const IOobject &io, const regIOobject &rio)
 Copy construct with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry, if not already registered. More...
 
bool checkOut ()
 Remove all file watches and remove object from registry. More...
 
virtual void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
bool store ()
 
void release (const bool unregister=false)
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
label & eventNo ()
 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 as up-to-date. More...
 
virtual void rename (const word &newName)
 Rename. More...
 
const dictionaryfindMetaData () const noexcept
 Return pointer to meta-data or nullptr. More...
 
dictionarygetMetaData () noexcept
 Get or create meta-data. More...
 
void removeMetaData ()
 Remove meta-data. More...
 
virtual void updateMetaData ()
 Update internal meta-data (eg, prior to writing) More...
 
virtual fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool valid=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...
 
virtual label addWatch (const fileName &)
 Add file watch for fileName on object if not yet watched. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 Write using stream options. More...
 
virtual bool write (const bool valid=true) const
 Write using setting from DB. More...
 
virtual bool global () const
 Is object global. More...
 
void operator= (const IOobject &io)
 Copy assignment. More...
 
virtual bool writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
 Write using given format, version and compression. More...
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Declare type-name, virtual type (with debug switch) More...
 
 IOobject (const IOobject &)=default
 Copy construct. More...
 
virtual ~IOobject ()=default
 Destructor. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 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, bool globalObject=false)
 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, bool globalObject=false)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Copy construct, resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Copy construct, resetting name. More...
 
 IOobject (const IOobject &io, readOption, writeOption)
 Copy construct, resetting io options. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
const objectRegistrydb () const noexcept
 Return the local objectRegistry. More...
 
const Timetime () const
 Return Time associated with the objectRegistry. More...
 
const wordname () const noexcept
 Return name. More...
 
const wordheaderClassName () const noexcept
 Return name of the class name read from header. More...
 
wordheaderClassName () noexcept
 Return non-constant access to the class name read from header. More...
 
const stringnote () const noexcept
 Return the optional note. More...
 
stringnote () noexcept
 Return non-constant access to the optional note. More...
 
bool registerObject () const noexcept
 Should object created with this IOobject be registered? More...
 
bool registerObject (bool on) noexcept
 Change registration preference, return previous value. More...
 
bool globalObject () const noexcept
 Is object same for all processors? More...
 
bool globalObject (bool on) noexcept
 Change global-object status, return previous value. More...
 
unsigned labelByteSize () const noexcept
 The sizeof (label) in bytes, possibly read from the header. More...
 
unsigned scalarByteSize () const noexcept
 The sizeof (scalar) in bytes, possibly read from the header. More...
 
bool isHeaderClassName (const word &clsName) const
 Test if headerClassName() equals the given class name. More...
 
template<class Type >
bool isHeaderClassName () const
 Test if headerClassName() equals Type::typeName. More...
 
readOption readOpt () const noexcept
 The read option. More...
 
readOption readOpt (readOption opt) noexcept
 Change the read option, return previous value. More...
 
writeOption writeOpt () const noexcept
 The write option. More...
 
writeOption writeOpt (writeOption opt) noexcept
 Change the write option, return previous value. More...
 
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
 
const fileNameinstance () const noexcept
 
fileNameinstance () noexcept
 
const fileNamelocal () const noexcept
 
fileName path () const
 The complete path. More...
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 The complete path with alternative instance and local. More...
 
fileName objectPath () const
 The complete path + object name. More...
 
fileName objectRelPath () const
 The object path relative to the root. More...
 
fileName localFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches up if in parallel. More...
 
IOstreamOption parseHeader (const dictionary &headerDict)
 
bool readHeader (Istream &is)
 
bool readHeader (dictionary &headerDict, Istream &is)
 
template<class Type >
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 Read header (uses typeFilePath to find file) and check its info. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &os) const
 Write header with current type() More...
 
bool writeHeader (Ostream &os, const word &objectType) const
 Write header with override of type. More...
 
void writeHeader (dictionary &dict, IOstreamOption streamOpt) const
 
void writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
 
bool good () const noexcept
 
bool bad () const noexcept
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &io)
 
readOptionreadOpt () noexcept
 Access to the read option. More...
 
writeOptionwriteOpt () noexcept
 Access to the write option. More...
 
boolregisterObject () noexcept
 Access to the register object option. More...
 
boolglobalObject () noexcept
 Access to the global object option. More...
 
template<>
bool isHeaderClassName () const
 Specialization for void always returns true (no headerClassName check). More...
 
template<class StringType >
Foam::word groupName (StringType base, const word &group)
 

Static Public Member Functions

static tmp< labelFieldagglomerate (label &nCoarseCells, const lduAddressing &fineMatrixAddressing, const scalarField &faceWeights)
 Calculate and return agglomeration. More...
 
- Static Public Member Functions inherited from GAMGAgglomeration
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 const 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 &restriction, const label nCoarse)
 Given restriction determines if coarse cells are connected. More...
 
- Static Public Member Functions inherited from MeshObject< lduMesh, GeometricMeshObject, GAMGAgglomeration >
static const GAMGAgglomerationNew (const lduMesh &mesh, Args &&... args)
 Get existing or create a new MeshObject. More...
 
static bool Delete (const lduMesh &mesh)
 Static destructor. More...
 
- Static Public Member Functions inherited from meshObject
template<class Mesh >
static void movePoints (objectRegistry &obr)
 
template<class Mesh >
static void updateMesh (objectRegistry &obr, const mapPolyMesh &mpm)
 
template<class Mesh , template< class > class MeshObjectType>
static void clear (objectRegistry &obr)
 
template<class Mesh , template< class > class FromType, template< class > class ToType>
static void clearUpto (objectRegistry &obr)
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *p)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool bannerEnabled () noexcept
 Status of output file banner. More...
 
static bool bannerEnabled (bool on) noexcept
 Enable/disable an output file banner. More...
 
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class StringType >
static word groupName (StringType base, const word &group)
 Create dot-delimited name.group string. More...
 
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...
 
static word scopedName (const std::string &scope, const word &name)
 Create scope:name or scope_name string. More...
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 Return the IOobject, but also consider an alternative file name. More...
 
static OstreamwriteBanner (Ostream &os, const bool noSyntaxHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
static OstreamwriteDivider (Ostream &os)
 Write the standard file section divider. More...
 
static OstreamwriteEndDivider (Ostream &os)
 Write the standard end file divider. More...
 

Protected Member Functions

void agglomerate (const lduMesh &mesh, const scalarField &faceWeights)
 Agglomerate all levels starting from the given face weights. More...
 
 pairGAMGAgglomeration (const pairGAMGAgglomeration &)=delete
 No copy construct. More...
 
void operator= (const pairGAMGAgglomeration &)=delete
 No copy assignment. More...
 
- Protected Member Functions inherited from GAMGAgglomeration
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...
 
 GAMGAgglomeration (const GAMGAgglomeration &)=delete
 No copy construct. More...
 
void operator= (const GAMGAgglomeration &)=delete
 No copy assignment. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
 Helper: check readOpt flags and read if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 Set the object state to bad. More...
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState : char { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
enum  fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 Names for the fileCheckTypes. More...
 
static char scopeSeparator
 Character for scoping object names (':' or '_') More...
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
static float fileModificationSkew
 Time skew (seconds) for file modification checks. More...
 
static int maxFileModificationPolls
 Max number of times to poll for file modification changes. More...
 
- Static Protected Member Functions inherited from GAMGAgglomeration
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...
 
- Static Protected Member Functions inherited from IOobject
static void writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
 
static void writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
 
- Protected Attributes inherited from GAMGAgglomeration
const label maxLevels_
 Max number of levels. More...
 
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< labelListagglomProcIDs_
 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...
 
- Protected Attributes inherited from MeshObject< lduMesh, GeometricMeshObject, GAMGAgglomeration >
const lduMeshmesh_
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

Agglomerate using the pair algorithm.

Source files

Definition at line 51 of file pairGAMGAgglomeration.H.

Constructor & Destructor Documentation

◆ pairGAMGAgglomeration() [1/2]

pairGAMGAgglomeration ( const pairGAMGAgglomeration )
protecteddelete

No copy construct.

◆ pairGAMGAgglomeration() [2/2]

pairGAMGAgglomeration ( const lduMesh mesh,
const dictionary controlDict 
)

Construct given mesh and controls.

Definition at line 43 of file pairGAMGAgglomeration.C.

Member Function Documentation

◆ agglomerate() [1/2]

void agglomerate ( const lduMesh mesh,
const scalarField faceWeights 
)
protected

Agglomerate all levels starting from the given face weights.

Definition at line 34 of file pairGAMGAgglomerate.C.

◆ operator=()

void operator= ( const pairGAMGAgglomeration )
protecteddelete

No copy assignment.

◆ TypeName()

TypeName ( "pair"  )

Runtime type information.

◆ agglomerate() [2/2]

Foam::tmp< Foam::labelField > agglomerate ( label &  nCoarseCells,
const lduAddressing fineMatrixAddressing,
const scalarField faceWeights 
)
static

Calculate and return agglomeration.

Definition at line 123 of file pairGAMGAgglomerate.C.

References forAll, lduAddressing::lowerAddr(), Foam::max(), tmp< T >::ref(), UList< T >::size(), lduAddressing::size(), lduAddressing::upperAddr(), and Foam::Zero.

Here is the call graph for this function:

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