FreeFOAM The Cross-Platform CFD Toolkit
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...

#include <dynamicMesh/polyAddFace.H>


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 52 of file polyAddFace.H.

+ Inheritance diagram for polyAddFace:
+ Collaboration diagram for polyAddFace:

List of all members.

Public Member Functions

 TypeName ("addFace")
 Runtime type information.
 polyAddFace ()
 Construct null. Used for constructing lists.
 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.
virtual autoPtr< topoActionclone () const
 Construct and return a clone.
const facenewFace () const
 Return face.
label owner () const
 Return owner cell.
label neighbour () const
 Return neighour cell.
bool isPointMaster () const
 Is the face mastered by a point.
bool isEdgeMaster () const
 Is the face mastered by an edge.
bool isFaceMaster () const
 Is the face mastered by another face.
bool appended () const
 Is the face appended with no master.
label masterPointID () const
 Return master point ID.
label masterEdgeID () const
 Return master edge ID.
label masterFaceID () const
 Return master face 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)
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 ()

Constructor & Destructor Documentation

polyAddFace ( )
inline

Construct null. Used for constructing lists.

Definition at line 100 of file polyAddFace.H.

Referenced by polyAddFace::clone().

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

Construct from components.

Definition at line 117 of file polyAddFace.H.

References Foam::abort(), Foam::FatalError, FatalErrorIn, Foam::min(), and List< T >::size().


Member Function Documentation

TypeName ( "addFace"  )

Runtime type information.

virtual autoPtr<topoAction> clone ( ) const
inlinevirtual

Construct and return a clone.

Implements topoAction.

Definition at line 312 of file polyAddFace.H.

References polyAddFace::polyAddFace().

const face& newFace ( ) const
inline

Return face.

Definition at line 323 of file polyAddFace.H.

Referenced by polyTopoChange::setAction().

label owner ( ) const
inline

Return owner cell.

Definition at line 329 of file polyAddFace.H.

Referenced by polyTopoChange::setAction().

label neighbour ( ) const
inline

Return neighour cell.

Definition at line 335 of file polyAddFace.H.

Referenced by polyTopoChange::setAction().

bool isPointMaster ( ) const
inline

Is the face mastered by a point.

Definition at line 341 of file polyAddFace.H.

Referenced by polyAddFace::appended().

bool isEdgeMaster ( ) const
inline

Is the face mastered by an edge.

Definition at line 347 of file polyAddFace.H.

Referenced by polyAddFace::appended().

bool isFaceMaster ( ) const
inline

Is the face mastered by another face.

Definition at line 353 of file polyAddFace.H.

Referenced by polyAddFace::appended().

bool appended ( ) const
inline

Is the face appended with no master.

Definition at line 359 of file polyAddFace.H.

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

label masterPointID ( ) const
inline

Return master point ID.

Definition at line 365 of file polyAddFace.H.

Referenced by polyTopoChange::setAction().

label masterEdgeID ( ) const
inline

Return master edge ID.

Definition at line 371 of file polyAddFace.H.

Referenced by polyTopoChange::setAction().

label masterFaceID ( ) const
inline

Return master face ID.

Definition at line 377 of file polyAddFace.H.

Referenced by polyTopoChange::setAction().

bool flipFaceFlux ( ) const
inline

Does the face flux need to be flipped.

Definition at line 383 of file polyAddFace.H.

Referenced by polyTopoChange::setAction().

bool isInPatch ( ) const
inline

Does the face belong to a boundary patch?

Definition at line 389 of file polyAddFace.H.

label patchID ( ) const
inline

Boundary patch ID.

Definition at line 395 of file polyAddFace.H.

Referenced by polyTopoChange::setAction().

bool isInZone ( ) const
inline

Does the face belong to a zone?

Definition at line 401 of file polyAddFace.H.

bool onlyInZone ( ) const
inline

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

Definition at line 407 of file polyAddFace.H.

label zoneID ( ) const
inline

Face zone ID.

Definition at line 413 of file polyAddFace.H.

Referenced by polyTopoChange::setAction().

label zoneFlip ( ) const
inline

Face zone flip.

Definition at line 419 of file polyAddFace.H.

Referenced by polyTopoChange::setAction().


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