Primitive patch pair agglomerate method. More...

#include <pairPatchAgglomeration.H>

Collaboration diagram for pairPatchAgglomeration:

[legend]

Public Member Functions
	TypeName ("pairPatch")
	Runtime type information.
	pairPatchAgglomeration (const faceList &faces, const pointField &points, const dictionary &controlDict)
	Construct given faces, points and control dictionary.
	pairPatchAgglomeration (const faceList &faces, const pointField &points, const label mergeLevels, const label maxLevels, const label nFacesInCoarsestLevel, const label nGlobalFacesInCoarsestLevel, const scalar featureAngle=0)
	Construct from components.
virtual	~pairPatchAgglomeration ()
void	agglomerate ()
	Agglomerate patch.
label	size () const
	Return size.
const labelList &	restrictTopBottomAddressing () const
	Return restriction from top level to bottom level.
const bPatch &	patchLevel (const label leveli) const
	Return primitivePatch of given level.
const labelField &	restrictAddressing (const label leveli) const
	Return cell restrict addressing of given level.
template<class Type>
void	restrictField (Field< Type > &cf, const Field< Type > &ff, const label fineLevelIndex) const
	Restrict (integrate by summation) cell field.
template<class Type>
void	prolongField (Field< Type > &ff, const Field< Type > &cf, const label coarseLevelIndex) const
	Prolong (interpolate by injection) cell field.

Protected Types
typedef PrimitivePatch< List< face >, const pointField >	bPatch

Protected Attributes
label	mergeLevels_
	Number of levels to merge, 1 = don't merge, 2 = merge pairs etc.
label	maxLevels_
	Max number of levels.
label	nFacesInCoarsestLevel_
	Number of faces in coarsest level.
label	nGlobalFacesInCoarsestLevel_
	Global number of faces in coarsest level.
scalar	featureAngle_
	Feature angle.
labelList	nFaces_
	The number of faces in each level.
PtrList< labelField >	restrictAddressing_
	Cell restriction addressing array.
labelList	restrictTopBottomAddressing_
	Maps from finest to coarsest.
PtrList< bPatch >	patchLevels_
	Hierarchy of patch addressing.
EdgeMap< scalar >	facePairWeight_
	Edge weights.

Detailed Description

Primitive patch pair agglomerate method.

Source files

Definition at line 50 of file pairPatchAgglomeration.H.

Member Typedef Documentation

◆ bPatch

typedef PrimitivePatch<List<face>, const pointField> bPatch

protected

Definition at line 54 of file pairPatchAgglomeration.H.

Constructor & Destructor Documentation

◆ pairPatchAgglomeration() [1/2]

pairPatchAgglomeration	(	const faceList &	faces,
		const pointField &	points,
		const dictionary &	controlDict )

Construct given faces, points and control dictionary.

Definition at line 336 of file pairPatchAgglomeration.C.

References controlDict(), facePairWeight_, featureAngle_, Foam::identity(), Foam::labelMax, maxLevels_, mergeLevels_, nFaces_, nFacesInCoarsestLevel_, nGlobalFacesInCoarsestLevel_, patchLevels_, points, restrictAddressing_, restrictTopBottomAddressing_, size(), and UList< T >::size().

Here is the call graph for this function:

◆ pairPatchAgglomeration() [2/2]

pairPatchAgglomeration	(	const faceList &	faces,
		const pointField &	points,
		const label	mergeLevels,
		const label	maxLevels,
		const label	nFacesInCoarsestLevel,
		const label	nGlobalFacesInCoarsestLevel,
		const scalar	featureAngle = 0 )

Construct from components.

Definition at line 377 of file pairPatchAgglomeration.C.

References facePairWeight_, featureAngle_, Foam::identity(), maxLevels_, mergeLevels_, nFaces_, nFacesInCoarsestLevel_, nGlobalFacesInCoarsestLevel_, patchLevels_, points, restrictAddressing_, restrictTopBottomAddressing_, size(), and UList< T >::size().

Here is the call graph for this function:

◆ ~pairPatchAgglomeration()

~pairPatchAgglomeration ( )

virtual

Definition at line 412 of file pairPatchAgglomeration.C.

Member Function Documentation

◆ TypeName()

TypeName ( "pairPatch" )

Runtime type information.

References controlDict(), and points.

Here is the call graph for this function:

◆ agglomerate()

void agglomerate ( )

Agglomerate patch.

Definition at line 565 of file pairPatchAgglomeration.C.

References Foam::endl(), maxLevels_, mergeLevels_, Foam::name(), nFaces_, os(), patchLevels_, Foam::Pout, and restrictAddressing_.

Referenced by extractEulerianParticles::initialiseBins().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ size()

label size ( ) const

inline

Return size.

Definition at line 258 of file pairPatchAgglomeration.H.

References patchLevels_.

Referenced by pairPatchAgglomeration(), and pairPatchAgglomeration().

Here is the caller graph for this function:

◆ restrictTopBottomAddressing()

const labelList & restrictTopBottomAddressing ( ) const

