Geometric agglomerated algebraic multigrid agglomeration class. More...

#include <GAMGAgglomeration.H>

Inheritance diagram for GAMGAgglomeration:

[legend]

Collaboration diagram for GAMGAgglomeration:

[legend]

Public Member Functions
	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.
	GAMGAgglomeration (const lduMesh &mesh, const dictionary &controlDict)
	Construct given mesh and controls.
	~GAMGAgglomeration ()
	Destructor.
virtual bool	movePoints ()
	Update when the mesh moves.
label	size () const
const lduMesh &	meshLevel (const label leveli) const
	Return LDU mesh of given level.
bool	hasMeshLevel (const label leveli) const
	Do we have mesh for given level?
const lduInterfacePtrsList &	interfaceLevel (const label leveli) const
	Return LDU interface addressing of given level.
const labelField &	restrictAddressing (const label leveli) const
	Return cell restrict addressing of given level.
const labelList &	faceRestrictAddressing (const label leveli) const
	Return face restrict addressing of given level.
const labelListList &	patchFaceRestrictAddressing (const label leveli) const
const boolList &	faceFlipMap (const label leveli) const
	Return face flip map of given level.
label	nCells (const label leveli) const
	Return number of coarse cells (before processor agglomeration).
label	nFaces (const label leveli) const
	Return number of coarse faces (before processor agglomeration).
const labelList &	nPatchFaces (const label leveli) const
	Return number of coarse patch faces (before processor agglomeration).
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.
template<class Type>
void	restrictFaceField (Field< Type > &cf, const Field< Type > &ff, const label fineLevelIndex) const
	Restrict (integrate by summation) face field.
template<class Type>
void	restrictField (Field< Type > &cf, const Field< Type > &ff, const labelList &fineToCoarse) const
	Restrict (integrate by summation) cell field.
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.
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.
bool	processorAgglomerate () const
	Whether to agglomerate across processors.
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.
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).
bool	hasProcMesh (const label fineLeveli) const
	Check that level has combined mesh.
label	procCommunicator (const label fineLeveli) const
	Communicator for current level or -1.
label	agglomCommunicator (const label fineLeveli) const
	Communicator for collecting contributions.
const labelList &	cellOffsets (const label fineLeveli) const
	Mapping from processor to procMesh cells.
const labelListList &	faceMap (const label fineLeveli) const
	Mapping from processor to procMesh face.
const labelListList &	boundaryMap (const label fineLeveli) const
	Mapping from processor to procMesh boundary.
const labelListListList &	boundaryFaceMap (const label fineLeveli) const
	Mapping from processor to procMesh boundary face.
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).
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, MoveableMeshObject, GAMGAgglomeration >
	MeshObject (const lduMesh &mesh)
	Construct with Type::typeName on Mesh.
	MeshObject (const word &objName, const lduMesh &mesh)
	Construct with given object name on Mesh.
virtual	~MeshObject ()=default
	Destructor.
const lduMesh &	mesh () const noexcept
	Reference to the mesh.
virtual bool	writeData (Ostream &os) const
	Dummy write.
Public Member Functions inherited from MoveableMeshObject< Mesh >
	MoveableMeshObject (const word &objName, const objectRegistry &obr)
	Construct from name and instance on registry.
Public Member Functions inherited from GeometricMeshObject< Mesh >
	GeometricMeshObject (const word &objName, const objectRegistry &obr)
	Construct from name and instance on registry.
Public Member Functions inherited from TopologicalMeshObject< Mesh >
	TopologicalMeshObject (const word &objName, const objectRegistry &obr)
	Construct from name and instance on registry.
Public Member Functions inherited from meshObject
	ClassName ("meshObject")
	Runtime declaration and debug switch.
	meshObject (const word &objName, const objectRegistry &obr)
	Construct with given object name on a registry.
Public Member Functions inherited from regIOobject
void	operator= (const regIOobject &)=delete
	No copy assignment.
	TypeName ("regIOobject")
	Runtime type information.
	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).
	regIOobject (const regIOobject &rio)
	Copy construct.
	regIOobject (const regIOobject &rio, bool registerCopy)
	Copy construct, transferring registry registration to the copy if registerCopy is true.
	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy construct with new name, transferring registry registration to the copy if registerCopy is true.
	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters.
virtual	~regIOobject ()
	Destructor.
bool	checkIn ()
	Add object to registry, if not already registered.
bool	checkOut ()
	Remove object from registry, and remove all file watches.
virtual void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED).
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.
bool	ownedByRegistry () const noexcept
	Is this object owned by the registry?
bool	store ()
	Register object with its registry and transfer ownership to the registry.
void	release (const bool unregister=false) noexcept
	Set object as not ownedByRegistry.
label	eventNo () const noexcept
	Event number at last update.
label &	eventNo () noexcept
	Event number at last update.
bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object.
bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
void	setUpToDate ()
	Set as up-to-date.
virtual void	rename (const word &newName)
	Rename.
const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr.
dictionary &	getMetaData () noexcept
	Get or create meta-data.
void	removeMetaData ()
	Remove meta-data.
virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing).
virtual fileName	filePath () const
	Return complete path + object name if the file exists.
bool	headerOk ()
	Read and check header info. Does not check the headerClassName.
Istream &	readStream (const word &, const bool readOnProc=true)
	Return Istream and check object type against that given.
void	close ()
	Close Istream.
virtual bool	readData (Istream &)
	Virtual readData function.
virtual bool	read ()
	Read object.
virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched.
const labelList &	watchIndices () const noexcept
	Read access to file-monitoring handles.
labelList &	watchIndices () noexcept
	Write access to file-monitoring handles.
virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time).
virtual bool	readIfModified ()
	Read object if modified (as set by call to modified).
virtual bool	writeObject (IOstreamOption streamOpt, const bool writeOnProc) const
	Write using stream options.
virtual bool	write (const bool writeOnProc=true) const
	Write using setting from DB.
virtual bool	global () const
	Is object global.
void	operator= (const IOobject &io)
	Copy assignment.
virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const
	Write using given format, version and compression.
Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch).
	IOobject (const IOobject &)=default
	Copy construct.
