Geometric agglomerated algebraic multigrid agglomeration class. More...

Inheritance diagram for GAMGAgglomeration:

[legend]

Collaboration diagram for GAMGAgglomeration:

[legend]

Public Member Functions
	TypeName ("GAMGAgglomeration")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, GAMGAgglomeration, lduMesh,(const lduMesh &mesh, const dictionary &controlDict),(mesh, controlDict))
	Runtime selection table for pure geometric agglomerators. More...

	declareRunTimeSelectionTable (autoPtr, GAMGAgglomeration, lduMatrix,(const lduMatrix &matrix, const dictionary &controlDict),(matrix, controlDict))
	Runtime selection table for matrix or mixed geometric/matrix. More...

	declareRunTimeSelectionTable (autoPtr, GAMGAgglomeration, geometry,(const lduMesh &mesh, const scalarField &cellVolumes, const vectorField &faceAreas, const dictionary &controlDict),(mesh, cellVolumes, faceAreas, controlDict))
	Runtime selection table for matrix or mixed geometric/matrix. More...

	GAMGAgglomeration (const lduMesh &mesh, const dictionary &controlDict)
	Construct given mesh and controls. More...

	GAMGAgglomeration (const GAMGAgglomeration &)=delete
	Disallow default bitwise copy construction. More...

	~GAMGAgglomeration ()
	Destructor. More...

label	size () const

const 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. More...

template<class Type >
void	restrictField (Field< Type > &cf, const Field< Type > &ff, const label fineLevelIndex, const bool procAgglom) const
	Restrict (integrate by summation) cell field. More...

template<class Type >
void	restrictFaceField (Field< Type > &cf, const Field< Type > &ff, const label fineLevelIndex) const
	Restrict (integrate by summation) face field. More...

template<class Type >
void	restrictField (Field< Type > &cf, const Field< Type > &ff, const labelList &fineToCoarse) const
	Restrict (integrate by summation) cell field. More...

template<class Type >
void	prolongField (Field< Type > &ff, const Field< Type > &cf, const label coarseLevelIndex, const bool procAgglom) const
	Prolong (interpolate by injection) cell field. More...

bool	processorAgglomerate () const
	Whether to agglomerate across processors. More...

