Public Member Functions | Private Attributes
polyAddFace Class Reference

A face addition data class. A face can be inflated either from a point or from another face and can either be in internal or a boundary face. More...

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

Public Member Functions

 TypeName ("addFace")
 Runtime type information. More...
 
 polyAddFace ()
 Construct null. Used for constructing lists. More...
 
 polyAddFace (const face &f, const label owner, const label neighbour, const label masterPointID, const label masterEdgeID, const label masterFaceID, const bool flipFaceFlux, const label patchID, const label zoneID, const bool zoneFlip)
 Construct from components. More...
 
virtual autoPtr< topoActionclone () const
 Construct and return a clone. More...
 
const facenewFace () const
 Return face. More...
 
label owner () const
 Return owner cell. More...
 
label neighbour () const
 Return neighour cell. More...
 
bool isPointMaster () const
 Is the face mastered by a point. More...
 
bool isEdgeMaster () const
 Is the face mastered by an edge. More...
 
bool isFaceMaster () const
 Is the face mastered by another face. More...
 
bool appended () const
 Is the face appended with no master. More...
 
label masterPointID () const
 Return master point ID. More...
 
label masterEdgeID () const
 Return master edge ID. More...
 
label masterFaceID () const
 Return master face ID. More...
 
bool flipFaceFlux () const
 Does the face flux need to be flipped. More...
 
bool isInPatch () const
 Does the face belong to a boundary patch? More...
 
label patchID () const
 Boundary patch ID. More...
 
bool isInZone () const
 Does the face belong to a zone? More...
 
bool onlyInZone () const
 Is the face only a zone face (i.e. not belonging to a cell) More...
 
label zoneID () const
 Face zone ID. More...
 
label zoneFlip () const
 Face zone flip. More...
 
- Public Member Functions inherited from topoAction
 TypeName ("topoAction")
 Runtime type information. More...
 
 topoAction ()
 Construct null. More...
 
virtual ~topoAction ()
 Destructor. More...
 

Private Attributes

face face_
 Face identifier. More...
 
label owner_
 Face owner. More...
 
label neighbour_
 Face neighbour. More...
 
label masterPointID_
 Master point ID for faces blown up from points. More...
 
label masterEdgeID_
 Master edge ID for faces blown up from edges. More...
 
label masterFaceID_
 Master face ID for faces blown up from faces. More...
 
bool flipFaceFlux_
 Does the face flux need to be flipped. More...
 
label patchID_
 Boundary patch ID. More...
 
label zoneID_
 Face zone ID. More...
 
bool zoneFlip_
 Face zone flip. More...
 

Detailed Description

A face addition data class. A face can be inflated either from a point or from another face and can either be in internal or a boundary face.

Definition at line 51 of file polyAddFace.H.

Constructor & Destructor Documentation

◆ polyAddFace() [1/2]

polyAddFace ( )
inline

Construct null. Used for constructing lists.

Definition at line 99 of file polyAddFace.H.

Referenced by polyAddFace::clone().

Here is the caller graph for this function:

◆ polyAddFace() [2/2]

polyAddFace ( const face f,
const label  owner,
const label  neighbour,
const label  masterPointID,
const label  masterEdgeID,
const label  masterFaceID,
const bool  flipFaceFlux,
const label  patchID,
const label  zoneID,
const bool  zoneFlip 
)
inline

Member Function Documentation

◆ TypeName()

TypeName ( "addFace"  )

Runtime type information.

◆ clone()

virtual autoPtr<topoAction> clone ( ) const
inlinevirtual

Construct and return a clone.

Implements topoAction.

Definition at line 227 of file polyAddFace.H.

References polyAddFace::polyAddFace().

Here is the call graph for this function:

◆ newFace()

const face& newFace ( ) const
inline

Return face.

Definition at line 238 of file polyAddFace.H.

References polyAddFace::face_.

Referenced by polyTopoChange::setAction().

Here is the caller graph for this function:

◆ owner()

label owner ( ) const
inline

Return owner cell.

Definition at line 244 of file polyAddFace.H.

References polyAddFace::owner_.

Referenced by polyTopoChange::setAction().

Here is the caller graph for this function:

◆ neighbour()

label neighbour ( ) const
inline

Return neighour cell.

Definition at line 250 of file polyAddFace.H.

References polyAddFace::neighbour_.

Referenced by polyTopoChange::setAction().

Here is the caller graph for this function:

◆ isPointMaster()

bool isPointMaster ( ) const
inline

Is the face mastered by a point.

Definition at line 256 of file polyAddFace.H.

References polyAddFace::masterPointID_.

Referenced by polyAddFace::appended().

Here is the caller graph for this function:

◆ isEdgeMaster()

bool isEdgeMaster ( ) const
inline

