Geometric agglomerated algebraic multigrid agglomeration class. More...

Inheritance diagram for GAMGAgglomeration:

Collaboration diagram for GAMGAgglomeration:

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

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

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

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

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

	~GAMGAgglomeration ()
	Destructor. More...

label	size () const

const 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

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

const labelList &	agglomProcIDs (const label fineLeveli) const

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

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

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

Public Member Functions inherited from MeshObject< lduMesh, GeometricMeshObject, GAMGAgglomeration >
	MeshObject (const lduMesh &mesh)
	Construct on Mesh type. More...

virtual	~MeshObject ()=default
	Destructor. More...

const lduMesh &	mesh () const

virtual bool	writeData (Ostream &os) const

Public Member Functions inherited from GeometricMeshObject< lduMesh >
	GeometricMeshObject (const word &typeName, const objectRegistry &obr)
	Construct from name and instance on registry. More...

Public Member Functions inherited from TopologicalMeshObject< lduMesh >
	TopologicalMeshObject (const word &typeName, const objectRegistry &obr)
	Construct from name and instance on registry. More...

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

	meshObject (const word &typeName, const objectRegistry &obr)
	Construct from name and instance on registry. More...

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

	regIOobject (const IOobject &io, const bool isTimeObject=false)

	regIOobject (const regIOobject &rio)
	Copy construct. More...

	regIOobject (const regIOobject &rio, bool registerCopy)

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)

	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry, if not already registered. More...

bool	checkOut ()
	Remove all file watches and remove object from registry. More...

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

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

bool	store ()

void	release (const bool unregister=false)
	Release ownership of this object from its registry. More...

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

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

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

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

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

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

void	setUpToDate ()
	Set as up-to-date. More...

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

const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr. More...

dictionary &	getMetaData () noexcept
	Get or create meta-data. More...

void	removeMetaData ()
	Remove meta-data. More...

virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing) More...

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

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

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

void	close ()
	Close Istream. More...

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

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

virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched. More...

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

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

virtual bool	modified () const

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

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const
	Write using stream options. More...

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

virtual bool	global () const
	Is object global. More...

void	operator= (const IOobject &io)
	Copy assignment. More...

virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
	Write using given format, version and compression. More...

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch) More...

	IOobject (const IOobject &)=default
	Copy construct. More...

virtual	~IOobject ()=default
	Destructor. More...

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

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

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

	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name. More...

	IOobject (const IOobject &io, readOption, writeOption)
	Copy construct, resetting io options. More...

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

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

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

const Time &	time () const
	Return Time associated with the objectRegistry. More...

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

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

word &	headerClassName () noexcept
	Return non-constant access to the class name read from header. More...

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

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

bool	registerObject () const noexcept
	Should object created with this IOobject be registered? More...

bool	registerObject (bool on) noexcept
	Change registration preference, return previous value. More...

bool	globalObject () const noexcept
	Is object same for all processors? More...

bool	globalObject (bool on) noexcept
	Change global-object status, return previous value. More...

unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header. More...

unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header. More...

bool	isHeaderClassName (const word &clsName) const
	Test if headerClassName() equals the given class name. More...

template<class Type >
bool	isHeaderClassName () const
	Test if headerClassName() equals Type::typeName. More...

readOption	readOpt () const noexcept
	The read option. More...

readOption	readOpt (readOption opt) noexcept
	Change the read option, return previous value. More...

writeOption	writeOpt () const noexcept
	The write option. More...

writeOption	writeOpt (writeOption opt) noexcept
	Change the write option, return previous value. More...

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

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

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const noexcept

fileName &	instance () noexcept

const fileName &	local () const noexcept

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

fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local. More...

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

fileName	objectRelPath () const
	The object path relative to the root. More...

fileName	localFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches up if in parallel. More...

IOstreamOption	parseHeader (const dictionary &headerDict)

bool	readHeader (Istream &is)

bool	readHeader (dictionary &headerDict, Istream &is)

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (uses typeFilePath to find file) and check its info. More...

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

bool	writeHeader (Ostream &os) const
	Write header with current type() More...

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

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const

bool	good () const noexcept

bool	bad () const noexcept

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

void	operator= (const IOobject &io)

readOption &	readOpt () noexcept
	Access to the read option. More...

writeOption &	writeOpt () noexcept
	Access to the write option. More...

bool &	registerObject () noexcept
	Access to the register object option. More...

bool &	globalObject () noexcept
	Access to the global object option. More...

template<>
bool	isHeaderClassName () const
	Specialization for `void` always returns true (no headerClassName check). More...