virtual	~IOobject ()=default
	Destructor.
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, registry, io options.
	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, local, registry, io options.
	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from path, registry, io options.
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, registry, io options.
	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, local, registry, io options.
	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from path, registry, io options.
	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry.
	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name.
	IOobject (const IOobject &io, const word &name, const fileName &local)
	Copy construct, resetting name and local component.
	IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt)
	Copy construct, resetting read/write options.
	IOobject (const IOobject &io, IOobjectOption::registerOption regOpt)
	Copy construct, resetting register option.
autoPtr< IOobject >	clone () const
	Clone.
autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry.
const objectRegistry &	db () const noexcept
	Return the local objectRegistry.
const Time &	time () const noexcept
	Return Time associated with the objectRegistry.
const word &	name () const noexcept
	Return the object name.
const word &	headerClassName () const noexcept
	Return name of the class name read from header.
word &	headerClassName () noexcept
	Modifiable access to the class name read from header.
const string &	note () const noexcept
	Return the optional note.
string &	note () noexcept
	Modifiable access to the optional note.
unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header.
unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header.
void	resetHeader (const word &newName=word::null)
	Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file.
bool	hasHeaderClass () const noexcept
	True if headerClassName() is non-empty (after reading).
bool	isHeaderClass (const word &expectedType) const
	Check if headerClassName() equals the expected type. Always true if the expected type is empty.
template<class Type>
bool	isHeaderClass () const
	Check if headerClassName() equals Type::typeName Always true for a `void` type.
word	group () const
	Return group (extension part of name).
word	member () const
	Return member (name without the extension).
const fileName &	rootPath () const noexcept
	Return the Time::rootPath().
const fileName &	caseName () const noexcept
	Return the Time::caseName().
const fileName &	globalCaseName () const noexcept
	Return the Time::globalCaseName().
const fileName &	caseName (IOobjectOption::Layout) const noexcept
	Return the Time::caseName() - normal or global.
const fileName &	instance () const noexcept
	Read access to instance path component.
fileName &	instance () noexcept
	Modifiable access to instance path component.
scalar	instanceValue () const
	Return the scalar value of the instance component (or 0), which often corresponds to a time index/value.
const fileName &	local () const noexcept
	Read access to local path component.
fileName &	local () noexcept
	Modifiable access to the local path component.
fileName	path () const
	The complete path for the object (with instance, local,...).
fileName	globalPath () const
	The complete global path for the object (with instance, local,...).
fileName	path (IOobjectOption::Layout) const
	The complete path (normal or global) for the object.
fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local.
fileName	globalPath (const word &instance, const fileName &local=fileName::null) const
	The complete global path with alternative instance and local.
fileName	path (IOobjectOption::Layout, const word &instance, const fileName &local=fileName::null) const
	The complete path (normal or global) with alternative instance and local.
fileName	objectPath () const
	The complete path + object name.
fileName	globalObjectPath () const
	The complete global path + object name.
fileName	objectPath (IOobjectOption::Layout) const
	The complete path (normal or global) + object name.
fileName	objectPath (IOobjectOption::Layout, const word &instance) const
	The complete path (normal or global) + object name with alternative instance.
fileName	objectPath (const word &instance) const
	The complete path + object name with alternative instance.
fileName	globalObjectPath (const word &instance) const
	The complete global path + object name with alternative instance.
fileName	objectRelPath () const
	The object path relative to the case.
fileName	localFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching locally.
fileName	globalFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching up if in parallel.
IOstreamOption	parseHeader (const dictionary &headerDict)
	Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics.
bool	readHeader (Istream &is)
	Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics.
bool	readHeader (dictionary &headerDict, Istream &is)
	Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics.
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. A `void` type suppresses trait and type-name checks.
template<class Type, bool Searching>
bool	typeHeaderOk (const bool checkType=true, const bool verbose=true)
	Forwards to single-parameter version with the specified search type. A `void` type suppresses trait and type-name checks.
template<class Type>
fileName	typeFilePath (const bool search=true) const
	Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait.
template<class Type>
void	warnNoRereading () const
	Helper: warn that type does not support re-reading.
bool	writeHeader (Ostream &os) const
	Write header with current type().
bool	writeHeader (Ostream &os, const word &objectType) const
	Write header with override of type.
void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const
	Write header into a dictionary with current type() and given output format.
void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
	Write header into a dictionary with override of type and given output format.
bool	good () const noexcept
	Did last readHeader() succeed?
bool	bad () const noexcept
	Did last readHeader() fail?
InfoProxy< IOobject >	info () const noexcept
	Return info proxy, for printing information to a stream.
void	operator= (const IOobject &io)
	Copy assignment, copies all values (except the registry).
template<class Type>
bool	isHeaderClassName () const
	Same as isHeaderClass().
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.
constexpr	IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_WRITE with specified read/register options.
constexpr	IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_READ with specified write/register options.
constexpr	IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option.
constexpr	IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept
	Construct from components with specified register option as bool.