const labelList &	procAgglomMap (const label fineLeveli) const
	Mapping from processor to agglomerated processor (global, all. More...

const labelList &	agglomProcIDs (const label fineLeveli) const
	Set of processors to agglomerate. Element 0 is the. More...

bool	hasProcMesh (const label fineLeveli) const
	Check that level has combined mesh. More...

label	procCommunicator (const label fineLeveli) const
	Communicator for current level or -1. More...

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

void	operator= (const GAMGAgglomeration &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from MeshObject< lduMesh, GeometricMeshObject, GAMGAgglomeration >
	MeshObject (const lduMesh &mesh)

	MeshObject (const lduMesh &mesh, const IOobject &io)

virtual	~MeshObject ()

const lduMesh &	mesh () const

virtual bool	writeData (Foam::Ostream &) const

Public Member Functions inherited from GeometricMeshObject< lduMesh >
	GeometricMeshObject (const word &typeName, const objectRegistry &obr)

	GeometricMeshObject (const word &typeName, const IOobject &io)

Public Member Functions inherited from TopologicalMeshObject< lduMesh >
	TopologicalMeshObject (const word &typeName, const objectRegistry &obr)

	TopologicalMeshObject (const word &typeName, const IOobject &io)

Public Member Functions inherited from meshObject
	ClassName ("meshObject")

	meshObject (const word &typeName, const objectRegistry &obr)

	meshObject (const word &typeName, const IOobject &io)

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the. More...

	regIOobject (const regIOobject &)
	Copy constructor. More...

	regIOobject (const regIOobject &&)
	Move constructor. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Copy constructor, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy constructor with new name, transferring registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Copy constructor with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

virtual bool	global () const
	Return true if object is global, i.e. same for all processors. More...

virtual bool	globalFile () const
	Return true if object is global, i.e. same for all processors. More...

const fileName &	caseName () const

fileName	path () const
	Return complete path. More...

fileName	objectPath () const
	Return complete path + object name. More...

fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	checkIn ()
	Add object to registry. More...

bool	checkOut ()
	Remove object from registry. More...

void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	registered () const
	Is this object registered with the registry? More...

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

void	store ()
	Transfer ownership of this object to its registry. More...

void	release ()
	Release ownership of this object from its registry. More...

label	eventNo () const
	Event number at last update. More...

label &	eventNo ()
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set up to date (obviously) More...

virtual void	rename (const word &newName)
	Rename. More...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool read=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual bool	readData (Istream &)
	Virtual readData function. More...

virtual bool	read ()
	Read object. More...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) More...

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
	Write using given format, version and compression. More...

virtual bool	write (const bool write=true) const
	Write using setting from DB. More...

void	operator= (const IOobject &)

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Runtime type information. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Construct from copy resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Construct from copy resetting name. More...

	IOobject (const IOobject &io)=default
	Copy constructor. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

virtual	~IOobject ()
	Destructor. More...

const Time &	time () const
	Return time. More...

const objectRegistry &	db () const
	Return the local objectRegistry. More...

const word &	name () const
	Return name. More...

const word &	headerClassName () const
	Return name of the class name read from header. More...

word &	headerClassName ()
	Return name of the class name read from header. More...

string &	note ()
	Return non-constant access to the optional note. More...

const string &	note () const
	Return the optional note. More...

bool &	registerObject ()
	Register object created from this IOobject with registry if true. More...

bool	registerObject () const
	Register object created from this IOobject with registry if true. More...

readOption	readOpt () const

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

word	modelName (const char *name) const
	Return the name of the object within this model. More...

const fileName &	rootPath () const

const fileName &	caseName (const bool global) const

fileName &	instance () const
	Return the instance directory, constant, system, <time> etc. More...

void	updateInstance () const
	If the instance is a time directory update to the current time. More...

const fileName &	local () const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	relativePath () const
	Return the path relative to the case directory. More...

fileName	relativeObjectPath () const
	Return complete relativePath + object name. More...

fileName	filePath (const word &typeName, const bool global) const
	Return complete path + object name if the file exists. More...

bool	readHeader (Istream &)
	Read header. More...

bool	headerOk ()
	Read header of local object without type-checking. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &) const
	Write header. More...

bool	writeHeader (Ostream &, const word &objectType) const
	Write header. Allow override of type. More...

bool	good () const

bool	bad () const

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &)

template<class Name >
Foam::word	groupName (Name name, const word &group)

template<class Name >
Foam::word	modelName (Name name, const word &model)

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 autoPtr< 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 &restrict, const label nCoarse)
	Given restriction determines if coarse cells are connected. More...

Static Public Member Functions inherited from MeshObject< lduMesh, GeometricMeshObject, GAMGAgglomeration >
static GAMGAgglomeration &	New (lduMesh &mesh)

static const GAMGAgglomeration &	New (const lduMesh &mesh)

static GAMGAgglomeration &	New (lduMesh &mesh, const Args &... args)

static const GAMGAgglomeration &	New (const lduMesh &mesh, const Args &... args)

static bool	Delete (const lduMesh &mesh)

static bool	found (const lduMesh &mesh)
	Return true if this MeshObject is found in the mesh registry. More...

Static Public Member Functions inherited from meshObject
template<class Mesh >
static void	movePoints (objectRegistry &)

template<class Mesh >
static void	topoChange (objectRegistry &, const polyTopoChangeMap &)

template<class Mesh >
static void	mapMesh (objectRegistry &, const polyMeshMap &)

template<class Mesh >
static void	distribute (objectRegistry &, const polyDistributionMap &)

