polyModifyFace Class Reference

Class describing modification of a face. More...

Inheritance diagram for polyModifyFace:

Collaboration diagram for polyModifyFace:

Public Member Functions
	TypeName ("modifyFace")
	Runtime type information. More...
	polyModifyFace ()
	Construct null. Used in constructing lists. More...
	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. More...
virtual autoPtr< topoAction >	clone () const
	Construct and return a clone. More...
const face &	newFace () const
	Return face. More...
label	faceID () const
	Return master face ID. More...
label	owner () const
	Return owner cell ID. More...
label	neighbour () const
	Return owner cell 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...
bool	removeFromZone () const
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. More...
label	faceID_
	Master face ID. More...
label	owner_
	Face owner. More...
label	neighbour_
	Face neighbour. More...
bool	flipFaceFlux_
	Does the face flux need to be flipped. More...
label	patchID_
	Boundary patch ID. More...
bool	removeFromZone_
	Remove from current zone. More...
label	zoneID_
	Face zone ID. More...
bool	zoneFlip_
	Face zone flip. More...

Detailed Description

Class describing modification of a face.

Definition at line 48 of file polyModifyFace.H.

Constructor & Destructor Documentation

polyModifyFace() [1/2]

polyModifyFace ( )

inline

Construct null. Used in constructing lists.

Definition at line 93 of file polyModifyFace.H.

Referenced by polyModifyFace::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 108 of file polyModifyFace.H.

References Foam::abort(), polyModifyFace::face_, polyModifyFace::faceID_, Foam::FatalError, FatalErrorInFunction, Foam::min(), polyModifyFace::neighbour_, polyModifyFace::owner_, polyModifyFace::patchID_, List::size(), polyModifyFace::zoneFlip(), and polyModifyFace::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 187 of file polyModifyFace.H.

References polyModifyFace::polyModifyFace().

Here is the call graph for this function:

newFace()

const face& newFace ( ) const

inline

Return face.

Definition at line 198 of file polyModifyFace.H.

References polyModifyFace::face_.

Referenced by polyTopoChange::setAction().

Here is the caller graph for this function:

faceID()

label faceID ( ) const

inline

Return master face ID.

Definition at line 204 of file polyModifyFace.H.

References polyModifyFace::faceID_.

Referenced by polyTopoChange::setAction().

Here is the caller graph for this function:

owner()

label owner ( ) const

inline

Return owner cell ID.

Definition at line 210 of file polyModifyFace.H.

References polyModifyFace::owner_.

Referenced by polyTopoChange::setAction().

Here is the caller graph for this function:

neighbour()

label neighbour ( ) const

inline

Return owner cell ID.

Definition at line 216 of file polyModifyFace.H.

References polyModifyFace::neighbour_.

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

References polyModifyFace::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 228 of file polyModifyFace.H.

References polyModifyFace::patchID_.

patchID()

label patchID ( ) const

inline

Boundary patch ID.

Definition at line 234 of file polyModifyFace.H.

References polyModifyFace::patchID_.

Referenced by 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 240 of file polyModifyFace.H.

References polyModifyFace::zoneID_.

onlyInZone()

bool onlyInZone ( ) const

inline

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

Definition at line 246 of file polyModifyFace.H.

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

removeFromZone()

bool removeFromZone ( ) const

inline

Definition at line 251 of file polyModifyFace.H.

References polyModifyFace::removeFromZone_.

zoneID()

label zoneID ( ) const

inline

Face zone ID.

Definition at line 257 of file polyModifyFace.H.

References polyModifyFace::zoneID_.

Referenced by polyTopoChange::setAction().

Here is the caller graph for this function:

zoneFlip()

label zoneFlip ( ) const

inline

Face zone flip.

Definition at line 263 of file polyModifyFace.H.

References polyModifyFace::zoneFlip_.

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

Here is the caller graph for this function:

Field Documentation

face_

face face_

private

Face.

Definition at line 55 of file polyModifyFace.H.

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

faceID_

label faceID_

private

Master face ID.

Definition at line 58 of file polyModifyFace.H.

Referenced by polyModifyFace::faceID(), and polyModifyFace::polyModifyFace().

owner_

label owner_

private

Face owner.

Definition at line 61 of file polyModifyFace.H.

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

neighbour_

label neighbour_

private

Face neighbour.

Definition at line 64 of file polyModifyFace.H.

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

flipFaceFlux_

bool flipFaceFlux_

private

Does the face flux need to be flipped.

Definition at line 67 of file polyModifyFace.H.

Referenced by polyModifyFace::flipFaceFlux().

patchID_

label patchID_

private

Boundary patch ID.

Definition at line 70 of file polyModifyFace.H.

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

removeFromZone_

bool removeFromZone_

private

Remove from current zone.

Definition at line 73 of file polyModifyFace.H.

Referenced by polyModifyFace::removeFromZone().

zoneID_

label zoneID_

private

Face zone ID.

Definition at line 76 of file polyModifyFace.H.

Referenced by polyModifyFace::isInZone(), polyModifyFace::onlyInZone(), polyModifyFace::polyModifyFace(), and polyModifyFace::zoneID().

zoneFlip_

bool zoneFlip_

private

Face zone flip.

Definition at line 79 of file polyModifyFace.H.

Referenced by polyModifyFace::zoneFlip().

---

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

• src/dynamicMesh/polyTopoChange/polyTopoChange/modifyObject/polyModifyFace.H