cylinderToCell Class Reference

A topoSetCellSource to select all cells whose cell centre inside a given bounding cylinder or cylinder annulus. More...

Inheritance diagram for cylinderToCell:
[legend]
Collaboration diagram for cylinderToCell:
[legend]

Public Member Functions

 TypeName ("cylinderToCell")
 Runtime type information. More...
 
 cylinderToCell (const polyMesh &mesh, const point &point1, const point &point2, const scalar radius, const scalar innerRadius=0)
 Construct from components. More...
 
 cylinderToCell (const polyMesh &mesh, const dictionary &dict)
 Construct from dictionary. More...
 
 cylinderToCell (const polyMesh &mesh, Istream &is)
 Construct from Istream. More...
 
virtual ~cylinderToCell ()=default
 Destructor. More...
 
virtual void applyToSet (const topoSetSource::setAction action, topoSet &set) const
 Apply specified action to the topoSet. More...
 
- Public Member Functions inherited from topoSetCellSource
 declareRunTimeSelectionTable (autoPtr, topoSetCellSource, word,(const polyMesh &mesh, const dictionary &dict),(mesh, dict))
 
 declareRunTimeSelectionTable (autoPtr, topoSetCellSource, istream,(const polyMesh &mesh, Istream &is),(mesh, is))
 
 topoSetCellSource (const polyMesh &mesh)
 Construct from mesh. More...
 
 topoSetCellSource (const polyMesh &mesh, const dictionary &dict)
 Construct from mesh, use "verbose" entry if present. More...
 
autoPtr< topoSetCellSourceclone () const
 Clone (disallowed) More...
 
virtual ~topoSetCellSource ()=default
 Destructor. More...
 
virtual topoSetSource::sourceType setType () const
 The source category is a cellSet. More...
 
- Public Member Functions inherited from topoSetSource
 TypeName ("topoSetSource")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, topoSetSource, word,(const polyMesh &mesh, const dictionary &dict),(mesh, dict))
 
 declareRunTimeSelectionTable (autoPtr, topoSetSource, istream,(const polyMesh &mesh, Istream &is),(mesh, is))
 
 topoSetSource (const polyMesh &mesh, bool verbose=true)
 Construct from mesh, with preferred verbosity. More...
 
 topoSetSource (const polyMesh &mesh, const dictionary &dict)
 Construct from mesh, use "verbose" entry if present. More...
 
autoPtr< topoSetSourceclone () const
 Clone (disallowed) More...
 
virtual ~topoSetSource ()=default
 Destructor. More...
 
const polyMeshmesh () const noexcept
 Reference to the mesh. More...
 
bool verbose () const noexcept
 Get output verbosity. More...
 
bool verbose (bool on) noexcept
 Enable/disable verbose output. More...
 
void verbose (const dictionary &dict)
 Use "verbose" entry (if present) to enable/disable verbose output. More...
 
virtual sourceType setType () const =0
 The source category (cell/face/point combined with set/zone) More...
 
virtual void applyToSet (const topoSetSource::setAction action, topoSet &set) const =0
 Apply specified action to the topoSet. More...
 

Protected Member Functions

 cylinderToCell (const polyMesh &mesh, Istream &is, const bool mandatoryInnerRadius)
 Construct from Istream with mandatory inner radius. More...
 
- Protected Member Functions inherited from topoSetSource
void addOrDelete (topoSet &set, const label id, const bool add) const
 Add or delete id from set. Add when 'add' is true. More...
 
void addOrDelete (topoSet &set, const labelUList &labels, const bool add) const
 Add or delete labels from set. Add when 'add' is true. More...
 
void addOrDelete (topoSet &set, const bitSet &labels, const bool add) const
 Add or delete labels from set. Add when 'add' is true. More...
 
 topoSetSource (const topoSetSource &)=delete
 No copy construct. More...
 
void operator= (const topoSetSource &)=delete
 No copy assignment. More...
 

Additional Inherited Members

- Public Types inherited from topoSetSource
enum  sourceType {
  UNKNOWN_SOURCE = 0 , CELL_TYPE = 0x1 , FACE_TYPE = 0x2 , POINT_TYPE = 0x4 ,
  SET_SOURCE = 0x10 , CELLSET_SOURCE = (CELL_TYPE | SET_SOURCE) , FACESET_SOURCE = (FACE_TYPE | SET_SOURCE) , POINTSET_SOURCE = (POINT_TYPE | SET_SOURCE) ,
  ZONE_SOURCE = 0x20 , CELLZONE_SOURCE = (CELL_TYPE | ZONE_SOURCE) , FACEZONE_SOURCE = (FACE_TYPE | ZONE_SOURCE) , POINTZONE_SOURCE = (POINT_TYPE | ZONE_SOURCE) ,
  CELLSETSOURCE = CELLSET_SOURCE , FACESETSOURCE = FACESET_SOURCE , POINTSETSOURCE = POINTSET_SOURCE , CELLZONESOURCE = CELLZONE_SOURCE ,
  FACEZONESOURCE = FACEZONE_SOURCE , POINTZONESOURCE = POINTZONE_SOURCE
}
 Enumeration defining the types of sources. More...
 