template<class Mesh >
static void	addPatch (objectRegistry &, const label patchi)

template<class Mesh >
static void	reorderPatches (objectRegistry &, const labelUList &newToOld, const bool validBoundary)

template<class Mesh , template< class > class MeshObjectType>
static void	clear (objectRegistry &)

template<class Mesh , template< class > class FromType, template< class > class ToType>
static void	clearUpto (objectRegistry &)
	Clear all meshObject derived from FromType up to (but not including) More...

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *)
	Transfer ownership of the given object pointer to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &)
	Transfer ownership of the given object pointer to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class Name >
static word	groupName (Name name, const word &group)

static word	group (const word &name)
	Return group (extension part of name) More...

static word	member (const word &name)
	Return member (name without the extension) More...

template<class Name >
static word	modelName (Name name, const word &model)
	Return the name of the object within the given model. More...

template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider. More...

template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider. More...

Protected Member Functions
void	agglomerateLduAddressing (const label fineLevelIndex)
	Assemble coarse mesh addressing. More...

void	combineLevels (const label curLevel)
	Combine a level with the previous one. More...

void	compactLevels (const label nCreatedLevels)
	Shrink the number of levels to that specified. More...

bool	continueAgglomerating (const label nCells, const label nCoarseCells) const
	Check the need for further agglomeration. More...

void	clearLevel (const label leveli)

void	procAgglomerateLduAddressing (const label comm, const labelList &procAgglomMap, const labelList &procIDs, const label allMeshComm, const label levelIndex)
	Collect and combine processor meshes into allMesh: More...

void	procAgglomerateRestrictAddressing (const label comm, const labelList &procIDs, const label levelIndex)
	Collect and combine basic restriction addressing: More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
	Read header, check readOpt flags and read data if necessary. More...

Protected Member Functions inherited from IOobject
void	setBad (const string &)
	Set the object state to bad. More...

template<class Type >
bool	typeHeaderOk (const bool checkType)
	Read header using typeGlobalFile to find file. More...

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

Protected Attributes
const label	maxLevels_
	Max number of levels. More...

const label	nCellsInCoarsestLevel_
	Number of cells in coarsest level. More...

const lduInterfacePtrsList	meshInterfaces_
	Cached mesh interfaces. More...

autoPtr< 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< 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_

Friends
class	GAMGProcAgglomeration
	Declare friendship with GAMGProcAgglomeration. More...

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
	Enumeration defining the read options. More...

enum	writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
	Enumeration defining the write options. More...

enum	fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Enumeration defining the file checking options. More...

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static constexpr const char *	foamFile = "FoamFile"
	Keyword for the FoamFile header sub-dictionary. More...

static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

Detailed Description

Geometric agglomerated algebraic multigrid agglomeration class.

Source files

Definition at line 61 of file GAMGAgglomeration.H.

Constructor & Destructor Documentation

◆ GAMGAgglomeration() [1/2]

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

Construct given mesh and controls.

Definition at line 229 of file GAMGAgglomeration.C.

References GAMGAgglomeration::New().

Referenced by GAMGAgglomeration::continueAgglomerating().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GAMGAgglomeration() [2/2]

GAMGAgglomeration ( const GAMGAgglomeration & )

delete

Disallow default bitwise copy construction.

◆ ~GAMGAgglomeration()

~GAMGAgglomeration ( )

Destructor.

Definition at line 436 of file GAMGAgglomeration.C.

References GAMGAgglomeration::meshLevel().

Here is the call graph for this function:

Member Function Documentation

◆ agglomerateLduAddressing()

void agglomerateLduAddressing ( const label fineLevelIndex )

protected

Assemble coarse mesh addressing.

Definition at line 33 of file GAMGAgglomerateLduAddressing.C.