template<class StringType >
Foam::word	groupName (StringType base, const word &group)

Static Public Member Functions
static const GAMGAgglomeration &	New (const lduMesh &mesh, const dictionary &controlDict)
	Return the selected geometric agglomerator. More...

static const GAMGAgglomeration &	New (const lduMatrix &matrix, const dictionary &controlDict)
	Return the selected matrix agglomerator. More...

static const GAMGAgglomeration &	New (const lduMesh &mesh, const scalarField &cellVolumes, const vectorField &faceAreas, const dictionary &controlDict)
	Return the selected geometric agglomerator. More...

static void	calculateRegionMaster (const label comm, const labelList &procAgglomMap, labelList &masterProcs, List< label > &agglomProcIDs)
	Given fine to coarse processor map determine: More...

static bool	checkRestriction (labelList &newRestrict, label &nNewCoarse, const lduAddressing &fineAddressing, const labelUList &restriction, const label nCoarse)
	Given restriction determines if coarse cells are connected. More...

Static Public Member Functions inherited from MeshObject< lduMesh, GeometricMeshObject, GAMGAgglomeration >
static const GAMGAgglomeration &	New (const lduMesh &mesh, Args &&... args)
	Get existing or create a new MeshObject. More...

static bool	Delete (const lduMesh &mesh)
	Static destructor. More...

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

template<class Mesh >
static void	updateMesh (objectRegistry &obr, const mapPolyMesh &mpm)

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

template<class Mesh , template< class > class FromType, template< class > class ToType>
static void	clearUpto (objectRegistry &obr)

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

template<class Type >
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner. More...

static bool	bannerEnabled (bool on) noexcept
	Enable/disable an output file banner. More...

static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class StringType >
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string. More...

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

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

static word	scopedName (const std::string &scope, const word &name)
	Create scope:name or scope_name string. More...

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name. More...

static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider. More...

static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider. More...

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

	GAMGAgglomeration (const GAMGAgglomeration &)=delete
	No copy construct. More...

void	operator= (const GAMGAgglomeration &)=delete
	No copy assignment. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
	Helper: check readOpt flags and read if necessary. More...

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

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

Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)

static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)

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

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

const lduInterfacePtrsList	meshInterfaces_
	Cached mesh interfaces. More...

autoPtr< GAMGProcAgglomeration >	procAgglomeratorPtr_

labelList	nCells_
	The number of cells in each level. More...

PtrList< labelField >	restrictAddressing_
	Cell restriction addressing array. More...

labelList	nFaces_
	The number of (coarse) faces in each level. More...

PtrList< labelList >	faceRestrictAddressing_
	Face restriction addressing array. More...

PtrList< boolList >	faceFlipMap_
	Face flip: for faces mapped to internal faces stores whether. More...

PtrList< labelList >	nPatchFaces_
	The number of (coarse) patch faces in each level. More...

PtrList< labelListList >	patchFaceRestrictAddressing_
	Patch-local face restriction addressing array. More...

PtrList< lduPrimitiveMesh >	meshLevels_
	Hierarchy of mesh addressing. More...

PtrList< labelList >	procAgglomMap_
	Per level, per processor the processor it agglomerates into. More...

PtrList< labelList >	agglomProcIDs_
	Per level the set of processors to agglomerate. Element 0 is. More...

labelList	procCommunicator_
	Communicator for given level. More...

