A topoSetPointSource
to select all points which are inside a given bounding cylinder or cylinder annulus.
More...
Public Member Functions | |
TypeName ("cylinderToPoint") | |
Runtime type information. More... | |
cylinderToPoint (const polyMesh &mesh, const point &point1, const point &point2, const scalar radius, const scalar innerRadius=0) | |
Construct from components. More... | |
cylinderToPoint (const polyMesh &mesh, const dictionary &dict) | |
Construct from dictionary. More... | |
cylinderToPoint (const polyMesh &mesh, Istream &is) | |
Construct from Istream. More... | |
virtual | ~cylinderToPoint ()=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 topoSetPointSource | |
declareRunTimeSelectionTable (autoPtr, topoSetPointSource, word,(const polyMesh &mesh, const dictionary &dict),(mesh, dict)) | |
declareRunTimeSelectionTable (autoPtr, topoSetPointSource, istream,(const polyMesh &mesh, Istream &is),(mesh, is)) | |
topoSetPointSource (const polyMesh &mesh) | |
Construct from mesh. More... | |
topoSetPointSource (const polyMesh &mesh, const dictionary &dict) | |
Construct from mesh, use "verbose" entry if present. More... | |
autoPtr< topoSetPointSource > | clone () const |
Clone (disallowed) More... | |
virtual | ~topoSetPointSource ()=default |
Destructor. More... | |
virtual topoSetSource::sourceType | setType () const |
The source category is a pointSet. 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< topoSetSource > | clone () const |
Clone (disallowed) More... | |
virtual | ~topoSetSource ()=default |
Destructor. More... | |
const polyMesh & | mesh () 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... | |
Protected Member Functions | |
cylinderToPoint (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 topoSetPointSource | |
static autoPtr< topoSetPointSource > | New (const word &sourceType, const polyMesh &mesh, const dictionary &dict) |
Return a reference to the selected source type. More... | |
static autoPtr< topoSetPointSource > | New (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 Istream & | checkIs (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 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. More... | |
static autoPtr< topoSetSource > | New (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< setAction > | actionNames |
The setActions enum text. Names: "new", add", "subtract", "subset", "invert",
"clear", "remove", "list", "ignore". More... | |
static const Enum< setAction > | combineNames |
The setAction enum text when combining selections. Names: "use", "add", "subtract", "subset", "invert", "ignore". More... | |
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 polyMesh & | mesh_ |
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... | |
A topoSetPointSource
to select all points which are inside a given bounding cylinder or cylinder annulus.
Operand | Type | Location |
---|---|---|
output | pointSet | $FOAM_CASE/constant/polyMesh/sets/<set> |
system/topoSetDict.actions
: { // Mandatory (inherited) entries name <name>; type pointSet; action <action>; // Mandatory entries source cylinderToPoint; 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 pointSet | word | yes | - |
type | Type name: pointSet | word | yes | - |
action | Action applied on points - see below | word | yes | - |
source | Source name: cylinderToPoint | 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 pointSet from selected points add | Add selected points into this pointSet subtract | Remove selected points from this pointSet
Definition at line 167 of file cylinderToPoint.H.
|
protected |
Construct from Istream with mandatory inner radius.
Definition at line 127 of file cylinderToPoint.C.
cylinderToPoint | ( | const polyMesh & | mesh, |
const point & | point1, | ||
const point & | point2, | ||
const scalar | radius, | ||
const scalar | innerRadius = 0 |
||
) |
Construct from components.
Definition at line 93 of file cylinderToPoint.C.
cylinderToPoint | ( | const polyMesh & | mesh, |
const dictionary & | dict | ||
) |
Construct from dictionary.
Definition at line 110 of file cylinderToPoint.C.
cylinderToPoint | ( | const polyMesh & | mesh, |
Istream & | is | ||
) |
Construct from Istream.
Definition at line 147 of file cylinderToPoint.C.
|
virtualdefault |
Destructor.
TypeName | ( | "cylinderToPoint" | ) |
Runtime type information.
|
virtual |
Apply specified action to the topoSet.
Implements topoSetSource.
Definition at line 159 of file cylinderToPoint.C.
References topoSetSource::ADD, Foam::ListListOps::combine(), Foam::endl(), Foam::Info, topoSetSource::NEW, and topoSetSource::SUBTRACT.
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.