References Foam::abort(), lduMesh::comm(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, forAllReverse, lduMesh::lduAddr(), lduAddressing::lowerAddr(), Foam::min(), Foam::compressible::New(), Foam::Pout, GAMGAgglomeration::procAgglomerateLduAddressing(), UPtrList< T >::set(), List< T >::setSize(), UPtrList< T >::size(), List< T >::size(), lduAddressing::size(), UList< T >::size(), and lduAddressing::upperAddr().

Here is the call graph for this function:

◆ combineLevels()

void combineLevels ( const label curLevel )

protected

Combine a level with the previous one.

Definition at line 522 of file GAMGAgglomerateLduAddressing.C.

References GAMGAgglomeration::calculateRegionMaster(), GAMGInterface::combine(), GAMGAgglomeration::faceFlipMap_, GAMGAgglomeration::faceRestrictAddressing_, forAll, GAMGAgglomeration::meshLevels_, GAMGAgglomeration::nCells_, GAMGAgglomeration::nFaces_, GAMGAgglomeration::nPatchFaces_, GAMGAgglomeration::patchFaceRestrictAddressing_, GAMGAgglomeration::restrictAddressing_, and UPtrList< T >::set().

Here is the call graph for this function:

◆ compactLevels()

void compactLevels ( const label nCreatedLevels )

protected

Shrink the number of levels to that specified.

Definition at line 48 of file GAMGAgglomeration.C.

References lduAddressing::band(), GAMGAgglomeration::continueAgglomerating(), Foam::endl(), forAll, Foam::Info, lduMesh::interfaces(), lduMesh::lduAddr(), lduAddressing::lowerAddr(), Foam::nl, Foam::returnReduce(), Foam::setw(), lduAddressing::size(), UList< T >::size(), and Foam::type().

Here is the call graph for this function:

◆ continueAgglomerating()

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

protected

Check the need for further agglomeration.

Definition at line 208 of file GAMGAgglomeration.C.

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

Referenced by GAMGAgglomeration::compactLevels().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gatherList()

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

staticprotected

Gather value from all procIDs onto procIDs[0].

Definition at line 34 of file GAMGAgglomerationTemplates.C.

References GAMGAgglomeration::restrictField(), List< T >::setSize(), and List< T >::size().

Here is the call graph for this function:

◆ clearLevel()

void clearLevel ( const label leveli )

protected

Definition at line 487 of file GAMGAgglomeration.C.

References GAMGAgglomeration::procAgglomMap().

Here is the call 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 365 of file GAMGAgglomerateLduAddressing.C.

References GAMGAgglomeration::procAgglomerateRestrictAddressing().

Referenced by GAMGAgglomeration::agglomerateLduAddressing().

Here is the call graph for this function:

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

References forAll, globalIndex::gather(), UList< T >::last(), and List< T >::size().

Referenced by GAMGAgglomeration::procAgglomerateLduAddressing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "GAMGAgglomeration" )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/3]

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

Runtime selection table for pure geometric agglomerators.

◆ declareRunTimeSelectionTable() [2/3]

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

Runtime selection table for matrix or mixed geometric/matrix.

agglomerators

◆ declareRunTimeSelectionTable() [3/3]

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

Runtime selection table for matrix or mixed geometric/matrix.

agglomerators

◆ New() [1/3]

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

static

Return the selected geometric agglomerator.

Definition at line 282 of file GAMGAgglomeration.C.

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

Referenced by GAMGAgglomeration::GAMGAgglomeration(), and GAMGAgglomeration::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 335 of file GAMGAgglomeration.C.

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

Here is the call graph for this function:

◆ New() [3/3]

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

static

Return the selected geometric agglomerator.

Definition at line 389 of file GAMGAgglomeration.C.

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

Here is the call graph for this function:

◆ size()

label size ( ) const

inline

Definition at line 318 of file GAMGAgglomeration.H.

References GAMGAgglomeration::hasMeshLevel(), GAMGAgglomeration::interfaceLevel(), GAMGAgglomeration::meshLevel(), and UPtrList< T >::size().