PtrList< 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 : char { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...

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

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

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

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes. More...

static char	scopeSeparator
	Character for scoping object names (':' or '_') More...

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

static float	fileModificationSkew
	Time skew (seconds) for file modification checks. More...

static int	maxFileModificationPolls
	Max number of times to poll for file modification changes. More...

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. More...

Detailed Description

Geometric agglomerated algebraic multigrid agglomeration class.

Source files

Definition at line 64 of file GAMGAgglomeration.H.

Constructor & Destructor Documentation

◆ GAMGAgglomeration() [1/2]

GAMGAgglomeration ( const GAMGAgglomeration & )

protecteddelete

No copy construct.

◆ GAMGAgglomeration() [2/2]

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

Construct given mesh and controls.

Definition at line 232 of file GAMGAgglomeration.C.

References fvMesh::lduAddr(), Foam::max(), mesh, Foam::min(), Foam::reduce(), and lduAddressing::size().

Here is the call graph for this function:

◆ ~GAMGAgglomeration()

~GAMGAgglomeration ( )

Destructor.

Definition at line 448 of file GAMGAgglomeration.C.

Member Function Documentation

◆ agglomerateLduAddressing()

void agglomerateLduAddressing ( const label fineLevelIndex )

protected

Assemble coarse mesh addressing.

Definition at line 37 of file GAMGAgglomerateLduAddressing.C.

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

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

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

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

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

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

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

References List< T >::setSize().

Here is the call graph for this function:

◆ clearLevel()

void clearLevel ( const label leveli )

protected

Definition at line 499 of file GAMGAgglomeration.C.

◆ procAgglomerateLduAddressing()

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

protected

Collect and combine processor meshes into allMesh:

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

Definition at line 435 of file GAMGAgglomerateLduAddressing.C.

References List< T >::set().

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

References forAll, and globalIndex::gather().

Here is the call graph for this function:

◆ operator=()

void operator= ( const GAMGAgglomeration & )

protecteddelete

No copy assignment.

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

References objectRegistry::cfindObject(), controlDict(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Time::libs(), mesh, dlLibraryTable::open(), fvMesh::thisDb(), and objectRegistry::time().

Here is the call graph for this function:

◆ New() [2/3]

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

static

Return the selected matrix agglomerator.

Definition at line 342 of file GAMGAgglomeration.C.

References objectRegistry::cfindObject(), controlDict(), Time::libs(), mesh, lduMatrix::mesh(), Foam::New(), dlLibraryTable::open(), fvMesh::thisDb(), and objectRegistry::time().

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

References objectRegistry::cfindObject(), controlDict(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, mesh, fvMesh::thisDb(), and objectRegistry::time().

Here is the call graph for this function:

◆ size()

label size ( ) const

inline

Definition at line 325 of file GAMGAgglomeration.H.

References GAMGAgglomeration::meshLevels_.

Referenced by GAMGAgglomeration::compactLevels(), GAMGProcAgglomeration::printStats(), and dynamicOversetFvMesh::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 455 of file GAMGAgglomeration.C.

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

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

◆ restrictAddressing()

const labelField& restrictAddressing ( const label leveli ) const

inline

Return cell restrict addressing of given level.

Definition at line 343 of file GAMGAgglomeration.H.

References GAMGAgglomeration::restrictAddressing_.

Referenced by GAMGProcAgglomeration::printStats(), and dynamicOversetFvMesh::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 349 of file GAMGAgglomeration.H.

References GAMGAgglomeration::faceRestrictAddressing_.

Referenced by GAMGProcAgglomeration::printStats().

Here is the caller graph for this function:

◆ patchFaceRestrictAddressing()

const labelListList& patchFaceRestrictAddressing ( const label leveli ) const

inline

Definition at line 354 of file GAMGAgglomeration.H.

References GAMGAgglomeration::patchFaceRestrictAddressing_.

Referenced by GAMGProcAgglomeration::printStats().

Here is the caller graph for this function:

◆ faceFlipMap()

const boolList& faceFlipMap ( const label leveli ) const

inline

Return face flip map of given level.

Definition at line 361 of file GAMGAgglomeration.H.

References GAMGAgglomeration::faceFlipMap_.

◆ nCells()

label nCells ( const label leveli ) const

inline

Return number of coarse cells (before processor agglomeration)

Definition at line 367 of file GAMGAgglomeration.H.

References GAMGAgglomeration::nCells_.

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

Here is the caller graph for this function:

◆ nFaces()

label nFaces ( const label leveli ) const

inline

Return number of coarse faces (before processor agglomeration)

Definition at line 373 of file GAMGAgglomeration.H.

References GAMGAgglomeration::nFaces_.

Referenced by GAMGProcAgglomeration::printStats().

Here is the caller graph for this function:

◆ nPatchFaces()

const labelList& nPatchFaces ( const label leveli ) const

inline

Return number of coarse patch faces (before processor agglomeration)

Definition at line 380 of file GAMGAgglomeration.H.

References GAMGAgglomeration::nPatchFaces_.

◆ 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 97 of file GAMGAgglomerationTemplates.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and Foam::fv::ff().

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

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

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

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

Here is the call graph for this function:

◆ prolongField()

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

Prolong (interpolate by injection) cell field.

Definition at line 174 of file GAMGAgglomerationTemplates.C.

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

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

References Foam::findIndices(), forAll, forAllConstIters(), Foam::min(), UPstream::myProcNo(), and List< T >::setSize().

Referenced by masterCoarsestGAMGProcAgglomeration::agglomerate(), eagerGAMGProcAgglomeration::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 447 of file GAMGAgglomeration.H.

References bool, and GAMGAgglomeration::procAgglomeratorPtr_.

Referenced by GAMGAgglomeration::compactLevels().

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

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

◆ hasProcMesh()

bool hasProcMesh ( const label fineLeveli ) const

Check that level has combined mesh.

Definition at line 537 of file GAMGAgglomeration.C.

◆ procCommunicator()

Foam::label procCommunicator ( const label fineLeveli ) const

Communicator for current level or -1.

Definition at line 543 of file GAMGAgglomeration.C.

◆ cellOffsets()

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

Mapping from processor to procMesh cells.

Definition at line 550 of file GAMGAgglomeration.C.

◆ faceMap()

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

Mapping from processor to procMesh face.

Definition at line 559 of file GAMGAgglomeration.C.

◆ boundaryMap()

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

Mapping from processor to procMesh boundary.

Definition at line 568 of file GAMGAgglomeration.C.

◆ boundaryFaceMap()

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

Mapping from processor to procMesh boundary face.

Definition at line 577 of file GAMGAgglomeration.C.

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

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

Here is the call graph for this function:

Friends And Related Function Documentation

◆ GAMGProcAgglomeration

friend class GAMGProcAgglomeration

friend

Declare friendship with GAMGProcAgglomeration.

Definition at line 218 of file GAMGAgglomeration.H.

Member Data Documentation

◆ maxLevels_

const label maxLevels_

protected

Max number of levels.

Definition at line 73 of file GAMGAgglomeration.H.

◆ nCellsInCoarsestLevel_

label nCellsInCoarsestLevel_

protected

Number of cells in coarsest level.

Definition at line 76 of file GAMGAgglomeration.H.

◆ meshInterfaces_

const lduInterfacePtrsList meshInterfaces_

protected

Cached mesh interfaces.

Definition at line 79 of file GAMGAgglomeration.H.

◆ procAgglomeratorPtr_

autoPtr<GAMGProcAgglomeration> procAgglomeratorPtr_

protected

Definition at line 81 of file GAMGAgglomeration.H.

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

◆ nCells_

labelList nCells_

protected

The number of cells in each level.

Definition at line 84 of file GAMGAgglomeration.H.

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

◆ restrictAddressing_

PtrList<labelField> restrictAddressing_

protected

Cell restriction addressing array.

Maps from the finer to the coarser level.

Definition at line 88 of file GAMGAgglomeration.H.

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

◆ nFaces_

labelList nFaces_

protected

The number of (coarse) faces in each level.

max(faceRestrictAddressing)+1.

Definition at line 92 of file GAMGAgglomeration.H.

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

◆ faceRestrictAddressing_

PtrList<labelList> faceRestrictAddressing_

protected

Face restriction addressing array.

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

Definition at line 100 of file GAMGAgglomeration.H.

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

◆ faceFlipMap_

PtrList<boolList> faceFlipMap_

protected

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

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

Definition at line 105 of file GAMGAgglomeration.H.

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

◆ nPatchFaces_

PtrList<labelList> nPatchFaces_

protected

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

max(patchFaceRestrictAddressing_)+1.

Definition at line 109 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration::combineLevels(), GAMGAgglomeration::compactLevels(), and GAMGAgglomeration::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 114 of file GAMGAgglomeration.H.

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

◆ meshLevels_

PtrList<lduPrimitiveMesh> meshLevels_

protected

Hierarchy of mesh addressing.

Definition at line 117 of file GAMGAgglomeration.H.

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

◆ procAgglomMap_

PtrList<labelList> procAgglomMap_

mutableprotected

Per level, per processor the processor it agglomerates into.

Definition at line 123 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration::compactLevels(), and 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 127 of file GAMGAgglomeration.H.

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

◆ procCommunicator_

labelList procCommunicator_

mutableprotected

Communicator for given level.

Definition at line 130 of file GAMGAgglomeration.H.

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

◆ procCellOffsets_

PtrList<labelList> procCellOffsets_

mutableprotected

Mapping from processor to procMeshLevel cells.

Definition at line 133 of file GAMGAgglomeration.H.

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

◆ procFaceMap_

PtrList<labelListList> procFaceMap_

mutableprotected

Mapping from processor to procMeshLevel face.

Definition at line 136 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration::compactLevels().

◆ procBoundaryMap_

PtrList<labelListList> procBoundaryMap_

mutableprotected

Mapping from processor to procMeshLevel boundary.

Definition at line 139 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration::compactLevels().

◆ procBoundaryFaceMap_

PtrList<labelListListList> procBoundaryFaceMap_

mutableprotected

Mapping from processor to procMeshLevel boundary face.

Definition at line 142 of file GAMGAgglomeration.H.

Referenced by GAMGAgglomeration::compactLevels().

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()

◆ operator=()

◆ 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()

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_