constexpr	IOobjectOption (bool registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option as bool.
readOption	readOpt () const noexcept
	Get the read option.
readOption	readOpt (readOption opt) noexcept
	Set the read option.
writeOption	writeOpt () const noexcept
	Get the write option.
writeOption	writeOpt (writeOption opt) noexcept
	Set the write option.
bool	registerObject () const noexcept
	Should objects created with this IOobject be registered?
bool	registerObject (bool on) noexcept
	Change registration preference.
bool	globalObject () const noexcept
	True if object is treated the same for all processors.
bool	globalObject (bool on) noexcept
	Change global-object status.
bool	isAnyRead () const noexcept
	True if any reading may be required (ie, != NO_READ).
bool	isReadRequired () const noexcept
	True if (MUST_READ \| READ_MODIFIED) bits are set.
bool	isReadOptional () const noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
readOption &	readOpt () noexcept
	Access to the read option.
writeOption &	writeOpt () noexcept
	Access to the write option.
bool &	registerObject () noexcept
	Access to the register object option.
bool &	globalObject () noexcept
	Access to the global object option.

Static Public Member Functions
static const GAMGAgglomeration &	New (const lduMesh &mesh, const dictionary &controlDict)
	Return the selected geometric agglomerator.
static const GAMGAgglomeration &	New (const lduMatrix &matrix, const dictionary &controlDict)
	Return the selected matrix agglomerator.
static const GAMGAgglomeration &	New (const lduMesh &mesh, const scalarField &cellVolumes, const vectorField &faceAreas, const dictionary &controlDict)
	Return the selected geometric agglomerator.
static void	calculateRegionMaster (const label comm, const labelList &procAgglomMap, labelList &masterProcs, List< label > &agglomProcIDs)
	Given fine to coarse processor map determine:
static bool	checkRestriction (labelList &newRestrict, label &nNewCoarse, const lduAddressing &fineAddressing, const labelUList &restriction, const label nCoarse)
	Given restriction determines if coarse cells are connected.
Static Public Member Functions inherited from MeshObject< lduMesh, MoveableMeshObject, GAMGAgglomeration >
static FOAM_NO_DANGLING_REFERENCE const GAMGAgglomeration &	New (const lduMesh &mesh, Args &&... args)
	Get existing or create MeshObject registered with typeName.
static FOAM_NO_DANGLING_REFERENCE const GAMGAgglomeration &	New (const word &objName, const lduMesh &mesh, Args &&... args)
	Get existing or create MeshObject with given registration name.
static bool	Store (std::unique_ptr< GAMGAgglomeration > &&ptr)
	Transfer ownership of meshObject to registry.
static bool	Delete (const word &objName, const lduMesh &mesh)
	Static destructor using given registration name.
static bool	Delete (const lduMesh &mesh)
	Static destructor using Type::typeName.
static std::unique_ptr< GAMGAgglomeration >	Release (const word &objName, const lduMesh &mesh, bool checkout=true)
	Release ownership of meshObject (with given registration name) from registry. Returns nullptr if not found or not owned.
static std::unique_ptr< GAMGAgglomeration >	Release (const lduMesh &mesh, bool checkout=true)
	Release ownership of meshObject (with Type::typeName name) from registry.
Static Public Member Functions inherited from meshObject
template<class Mesh>
static void	movePoints (objectRegistry &obr)
	Update for mesh motion.
template<class Mesh>
static void	updateMesh (objectRegistry &obr, const mapPolyMesh &mpm)
	Update topology using the given map.
template<class Mesh, template< class > class MeshObjectType>
static void	clear (objectRegistry &obr)
	Clear/remove all meshObject of MeshObjectType via objectRegistry::checkOut().
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.
Static Public Member Functions inherited from regIOobject
template<class Type>
static Type &	store (Type *p)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (std::unique_ptr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry.
Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner.
static bool	bannerEnabled (bool on) noexcept
	Enable/disable output file banner.
static bool	fileModificationChecking_masterOnly () noexcept
	Test fileModificationChecking for master-only.
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components.
template<class StringType>
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string.
static word	group (const word &name)
	Return group (extension part of name).
static word	member (const word &name)
	Return member (name without the extension).
static word	scopedName (const std::string &scope, const word &name)
	Create scope:name or scope_name string.
static word	scopedName (const std::string &scope, const word &name1, const word &name2)
	Create scope:name1:name2 or scope_name1_name2 string.
static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name.
static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
	Write the standard OpenFOAM file/dictionary banner.
static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider.
static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider.
Static Public Member Functions inherited from IOobjectOption
static bool	isAnyRead (readOption opt) noexcept
	True if any reading may be required (ie, != NO_READ).
static bool	isReadRequired (readOption opt) noexcept
	True if (MUST_READ \| READ_MODIFIED) bits are set.
static bool	isReadOptional (readOption opt) noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
static readOption	lazierRead (readOption opt) noexcept
	Downgrade readOption optional (LAZY_READ), leaves NO_READ intact.

Protected Member Functions
bool	requiresUpdate () const
	Does the agglomeration need to be fully updated?
void	agglomerateLduAddressing (const label fineLevelIndex)
	Assemble coarse mesh addressing.
void	combineLevels (const label curLevel)
	Combine a level with the previous one.
void	compactLevels (const label nCreatedLevels, const bool doProcessorAgglomerate)
	Shrink the number of levels to that specified. Optionally do.
bool	continueAgglomerating (const label nCellsInCoarsestLevel, const label nCells, const label nCoarseCells, const label comm) const
	Check the need for further agglomeration.
void	clearLevel (const label leveli)
void	printLevels () const
	Print level overview.
void	procAgglomerateLduAddressing (const label comm, const labelList &procAgglomMap, const labelList &procIDs, const label allMeshComm, const label levelIndex)
	Collect and combine processor meshes into allMesh:
void	procAgglomerateRestrictAddressing (const label comm, const labelList &procIDs, const label levelIndex)
	Collect and combine basic restriction addressing:
	GAMGAgglomeration (const GAMGAgglomeration &)=delete
	No copy construct.
void	operator= (const GAMGAgglomeration &)=delete
	No copy assignment.
Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
	Helper: check readOpt flags and read if necessary.
Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad.

Protected Attributes
const label	maxLevels_
	Max number of levels.
const label	updateInterval_
	Update agglomeration every updateInterval_ steps.
bool	requireUpdate_
	Does agglomeration require update.
label	nCellsInCoarsestLevel_
	Number of cells in coarsest level.
const lduInterfacePtrsList	meshInterfaces_
	Cached mesh interfaces.
autoPtr< GAMGProcAgglomeration >	procAgglomeratorPtr_
labelList	nCells_
	The number of cells in each level.
PtrList< labelField >	restrictAddressing_
	Cell restriction addressing array.
labelList	nFaces_
	The number of (coarse) faces in each level.
PtrList< labelList >	faceRestrictAddressing_
	Face restriction addressing array.
PtrList< boolList >	faceFlipMap_
	Face flip: for faces mapped to internal faces stores whether.
PtrList< labelList >	nPatchFaces_
	The number of (coarse) patch faces in each level.
PtrList< labelListList >	patchFaceRestrictAddressing_
	Patch-local face restriction addressing array.
PtrList< lduPrimitiveMesh >	meshLevels_
	Hierarchy of mesh addressing.
PtrList< labelList >	procAgglomMap_
	Per level, per processor the processor it agglomerates into.
PtrList< labelList >	agglomProcIDs_
	Per level the set of processors to agglomerate. Element 0 is.
labelList	procCommunicator_
	Communicator for given level.
PtrList< UPstream::communicator >	procAgglomCommunicator_
	Communicator for collecting contributions. Note self-contained.
PtrList< labelList >	procCellOffsets_
	Mapping from processor to procMeshLevel cells.
PtrList< labelListList >	procFaceMap_
	Mapping from processor to procMeshLevel face.
PtrList< labelListList >	procBoundaryMap_
	Mapping from processor to procMeshLevel boundary.
PtrList< labelListListList >	procBoundaryFaceMap_
	Mapping from processor to procMeshLevel boundary face.
Protected Attributes inherited from MeshObject< lduMesh, MoveableMeshObject, GAMGAgglomeration >
const lduMesh &	mesh_
	Reference to the mesh.

Friends
class	GAMGProcAgglomeration
	Declare friendship with GAMGProcAgglomeration.

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 = 1 , timeStampMaster = 3 , inotify = 4 , inotifyMaster = 6 }
	Enumeration defining the file checking options (time-stamp \| inotify) \| (all \| masterOnly). 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...
enum class	Layout : unsigned char { regular , global }
	The layout of the case structure. More...
Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes.
static char	scopeSeparator
	Character for scoping object names (':' or '_').
static fileCheckTypes	fileModificationChecking
	Type of file modification checking.
static float	fileModificationSkew
	Time skew (seconds) for file modification checks.
static int	maxFileModificationPolls
	Max number of times to poll for file modification changes.
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.
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.
Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects.

Detailed Description

Geometric agglomerated algebraic multigrid agglomeration class.

Example of the specification in fvSolution:

{
    solver              GAMG;
    smoother            symGaussSeidel;

    // Whether to cache the agglomeration
    cacheAgglomeration  yes;
    // Optionally update every updateInterval mesh motion. Default is 1.
    updateInterval      10;
    // Optional name (default is GAMGAgglomeration)
    //name            pAgglomeration;

    // Optionally agglomerate coarsest-level across processors
    processorAgglomerator   masterCoarsest;
    nMasters            2;

    tolerance       1e-2;
    relTol          0;
}

Source files

Definition at line 83 of file GAMGAgglomeration.H.

Constructor & Destructor Documentation

◆ GAMGAgglomeration() [1/2]

GAMGAgglomeration ( const GAMGAgglomeration & )

protecteddelete

No copy construct.

References GAMGAgglomeration().

Referenced by declareRunTimeSelectionTable(), declareRunTimeSelectionTable(), declareRunTimeSelectionTable(), decompositionGAMGAgglomeration::decompositionGAMGAgglomeration(), decompositionGAMGAgglomeration::decompositionGAMGAgglomeration(), dummyAgglomeration::dummyAgglomeration(), GAMGAgglomeration(), GAMGAgglomeration(), MGridGenGAMGAgglomeration::MGridGenGAMGAgglomeration(), New(), New(), New(), operator=(), and pairGAMGAgglomeration::pairGAMGAgglomeration().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GAMGAgglomeration() [2/2]

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

Construct given mesh and controls.

Definition at line 233 of file GAMGAgglomeration.C.

References agglomProcIDs_, controlDict(), faceFlipMap_, faceRestrictAddressing_, found, GAMGAgglomeration(), GAMGProcAgglomeration, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, Foam::max(), maxLevels_, MeshObject< lduMesh, MoveableMeshObject, GAMGAgglomeration >::mesh(), meshInterfaces_, meshLevels_, Foam::min(), nCells_, nCellsInCoarsestLevel_, New(), nFaces_, nPatchFaces_, patchFaceRestrictAddressing_, procAgglomCommunicator_, procAgglomeratorPtr_, procAgglomMap_, procBoundaryFaceMap_, procBoundaryMap_, procCellOffsets_, procCommunicator_, processorAgglomerate(), procFaceMap_, Foam::reduce(), requireUpdate_, restrictAddressing_, and updateInterval_.

Here is the call graph for this function:

◆ ~GAMGAgglomeration()

~GAMGAgglomeration ( )

Destructor.

Definition at line 510 of file GAMGAgglomeration.C.

Member Function Documentation

◆ requiresUpdate()

bool requiresUpdate ( ) const

protected

Does the agglomeration need to be fully updated?

Definition at line 516 of file GAMGAgglomeration.C.

References MeshObject< lduMesh, MoveableMeshObject, GAMGAgglomeration >::mesh_, IOobject::time(), timeIndex, and updateInterval_.

Referenced by faceAreaPairGAMGAgglomeration::faceAreaPairGAMGAgglomeration(), faceAreaPairGAMGAgglomeration::faceAreaPairGAMGAgglomeration(), and movePoints().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ agglomerateLduAddressing()

void agglomerateLduAddressing ( const label fineLevelIndex )

protected

Assemble coarse mesh addressing.

Definition at line 30 of file GAMGAgglomerateLduAddressing.C.

References Foam::abort(), List< T >::clear(), lduMesh::comm(), Foam::endl(), Foam::exit(), faceFlipMap(), faceFlipMap_, faceRestrictAddressing_, Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), forAll, forAllReverse, interfaceLevel(), lduMesh::lduAddr(), lduAddressing::lowerAddr(), meshLevel(), meshLevels_, Foam::min(), nCells_, GAMGInterface::New(), nFaces_, Foam::nl, UPstream::nonBlocking, lduPrimitiveMesh::nonBlockingSchedule(), nPatchFaces(), nPatchFaces_, UPstream::nRequests(), lduAddressing::patchAddr(), patchFaceRestrictAddressing_, Foam::Pout, Foam::refCast(), restrictAddressing(), UPtrList< T >::set(), List< T >::setSize(), lduAddressing::size(), UList< T >::size(), UPtrList< T >::size(), lduAddressing::upperAddr(), UPstream::waitRequests(), and Foam::Zero.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ combineLevels()