Referenced by GAMGProcAgglomeration::printStats().

Here is the call graph for this function:

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

Referenced by GAMGProcAgglomeration::printStats(), GAMGAgglomeration::size(), and GAMGAgglomeration::~GAMGAgglomeration().

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

References GAMGAgglomeration::interfaceLevel().

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

Here is the call graph for this function:

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

Referenced by GAMGAgglomeration::hasMeshLevel(), and GAMGAgglomeration::size().

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

Referenced by GAMGProcAgglomeration::printStats(), and GAMGSolver::solve().

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

Referenced by GAMGProcAgglomeration::printStats().

Here is the caller graph for this function:

◆ patchFaceRestrictAddressing()

const labelListList& patchFaceRestrictAddressing ( const label leveli ) const

inline

Definition at line 347 of file GAMGAgglomeration.H.

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

◆ nCells()

label nCells ( const label leveli ) const

inline

Return number of coarse cells (before processor agglomeration)

Definition at line 360 of file GAMGAgglomeration.H.

Referenced by GAMGProcAgglomeration::printStats(), and GAMGSolver::solve().

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

References GAMGAgglomeration::agglomProcIDs(), GAMGAgglomeration::calculateRegionMaster(), Foam::fv::ff(), GAMGAgglomeration::nPatchFaces(), GAMGAgglomeration::procAgglomMap(), GAMGAgglomeration::prolongField(), GAMGAgglomeration::restrictFaceField(), and GAMGAgglomeration::restrictField().

Referenced by GAMGProcAgglomeration::printStats().

Here is the call graph for this function:

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

Referenced by GAMGAgglomeration::nFaces().

Here is the caller graph for this function:

◆ restrictField() [1/2]

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

Restrict (integrate by summation) cell field.

Definition at line 95 of file GAMGAgglomerationTemplates.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, GAMGAgglomeration::restrictFaceField(), List< T >::size(), and List< Type >::size().

Referenced by GAMGAgglomeration::gatherList(), GAMGAgglomeration::nFaces(), GAMGAgglomeration::restrictField(), and GAMGSolver::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ restrictFaceField()

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

Restrict (integrate by summation) face field.

Definition at line 139 of file GAMGAgglomerationTemplates.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, GAMGAgglomeration::prolongField(), List< Type >::size(), List< T >::size(), and Foam::Zero.

Referenced by GAMGAgglomeration::nFaces(), and GAMGAgglomeration::restrictField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ restrictField() [2/2]

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

Restrict (integrate by summation) cell field.

Definition at line 78 of file GAMGAgglomerationTemplates.C.

References forAll, GAMGAgglomeration::restrictField(), and Foam::Zero.

Here is the call graph for this function:

◆ prolongField()

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

Prolong (interpolate by injection) cell field.

Definition at line 172 of file GAMGAgglomerationTemplates.C.

References forAll.

Referenced by GAMGAgglomeration::nFaces(), GAMGAgglomeration::restrictFaceField(), and GAMGSolver::solve().

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

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

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

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

References GAMGAgglomeration::agglomProcIDs(), GAMGAgglomeration::boundaryFaceMap(), GAMGAgglomeration::boundaryMap(), GAMGAgglomeration::cellOffsets(), GAMGAgglomeration::checkRestriction(), GAMGAgglomeration::faceMap(), GAMGAgglomeration::hasProcMesh(), GAMGAgglomeration::operator=(), GAMGAgglomeration::procAgglomMap(), GAMGAgglomeration::procCommunicator(), and autoPtr< T >::valid().

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

References GAMGAgglomeration::agglomProcIDs().

Referenced by GAMGAgglomeration::clearLevel(), GAMGAgglomeration::nFaces(), and GAMGAgglomeration::processorAgglomerate().

Here is the call graph for this function:

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

