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 patchGroup name. More...
 
 coupleGroupIdentifier (const dictionary &dict)
 Construct from dictionary. More...
 
const word & name () const noexcept
 Name of patchGroup. More...
 
bool valid () const noexcept
 Is a valid patchGroup (non-empty) name. 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 57 of file coupleGroupIdentifier.H.

Constructor & Destructor Documentation

◆ coupleGroupIdentifier() [1/3]

coupleGroupIdentifier ( )
default

Default construct.

◆ coupleGroupIdentifier() [2/3]

coupleGroupIdentifier ( const word &  patchGroupName)
inlineexplicit

Construct from patchGroup name.

Definition at line 87 of file coupleGroupIdentifier.H.

◆ coupleGroupIdentifier() [3/3]

coupleGroupIdentifier ( const dictionary &  dict)
explicit

Construct from dictionary.

Definition at line 133 of file coupleGroupIdentifier.C.

References dict, and dictionary::readIfPresent().

Here is the call graph for this function:

Member Function Documentation

◆ name()

const word & name ( ) const
inlinenoexcept

Name of patchGroup.

Definition at line 99 of file coupleGroupIdentifier.H.

◆ valid()

bool valid ( ) const
inlinenoexcept

Is a valid patchGroup (non-empty) name.

Definition at line 105 of file coupleGroupIdentifier.H.

Referenced by cyclicAMIPolyPatch::cyclicAMIPolyPatch(), cyclicPolyPatch::cyclicPolyPatch(), and mappedPatchBase::mappedPatchBase().

Here is the caller graph for this function:

◆ 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 141 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 152 of file coupleGroupIdentifier.C.

References polyPatch::boundaryMesh(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAllConstIters, objectRegistry::lookupClass(), mesh, polyBoundaryMesh::mesh(), fvMesh::name(), IOobject::name(), patchIdentifier::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 211 of file coupleGroupIdentifier.C.

References os(), and Ostream::writeEntry().

Referenced by Foam::operator<<().

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