faPatchData Class Reference

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

Collaboration diagram for faPatchData:
[legend]

Public Member Functions

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

Public Attributes

word name_
 
word type_
 
label ownerPolyPatchId_
 
label neighPolyPatchId_
 
int ownerProcId_
 The owner/neighbour for processor patches. More...
 
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 54 of file faPatchData.H.

Constructor & Destructor Documentation

◆ faPatchData()

Default construct.

Definition at line 35 of file faPatchData.C.

Member Function Documentation

◆ name()

const Foam::word & name ( ) const
noexcept

Return the name.

Definition at line 46 of file faPatchData.C.

◆ dict()

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

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

Definition at line 52 of file faPatchData.C.

References dictionary::add(), and coupled().

Here is the call graph for this function:

◆ clear()

void clear ( )

Reset data.

Definition at line 77 of file faPatchData.C.

◆ assign()

void assign ( const faPatch fap)

Clear and populate with values from finiteArea patch.

Definition at line 92 of file faPatchData.C.

References clear(), faPatch::edgeLabels(), patchIdentifier::name(), and faPatch::ngbPolyPatchIndex().

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 112 of file faPatchData.C.

References clear(), processorPolyPatch::newName(), and ensightPTraits< Type >::typeName.

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 104 of file faPatchData.H.

References faPatchData::neighProcId_, and faPatchData::ownerProcId_.

◆ owner()

bool owner ( ) const
inlinenoexcept

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

Definition at line 110 of file faPatchData.H.

References faPatchData::neighProcId_, and faPatchData::ownerProcId_.

Referenced by faPatchData::neighbour().

Here is the caller graph for this function:

◆ neighbour()

bool neighbour ( ) const
inlinenoexcept

Does the other side own the patch?

Definition at line 116 of file faPatchData.H.

References faPatchData::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 130 of file faPatchData.C.

◆ comparePatchPair()

int comparePatchPair ( const labelPair patchPair) const
noexcept

Unordered comparison with owner/neighbour patchPair.

Definition at line 148 of file faPatchData.C.

Member Data Documentation

◆ name_

word name_

Definition at line 60 of file faPatchData.H.

◆ type_

word type_

Definition at line 61 of file faPatchData.H.

◆ ownerPolyPatchId_

label ownerPolyPatchId_

Definition at line 63 of file faPatchData.H.

◆ neighPolyPatchId_

label neighPolyPatchId_

Definition at line 64 of file faPatchData.H.

◆ ownerProcId_

int ownerProcId_

The owner/neighbour for processor patches.

Definition at line 67 of file faPatchData.H.

Referenced by faPatchData::coupled(), and faPatchData::owner().

◆ neighProcId_

int neighProcId_

Definition at line 68 of file faPatchData.H.

Referenced by faPatchData::coupled(), and faPatchData::owner().

◆ edgeLabels_

labelList edgeLabels_

Definition at line 71 of file faPatchData.H.


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