void combineLevels ( const label curLevel )

protected

Combine a level with the previous one.

Definition at line 651 of file GAMGAgglomerateLduAddressing.C.

References GAMGInterface::combine(), faceFlipMap_, faceRestrictAddressing_, forAll, meshLevels_, nCells_, nFaces_, nPatchFaces_, patchFaceRestrictAddressing_, Foam::refCast(), restrictAddressing_, 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,
		const bool	doProcessorAgglomerate )

protected

Shrink the number of levels to that specified. Optionally do.

processor agglomeration

Definition at line 44 of file GAMGAgglomeration.C.

References agglomProcIDs_, faceFlipMap_, faceRestrictAddressing_, meshLevels_, nCells_, nFaces_, nPatchFaces_, patchFaceRestrictAddressing_, procAgglomCommunicator_, procAgglomeratorPtr_, procAgglomMap_, procBoundaryFaceMap_, procBoundaryMap_, procCellOffsets_, procCommunicator_, processorAgglomerate(), procFaceMap_, and restrictAddressing_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ continueAgglomerating()

bool continueAgglomerating	(	const label	nCellsInCoarsestLevel,
		const label	nCells,
		const label	nCoarseCells,
		const label	comm ) const

protected

Check the need for further agglomeration.

Definition at line 208 of file GAMGAgglomeration.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearLevel()

