Loading...
Searching...
No Matches
faPatchData Class Reference

Helper class for holding data during faPatch construction. Most data members are exposed at the moment. More...

#include <faPatchData.H>

Collaboration diagram for faPatchData:
Collaboration graph
[legend]

Public Member Functions

 faPatchData ()
 Default construct.
const word & name () const noexcept
 Return the name.
dictionary dict (const bool withEdgeLabels=true) const
 Contents transcribed into a patch dictionary, usually including the edge labels.
bool good () const
 Has name/type etc.
void clear ()
 Reset data.
void assign (const faPatch &fap)
 Clear and populate with values from finiteArea patch.
bool assign_coupled (int ownProci, int neiProci)
 Set values consistent with a processor coupling.
bool coupled () const noexcept
 True if owner/neighbour processor ids are non-equal.
bool owner () const noexcept
 Does this side own the patch? Also true for non-coupled patches.
bool neighbour () const noexcept
 Does the other side own the patch?
int matchPatchPair (const labelPair &patchPair) const noexcept
 Ordered match with owner/neighbour patchPair.
int comparePatchPair (const labelPair &patchPair) const noexcept
 Unordered comparison with owner/neighbour patchPair.

Public Attributes

word name_
word type_
label ownerPolyPatchId_
label neighPolyPatchId_
int ownerProcId_
 The owner/neighbour for processor patches.
int neighProcId_
labelList edgeLabels_

Detailed Description

Helper class for holding data during faPatch construction. Most data members are exposed at the moment.

Definition at line 48 of file faPatchData.H.

Constructor & Destructor Documentation

◆ faPatchData()

faPatchData ( )

Default construct.

Definition at line 28 of file faPatchData.C.

References neighPolyPatchId_, neighProcId_, ownerPolyPatchId_, and ownerProcId_.

Member Function Documentation

◆ name()

const Foam::word & name ( ) const
noexcept

Return the name.

Definition at line 39 of file faPatchData.C.

References name_, and Foam::noexcept.

◆ dict()

Foam::dictionary dict ( const bool withEdgeLabels = true) const

Contents transcribed into a patch dictionary, usually including the edge labels.

Definition at line 45 of file faPatchData.C.

References dictionary::add(), coupled, edgeLabels_, neighPolyPatchId_, neighProcId_, ownerProcId_, and type_.

Here is the call graph for this function:

◆ good()

bool good ( ) const

Has name/type etc.

Definition at line 70 of file faPatchData.C.

References name_, and type_.

◆ clear()

void clear ( )

Reset data.

Definition at line 76 of file faPatchData.C.

References edgeLabels_, name_, neighPolyPatchId_, neighProcId_, ownerPolyPatchId_, ownerProcId_, and type_.

◆ assign()

void assign ( const faPatch & fap)

Clear and populate with values from finiteArea patch.

Definition at line 91 of file faPatchData.C.

References clear(), faPatch::edgeLabels(), edgeLabels_, Foam::isA(), patchIdentifier::name(), name_, neighPolyPatchId_, neighProcId_, faPatch::ngbPolyPatchIndex(), ownerProcId_, and type_.

Here is the call graph for this function:

◆ assign_coupled()

bool assign_coupled ( int ownProci,
int neiProci )

Set values consistent with a processor coupling.

Definition at line 111 of file faPatchData.C.

References clear(), name_, neighProcId_, processorPolyPatch::newName(), ownerProcId_, and type_.

Here is the call graph for this function:

◆ coupled()

bool coupled ( ) const
inlinenoexcept

True if owner/neighbour processor ids are non-equal.

Definition at line 119 of file faPatchData.H.

References coupled(), neighProcId_, Foam::noexcept, and ownerProcId_.

Referenced by coupled().

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

◆ owner()

bool owner ( ) const
inlinenoexcept

Does this side own the patch? Also true for non-coupled patches.

Definition at line 127 of file faPatchData.H.

References neighProcId_, Foam::noexcept, and ownerProcId_.

Referenced by neighbour().

Here is the caller graph for this function:

◆ neighbour()

bool neighbour ( ) const
inlinenoexcept

Does the other side own the patch?

Definition at line 135 of file faPatchData.H.

References Foam::noexcept, and owner().

Here is the call graph for this function:

◆ matchPatchPair()

int matchPatchPair ( const labelPair & patchPair) const
noexcept

Ordered match with owner/neighbour patchPair.

Returns
  • 0: matched none
  • 1: matched first only (owner)
  • 2: matched second only (neighbour)
  • 3: matched both (owner/neighbour)

Definition at line 129 of file faPatchData.C.

References neighPolyPatchId_, and ownerPolyPatchId_.

◆ comparePatchPair()

int comparePatchPair ( const labelPair & patchPair) const
noexcept

Unordered comparison with owner/neighbour patchPair.

Definition at line 147 of file faPatchData.C.

References neighPolyPatchId_, and ownerPolyPatchId_.

Member Data Documentation

◆ name_

word name_

Definition at line 54 of file faPatchData.H.

Referenced by assign(), assign_coupled(), clear(), good(), and name().

◆ type_

word type_

Definition at line 55 of file faPatchData.H.

Referenced by assign(), assign_coupled(), clear(), dict(), and good().

◆ ownerPolyPatchId_

label ownerPolyPatchId_

Definition at line 57 of file faPatchData.H.

Referenced by clear(), comparePatchPair(), faPatchData(), and matchPatchPair().

◆ neighPolyPatchId_

label neighPolyPatchId_

Definition at line 58 of file faPatchData.H.

Referenced by assign(), clear(), comparePatchPair(), dict(), faPatchData(), and matchPatchPair().

◆ ownerProcId_

int ownerProcId_

The owner/neighbour for processor patches.

Definition at line 63 of file faPatchData.H.

Referenced by assign(), assign_coupled(), clear(), coupled(), dict(), faPatchData(), and owner().

◆ neighProcId_

int neighProcId_

Definition at line 64 of file faPatchData.H.

Referenced by assign(), assign_coupled(), clear(), coupled(), dict(), faPatchData(), and owner().

◆ edgeLabels_

labelList edgeLabels_

Definition at line 67 of file faPatchData.H.

Referenced by assign(), clear(), and dict().

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