Referenced by GAMGAgglomeration::nFaces(), GAMGAgglomeration::procAgglomMap(), and GAMGAgglomeration::processorAgglomerate().

Here is the caller graph for this function:

◆ hasProcMesh()

bool hasProcMesh ( const label fineLeveli ) const

Check that level has combined mesh.

Definition at line 525 of file GAMGAgglomeration.C.

Referenced by GAMGAgglomeration::processorAgglomerate().

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

References GAMGAgglomeration::cellOffsets().

Referenced by GAMGAgglomeration::processorAgglomerate().

Here is the call graph for this function:

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

References GAMGAgglomeration::faceMap().

Referenced by GAMGAgglomeration::procCommunicator(), and GAMGAgglomeration::processorAgglomerate().

Here is the call graph for this function:

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

References GAMGAgglomeration::boundaryMap().

Referenced by GAMGAgglomeration::cellOffsets(), and GAMGAgglomeration::processorAgglomerate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ boundaryMap()

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

Mapping from processor to procMesh boundary.

Definition at line 556 of file GAMGAgglomeration.C.

References GAMGAgglomeration::boundaryFaceMap().

Referenced by GAMGAgglomeration::faceMap(), and GAMGAgglomeration::processorAgglomerate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ boundaryFaceMap()

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

Mapping from processor to procMesh boundary face.

Definition at line 565 of file GAMGAgglomeration.C.

References GAMGAgglomeration::checkRestriction().

Referenced by GAMGAgglomeration::boundaryMap(), and GAMGAgglomeration::processorAgglomerate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkRestriction()

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

static

Given restriction determines if coarse cells are connected.

Return ok is so, otherwise creates new restriction that is

Definition at line 574 of file GAMGAgglomeration.C.

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

Referenced by GAMGAgglomeration::boundaryFaceMap(), and GAMGAgglomeration::processorAgglomerate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const GAMGAgglomeration & )

delete

Disallow default bitwise assignment.

Referenced by GAMGAgglomeration::processorAgglomerate().

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ GAMGProcAgglomeration

friend class GAMGProcAgglomeration

friend

Declare friendship with GAMGProcAgglomeration.

Definition at line 208 of file GAMGAgglomeration.H.

Member Data Documentation

◆ maxLevels_

const label maxLevels_

protected

Max number of levels.

Definition at line 70 of file GAMGAgglomeration.H.

◆ nCellsInCoarsestLevel_

const label nCellsInCoarsestLevel_

protected

Number of cells in coarsest level.

Definition at line 73 of file GAMGAgglomeration.H.

◆ meshInterfaces_

const lduInterfacePtrsList meshInterfaces_

protected

Cached mesh interfaces.

Definition at line 76 of file GAMGAgglomeration.H.

◆ procAgglomeratorPtr_

autoPtr<GAMGProcAgglomeration> procAgglomeratorPtr_

protected

Definition at line 78 of file GAMGAgglomeration.H.

◆ nCells_

labelList nCells_

protected

The number of cells in each level.

Definition at line 81 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration::combineLevels().

◆ restrictAddressing_

PtrList<labelField> restrictAddressing_

protected

Cell restriction addressing array.

Maps from the finer to the coarser level.

Definition at line 85 of file GAMGAgglomeration.H.

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

◆ nFaces_

labelList nFaces_

protected

The number of (coarse) faces in each level.

max(faceRestrictAddressing)+1.

Definition at line 89 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration::combineLevels().

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

Referenced by GAMGAgglomeration::combineLevels().

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

Referenced by GAMGAgglomeration::combineLevels().

◆ nPatchFaces_

PtrList<labelList> nPatchFaces_

protected

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

max(patchFaceRestrictAddressing_)+1.

Definition at line 106 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration::combineLevels().

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

Referenced by GAMGAgglomeration::combineLevels().

◆ meshLevels_

PtrList<lduPrimitiveMesh> meshLevels_

protected

Hierarchy of mesh addressing.

