A topoSetCellSource
to select cells based on front
or back
side of given faceZone(s)
.
More...
Public Types | |
enum | faceAction { FRONT, BACK, BOTH, MASTER = FRONT, SLAVE = BACK } |
Enumeration defining the valid options. More... | |
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... | |
Public Member Functions | |
TypeName ("faceZoneToCell") | |
Runtime type information. More... | |
faceZoneToCell (const polyMesh &mesh, const wordRes &zoneSelector, const faceAction option) | |
Construct from mesh, zones selector and selection option. More... | |
faceZoneToCell (const polyMesh &mesh, const wordRe &zoneName, const faceAction option) | |
Construct from mesh, single zone selector and selection option. More... | |
faceZoneToCell (const polyMesh &mesh, const dictionary &dict) | |
Construct from dictionary. More... | |
faceZoneToCell (const polyMesh &mesh, Istream &is) | |
Construct from Istream. More... | |
virtual | ~faceZoneToCell ()=default |
Destructor. More... | |
const wordRes & | zones () const noexcept |
Return the current zones selector. More... | |
void | zones (const wordRes &zoneSelector) |
Define the zones selector. More... | |
void | zones (const wordRe &zoneName) |
Define the zones selector with a single zone selector. 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< topoSetCellSource > | clone () 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< 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... | |
bool | hasTransform () const noexcept |
True if coordinate transform is active. More... | |
tmp< pointField > | transform (const pointField &points) const |
Coordinate transform (optionally) coordinates. Returns reference to input data if no transform is active. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from topoSetCellSource | |
static autoPtr< topoSetCellSource > | New (const word &sourceType, const polyMesh &mesh, const dictionary &dict) |
Return a reference to the selected source type. More... | |
static autoPtr< topoSetCellSource > | 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 bool | readNames (const dictionary &dict, wordList &names) |
Helper: extract wordList of patches/zones from dictionary. Returns. 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... | |
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... | |
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... | |
autoPtr< solidBodyMotionFunction > | transformPtr_ |
Optional transformation for geometric data. More... | |
Static Protected Attributes inherited from topoSetSource | |
static const string | illegalSource_ |
static HashTable< string > * | usageTablePtr_ = nullptr |
A table of usage strings. More... | |
A topoSetCellSource
to select cells based on front
or back
side of given faceZone(s)
.
Operand | Type | Location |
---|---|---|
input | faceZone(s) | $FOAM_CASE/constant/polyMesh/faceZones |
output | cellSet | $FOAM_CASE/constant/polyMesh/sets/<set> |
system/topoSetDict.actions
: { // Mandatory (inherited) entries name <name>; type cellSet; action <action>; // Mandatory entries source faceZoneToCell; option <option>; // Conditional mandatory entries // Select one of the below // Option-1 zones ( <faceZoneName1> <faceZoneName2> ... ); // Option-2 zone <faceZoneName>; }
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: faceZoneToCell | word | yes | - |
option | Selection type - see below | word | yes | - |
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
Options for the option
entry:
front | Cells on the front side of the faceZone (also as 'master') back | Cells on the back side of the faceZone (also as 'slave') both | Both front and back side of the faceZone
Options for the conditional mandatory entries:
Entry | Description | Type | Req'd | Dflt zones | Names of input faceZones | wordRes | cond'l | - zone | Name of input faceZone | wordRe | cond'l | -
zones
, and zone
.Definition at line 173 of file faceZoneToCell.H.
enum faceAction |
Enumeration defining the valid options.
Enumerator | |
---|---|
FRONT | The front (positive normal) side of the faces. |
BACK | The back (negative normal) side of the faces. |
BOTH | Both front and back side of faces. |
MASTER | |
SLAVE |
Definition at line 181 of file faceZoneToCell.H.
faceZoneToCell | ( | const polyMesh & | mesh, |
const wordRes & | zoneSelector, | ||
const faceAction | option | ||
) |
Construct from mesh, zones selector and selection option.
Definition at line 179 of file faceZoneToCell.C.
faceZoneToCell | ( | const polyMesh & | mesh, |
const wordRe & | zoneName, | ||
const faceAction | option | ||
) |
Construct from mesh, single zone selector and selection option.
Definition at line 192 of file faceZoneToCell.C.
faceZoneToCell | ( | const polyMesh & | mesh, |
const dictionary & | dict | ||
) |
Construct from dictionary.
Definition at line 205 of file faceZoneToCell.C.
References dict, dictionary::getCompat(), and dictionary::readIfPresent().
faceZoneToCell | ( | const polyMesh & | mesh, |
Istream & | is | ||
) |
Construct from Istream.
Definition at line 224 of file faceZoneToCell.C.
|
virtualdefault |
Destructor.
TypeName | ( | "faceZoneToCell" | ) |
Runtime type information.
|
noexcept |
Return the current zones selector.
Definition at line 237 of file faceZoneToCell.C.
void zones | ( | const wordRes & | zoneSelector | ) |
Define the zones selector.
Definition at line 243 of file faceZoneToCell.C.
void zones | ( | const wordRe & | zoneName | ) |
Define the zones selector with a single zone selector.
Definition at line 249 of file faceZoneToCell.C.
References List< T >::resize().
|
virtual |
Apply specified action to the topoSet.
Implements topoSetSource.
Definition at line 257 of file faceZoneToCell.C.
References topoSetSource::ADD, Foam::ListListOps::combine(), Foam::endl(), Foam::flatOutput(), Foam::Info, topoSetSource::NEW, and topoSetSource::SUBTRACT.