Public Member Functions | Friends | List of all members
coupleGroupIdentifier Class Reference

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

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

Friends

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

Detailed Description

Encapsulates using patchGroups to specify coupled patch.

Source files

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

◆ name()

const Foam::word & name ( ) const
inline

Name of patchGroup.

Definition at line 30 of file coupleGroupIdentifierI.H.

Referenced by mappedPatchBase::coupleGroup(), coupleGroupIdentifier::findOtherPatchID(), and coupleGroupIdentifier::write().

Here is the caller graph for this function:

◆ valid()

bool valid ( ) const
inline

Is a valid patchGroup.

Definition at line 36 of file coupleGroupIdentifierI.H.

Referenced by mappedPatchBase::samplePatch(), mappedPatchBase::sampleRegion(), and coupleGroupIdentifier::write().

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 152 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. 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(), polyBoundaryMesh::mesh(), coupleGroupIdentifier::name(), patchIdentifier::name(), IOobject::name(), HashTable< T, Key, Hash >::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 coupleGroupIdentifier::name(), coupleGroupIdentifier::valid(), and Foam::writeEntry().

Referenced by Foam::operator<<().

Here is the call graph for this function:
Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream &  ,
const coupleGroupIdentifier &   
)
friend
The documentation for this class was generated from the following files: