Public Member Functions | List of all members
coupleGroupIdentifier Class Reference

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

Public Member Functions

 coupleGroupIdentifier ()=default
 Default construct. More...
 
 coupleGroupIdentifier (const word &patchGroupName)
 Construct from components. More...
 
 coupleGroupIdentifier (const dictionary &dict)
 Construct from dictionary. More...
 
const word & name () const
 Name of patchGroup. More...
 
bool valid () const
 Is a valid patchGroup. More...
 
label findOtherPatchID (const polyPatch &thisPatch) const
 Find other patch in same region. More...
 
label findOtherPatchID (const polyPatch &thisPatch, word &otherRegion) const
 Find other patch and region. More...
 
void write (Ostream &os) const
 Write the coupleGroup dictionary entry. More...
 

Detailed Description

Encapsulates using "patchGroups" to specify coupled patch.

Source files

Definition at line 58 of file coupleGroupIdentifier.H.

Constructor & Destructor Documentation

◆ coupleGroupIdentifier() [1/3]

coupleGroupIdentifier ( )
default

Default construct.

◆ coupleGroupIdentifier() [2/3]

coupleGroupIdentifier ( const word &  patchGroupName)
inlineexplicit

Construct from components.

Definition at line 31 of file coupleGroupIdentifierI.H.

◆ coupleGroupIdentifier() [3/3]

coupleGroupIdentifier ( const dictionary &  dict)
explicit

Construct from dictionary.

Definition at line 133 of file coupleGroupIdentifier.C.

References dict.

Member Function Documentation

◆ name()

const Foam::word & name ( ) const
inline

Name of patchGroup.

Definition at line 41 of file coupleGroupIdentifierI.H.

◆ valid()

bool valid ( ) const
inline

Is a valid patchGroup.

Definition at line 47 of file coupleGroupIdentifierI.H.

◆ findOtherPatchID() [1/2]

Foam::label findOtherPatchID ( const polyPatch &  thisPatch) const

Find other patch in same region.

Returns
index of patch or -1.

Definition at line 144 of file coupleGroupIdentifier.C.

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

Here is the call graph for this function:

◆ findOtherPatchID() [2/2]

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. FatalError if patch not found

Definition at line 155 of file coupleGroupIdentifier.C.

References polyPatch::boundaryMesh(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAllConstIters(), objectRegistry::lookupClass(), mesh, polyBoundaryMesh::mesh(), patchIdentifier::name(), fvMesh::name(), IOobject::name(), Foam::name(), patchID, runTime, HashTable< T, Key, Hash >::sortedToc(), and objectRegistry::time().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const

Write the coupleGroup dictionary entry.

Definition at line 213 of file coupleGroupIdentifier.C.

References Foam::name(), and Ostream::writeEntry().

Here is the call graph for this function:
The documentation for this class was generated from the following files: