Public Member Functions | Private Attributes
polyModifyCell Class Reference

Class describing modification of a cell. More...

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

Public Member Functions

 TypeName ("modifyCell")
 Runtime type information. More...
 
 polyModifyCell ()
 Construct null. Used only for list construction. More...
 
 polyModifyCell (const label cellID, const bool removeFromZone, const label newZoneID)
 Construct from components. More...
 
virtual autoPtr< topoActionclone () const
 Construct and return a clone. More...
 
label cellID () const
 Cell ID. More...
 
bool isInZone () const
 Does the cell belong to a zone? More...
 
bool removeFromZone () const
 
label zoneID () const
 Cell zone ID. More...
 
- Public Member Functions inherited from topoAction
 TypeName ("topoAction")
 Runtime type information. More...
 
 topoAction ()
 Construct null. More...
 
virtual ~topoAction ()
 Destructor. More...
 

Private Attributes

label cellID_
 Cell ID. More...
 
bool removeFromZone_
 Remove from current zone. More...
 
label zoneID_
 New zone ID. More...
 

Detailed Description

Class describing modification of a cell.

Definition at line 46 of file polyModifyCell.H.

Constructor & Destructor Documentation

◆ polyModifyCell() [1/2]

polyModifyCell ( )
inline

Construct null. Used only for list construction.

Definition at line 73 of file polyModifyCell.H.

Referenced by polyModifyCell::clone().

Here is the caller graph for this function:

◆ polyModifyCell() [2/2]

polyModifyCell ( const label  cellID,
const bool  removeFromZone,
const label  newZoneID 
)
inline

Construct from components.

Definition at line 82 of file polyModifyCell.H.

Member Function Documentation

◆ TypeName()

TypeName ( "modifyCell"  )

Runtime type information.

◆ clone()

virtual autoPtr<topoAction> clone ( ) const
inlinevirtual

Construct and return a clone.

Implements topoAction.

Definition at line 94 of file polyModifyCell.H.

References polyModifyCell::polyModifyCell().

Here is the call graph for this function:

◆ cellID()

label cellID ( ) const
inline

Cell ID.

Definition at line 105 of file polyModifyCell.H.

References polyModifyCell::cellID_.

Referenced by polyTopoChange::setAction().

Here is the caller graph for this function:

◆ isInZone()

bool isInZone ( ) const
inline

Does the cell belong to a zone?

Definition at line 111 of file polyModifyCell.H.

References polyModifyCell::zoneID_.

◆ removeFromZone()

bool removeFromZone ( ) const
inline

Definition at line 116 of file polyModifyCell.H.

References polyModifyCell::removeFromZone_.

Referenced by polyTopoChange::setAction().

Here is the caller graph for this function:

◆ zoneID()

label zoneID ( ) const
inline

Cell zone ID.

Definition at line 122 of file polyModifyCell.H.

References polyModifyCell::zoneID_.

Referenced by polyTopoChange::setAction().

Here is the caller graph for this function:

Field Documentation

◆ cellID_

label cellID_
private

Cell ID.

Definition at line 53 of file polyModifyCell.H.

Referenced by polyModifyCell::cellID().

◆ removeFromZone_

bool removeFromZone_
private

Remove from current zone.

Definition at line 56 of file polyModifyCell.H.

Referenced by polyModifyCell::removeFromZone().

◆ zoneID_

label zoneID_
private

New zone ID.

Definition at line 59 of file polyModifyCell.H.

Referenced by polyModifyCell::isInZone(), and polyModifyCell::zoneID().


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