void clearLevel ( const label leveli )

protected

Definition at line 580 of file GAMGAgglomeration.C.

References faceFlipMap_, faceRestrictAddressing_, hasMeshLevel(), meshLevels_, nCells_, nFaces_, nPatchFaces_, patchFaceRestrictAddressing_, and restrictAddressing_.

Referenced by procAgglomerateLduAddressing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ printLevels()

void printLevels ( ) const

protected

Print level overview.

Definition at line 76 of file GAMGAgglomeration.C.

References lduAddressing::band(), Foam::endl(), forAll, hasMeshLevel(), Foam::Info, lduMesh::interfaces(), lduMesh::lduAddr(), lduAddressing::lowerAddr(), meshLevel(), nCells(), Foam::nl, procAgglomeratorPtr_, processorAgglomerate(), Foam::returnReduce(), Tuple2< T1, T2 >::second(), UPtrList< T >::set(), Foam::setw(), size(), lduAddressing::size(), UList< T >::size(), UPtrList< T >::size(), and Foam::type().

Referenced by faceAreaPairGAMGAgglomeration::movePoints(), New(), New(), and New().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 421 of file GAMGAgglomerateLduAddressing.C.

References agglomCommunicator(), agglomProcIDs_, clearLevel(), refPtr< T >::cref(), UList< T >::data(), lduPrimitiveMesh::gather(), lduMesh::interfaces(), CompactListList< T >::localSizes(), meshLevels_, UPstream::mpiScatterv(), UPstream::myProcNo(), CompactListList< T >::offsets(), CompactListList< T >::pack(), procAgglomCommunicator_, procAgglomerateRestrictAddressing(), procAgglomMap(), procAgglomMap_, procBoundaryFaceMap_, procBoundaryMap_, procCellOffsets_, procCommunicator_, procFaceMap_, List< T >::setSize(), UList< T >::size(), UPtrList< T >::size(), and CompactListList< T >::values().

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 548 of file GAMGAgglomerateLduAddressing.C.

References UList< T >::back(), UList< T >::empty(), UList< T >::first(), forAll, globalIndex::gather(), globalIndex::listGatherValues(), UPstream::msgType(), UPstream::myProcNo(), nCells_, UPstream::nonBlocking, List< T >::resize(), restrictAddressing_, UPstream::scheduled, size(), and UList< T >::size().

Referenced by procAgglomerateLduAddressing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const GAMGAgglomeration & )

protecteddelete

No copy assignment.

References GAMGAgglomeration().

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.

References controlDict(), GAMGAgglomeration(), and MeshObject< lduMesh, MoveableMeshObject, GAMGAgglomeration >::mesh().

Here is the call graph for this function:

◆ 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.

References controlDict(), and GAMGAgglomeration().

Here is the call graph for this function:

◆ 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.

References controlDict(), GAMGAgglomeration(), and MeshObject< lduMesh, MoveableMeshObject, GAMGAgglomeration >::mesh().

Here is the call graph for this function:

◆ New() [1/3]

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

static

Return the selected geometric agglomerator.

Definition at line 306 of file GAMGAgglomeration.C.

