Geometric agglomerated algebraic multigrid agglomeration class. More...
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 agglomerators. 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 agglomerators. More... | |
GAMGAgglomeration (const lduMesh &mesh, const dictionary &controlDict) | |
Construct given mesh and controls. More... | |
~GAMGAgglomeration () | |
Destructor. More... | |
label | size () const |
const lduMesh & | meshLevel (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 lduInterfacePtrsList & | interfaceLevel (const label leveli) const |
Return LDU interface addressing of given level. More... | |
const labelField & | restrictAddressing (const label leveli) const |
Return cell restrict addressing of given level. More... | |
const labelList & | faceRestrictAddressing (const label leveli) const |
Return face restrict addressing of given level. More... | |
const labelListList & | patchFaceRestrictAddressing (const label leveli) const |
const boolList & | faceFlipMap (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 labelList & | nPatchFaces (const label leveli) const |
Return number of coarse patch faces (before processor agglomeration) 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... | |
template<class Type > | |
const Field< Type > & | prolongField (Field< Type > &ff, Field< Type > &work, const Field< Type > &cf, const label coarseLevelIndex) const |
Prolong (interpolate by injection) cell field. Return reference. More... | |
bool | processorAgglomerate () const |
Whether to agglomerate across processors. More... | |
const 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. More... | |
const 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) 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... | |
label | agglomCommunicator (const label fineLeveli) const |
Communicator for collecting contributions. More... | |
const labelList & | cellOffsets (const label fineLeveli) const |
Mapping from processor to procMesh cells. More... | |
const labelListList & | faceMap (const label fineLeveli) const |
Mapping from processor to procMesh face. More... | |
const labelListList & | boundaryMap (const label fineLeveli) const |
Mapping from processor to procMesh boundary. More... | |
const labelListListList & | boundaryFaceMap (const label fineLeveli) const |
Mapping from processor to procMesh boundary face. More... | |
virtual void | agglomerate (const label nCellsInCoarsestLevel, const label startLevel, const scalarField &startFaceWeights, const bool doProcessorAgglomerate=true)=0 |
Agglomerate from a starting level. Starting level is usually 0 (initial mesh) but sometimes >0 (restarting after processor agglomeration) More... | |
template<class Type > | |
const Foam::Field< Type > & | prolongField (Field< Type > &ff, Field< Type > &allCf, const Field< Type > &cf, const label levelIndex) const |
Public Member Functions inherited from MeshObject< lduMesh, GeometricMeshObject, GAMGAgglomeration > | |
MeshObject (const lduMesh &mesh) | |
Construct with Type::typeName on Mesh. More... | |
MeshObject (const word &objName, const lduMesh &mesh) | |
Construct with given object name on Mesh. More... | |
virtual | ~MeshObject ()=default |
Destructor. More... | |
const lduMesh & | mesh () const noexcept |
Reference to the mesh. More... | |
virtual bool | writeData (Ostream &os) const |
Dummy write. More... | |
Public Member Functions inherited from GeometricMeshObject< lduMesh > | |
GeometricMeshObject (const word &objName, const objectRegistry &obr) | |
Construct from name and instance on registry. More... | |
Public Member Functions inherited from TopologicalMeshObject< lduMesh > | |
TopologicalMeshObject (const word &objName, const objectRegistry &obr) | |
Construct from name and instance on registry. More... | |
Public Member Functions inherited from meshObject | |
ClassName ("meshObject") | |
Runtime declaration and debug switch. More... | |
meshObject (const word &objName, const objectRegistry &obr) | |
Construct with given object name on a registry. More... | |
Public Member Functions inherited from regIOobject | |
void | operator= (const regIOobject &)=delete |
No copy assignment. More... | |
TypeName ("regIOobject") | |
Runtime type information. More... | |
regIOobject (const IOobject &io, const bool isTimeObject=false) | |
Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time). More... | |
regIOobject (const regIOobject &rio) | |
Copy construct. More... | |
regIOobject (const regIOobject &rio, bool registerCopy) | |
Copy construct, transferring registry registration to the copy if registerCopy is true. More... | |
regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
Copy construct with new name, transferring registry registration to the copy if registerCopy is true. More... | |
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 object from registry, and remove all file watches. More... | |
virtual void | addWatch () |
Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
bool | registered () const noexcept |
Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference. More... | |
bool | ownedByRegistry () const noexcept |
Is this object owned by the registry? More... | |
bool | store () |
Register object with its registry and transfer ownership to the registry. More... | |
void | release (const bool unregister=false) noexcept |
Set object as not ownedByRegistry. More... | |
label | eventNo () const noexcept |
Event number at last update. More... | |
label & | eventNo () noexcept |
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 dictionary * | findMetaData () const noexcept |
Return pointer to meta-data or nullptr. More... | |
dictionary & | getMetaData () 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. Does not check the headerClassName. More... | |
Istream & | readStream (const word &, const bool readOnProc=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 labelList & | watchIndices () const noexcept |
Read access to file-monitoring handles. More... | |
labelList & | watchIndices () noexcept |
Write access to file-monitoring handles. More... | |
virtual bool | modified () const |
Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time) More... | |
virtual bool | readIfModified () |
Read object if modified (as set by call to modified) More... | |
virtual bool | writeObject (IOstreamOption streamOpt, const bool writeOnProc) const |
Write using stream options. More... | |
virtual bool | write (const bool writeOnProc=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 cmp, const bool writeOnProc) 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 ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from path, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::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 ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from path, registry, io options. More... | |
IOobject (const IOobject &io, const objectRegistry ®istry) | |
Copy construct, resetting registry. More... | |
IOobject (const IOobject &io, const word &name) | |
Copy construct, resetting name. More... | |
IOobject (const IOobject &io, const word &name, const fileName &local) | |
Copy construct, resetting name and local component. More... | |
IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) | |
Copy construct, resetting read/write options. More... | |
IOobject (const IOobject &io, IOobjectOption::registerOption regOpt) | |
Copy construct, resetting register option. More... | |
autoPtr< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
const objectRegistry & | db () const noexcept |
Return the local objectRegistry. More... | |
const Time & | time () const noexcept |
Return Time associated with the objectRegistry. More... | |
const word & | name () const noexcept |
Return the object name. More... | |
const word & | headerClassName () const noexcept |
Return name of the class name read from header. More... | |
word & | headerClassName () noexcept |
Return non-constant access to the class name read from header. More... | |
const string & | note () const noexcept |
Return the optional note. More... | |
string & | note () noexcept |
Modifiable access to the optional note. 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... | |
void | resetHeader (const word &newName=word::null) |
Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. More... | |
bool | hasHeaderClass () const noexcept |
True if headerClassName() is non-empty (after reading) More... | |
template<class Type > | |
bool | isHeaderClass () const |
Check if headerClassName() equals Type::typeName. More... | |
template<class Type > | |
bool | isHeaderClassName () const |
Same as isHeaderClass() More... | |
word | group () const |
Return group (extension part of name) More... | |
word | member () const |
Return member (name without the extension) More... | |
const fileName & | rootPath () const noexcept |
Return the Time::rootPath() More... | |
const fileName & | caseName () const noexcept |
Return the Time::caseName() More... | |
const fileName & | globalCaseName () const noexcept |
Return the Time::globalCaseName() More... | |
const fileName & | instance () const noexcept |
Read access to instance path component. More... | |
fileName & | instance () noexcept |
Write access to instance path component. More... | |
const fileName & | local () const noexcept |
Read access to local path component. More... | |
fileName | path () const |
The complete path for the object (with instance, local,...). More... | |
fileName | globalPath () const |
The complete global path for the object (with instance, local,...) More... | |
fileName | path (const word &instance, const fileName &local=fileName::null) const |
The complete path with alternative instance and local. More... | |
fileName | globalPath (const word &instance, const fileName &local=fileName::null) const |
The complete global path with alternative instance and local. More... | |
fileName | objectPath () const |
The complete path + object name. More... | |
fileName | globalObjectPath () const |
The complete global 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 |
Redirect to fileHandler filePath, searching locally. More... | |
fileName | globalFilePath (const word &typeName, const bool search=true) const |
Redirect to fileHandler filePath, searching up if in parallel. More... | |
IOstreamOption | parseHeader (const dictionary &headerDict) |
Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. More... | |
bool | readHeader (Istream &is) |
Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. More... | |
bool | readHeader (dictionary &headerDict, Istream &is) |
Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. More... | |
template<class Type > | |
bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
Read header (respects is_globalIOobject trait) and check its info. More... | |
template<class Type > | |
fileName | typeFilePath (const bool search=true) const |
Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. 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 |
Write header into a dictionary with current type() and given output format. More... | |
void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
Write header into a dictionary with override of type and given output format. More... | |
bool | good () const noexcept |
Did last readHeader() succeed? More... | |
bool | bad () const noexcept |
Did last readHeader() fail? More... | |
InfoProxy< IOobject > | info () const noexcept |
Return info proxy, for printing information to a stream. More... | |
void | operator= (const IOobject &io) |
Copy assignment, copies all values (except the registry) More... | |
template<> | |
bool | isHeaderClass () const |
Specialization for void always returns true (no headerClassName check). More... | |
template<class StringType > | |
Foam::word | groupName (StringType base, const word &group) |
template<class Type > | |
Foam::fileName | typeFilePath (const bool search) const |
Public Member Functions inherited from IOobjectOption | |
constexpr | IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options. More... | |
constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_WRITE with specified read/register options. More... | |
constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_READ with specified write/register options. More... | |
constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option. More... | |
constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
Construct from components with specified register option as bool. More... | |
constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option as bool. More... | |
readOption | readOpt () const noexcept |
Get the read option. More... | |
readOption | readOpt (readOption opt) noexcept |
Set the read option. More... | |
writeOption | writeOpt () const noexcept |
Get the write option. More... | |
writeOption | writeOpt (writeOption opt) noexcept |
Set the write option. More... | |
bool | registerObject () const noexcept |
Should objects created with this IOobject be registered? More... | |
bool | registerObject (bool on) noexcept |
Change registration preference. More... | |
bool | globalObject () const noexcept |
True if object is treated the same for all processors. More... | |
bool | globalObject (bool on) noexcept |
Change global-object status. More... | |
bool | isAnyRead () const noexcept |
True if any reading may be required (ie, != NO_READ) More... | |
bool | isReadRequired () const noexcept |
True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
bool | isReadOptional () const noexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More... | |
readOption & | readOpt () noexcept |
Access to the read option. More... | |
writeOption & | writeOpt () noexcept |
Access to the write option. More... | |
bool & | registerObject () noexcept |
Access to the register object option. More... | |
bool & | globalObject () noexcept |
Access to the global object option. More... | |
Static Public Member Functions | |
static const GAMGAgglomeration & | New (const lduMesh &mesh, const dictionary &controlDict) |
Return the selected geometric agglomerator. More... | |
static const GAMGAgglomeration & | New (const lduMatrix &matrix, const dictionary &controlDict) |
Return the selected matrix agglomerator. More... | |
static const GAMGAgglomeration & | New (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 GAMGAgglomeration & | New (const lduMesh &mesh, Args &&... args) |
Get existing or create MeshObject registered with typeName. More... | |
static const GAMGAgglomeration & | New (const word &objName, const lduMesh &mesh, Args &&... args) |
Get existing or create MeshObject with given registration name. More... | |
static bool | Store (std::unique_ptr< GAMGAgglomeration > &&ptr) |
Transfer ownership of meshObject to registry. More... | |
static bool | Delete (const word &objName, const lduMesh &mesh) |
Static destructor using given registration name. More... | |
static bool | Delete (const lduMesh &mesh) |
Static destructor using Type::typeName. More... | |
static std::unique_ptr< GAMGAgglomeration > | Release (const word &objName, const lduMesh &mesh, const bool checkout=false) |
Release ownership of meshObject (with given registration name) from registry. Returns nullptr if not found or not owned. More... | |
static std::unique_ptr< GAMGAgglomeration > | Release (const lduMesh &mesh, const bool checkout=false) |
Release ownership of meshObject (with Type::typeName name) from registry. More... | |
Static Public Member Functions inherited from meshObject | |
template<class Mesh > | |
static void | movePoints (objectRegistry &obr) |
Update for mesh motion. More... | |
template<class Mesh > | |
static void | updateMesh (objectRegistry &obr, const mapPolyMesh &mpm) |
Update topology using the given map. More... | |
template<class Mesh , template< class > class MeshObjectType> | |
static void | clear (objectRegistry &obr) |
Clear/remove all meshObject of MeshObjectType via objectRegistry::checkOut() More... | |
template<class Mesh , template< class > class FromType, template< class > class ToType> | |
static void | clearUpto (objectRegistry &obr) |
Clear all meshObject derived from FromType up to (but not including) ToType. More... | |
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 (std::unique_ptr< 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 (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 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 word | scopedName (const std::string &scope, const word &name1, const word &name2) |
Create scope:name1:name2 or scope_name1_name2 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 Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
Write the standard OpenFOAM file/dictionary banner. More... | |
static Ostream & | writeDivider (Ostream &os) |
Write the standard file section divider. More... | |
static Ostream & | writeEndDivider (Ostream &os) |
Write the standard end file divider. More... | |
Static Public Member Functions inherited from IOobjectOption | |
static bool | isAnyRead (readOption opt) noexcept |
True if any reading may be required (ie, != NO_READ) More... | |
static bool | isReadRequired (readOption opt) noexcept |
True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
static bool | isReadOptional (readOption opt) noexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More... | |
static readOption | lazierRead (readOption opt) noexcept |
Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. 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, const bool doProcessorAgglomerate) |
Shrink the number of levels to that specified. Optionally do. More... | |
bool | continueAgglomerating (const label nCellsInCoarsestLevel, const label nCells, const label nCoarseCells, const label comm) const |
Check the need for further agglomeration. More... | |
void | clearLevel (const label leveli) |
void | printLevels () const |
Print level overview. More... | |
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... | |
Protected Attributes | |
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< GAMGProcAgglomeration > | procAgglomeratorPtr_ |
labelList | nCells_ |
The number of cells in each level. More... | |
PtrList< labelField > | restrictAddressing_ |
Cell restriction addressing array. More... | |
labelList | nFaces_ |
The number of (coarse) faces in each level. More... | |
PtrList< labelList > | faceRestrictAddressing_ |
Face restriction addressing array. More... | |
PtrList< boolList > | faceFlipMap_ |
Face flip: for faces mapped to internal faces stores whether. More... | |
PtrList< labelList > | nPatchFaces_ |
The number of (coarse) patch faces in each level. More... | |
PtrList< labelListList > | patchFaceRestrictAddressing_ |
Patch-local face restriction addressing array. More... | |
PtrList< lduPrimitiveMesh > | meshLevels_ |
Hierarchy of mesh addressing. More... | |
PtrList< labelList > | procAgglomMap_ |
Per level, per processor the processor it agglomerates into. More... | |
PtrList< labelList > | agglomProcIDs_ |
Per level the set of processors to agglomerate. Element 0 is. More... | |
labelList | procCommunicator_ |
Communicator for given level. More... | |
PtrList< UPstream::communicator > | procAgglomCommunicator_ |
Communicator for collecting contributions. Note self-contained. More... | |
PtrList< labelList > | procCellOffsets_ |
Mapping from processor to procMeshLevel cells. More... | |
PtrList< labelListList > | procFaceMap_ |
Mapping from processor to procMeshLevel face. More... | |
PtrList< labelListList > | procBoundaryMap_ |
Mapping from processor to procMeshLevel boundary. More... | |
PtrList< labelListListList > | procBoundaryFaceMap_ |
Mapping from processor to procMeshLevel boundary face. More... | |
Protected Attributes inherited from MeshObject< lduMesh, GeometricMeshObject, GAMGAgglomeration > | |
const lduMesh & | mesh_ |
Reference to the mesh. More... | |
Friends | |
class | GAMGProcAgglomeration |
Declare friendship with GAMGProcAgglomeration. More... | |
Additional Inherited Members | |
Public Types inherited from IOobject | |
enum | objectState : char { GOOD, BAD } |
Enumeration defining the valid states of an IOobject. More... | |
enum | fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster } |
Enumeration defining the file checking options. More... | |
Public Types inherited from IOobjectOption | |
enum | readOption : unsigned char { NO_READ = 0, MUST_READ = 0x1, READ_MODIFIED = 0x3, MUST_READ_IF_MODIFIED = 0x3, LAZY_READ = 0x4, READ_IF_PRESENT = 0x4 } |
Enumeration defining read preferences. More... | |
enum | writeOption : unsigned char { NO_WRITE = 0, AUTO_WRITE = 0x10 } |
Enumeration defining write preferences. More... | |
enum | registerOption : unsigned char { NO_REGISTER = 0, REGISTER = 1, LEGACY_REGISTER = 2 } |
Enumeration for use with registerObject(). Values map to bool (false/true) More... | |
Static Public Attributes inherited from IOobject | |
static const Enum< fileCheckTypes > | fileCheckTypesNames |
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 IOobject | |
static void | writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr) |
Helper: write content for FoamFile IOobject header with optional meta information. More... | |
static void | writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr) |
Helper: write dictionary content for FoamFile header with optional meta information. More... | |
Static Protected Attributes inherited from regIOobject | |
static bool | masterOnlyReading = false |
To flag master-only reading of objects. More... | |
Geometric agglomerated algebraic multigrid agglomeration class.
Definition at line 61 of file GAMGAgglomeration.H.
|
protecteddelete |
No copy construct.
GAMGAgglomeration | ( | const lduMesh & | mesh, |
const dictionary & | controlDict | ||
) |
Construct given mesh and controls.
Definition at line 234 of file GAMGAgglomeration.C.
References fvMesh::lduAddr(), Foam::max(), mesh, Foam::min(), Foam::reduce(), and lduAddressing::size().
~GAMGAgglomeration | ( | ) |
Destructor.
Definition at line 466 of file GAMGAgglomeration.C.
|
protected |
Assemble coarse mesh addressing.
Definition at line 31 of file GAMGAgglomerateLduAddressing.C.
References Foam::abort(), List< T >::clear(), lduMesh::comm(), Foam::ensightOutput::debug, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), forAll, forAllReverse, lduMesh::lduAddr(), lduAddressing::lowerAddr(), Foam::min(), Foam::New(), Foam::nl, lduAddressing::patchAddr(), Foam::Pout, UPtrList< T >::set(), List< T >::set(), List< T >::setSize(), UList< T >::size(), lduAddressing::size(), UPtrList< T >::size(), lduAddressing::upperAddr(), and Foam::Zero.
|
protected |
Combine a level with the previous one.
Definition at line 624 of file GAMGAgglomerateLduAddressing.C.
References GAMGInterface::combine(), GAMGAgglomeration::faceFlipMap_, GAMGAgglomeration::faceRestrictAddressing_, forAll, GAMGAgglomeration::meshLevels_, GAMGAgglomeration::nCells_, GAMGAgglomeration::nFaces_, GAMGAgglomeration::nPatchFaces_, GAMGAgglomeration::patchFaceRestrictAddressing_, GAMGAgglomeration::restrictAddressing_, and UPtrList< T >::set().
|
protected |
Shrink the number of levels to that specified. Optionally do.
processor agglomeration
Definition at line 45 of file GAMGAgglomeration.C.
|
protected |
Check the need for further agglomeration.
Definition at line 209 of file GAMGAgglomeration.C.
References UPstream::msgType(), UPstream::nProcs(), and Foam::returnReduce().
|
protected |
Definition at line 517 of file GAMGAgglomeration.C.
|
protected |
Print level overview.
Definition at line 76 of file GAMGAgglomeration.C.
References lduAddressing::band(), Foam::endl(), forAll, GAMGAgglomeration::hasMeshLevel(), Foam::Info, lduMesh::interfaces(), lduMesh::lduAddr(), lduAddressing::lowerAddr(), GAMGAgglomeration::meshLevel(), GAMGAgglomeration::nCells(), Foam::nl, OSstream::precision(), GAMGAgglomeration::procAgglomeratorPtr_, GAMGAgglomeration::processorAgglomerate(), Foam::returnReduce(), Foam::setw(), UList< T >::size(), lduAddressing::size(), GAMGAgglomeration::size(), messageStream::stream(), and Foam::type().
Referenced by GAMGAgglomeration::New().
|
protected |
Collect and combine processor meshes into allMesh:
Definition at line 422 of file GAMGAgglomerateLduAddressing.C.
References UList< T >::cdata(), UList< T >::data(), Foam::PstreamDetail::gather(), lduMesh::interfaces(), CompactListList< T >::localSizes(), CompactListList< T >::offsets(), Foam::PstreamDetail::scatter(), List< T >::set(), List< T >::setSize(), UList< T >::size(), UPtrList< T >::size(), and CompactListList< T >::values().
|
protected |
Collect and combine basic restriction addressing:
Definition at line 549 of file GAMGAgglomerateLduAddressing.C.
References forAll, Foam::PstreamDetail::gather(), UList< T >::last(), UList< T >::size(), and List< T >::transfer().
|
protecteddelete |
No copy assignment.
TypeName | ( | "GAMGAgglomeration" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
GAMGAgglomeration | , | ||
lduMesh | , | ||
(const lduMesh &mesh, const dictionary &controlDict) | , | ||
(mesh, controlDict) | |||
) |
Runtime selection table for pure geometric agglomerators.
declareRunTimeSelectionTable | ( | autoPtr | , |
GAMGAgglomeration | , | ||
lduMatrix | , | ||
(const lduMatrix &matrix, const dictionary &controlDict) | , | ||
(matrix, controlDict) | |||
) |
Runtime selection table for matrix or mixed geometric/matrix agglomerators.
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.
|
static |
Return the selected geometric agglomerator.
Definition at line 296 of file GAMGAgglomeration.C.
References objectRegistry::cfindObject(), controlDict(), Foam::ensightOutput::debug, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Time::libs(), mesh, dlLibraryTable::open(), GAMGAgglomeration::printLevels(), regIOobject::store(), fvMesh::thisDb(), and objectRegistry::time().
|
static |
Return the selected matrix agglomerator.
Definition at line 350 of file GAMGAgglomeration.C.
References objectRegistry::cfindObject(), controlDict(), Foam::ensightOutput::debug, Time::libs(), mesh, lduMatrix::mesh(), Foam::New(), dlLibraryTable::open(), GAMGAgglomeration::printLevels(), regIOobject::store(), fvMesh::thisDb(), and objectRegistry::time().
|
static |
Return the selected geometric agglomerator.
Definition at line 401 of file GAMGAgglomeration.C.
References objectRegistry::cfindObject(), controlDict(), Foam::ensightOutput::debug, Foam::exit(), Foam::FatalError, FatalErrorInFunction, mesh, GAMGAgglomeration::printLevels(), regIOobject::store(), fvMesh::thisDb(), and objectRegistry::time().
|
inline |
Definition at line 422 of file GAMGAgglomeration.H.
References GAMGAgglomeration::meshLevels_.
Referenced by GAMGAgglomeration::printLevels(), GAMGProcAgglomeration::printStats(), and oversetFvMeshBase::writeAgglomeration().
const Foam::lduMesh & meshLevel | ( | const label | leveli | ) | const |
Return LDU mesh of given level.
Definition at line 473 of file GAMGAgglomeration.C.
Referenced by GAMGAgglomeration::printLevels(), and GAMGProcAgglomeration::printStats().
bool hasMeshLevel | ( | const label | leveli | ) | const |
Do we have mesh for given level?
Definition at line 488 of file GAMGAgglomeration.C.
Referenced by GAMGAgglomeration::printLevels(), and GAMGProcAgglomeration::printStats().
const Foam::lduInterfacePtrsList & interfaceLevel | ( | const label | leveli | ) | const |
Return LDU interface addressing of given level.
Definition at line 502 of file GAMGAgglomeration.C.
|
inline |
Return cell restrict addressing of given level.
Definition at line 448 of file GAMGAgglomeration.H.
References GAMGAgglomeration::restrictAddressing_.
Referenced by GAMGProcAgglomeration::printStats(), and oversetFvMeshBase::writeAgglomeration().
|
inline |
Return face restrict addressing of given level.
Definition at line 456 of file GAMGAgglomeration.H.
References GAMGAgglomeration::faceRestrictAddressing_.
Referenced by GAMGProcAgglomeration::printStats().
|
inline |
Definition at line 461 of file GAMGAgglomeration.H.
References GAMGAgglomeration::patchFaceRestrictAddressing_.
Referenced by GAMGProcAgglomeration::printStats().
|
inline |
Return face flip map of given level.
Definition at line 470 of file GAMGAgglomeration.H.
References GAMGAgglomeration::faceFlipMap_.
|
inline |
Return number of coarse cells (before processor agglomeration)
Definition at line 478 of file GAMGAgglomeration.H.
References GAMGAgglomeration::nCells_.
Referenced by GAMGAgglomeration::printLevels(), and GAMGProcAgglomeration::printStats().
|
inline |
Return number of coarse faces (before processor agglomeration)
Definition at line 486 of file GAMGAgglomeration.H.
References GAMGAgglomeration::nFaces_.
Referenced by GAMGProcAgglomeration::printStats().
|
inline |
Return number of coarse patch faces (before processor agglomeration)
Definition at line 495 of file GAMGAgglomeration.H.
References GAMGAgglomeration::nPatchFaces_.
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 47 of file GAMGAgglomerationTemplates.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::fv::ff(), Foam::PstreamDetail::gather(), and UList< T >::size().
void restrictFaceField | ( | Field< Type > & | cf, |
const Field< Type > & | ff, | ||
const label | fineLevelIndex | ||
) | const |
Restrict (integrate by summation) face field.
Definition at line 92 of file GAMGAgglomerationTemplates.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::fv::ff(), forAll, UList< T >::size(), and Foam::Zero.
void restrictField | ( | Field< Type > & | cf, |
const Field< Type > & | ff, | ||
const labelList & | fineToCoarse | ||
) | const |
Restrict (integrate by summation) cell field.
Definition at line 30 of file GAMGAgglomerationTemplates.C.
References Foam::fv::ff(), forAll, and Foam::Zero.
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 125 of file GAMGAgglomerationTemplates.C.
References Foam::fv::ff(), forAll, and Foam::PstreamDetail::scatter().
const Field<Type>& prolongField | ( | Field< Type > & | ff, |
Field< Type > & | work, | ||
const Field< Type > & | cf, | ||
const label | coarseLevelIndex | ||
) | const |
Prolong (interpolate by injection) cell field. Return reference.
to (potentially scattered) coarse field
|
static |
Given fine to coarse processor map determine:
Definition at line 724 of file GAMGAgglomerateLduAddressing.C.
References UList< T >::find(), Foam::findIndices(), forAll, forAllConstIters(), Foam::min(), UPstream::myProcNo(), List< T >::setSize(), and UList< T >::size().
Referenced by eagerGAMGProcAgglomeration::agglomerate(), procFacesGAMGProcAgglomeration::agglomerate(), and masterCoarsestGAMGProcAgglomeration::agglomerate().
|
inline |
Whether to agglomerate across processors.
Definition at line 589 of file GAMGAgglomeration.H.
References GAMGAgglomeration::procAgglomeratorPtr_.
Referenced by GAMGAgglomeration::printLevels().
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 538 of file GAMGAgglomeration.C.
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 547 of file GAMGAgglomeration.C.
bool hasProcMesh | ( | const label | fineLeveli | ) | const |
Check that level has combined mesh.
Definition at line 555 of file GAMGAgglomeration.C.
Foam::label procCommunicator | ( | const label | fineLeveli | ) | const |
Communicator for current level or -1.
Definition at line 561 of file GAMGAgglomeration.C.
Foam::label agglomCommunicator | ( | const label | fineLeveli | ) | const |
Communicator for collecting contributions.
Definition at line 567 of file GAMGAgglomeration.C.
const Foam::labelList & cellOffsets | ( | const label | fineLeveli | ) | const |
Mapping from processor to procMesh cells.
Definition at line 574 of file GAMGAgglomeration.C.
const Foam::labelListList & faceMap | ( | const label | fineLeveli | ) | const |
Mapping from processor to procMesh face.
Definition at line 583 of file GAMGAgglomeration.C.
const Foam::labelListList & boundaryMap | ( | const label | fineLeveli | ) | const |
Mapping from processor to procMesh boundary.
Definition at line 592 of file GAMGAgglomeration.C.
const Foam::labelListListList & boundaryFaceMap | ( | const label | fineLeveli | ) | const |
Mapping from processor to procMesh boundary face.
Definition at line 601 of file GAMGAgglomeration.C.
|
pure virtual |
Agglomerate from a starting level. Starting level is usually 0 (initial mesh) but sometimes >0 (restarting after processor agglomeration)
Implemented in MGridGenGAMGAgglomeration, pairGAMGAgglomeration, and dummyAgglomeration.
|
static |
Given restriction determines if coarse cells are connected.
Return ok is so, otherwise creates new restriction that is
Definition at line 610 of file GAMGAgglomeration.C.
References Foam::abort(), List< T >::append(), Foam::FatalError, FatalErrorInFunction, UList< T >::find(), forAll, UList< T >::found(), Foam::identity(), Foam::stringOps::lower(), lduAddressing::lowerAddr(), Foam::reduce(), List< T >::setSize(), UList< T >::size(), lduAddressing::size(), Foam::stringOps::upper(), and lduAddressing::upperAddr().
const Foam::Field<Type>& prolongField | ( | Field< Type > & | ff, |
Field< Type > & | allCf, | ||
const Field< Type > & | cf, | ||
const label | levelIndex | ||
) | const |
Definition at line 175 of file GAMGAgglomerationTemplates.C.
References Foam::fv::ff(), forAll, List< Type >::resize_nocopy(), and Foam::PstreamDetail::scatter().
|
friend |
Declare friendship with GAMGProcAgglomeration.
Definition at line 297 of file GAMGAgglomeration.H.
|
protected |
Max number of levels.
Definition at line 82 of file GAMGAgglomeration.H.
|
protected |
Number of cells in coarsest level.
Definition at line 87 of file GAMGAgglomeration.H.
|
protected |
Cached mesh interfaces.
Definition at line 92 of file GAMGAgglomeration.H.
|
protected |
Definition at line 94 of file GAMGAgglomeration.H.
Referenced by GAMGAgglomeration::printLevels(), and GAMGAgglomeration::processorAgglomerate().
|
protected |
The number of cells in each level.
Definition at line 99 of file GAMGAgglomeration.H.
Referenced by GAMGAgglomeration::combineLevels(), and GAMGAgglomeration::nCells().
|
protected |
Cell restriction addressing array.
Maps from the finer to the coarser level.
Definition at line 106 of file GAMGAgglomeration.H.
Referenced by GAMGAgglomeration::combineLevels(), GAMGProcAgglomeration::printStats(), and GAMGAgglomeration::restrictAddressing().
|
protected |
The number of (coarse) faces in each level.
max(faceRestrictAddressing)+1.
Definition at line 113 of file GAMGAgglomeration.H.
Referenced by GAMGAgglomeration::combineLevels(), and GAMGAgglomeration::nFaces().
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 124 of file GAMGAgglomeration.H.
Referenced by GAMGAgglomeration::combineLevels(), and GAMGAgglomeration::faceRestrictAddressing().
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 132 of file GAMGAgglomeration.H.
Referenced by GAMGAgglomeration::combineLevels(), and GAMGAgglomeration::faceFlipMap().
The number of (coarse) patch faces in each level.
max(patchFaceRestrictAddressing_)+1.
Definition at line 139 of file GAMGAgglomeration.H.
Referenced by GAMGAgglomeration::combineLevels(), and GAMGAgglomeration::nPatchFaces().
|
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 147 of file GAMGAgglomeration.H.
Referenced by GAMGAgglomeration::combineLevels(), and GAMGAgglomeration::patchFaceRestrictAddressing().
|
protected |
Hierarchy of mesh addressing.
Definition at line 152 of file GAMGAgglomeration.H.
Referenced by GAMGAgglomeration::combineLevels(), and GAMGAgglomeration::size().
Per level, per processor the processor it agglomerates into.
Definition at line 160 of file GAMGAgglomeration.H.
Referenced by GAMGProcAgglomeration::printStats().
Per level the set of processors to agglomerate. Element 0 is.
the 'master' of the cluster.
Definition at line 167 of file GAMGAgglomeration.H.
Referenced by GAMGProcAgglomeration::printStats().
|
mutableprotected |
Communicator for given level.
Definition at line 172 of file GAMGAgglomeration.H.
Referenced by GAMGProcAgglomeration::printStats().
|
mutableprotected |
Communicator for collecting contributions. Note self-contained.
communicator for ease of cleanup - this one gets allocated internally, not by the GAMGProcAgglomerations
Definition at line 180 of file GAMGAgglomeration.H.
Mapping from processor to procMeshLevel cells.
Definition at line 185 of file GAMGAgglomeration.H.
Referenced by GAMGProcAgglomeration::printStats().
|
mutableprotected |
Mapping from processor to procMeshLevel face.
Definition at line 190 of file GAMGAgglomeration.H.
|
mutableprotected |
Mapping from processor to procMeshLevel boundary.
Definition at line 195 of file GAMGAgglomeration.H.
|
mutableprotected |
Mapping from processor to procMeshLevel boundary face.
Definition at line 200 of file GAMGAgglomeration.H.