Base class of a source for a topoSet. More...
#include <meshTools/topoSetSource.H>
Base class of a source for a topoSet.
Implementer has to modify the given set (see applyToSet) according to its function and the setAction (one of add/delete/new)
Definition at line 64 of file topoSetSource.H.
Inheritance diagram for topoSetSource: Collaboration diagram for topoSetSource:Classes | |
| class | addToUsageTable |
| Class with constructor to add usage string to table. More...
| |
| class | iNew |
| Class used for the read-construction of. More...
| |
Public Types | |
| enum | setAction { CLEAR, NEW, INVERT, ADD, DELETE, SUBSET, LIST, REMOVE } |
Enumeration defining the valid actions. More... | |
Public Member Functions | |
| TypeName ("topoSetSource") | |
| Runtime type information.
| |
| 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) | |
| Construct from components.
| |
| autoPtr< topoSetSource > | clone () const |
| Clone.
| |
| virtual | ~topoSetSource () |
| const polyMesh & | mesh () const |
| virtual void | applyToSet (const setAction action, topoSet &) const =0 |
Static Public Member Functions | |
| static setAction | toAction (const word &actionName) |
| Convert string to action.
| |
| static Istream & | checkIs (Istream &is) |
| Check state of stream.
| |
| static const string & | usage (const word &name) |
| static autoPtr< topoSetSource > | New (const word &topoSetSourceType, const polyMesh &mesh, const dictionary &dict) |
| Return a reference to the selected topoSetSource.
| |
| static autoPtr< topoSetSource > | New (const word &topoSetSourceType, const polyMesh &mesh, Istream &is) |
| Return a reference to the selected topoSetSource.
| |
Protected Member Functions | |
| void | addOrDelete (topoSet &set, const label cellI, const bool) const |
| Add (if bool) cellI to set or delete cellI from set.
| |
Protected Attributes | |
| const polyMesh & | mesh_ |
Static Protected Attributes | |
| static HashTable< string > * | usageTablePtr_ = NULL |
| A table of usage strings.
| |
| enum setAction |
Enumeration defining the valid actions.
Definition at line 71 of file topoSetSource.H.
| topoSetSource | ( | const polyMesh & | mesh ) |
Construct from components.
Definition at line 165 of file topoSetSource.C.
| ~topoSetSource | ( | ) | [virtual]
|
Definition at line 173 of file topoSetSource.C.
| void addOrDelete | ( | topoSet & | set, |
| const label | cellI, | ||
| const bool | add | ||
| ) | const [protected]
|
Add (if bool) cellI to set or delete cellI from set.
Definition at line 145 of file topoSetSource.C.
| TypeName | ( | "topoSetSource" | ) |
Runtime type information.
Convert string to action.
Definition at line 146 of file topoSetSource.H.
| Foam::Istream & checkIs | ( | Istream & | is ) | [static]
|
Check state of stream.
Definition at line 126 of file topoSetSource.C.
References IOstream::eof(), Foam::exit(), Foam::FatalError, FatalErrorIn, and IOstream::good().
| declareRunTimeSelectionTable | ( | autoPtr | , |
| topoSetSource | , | ||
| word | , | ||
| (const polyMesh &mesh, const dictionary &dict) | , | ||
| (mesh, dict) | |||
| ) |
| declareRunTimeSelectionTable | ( | autoPtr | , |
| topoSetSource | , | ||
| istream | , | ||
| (const polyMesh &mesh, Istream &is) | , | ||
| (mesh, is) | |||
| ) |
Definition at line 205 of file topoSetSource.H.
References HashTable< T, Key, Hash >::found(), Foam::name(), and topoSetSource::usageTablePtr_.
| autoPtr<topoSetSource> clone | ( | ) | const [inline]
|
| autoPtr< topoSetSource > New | ( | const word & | topoSetSourceType, |
| const polyMesh & | mesh, | ||
| const dictionary & | dict | ||
| ) | [static]
|
Return a reference to the selected topoSetSource.
Definition at line 41 of file topoSetSource.C.
References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, and mesh.
Referenced by topoSetSource::iNew::operator()().
| autoPtr< topoSetSource > New | ( | const word & | topoSetSourceType, |
| const polyMesh & | mesh, | ||
| Istream & | is | ||
| ) | [static]
|
Return a reference to the selected topoSetSource.
Definition at line 70 of file topoSetSource.C.
References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, and mesh.
| const polyMesh& mesh | ( | ) | const [inline]
|
Definition at line 264 of file topoSetSource.H.
References topoSetSource::mesh_.
Implemented in boxToCell, cellToCell, cylinderAnnulusToCell, cylinderToCell, faceToCell, faceZoneToCell, fieldToCell, labelToCell, nbrToCell, nearestToCell, pointToCell, regionToCell, rotatedBoxToCell, shapeToCell, sphereToCell, surfaceToCell, zoneToCell, setToCellZone, boundaryToFace, boxToFace, cellToFace, faceToFace, labelToFace, normalToFace, patchToFace, pointToFace, zoneToFace, faceZoneToFaceZone, setsToFaceZone, setToFaceZone, boxToPoint, cellToPoint, faceToPoint, labelToPoint, nearestToPoint, pointToPoint, surfaceToPoint, zoneToPoint, and setToPointZone.
Foam::HashTable< Foam::string > * usageTablePtr_ = NULL [static, protected]
|
A table of usage strings.
Definition at line 86 of file topoSetSource.H.
Referenced by topoSetSource::addToUsageTable::addToUsageTable(), topoSetSource::usage(), and topoSetSource::addToUsageTable::~addToUsageTable().
Definition at line 115 of file topoSetSource.H.
Referenced by topoSetSource::mesh().