References controlDict(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, GAMGAgglomeration(), MeshObject< lduMesh, MoveableMeshObject, GAMGAgglomeration >::mesh(), New(), printLevels(), requireUpdate_, and regIOobject::store().

Referenced by decompositionGAMGAgglomeration::decompositionGAMGAgglomeration(), decompositionGAMGAgglomeration::decompositionGAMGAgglomeration(), GAMGAgglomeration(), New(), New(), and New().

Here is the call graph for this function:

Here is the caller 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 373 of file GAMGAgglomeration.C.

References controlDict(), GAMGAgglomeration(), lduMatrix::mesh(), MeshObject< lduMesh, MoveableMeshObject, GAMGAgglomeration >::mesh(), New(), Foam::New(), printLevels(), requireUpdate_, and regIOobject::store().

Here is the call graph for this function:

◆ New() [3/3]

const Foam::GAMGAgglomeration & New	(	const lduMesh &	mesh,
		const scalarField &	cellVolumes,
		const vectorField &	faceAreas,
		const dictionary &	controlDict )

static

Return the selected geometric agglomerator.

Definition at line 434 of file GAMGAgglomeration.C.

References controlDict(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, GAMGAgglomeration(), Time::libs(), MeshObject< lduMesh, MoveableMeshObject, GAMGAgglomeration >::mesh(), New(), dlLibraryTable::open(), printLevels(), requireUpdate_, regIOobject::store(), and IOobject::time().

Here is the call graph for this function:

◆ movePoints()

bool movePoints ( )

virtual

Update when the mesh moves.

Implements MoveableMeshObject< Mesh >.

Reimplemented in algebraicPairGAMGAgglomeration, and faceAreaPairGAMGAgglomeration.

Definition at line 524 of file GAMGAgglomeration.C.

References requiresUpdate(), and requireUpdate_.

Referenced by algebraicPairGAMGAgglomeration::movePoints(), and faceAreaPairGAMGAgglomeration::movePoints().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ size()

label size ( ) const

inline

Definition at line 465 of file GAMGAgglomeration.H.

References meshLevels_.

Referenced by MGridGenGAMGAgglomeration::agglomerate(), pairGAMGAgglomeration::agglomerate(), assemblyFaceAreaPairGAMGAgglomeration::assemblyFaceAreaPairGAMGAgglomeration(), dummyAgglomeration::dummyAgglomeration(), faceAreaPairGAMGAgglomeration::movePoints(), printLevels(), GAMGProcAgglomeration::printStats(), procAgglomerateRestrictAddressing(), and oversetFvMeshBase::writeAgglomeration().

Here is the caller graph for this function:

◆ meshLevel()

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

Return LDU mesh of given level.

Definition at line 535 of file GAMGAgglomeration.C.

References MeshObject< lduMesh, MoveableMeshObject, GAMGAgglomeration >::mesh_, and meshLevels_.

Referenced by decompositionGAMGAgglomeration::agglomerate(), MGridGenGAMGAgglomeration::agglomerate(), pairGAMGAgglomeration::agglomerate(), agglomerateLduAddressing(), faceAreaPairGAMGAgglomeration::movePoints(), printLevels(), and GAMGProcAgglomeration::printStats().

Here is the caller graph for this function:

◆ hasMeshLevel()

bool hasMeshLevel ( const label leveli ) const

Do we have mesh for given level?

Definition at line 551 of file GAMGAgglomeration.C.

References meshLevels_.

Referenced by decompositionGAMGAgglomeration::agglomerate(), pairGAMGAgglomeration::agglomerate(), clearLevel(), printLevels(), 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 564 of file GAMGAgglomeration.C.

References meshInterfaces_, and meshLevels_.

Referenced by agglomerateLduAddressing(), and faceAreaPairGAMGAgglomeration::movePoints().

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 491 of file GAMGAgglomeration.H.

References restrictAddressing_.

Referenced by agglomerateLduAddressing(), faceAreaPairGAMGAgglomeration::movePoints(), GAMGProcAgglomeration::printStats(), and oversetFvMeshBase::writeAgglomeration().

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 499 of file GAMGAgglomeration.H.

References 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 504 of file GAMGAgglomeration.H.

References 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 513 of file GAMGAgglomeration.H.

References faceFlipMap_.

Referenced by 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 521 of file GAMGAgglomeration.H.

References nCells_.

Referenced by decompositionGAMGAgglomeration::localCellCells(), printLevels(), 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 529 of file GAMGAgglomeration.H.

References 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 538 of file GAMGAgglomeration.H.

References nPatchFaces_.

Referenced by agglomerateLduAddressing().

Here is the caller graph for this function:

◆ restrictField() [1/2]

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.

Definition at line 46 of file GAMGAgglomerationTemplates.C.

References Foam::abort(), agglomProcIDs(), cellOffsets(), Foam::FatalError, FatalErrorInFunction, globalIndex::gatherInplace(), hasProcMesh(), UPstream::msgType(), nCells_, UPstream::nonBlocking, UPstream::parent(), procCommunicator_, List< T >::resize_nocopy(), restrictAddressing_, restrictField(), and UList< T >::size().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ restrictFaceField()

template<class Type>

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

Restrict (integrate by summation) face field.

Definition at line 94 of file GAMGAgglomerationTemplates.C.

References Foam::abort(), faceRestrictAddressing_, Foam::FatalError, FatalErrorInFunction, forAll, UList< T >::size(), and Foam::Zero.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ restrictField() [2/2]

template<class Type>

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

Restrict (integrate by summation) cell field.

Definition at line 29 of file GAMGAgglomerationTemplates.C.

References forAll, and Foam::Zero.

◆ prolongField() [1/3]

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.

Definition at line 127 of file GAMGAgglomerationTemplates.C.

References agglomProcIDs(), cellOffsets(), forAll, hasProcMesh(), UPstream::msgType(), nCells_, UPstream::nonBlocking, UPstream::parent(), procCommunicator_, restrictAddressing_, and globalIndex::scatter().

Here is the call graph for this function:

◆ prolongField() [2/3]

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.

to (potentially scattered) coarse field

References agglomProcIDs(), and procAgglomMap().

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 750 of file GAMGAgglomerateLduAddressing.C.

References agglomProcIDs(), HashTable< T, Key, Hash >::find(), Foam::findIndices(), forAll, forAllConstIters, HashTable< T, Key, Hash >::insert(), Foam::min(), UPstream::myProcNo(), procAgglomMap(), List< T >::setSize(), and HashTable< T, Key, Hash >::size().

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 632 of file GAMGAgglomeration.H.

References procAgglomeratorPtr_.

Referenced by decompositionGAMGAgglomeration::agglomerate(), pairGAMGAgglomeration::agglomerate(), compactLevels(), GAMGAgglomeration(), faceAreaPairGAMGAgglomeration::movePoints(), and printLevels().

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 600 of file GAMGAgglomeration.C.

References procAgglomMap_.

Referenced by calculateRegionMaster(), procAgglomerateLduAddressing(), and prolongField().

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 609 of file GAMGAgglomeration.C.

References agglomProcIDs_.

Referenced by calculateRegionMaster(), prolongField(), prolongField(), prolongField(), and restrictField().

Here is the caller graph for this function:

◆ hasProcMesh()

bool hasProcMesh ( const label fineLeveli ) const

Check that level has combined mesh.

Definition at line 618 of file GAMGAgglomeration.C.

References procCommunicator_.

Referenced by prolongField(), prolongField(), and restrictField().

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 624 of file GAMGAgglomeration.C.

References procCommunicator_.

◆ agglomCommunicator()

Foam::label agglomCommunicator ( const label fineLeveli ) const

Communicator for collecting contributions.

Definition at line 630 of file GAMGAgglomeration.C.

References procAgglomCommunicator_.

Referenced by procAgglomerateLduAddressing().

Here is the caller graph for this function:

◆ cellOffsets()

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

Mapping from processor to procMesh cells.

Definition at line 636 of file GAMGAgglomeration.C.

References procCellOffsets_.

Referenced by prolongField(), prolongField(), and restrictField().

Here is the caller graph for this function:

◆ faceMap()

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

Mapping from processor to procMesh face.

Definition at line 645 of file GAMGAgglomeration.C.

References procFaceMap_.

◆ boundaryMap()

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

Mapping from processor to procMesh boundary.

Definition at line 654 of file GAMGAgglomeration.C.

References procBoundaryMap_.

◆ boundaryFaceMap()

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

Mapping from processor to procMesh boundary face.

Definition at line 663 of file GAMGAgglomeration.C.

References procBoundaryFaceMap_.

◆ agglomerate()

virtual void agglomerate	(	const label	nCellsInCoarsestLevel,
		const label	startLevel,
		const scalarField &	startFaceWeights,
		const bool	doProcessorAgglomerate = true )

pure virtual

Agglomerate from a starting level. Starting level is usually 0 (initial mesh) but sometimes >0 (restarting after processor agglomeration).

Implemented in decompositionGAMGAgglomeration, dummyAgglomeration, MGridGenGAMGAgglomeration, and pairGAMGAgglomeration.

◆ checkRestriction()

bool checkRestriction	(	labelList &	newRestrict,
		label &	nNewCoarse,
		const lduAddressing &	fineAddressing,
		const labelUList &	restriction,
		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 672 of file GAMGAgglomeration.C.

References Foam::abort(), List< T >::append(), Foam::FatalError, FatalErrorInFunction, UList< T >::find(), forAll, UList< T >::found(), Foam::identity(), lduAddressing::lowerAddr(), List< T >::setSize(), lduAddressing::size(), UList< T >::size(), and lduAddressing::upperAddr().

Here is the call graph for this function:

◆ prolongField() [3/3]

template<class Type>

const Foam::Field< Type > & prolongField	(	Field< Type > &	ff,
		Field< Type > &	allCf,
		const Field< Type > &	cf,
		const label	levelIndex ) const

Definition at line 177 of file GAMGAgglomerationTemplates.C.

References agglomProcIDs(), cellOffsets(), forAll, hasProcMesh(), UPstream::msgType(), nCells_, UPstream::nonBlocking, UPstream::parent(), procCommunicator_, List< T >::resize_nocopy(), restrictAddressing_, and globalIndex::scatter().

Here is the call graph for this function:

◆ GAMGProcAgglomeration

friend class GAMGProcAgglomeration

friend

Declare friendship with GAMGProcAgglomeration.

Definition at line 334 of file GAMGAgglomeration.H.

References GAMGProcAgglomeration.

Referenced by GAMGAgglomeration(), and GAMGProcAgglomeration.

Member Data Documentation

◆ maxLevels_

const label maxLevels_

protected

Max number of levels.

Definition at line 104 of file GAMGAgglomeration.H.

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

◆ updateInterval_

const label updateInterval_

protected

Update agglomeration every updateInterval_ steps.

Definition at line 109 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration(), and requiresUpdate().

◆ requireUpdate_

bool requireUpdate_

mutableprotected

Does agglomeration require update.

Definition at line 114 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration(), algebraicPairGAMGAgglomeration::movePoints(), faceAreaPairGAMGAgglomeration::movePoints(), movePoints(), New(), New(), and New().

◆ nCellsInCoarsestLevel_

label nCellsInCoarsestLevel_

protected

Number of cells in coarsest level.

Definition at line 119 of file GAMGAgglomeration.H.

◆ meshInterfaces_

const lduInterfacePtrsList meshInterfaces_

protected

Cached mesh interfaces.

Definition at line 124 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration(), and interfaceLevel().

◆ procAgglomeratorPtr_

autoPtr<GAMGProcAgglomeration> procAgglomeratorPtr_

protected

Definition at line 126 of file GAMGAgglomeration.H.

Referenced by compactLevels(), GAMGAgglomeration(), printLevels(), and processorAgglomerate().

◆ nCells_

labelList nCells_

protected

The number of cells in each level.

Definition at line 131 of file GAMGAgglomeration.H.

Referenced by decompositionGAMGAgglomeration::agglomerate(), MGridGenGAMGAgglomeration::agglomerate(), pairGAMGAgglomeration::agglomerate(), agglomerateLduAddressing(), clearLevel(), combineLevels(), compactLevels(), dummyAgglomeration::dummyAgglomeration(), GAMGAgglomeration(), nCells(), procAgglomerateRestrictAddressing(), prolongField(), prolongField(), and restrictField().

◆ restrictAddressing_

PtrList<labelField> restrictAddressing_

protected

Cell restriction addressing array.

Maps from the finer to the coarser level.

Definition at line 138 of file GAMGAgglomeration.H.

Referenced by decompositionGAMGAgglomeration::agglomerate(), MGridGenGAMGAgglomeration::agglomerate(), pairGAMGAgglomeration::agglomerate(), clearLevel(), combineLevels(), compactLevels(), dummyAgglomeration::dummyAgglomeration(), GAMGAgglomeration(), GAMGProcAgglomeration::printStats(), procAgglomerateRestrictAddressing(), prolongField(), prolongField(), restrictAddressing(), and restrictField().

◆ nFaces_

labelList nFaces_

protected

The number of (coarse) faces in each level.

max(faceRestrictAddressing)+1.

Definition at line 145 of file GAMGAgglomeration.H.

Referenced by decompositionGAMGAgglomeration::agglomerate(), pairGAMGAgglomeration::agglomerate(), agglomerateLduAddressing(), clearLevel(), combineLevels(), compactLevels(), GAMGAgglomeration(), and 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 156 of file GAMGAgglomeration.H.

Referenced by decompositionGAMGAgglomeration::agglomerate(), pairGAMGAgglomeration::agglomerate(), agglomerateLduAddressing(), clearLevel(), combineLevels(), compactLevels(), faceRestrictAddressing(), GAMGAgglomeration(), and restrictFaceField().

◆ 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 164 of file GAMGAgglomeration.H.

Referenced by decompositionGAMGAgglomeration::agglomerate(), pairGAMGAgglomeration::agglomerate(), agglomerateLduAddressing(), clearLevel(), combineLevels(), compactLevels(), faceFlipMap(), and GAMGAgglomeration().

◆ nPatchFaces_

PtrList<labelList> nPatchFaces_

protected

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

max(patchFaceRestrictAddressing_)+1.

Definition at line 171 of file GAMGAgglomeration.H.

Referenced by decompositionGAMGAgglomeration::agglomerate(), pairGAMGAgglomeration::agglomerate(), agglomerateLduAddressing(), clearLevel(), combineLevels(), compactLevels(), GAMGAgglomeration(), and nPatchFaces().

◆ 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 179 of file GAMGAgglomeration.H.

Referenced by decompositionGAMGAgglomeration::agglomerate(), pairGAMGAgglomeration::agglomerate(), agglomerateLduAddressing(), clearLevel(), combineLevels(), compactLevels(), GAMGAgglomeration(), and patchFaceRestrictAddressing().

◆ meshLevels_

PtrList<lduPrimitiveMesh> meshLevels_

protected

Hierarchy of mesh addressing.

Definition at line 184 of file GAMGAgglomeration.H.

Referenced by decompositionGAMGAgglomeration::agglomerate(), MGridGenGAMGAgglomeration::agglomerate(), pairGAMGAgglomeration::agglomerate(), agglomerateLduAddressing(), clearLevel(), combineLevels(), compactLevels(), GAMGAgglomeration(), hasMeshLevel(), interfaceLevel(), meshLevel(), faceAreaPairGAMGAgglomeration::movePoints(), procAgglomerateLduAddressing(), and size().

◆ procAgglomMap_

PtrList<labelList> procAgglomMap_

mutableprotected

Per level, per processor the processor it agglomerates into.

Definition at line 192 of file GAMGAgglomeration.H.

Referenced by decompositionGAMGAgglomeration::agglomerate(), pairGAMGAgglomeration::agglomerate(), compactLevels(), GAMGAgglomeration(), GAMGProcAgglomeration::printStats(), procAgglomerateLduAddressing(), and procAgglomMap().

◆ agglomProcIDs_

PtrList<labelList> agglomProcIDs_

mutableprotected

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

the 'master' of the cluster.

Definition at line 199 of file GAMGAgglomeration.H.

Referenced by decompositionGAMGAgglomeration::agglomerate(), pairGAMGAgglomeration::agglomerate(), agglomProcIDs(), compactLevels(), GAMGAgglomeration(), GAMGProcAgglomeration::printStats(), and procAgglomerateLduAddressing().

◆ procCommunicator_

labelList procCommunicator_

mutableprotected

Communicator for given level.

Definition at line 204 of file GAMGAgglomeration.H.

Referenced by decompositionGAMGAgglomeration::agglomerate(), pairGAMGAgglomeration::agglomerate(), compactLevels(), GAMGAgglomeration(), hasProcMesh(), GAMGProcAgglomeration::printStats(), procAgglomerateLduAddressing(), procCommunicator(), prolongField(), prolongField(), and restrictField().

◆ procAgglomCommunicator_

PtrList<UPstream::communicator> procAgglomCommunicator_

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 212 of file GAMGAgglomeration.H.

Referenced by agglomCommunicator(), compactLevels(), GAMGAgglomeration(), and procAgglomerateLduAddressing().

◆ procCellOffsets_

PtrList<labelList> procCellOffsets_

mutableprotected

Mapping from processor to procMeshLevel cells.

Definition at line 217 of file GAMGAgglomeration.H.

Referenced by decompositionGAMGAgglomeration::agglomerate(), pairGAMGAgglomeration::agglomerate(), cellOffsets(), compactLevels(), GAMGAgglomeration(), GAMGProcAgglomeration::printStats(), and procAgglomerateLduAddressing().

◆ procFaceMap_

PtrList<labelListList> procFaceMap_

mutableprotected

Mapping from processor to procMeshLevel face.

Definition at line 222 of file GAMGAgglomeration.H.

Referenced by decompositionGAMGAgglomeration::agglomerate(), pairGAMGAgglomeration::agglomerate(), compactLevels(), faceMap(), GAMGAgglomeration(), and procAgglomerateLduAddressing().

◆ procBoundaryMap_

PtrList<labelListList> procBoundaryMap_

mutableprotected

Mapping from processor to procMeshLevel boundary.

Definition at line 227 of file GAMGAgglomeration.H.

Referenced by decompositionGAMGAgglomeration::agglomerate(), pairGAMGAgglomeration::agglomerate(), boundaryMap(), compactLevels(), GAMGAgglomeration(), and procAgglomerateLduAddressing().

◆ procBoundaryFaceMap_

PtrList<labelListListList> procBoundaryFaceMap_

mutableprotected

Mapping from processor to procMeshLevel boundary face.

Definition at line 232 of file GAMGAgglomeration.H.

Referenced by decompositionGAMGAgglomeration::agglomerate(), pairGAMGAgglomeration::agglomerate(), boundaryFaceMap(), compactLevels(), GAMGAgglomeration(), and procAgglomerateLduAddressing().

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

src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/GAMGAgglomerations/GAMGAgglomeration/GAMGAgglomeration.H
src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/GAMGAgglomerations/GAMGAgglomeration/GAMGAgglomerateLduAddressing.C
src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/GAMGAgglomerations/GAMGAgglomeration/GAMGAgglomeration.C
src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/GAMGAgglomerations/GAMGAgglomeration/GAMGAgglomerationTemplates.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GAMGAgglomeration() [1/2]

◆ GAMGAgglomeration() [2/2]

◆ ~GAMGAgglomeration()

Member Function Documentation

◆ requiresUpdate()

◆ agglomerateLduAddressing()

◆ combineLevels()

◆ compactLevels()

◆ continueAgglomerating()

◆ clearLevel()

◆ printLevels()

◆ procAgglomerateLduAddressing()

◆ procAgglomerateRestrictAddressing()

◆ operator=()

◆ TypeName()

◆ declareRunTimeSelectionTable() [1/3]

◆ declareRunTimeSelectionTable() [2/3]

◆ declareRunTimeSelectionTable() [3/3]

◆ New() [1/3]

◆ New() [2/3]

◆ New() [3/3]

◆ movePoints()

◆ size()

◆ meshLevel()

◆ hasMeshLevel()

◆ interfaceLevel()

◆ restrictAddressing()

◆ faceRestrictAddressing()

◆ patchFaceRestrictAddressing()

◆ faceFlipMap()

◆ nCells()

◆ nFaces()

◆ nPatchFaces()

◆ restrictField() [1/2]

◆ restrictFaceField()

◆ restrictField() [2/2]

◆ prolongField() [1/3]

◆ prolongField() [2/3]

◆ calculateRegionMaster()

◆ processorAgglomerate()

◆ procAgglomMap()

◆ agglomProcIDs()

◆ hasProcMesh()

◆ procCommunicator()

◆ agglomCommunicator()

◆ cellOffsets()

◆ faceMap()

◆ boundaryMap()

◆ boundaryFaceMap()

◆ agglomerate()

◆ checkRestriction()

◆ prolongField() [3/3]

Friends And Related Symbol Documentation

◆ GAMGProcAgglomeration

Member Data Documentation

◆ maxLevels_

◆ updateInterval_

◆ requireUpdate_

◆ nCellsInCoarsestLevel_

◆ meshInterfaces_

◆ procAgglomeratorPtr_

◆ nCells_

◆ restrictAddressing_

◆ nFaces_

◆ faceRestrictAddressing_

◆ faceFlipMap_

◆ nPatchFaces_

◆ patchFaceRestrictAddressing_

◆ meshLevels_

◆ procAgglomMap_

◆ agglomProcIDs_

◆ procCommunicator_