inline

Return restriction from top level to bottom level.

Definition at line 266 of file pairPatchAgglomeration.H.

References restrictTopBottomAddressing_.

Referenced by extractEulerianParticles::initialiseBins().

Here is the caller graph for this function:

◆ patchLevel()

const Foam::pairPatchAgglomeration::bPatch & patchLevel ( const label leveli ) const

Return primitivePatch of given level.

Definition at line 419 of file pairPatchAgglomeration.C.

References patchLevels_.

◆ restrictAddressing()

const labelField & restrictAddressing ( const label leveli ) const

inline

Return cell restrict addressing of given level.

Definition at line 279 of file pairPatchAgglomeration.H.

References restrictAddressing_.

◆ restrictField()

template<class Type>

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

Restrict (integrate by summation) cell field.

Definition at line 26 of file pairPatchAgglomerationTemplates.C.

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

Here is the call graph for this function:

◆ prolongField()

template<class Type>

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

Prolong (interpolate by injection) cell field.

Definition at line 54 of file pairPatchAgglomerationTemplates.C.

References forAll, and restrictAddressing_.

Member Data Documentation

◆ mergeLevels_

label mergeLevels_

protected

Number of levels to merge, 1 = don't merge, 2 = merge pairs etc.

Definition at line 61 of file pairPatchAgglomeration.H.

Referenced by agglomerate(), pairPatchAgglomeration(), and pairPatchAgglomeration().

◆ maxLevels_

label maxLevels_

protected

Max number of levels.

Definition at line 66 of file pairPatchAgglomeration.H.

Referenced by agglomerate(), pairPatchAgglomeration(), and pairPatchAgglomeration().

◆ nFacesInCoarsestLevel_

label nFacesInCoarsestLevel_

protected

Number of faces in coarsest level.

Definition at line 71 of file pairPatchAgglomeration.H.

Referenced by pairPatchAgglomeration(), and pairPatchAgglomeration().

◆ nGlobalFacesInCoarsestLevel_

label nGlobalFacesInCoarsestLevel_

protected

Global number of faces in coarsest level.

Definition at line 76 of file pairPatchAgglomeration.H.

Referenced by pairPatchAgglomeration(), and pairPatchAgglomeration().

◆ featureAngle_

scalar featureAngle_

protected

Feature angle.

Definition at line 81 of file pairPatchAgglomeration.H.

Referenced by pairPatchAgglomeration(), and pairPatchAgglomeration().

◆ nFaces_

labelList nFaces_

protected

The number of faces in each level.

Definition at line 86 of file pairPatchAgglomeration.H.

Referenced by agglomerate(), pairPatchAgglomeration(), and pairPatchAgglomeration().

◆ restrictAddressing_

PtrList<labelField> restrictAddressing_

protected

Cell restriction addressing array.

Maps from the finer to coarse level

Definition at line 93 of file pairPatchAgglomeration.H.

Referenced by agglomerate(), pairPatchAgglomeration(), pairPatchAgglomeration(), prolongField(), restrictAddressing(), and restrictField().

◆ restrictTopBottomAddressing_

labelList restrictTopBottomAddressing_

protected

Maps from finest to coarsest.

Definition at line 98 of file pairPatchAgglomeration.H.

Referenced by pairPatchAgglomeration(), pairPatchAgglomeration(), and restrictTopBottomAddressing().

◆ patchLevels_

PtrList<bPatch> patchLevels_

protected

Hierarchy of patch addressing.

Definition at line 103 of file pairPatchAgglomeration.H.

Referenced by agglomerate(), pairPatchAgglomeration(), pairPatchAgglomeration(), patchLevel(), and size().

◆ facePairWeight_

EdgeMap<scalar> facePairWeight_

protected

Edge weights.

Definition at line 108 of file pairPatchAgglomeration.H.

Referenced by pairPatchAgglomeration(), and pairPatchAgglomeration().

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

src/fvAgglomerationMethods/pairPatchAgglomeration/pairPatchAgglomeration.H
src/fvAgglomerationMethods/pairPatchAgglomeration/pairPatchAgglomeration.C
src/fvAgglomerationMethods/pairPatchAgglomeration/pairPatchAgglomerationTemplates.C

Public Member Functions

Protected Types

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ bPatch

Constructor & Destructor Documentation

◆ pairPatchAgglomeration() [1/2]

◆ pairPatchAgglomeration() [2/2]

◆ ~pairPatchAgglomeration()

Member Function Documentation

◆ TypeName()

◆ agglomerate()

◆ size()

◆ restrictTopBottomAddressing()

◆ patchLevel()

◆ restrictAddressing()

◆ restrictField()

◆ prolongField()

Member Data Documentation

◆ mergeLevels_

◆ maxLevels_

◆ nFacesInCoarsestLevel_

◆ nGlobalFacesInCoarsestLevel_

◆ featureAngle_

◆ nFaces_

◆ restrictAddressing_

◆ restrictTopBottomAddressing_

◆ patchLevels_

◆ facePairWeight_