coupleGroupIdentifier Class Reference

Encapsulates using patchGroups to specify coupled patch. More...

Collaboration diagram for coupleGroupIdentifier:

Public Member Functions
	coupleGroupIdentifier ()
	Construct null. More...
	coupleGroupIdentifier (const word &patchGroupName)
	Construct from components. More...
	coupleGroupIdentifier (const dictionary &)
	Construct from dictionary. More...
const word &	name () const
	Name of patchGroup. More...
bool	valid () const
	Is a valid patchGroup. More...
label	findOtherPatchID (const polyPatch &) const
	Find other patch in same region. Returns index of patch or -1. More...
label	findOtherPatchID (const polyPatch &, word &) const
	Find other patch and region. Returns index of patch and sets. More...
void	write (Ostream &) const
	Write the data as a dictionary. More...

Private Member Functions
label	findOtherPatchID (const polyMesh &, const polyPatch &) const
	Find other patch in specified mesh. Returns index of patch or -1. More...

Private Attributes
word	name_
	Name of patchGroup. More...

Friends
Ostream &	operator<< (Ostream &, const coupleGroupIdentifier &)

Detailed Description

Encapsulates using patchGroups to specify coupled patch.

Source files

• coupleGroupIdentifier.H
• coupleGroupIdentifierI.H
• coupleGroupIdentifier.C
• coupleGroupIdentifierIO.C

Definition at line 62 of file coupleGroupIdentifier.H.

Constructor & Destructor Documentation

coupleGroupIdentifier() [1/3]

coupleGroupIdentifier

(

)

Construct null.

Definition at line 131 of file coupleGroupIdentifier.C.

coupleGroupIdentifier() [2/3]

coupleGroupIdentifier

(

const word &

patchGroupName

)

Construct from components.

Definition at line 137 of file coupleGroupIdentifier.C.

coupleGroupIdentifier() [3/3]

coupleGroupIdentifier

(

const dictionary &

dict

)

Construct from dictionary.

Definition at line 143 of file coupleGroupIdentifier.C.

Member Function Documentation

findOtherPatchID() [1/3]

Foam::label findOtherPatchID ( const polyMesh &  mesh, const polyPatch &  thisPatch  ) const

private

Find other patch in specified mesh. Returns index of patch or -1.

Definition at line 33 of file coupleGroupIdentifier.C.

References polyPatch::boundaryMesh(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::findIndex(), polyBoundaryMesh::groupPatchIDs(), patchIdentifier::index(), mesh, polyBoundaryMesh::mesh(), patchIdentifier::name(), Foam::name(), IOobject::name(), and List::size().

Referenced by cyclicAMIPolyPatch::neighbPatchName().

Here is the call graph for this function:

Here is the caller graph for this function:

name()

const Foam::word & name ( ) const

inline

Name of patchGroup.

Definition at line 30 of file coupleGroupIdentifierI.H.

References coupleGroupIdentifier::name_.

valid()

bool valid ( ) const

inline

Is a valid patchGroup.

Definition at line 36 of file coupleGroupIdentifierI.H.

findOtherPatchID() [2/3]

Foam::label findOtherPatchID

(

const polyPatch &

thisPatch

)

const

Find other patch in same region. Returns index of patch or -1.

Definition at line 152 of file coupleGroupIdentifier.C.

References polyPatch::boundaryMesh(), and polyBoundaryMesh::mesh().

Here is the call graph for this function:

findOtherPatchID() [3/3]

Foam::label findOtherPatchID	(	const polyPatch &	thisPatch,
		word &	otherRegion
	)		const

Find other patch and region. Returns index of patch and sets.

otherRegion to name of region. Fatal error if patch not found

Definition at line 163 of file coupleGroupIdentifier.C.

References polyPatch::boundaryMesh(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAllConstIter(), objectRegistry::lookupClass(), mesh, polyBoundaryMesh::mesh(), patchIdentifier::name(), Foam::name(), fvMesh::name(), IOobject::name(), HashTable::sortedToc(), and objectRegistry::time().

Here is the call graph for this function:

write()

void write

(

Ostream &

os

)

const

Write the data as a dictionary.

Definition at line 221 of file coupleGroupIdentifier.C.

References token::END_STATEMENT, Foam::name(), Foam::nl, and Ostream::writeKeyword().

Here is the call graph for this function:

Friends And Related Function Documentation

operator<<

Ostream& operator<< ( Ostream &  , const coupleGroupIdentifier &    )

friend

Field Documentation

name_

word name_

private

Name of patchGroup.

Definition at line 67 of file coupleGroupIdentifier.H.

Referenced by coupleGroupIdentifier::name().

---

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

• src/OpenFOAM/meshes/Identifiers/patch/coupleGroupIdentifier.H
• src/OpenFOAM/meshes/Identifiers/patch/coupleGroupIdentifier.C
• src/OpenFOAM/meshes/Identifiers/patch/coupleGroupIdentifierI.H