enum  setAction {
  ADD , SUBTRACT , NEW , SUBSET ,
  INVERT , CLEAR , REMOVE , LIST ,
  IGNORE , DELETE = SUBTRACT
}
 Enumeration defining various actions. More...
 
- Static Public Member Functions inherited from topoSetCellSource
static autoPtr< topoSetCellSourceNew (const word &sourceType, const polyMesh &mesh, const dictionary &dict)
 Return a reference to the selected source type. More...
 
static autoPtr< topoSetCellSourceNew (const word &sourceType, const polyMesh &mesh, Istream &is)
 Return a reference to the selected source type. More...
 
- Static Public Member Functions inherited from topoSetSource
static IstreamcheckIs (Istream &is)
 Check state of stream. More...
 
static bool isSetSource (const sourceType t) noexcept
 True if a "set" source. More...
 
static bool isZoneSource (const sourceType t) noexcept
 True if a "zone" source. More...
 
static bool isCell (const sourceType t) noexcept
 True if "cell" geometric type. More...
 
static bool isFace (const sourceType t) noexcept
 True if "face" geometric type. More...
 
static bool isPoint (const sourceType t) noexcept
 True if "point" geometric type. More...
 
static const stringusage (const word &name)
 
static autoPtr< topoSetSourceNew (const word &topoSetSourceType, const polyMesh &mesh, const dictionary &dict)
 Return a reference to the selected topoSetSource. More...
 
static autoPtr< topoSetSourceNew (const word &topoSetSourceType, const polyMesh &mesh, Istream &is)
 Return a reference to the selected topoSetSource. More...
 
static setAction toAction (const word &actionName)
 Deprecated(2018-07) convert string to action. More...
 
- Static Public Attributes inherited from topoSetSource
static const Enum< setActionactionNames
 
static const Enum< setActioncombineNames
 
- Static Protected Member Functions inherited from topoSetSource
static bool check (labelList &list, const label maxLabel)
 Detect and remove any values less than 0 or ge maxLabel. More...
 
- Protected Attributes inherited from topoSetSource
const polyMeshmesh_
 Reference to the mesh. More...
 
bool verbose_
 Output verbosity (default: true) More...
 
- Static Protected Attributes inherited from topoSetSource
static const string illegalSource_
 
static HashTable< string > * usageTablePtr_ = nullptr
 A table of usage strings. More...
 

Detailed Description

A topoSetCellSource to select all cells whose cell centre inside a given bounding cylinder or cylinder annulus.

Operands:

Operand Type Location
output cellSet $FOAM_CASE/constant/polyMesh/sets/<set>
Usage
Minimal example by using system/topoSetDict.actions:
{
    // Mandatory (inherited) entries
    name           <name>;
    type           cellSet;
    action         <action>;

    // Mandatory entries
    source         cylinderToCell;
    point1         (<p1X> <p1Y> <p1Z>);
    point2         (<p2X> <p2Y> <p2Z>);
    radius         <radius1>;   // or outerRadius

    // Optional entries
    innerRadius    <radius2>;
}

where the entries mean:

Property Description Type Req'd Dflt
name Name of cellSet word yes -
type Type name: cellSet word yes -
action Action applied on cells - see below word yes -
source Source name: cylinderToCell word yes -
point1 (p1) Coordinate of the first endpoint vector yes -
point2 (p2) Coordinate of the second endpoint vector yes -
radius Cylinder outer radius scalar yes -
innerRadius Cylinder inner radius scalar no 0
outerRadius Alternative spelling for 'radius' scalar no -

Options for the action entry:

      new      | Create a new cellSet from selected cells
      add      | Add selected cells into this cellSet
      subtract | Remove selected cells from this cellSet
See also
Source files

Definition at line 172 of file cylinderToCell.H.

Constructor & Destructor Documentation

◆ cylinderToCell() [1/4]

cylinderToCell ( const polyMesh mesh,
Istream is,
const bool  mandatoryInnerRadius 
)
protected

Construct from Istream with mandatory inner radius.

Definition at line 141 of file cylinderToCell.C.

References topoSetSource::checkIs().

Here is the call graph for this function:

◆ cylinderToCell() [2/4]

cylinderToCell ( const polyMesh mesh,
const point point1,
const point point2,
const scalar  radius,
const scalar  innerRadius = 0 
)

Construct from components.

Definition at line 99 of file cylinderToCell.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ cylinderToCell() [3/4]

cylinderToCell ( const polyMesh mesh,
const dictionary dict 
)

Construct from dictionary.

Definition at line 124 of file cylinderToCell.C.

◆ cylinderToCell() [4/4]

cylinderToCell ( const polyMesh mesh,
Istream is 
)

Construct from Istream.

Definition at line 161 of file cylinderToCell.C.

◆ ~cylinderToCell()

virtual ~cylinderToCell ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "cylinderToCell"  )

Runtime type information.

◆ applyToSet()

void applyToSet ( const topoSetSource::setAction  action,
topoSet set 
) const
virtual

Apply specified action to the topoSet.

Implements topoSetSource.

Definition at line 173 of file cylinderToCell.C.

References topoSetSource::ADD, Foam::endl(), Foam::Info, topoSetSource::NEW, and topoSetSource::SUBTRACT.

Here is the call graph for this function:

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