Is the face mastered by an edge.

Definition at line 262 of file polyAddFace.H.

References polyAddFace::masterEdgeID_.

Referenced by polyAddFace::appended().

Here is the caller graph for this function:

◆ isFaceMaster()

bool isFaceMaster ( ) const
inline

Is the face mastered by another face.

Definition at line 268 of file polyAddFace.H.

References polyAddFace::masterFaceID_.

Referenced by polyAddFace::appended().

Here is the caller graph for this function:

◆ appended()

bool appended ( ) const
inline

Is the face appended with no master.

Definition at line 274 of file polyAddFace.H.

References polyAddFace::isEdgeMaster(), polyAddFace::isFaceMaster(), and polyAddFace::isPointMaster().

Here is the call graph for this function:

◆ masterPointID()

label masterPointID ( ) const
inline

Return master point ID.

Definition at line 280 of file polyAddFace.H.

References polyAddFace::masterPointID_.

Referenced by polyTopoChange::setAction().

Here is the caller graph for this function:

◆ masterEdgeID()

label masterEdgeID ( ) const
inline

Return master edge ID.

Definition at line 286 of file polyAddFace.H.

References polyAddFace::masterEdgeID_.

Referenced by polyTopoChange::setAction().

Here is the caller graph for this function:

◆ masterFaceID()

label masterFaceID ( ) const
inline

Return master face ID.

Definition at line 292 of file polyAddFace.H.

References polyAddFace::masterFaceID_.

Referenced by 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 298 of file polyAddFace.H.

References polyAddFace::flipFaceFlux_.

Referenced by 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 304 of file polyAddFace.H.

References polyAddFace::patchID_.

◆ patchID()

label patchID ( ) const
inline

Boundary patch ID.

Definition at line 310 of file polyAddFace.H.

References polyAddFace::patchID_.

Referenced by polyAddFace::polyAddFace(), 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 316 of file polyAddFace.H.

References polyAddFace::zoneID_.

◆ onlyInZone()

bool onlyInZone ( ) const
inline

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

Definition at line 322 of file polyAddFace.H.

References polyAddFace::neighbour_, polyAddFace::owner_, and polyAddFace::zoneID_.

◆ zoneID()

label zoneID ( ) const
inline

Face zone ID.

Definition at line 328 of file polyAddFace.H.

References polyAddFace::zoneID_.

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

Here is the caller graph for this function:

◆ zoneFlip()

label zoneFlip ( ) const
inline

Face zone flip.

Definition at line 334 of file polyAddFace.H.

References polyAddFace::zoneFlip_.

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

Here is the caller graph for this function:

Field Documentation

◆ face_

face face_
private

Face identifier.

Definition at line 58 of file polyAddFace.H.

Referenced by polyAddFace::newFace(), and polyAddFace::polyAddFace().

◆ owner_

label owner_
private

Face owner.

Definition at line 61 of file polyAddFace.H.

Referenced by polyAddFace::onlyInZone(), polyAddFace::owner(), and polyAddFace::polyAddFace().

◆ neighbour_

label neighbour_
private

Face neighbour.

Definition at line 64 of file polyAddFace.H.

Referenced by polyAddFace::neighbour(), polyAddFace::onlyInZone(), and polyAddFace::polyAddFace().

◆ masterPointID_

label masterPointID_
private

Master point ID for faces blown up from points.

Definition at line 67 of file polyAddFace.H.

Referenced by polyAddFace::isPointMaster(), polyAddFace::masterPointID(), and polyAddFace::polyAddFace().

◆ masterEdgeID_

label masterEdgeID_
private

Master edge ID for faces blown up from edges.

Definition at line 70 of file polyAddFace.H.

Referenced by polyAddFace::isEdgeMaster(), polyAddFace::masterEdgeID(), and polyAddFace::polyAddFace().

◆ masterFaceID_

label masterFaceID_
private

Master face ID for faces blown up from faces.

Definition at line 73 of file polyAddFace.H.

Referenced by polyAddFace::isFaceMaster(), polyAddFace::masterFaceID(), and polyAddFace::polyAddFace().

◆ flipFaceFlux_

bool flipFaceFlux_
private

Does the face flux need to be flipped.

Definition at line 76 of file polyAddFace.H.

Referenced by polyAddFace::flipFaceFlux().

◆ patchID_

label patchID_
private

Boundary patch ID.

Definition at line 79 of file polyAddFace.H.

Referenced by polyAddFace::isInPatch(), polyAddFace::patchID(), and polyAddFace::polyAddFace().

◆ zoneID_

label zoneID_
private

◆ zoneFlip_

bool zoneFlip_
private

Face zone flip.

Definition at line 85 of file polyAddFace.H.

Referenced by polyAddFace::zoneFlip().


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