Loading...
Searching...
No Matches
polyModifyFace Class Reference

Class describing modification of a face. More...

#include <polyModifyFace.H>

Inheritance diagram for polyModifyFace:
Inheritance graph
[legend]
Collaboration diagram for polyModifyFace:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("modifyFace")
 Runtime type information.
 polyModifyFace ()
 Construct null. Used in constructing lists.
 polyModifyFace (const face &f, const label faceID, const label owner, const label neighbour, const bool flipFaceFlux, const label patchID, const bool removeFromZone, const label zoneID, const bool zoneFlip)
 Construct from components.
virtual autoPtr< topoAction > clone () const
 Construct and return a clone.
const face & newFace () const
 Return face.
label faceID () const
 Return master face ID.
label owner () const
 Return owner cell ID.
label neighbour () const
 Return owner cell ID.
bool flipFaceFlux () const
 Does the face flux need to be flipped.
bool isInPatch () const
 Does the face belong to a boundary patch?
label patchID () const
 Boundary patch ID.
bool isInZone () const
 Does the face belong to a zone?
bool onlyInZone () const
 Is the face only a zone face (i.e. not belonging to a cell).
bool removeFromZone () const
label zoneID () const
 Face zone ID.
label zoneFlip () const
 Face zone flip.
Public Member Functions inherited from topoAction
 TypeName ("topoAction")
 Runtime type information.
 topoAction ()
 Construct null.
virtual ~topoAction ()=default
 Destructor.

Detailed Description

Class describing modification of a face.

Definition at line 44 of file polyModifyFace.H.

Constructor & Destructor Documentation

◆ polyModifyFace() [1/2]

polyModifyFace ( )
inline

Construct null. Used in constructing lists.

Definition at line 111 of file polyModifyFace.H.

Referenced by clone().

Here is the caller graph for this function:

◆ polyModifyFace() [2/2]

polyModifyFace ( const face & f,
const label faceID,
const label owner,
const label neighbour,
const bool flipFaceFlux,
const label patchID,
const bool removeFromZone,
const label zoneID,
const bool zoneFlip )
inline

Construct from components.

Definition at line 127 of file polyModifyFace.H.

References Foam::abort(), f(), faceID(), Foam::FatalError, FatalErrorInFunction, flipFaceFlux(), if(), Foam::min(), neighbour(), owner(), patchID(), removeFromZone(), zoneFlip(), and zoneID().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "modifyFace" )

Runtime type information.

◆ clone()

virtual autoPtr< topoAction > clone ( ) const
inlinevirtual

Construct and return a clone.

Implements topoAction.

Definition at line 209 of file polyModifyFace.H.

References polyModifyFace().

Here is the call graph for this function:

◆ newFace()

const face & newFace ( ) const
inline

Return face.

Definition at line 222 of file polyModifyFace.H.

Referenced by polyTopoChange::setAction().

Here is the caller graph for this function:

◆ faceID()

label faceID ( ) const
inline

Return master face ID.

Definition at line 230 of file polyModifyFace.H.

Referenced by polyModifyFace(), and polyTopoChange::setAction().

Here is the caller graph for this function:

◆ owner()

label owner ( ) const
inline

Return owner cell ID.

Definition at line 238 of file polyModifyFace.H.

Referenced by polyModifyFace(), and polyTopoChange::setAction().

Here is the caller graph for this function:

◆ neighbour()

label neighbour ( ) const
inline

Return owner cell ID.

Definition at line 246 of file polyModifyFace.H.

Referenced by polyModifyFace(), and polyTopoChange::setAction().

Here is the caller graph for this function:

◆ flipFaceFlux()

bool flipFaceFlux ( ) const
inline

Does the face flux need to be flipped.

Definition at line 254 of file polyModifyFace.H.

Referenced by polyModifyFace(), and polyTopoChange::setAction().

Here is the caller graph for this function:

◆ isInPatch()

bool isInPatch ( ) const
inline

Does the face belong to a boundary patch?

Definition at line 262 of file polyModifyFace.H.

◆ patchID()

label patchID ( ) const
inline

Boundary patch ID.

Definition at line 270 of file polyModifyFace.H.

Referenced by polyModifyFace(), and polyTopoChange::setAction().

Here is the caller graph for this function:

◆ isInZone()

bool isInZone ( ) const
inline

Does the face belong to a zone?

Definition at line 278 of file polyModifyFace.H.

◆ onlyInZone()

bool onlyInZone ( ) const
inline

Is the face only a zone face (i.e. not belonging to a cell).

Definition at line 286 of file polyModifyFace.H.

◆ removeFromZone()

bool removeFromZone ( ) const
inline

Definition at line 291 of file polyModifyFace.H.

Referenced by polyModifyFace().

Here is the caller graph for this function:

◆ zoneID()

label zoneID ( ) const
inline

Face zone ID.

Definition at line 299 of file polyModifyFace.H.

Referenced by polyModifyFace(), and polyTopoChange::setAction().

Here is the caller graph for this function:

◆ zoneFlip()

label zoneFlip ( ) const
inline

Face zone flip.

Definition at line 307 of file polyModifyFace.H.

Referenced by polyModifyFace(), and polyTopoChange::setAction().

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