Definition at line 114 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration::combineLevels().

◆ procAgglomMap_

PtrList<labelList> procAgglomMap_

mutableprotected

Per level, per processor the processor it agglomerates into.

Definition at line 120 of file GAMGAgglomeration.H.

Referenced by GAMGProcAgglomeration::printStats().

◆ agglomProcIDs_

PtrList<labelList> agglomProcIDs_

mutableprotected

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

the 'master' of the cluster.

Definition at line 124 of file GAMGAgglomeration.H.

Referenced by GAMGProcAgglomeration::printStats().

◆ procCommunicator_

labelList procCommunicator_

mutableprotected

Communicator for given level.

Definition at line 127 of file GAMGAgglomeration.H.

Referenced by GAMGProcAgglomeration::printStats().

◆ procCellOffsets_

PtrList<labelList> procCellOffsets_

mutableprotected

Mapping from processor to procMeshLevel cells.

Definition at line 130 of file GAMGAgglomeration.H.

Referenced by GAMGProcAgglomeration::printStats().

◆ procFaceMap_

PtrList<labelListList> procFaceMap_

mutableprotected

Mapping from processor to procMeshLevel face.

Definition at line 133 of file GAMGAgglomeration.H.

◆ procBoundaryMap_

PtrList<labelListList> procBoundaryMap_

mutableprotected

Mapping from processor to procMeshLevel boundary.

Definition at line 136 of file GAMGAgglomeration.H.

◆ procBoundaryFaceMap_

PtrList<labelListListList> procBoundaryFaceMap_

mutableprotected

Mapping from processor to procMeshLevel boundary face.

Definition at line 139 of file GAMGAgglomeration.H.

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

Static Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GAMGAgglomeration() [1/2]

◆ GAMGAgglomeration() [2/2]

◆ ~GAMGAgglomeration()

Member Function Documentation

◆ agglomerateLduAddressing()

◆ combineLevels()

◆ compactLevels()

◆ continueAgglomerating()

◆ gatherList()

◆ clearLevel()

◆ procAgglomerateLduAddressing()

◆ procAgglomerateRestrictAddressing()

◆ TypeName()

◆ declareRunTimeSelectionTable() [1/3]

◆ declareRunTimeSelectionTable() [2/3]

◆ declareRunTimeSelectionTable() [3/3]

◆ New() [1/3]

◆ New() [2/3]

◆ New() [3/3]

◆ size()

◆ meshLevel()

◆ hasMeshLevel()

◆ interfaceLevel()

◆ restrictAddressing()

◆ faceRestrictAddressing()

◆ patchFaceRestrictAddressing()

◆ faceFlipMap()

◆ nCells()

◆ nFaces()

◆ nPatchFaces()

◆ restrictField() [1/2]

◆ restrictFaceField()

◆ restrictField() [2/2]

◆ prolongField()

◆ calculateRegionMaster()

◆ processorAgglomerate()

◆ procAgglomMap()

◆ agglomProcIDs()

◆ hasProcMesh()

◆ procCommunicator()

◆ cellOffsets()

◆ faceMap()

◆ boundaryMap()

◆ boundaryFaceMap()

◆ checkRestriction()

◆ operator=()

Friends And Related Function Documentation

◆ GAMGProcAgglomeration

Member Data Documentation

◆ maxLevels_

◆ nCellsInCoarsestLevel_

◆ meshInterfaces_

◆ procAgglomeratorPtr_

◆ nCells_

◆ restrictAddressing_

◆ nFaces_

◆ faceRestrictAddressing_

◆ faceFlipMap_

◆ nPatchFaces_

◆ patchFaceRestrictAddressing_

◆ meshLevels_

◆ procAgglomMap_

◆ agglomProcIDs_

◆ procCommunicator_

◆ procCellOffsets_

◆ procFaceMap_

◆ procBoundaryMap_

◆ procBoundaryFaceMap_