FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

polyModifyFace Class Reference

Class describing modification of a face. More...

#include <dynamicMesh/polyModifyFace.H>


Detailed Description

Class describing modification of a face.

Definition at line 49 of file polyModifyFace.H.

Inheritance diagram for polyModifyFace:
Collaboration diagram for polyModifyFace:

List of all members.

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.

Constructor & Destructor Documentation

polyModifyFace (  ) [inline]

Construct null. Used in constructing lists.

Definition at line 94 of file polyModifyFace.H.

Referenced by polyModifyFace::clone().

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 109 of file polyModifyFace.H.

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


Member Function Documentation

TypeName ( "modifyFace"    )

Runtime type information.

virtual autoPtr<topoAction> clone (  ) const [inline, virtual]

Construct and return a clone.

Implements topoAction.

Definition at line 257 of file polyModifyFace.H.

References polyModifyFace::polyModifyFace().

const face& newFace (  ) const [inline]

Return face.

Definition at line 268 of file polyModifyFace.H.

Referenced by polyTopoChange::setAction().

label faceID (  ) const [inline]

Return master face ID.

Definition at line 274 of file polyModifyFace.H.

Referenced by polyTopoChange::setAction().

label owner (  ) const [inline]

Return owner cell ID.

Definition at line 280 of file polyModifyFace.H.

Referenced by polyTopoChange::setAction().

label neighbour (  ) const [inline]

Return owner cell ID.

Definition at line 286 of file polyModifyFace.H.

Referenced by polyTopoChange::setAction().

bool flipFaceFlux (  ) const [inline]

Does the face flux need to be flipped.

Definition at line 292 of file polyModifyFace.H.

Referenced by polyTopoChange::setAction().

bool isInPatch (  ) const [inline]

Does the face belong to a boundary patch?

Definition at line 298 of file polyModifyFace.H.

label patchID (  ) const [inline]

Boundary patch ID.

Definition at line 304 of file polyModifyFace.H.

Referenced by polyTopoChange::setAction().

bool isInZone (  ) const [inline]

Does the face belong to a zone?

Definition at line 310 of file polyModifyFace.H.

bool onlyInZone (  ) const [inline]

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

Definition at line 316 of file polyModifyFace.H.

bool removeFromZone (  ) const [inline]

Definition at line 321 of file polyModifyFace.H.

label zoneID (  ) const [inline]

Face zone ID.

Definition at line 327 of file polyModifyFace.H.

Referenced by polyTopoChange::setAction().

label zoneFlip (  ) const [inline]

Face zone flip.

Definition at line 333 of file polyModifyFace.H.

Referenced by polyTopoChange::setAction().


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