A topoSetCellSource
to select all cells based on usage in given faceSet(s)
, e.g. select cells that are the owner/neighbour/any
of the faces in a given faceSet
.
More...
Public Types | |
enum | faceAction { ANY, ALL, OWNER, NEIGHBOUR } |
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 ("faceToCell") | |
Runtime type information. More... | |
faceToCell (const polyMesh &mesh, const word &setName, const faceAction option) | |
Construct from components. More... | |
faceToCell (const polyMesh &mesh, const dictionary &dict) | |
Construct from dictionary. More... | |
faceToCell (const polyMesh &mesh, Istream &is) | |
Construct from Istream. More... | |
virtual | ~faceToCell ()=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< 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 all cells based on usage in given faceSet(s)
, e.g. select cells that are the owner/neighbour/any
of the faces in a given faceSet
.
Operand | Type | Location |
---|---|---|
input | faceSet(s) | $FOAM_CASE/constant/polyMesh/sets/<set> |
output | cellSet | $FOAM_CASE/constant/polyMesh/sets/<set> |
system/topoSetDict.actions
: { // Mandatory (inherited) entries name <name>; type cellSet; action <action>; // Mandatory entries source faceToCell; option <option>; // Conditional mandatory entries // Select one of the below // Option-1 sets ( <faceSetName0> <faceSetName1> ... ); // Option-2 zones ( <faceZoneName0> <faceZoneName1> ... ); // Option-3 set <faceSetName>; // Option-4 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: faceToCell | 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:
all | Cells that are either owner or neighbour of given faces any | Cells that are either owner or neighbour of given faces owner | Cells that are owner of given faces neighbour | Cells that are neighbour of given faces
Options for the conditional mandatory entries (in order of precedence):
Entry | Description | Type | Req'd | Dflt sets | Names of input faceSets | wordList | cond'l | - zones | Names of input faceZones | wordList | cond'l | - set | Name of input faceSet | word | cond'l | - zone | Name of input faceZone | word | cond'l | -
Definition at line 184 of file faceToCell.H.
enum faceAction |
Enumeration defining the valid options.
Enumerator | |
---|---|
ANY | |
ALL | |
OWNER | |
NEIGHBOUR |
Definition at line 192 of file faceToCell.H.
faceToCell | ( | const polyMesh & | mesh, |
const word & | setName, | ||
const faceAction | option | ||
) |
Construct from components.
Definition at line 153 of file faceToCell.C.
faceToCell | ( | const polyMesh & | mesh, |
const dictionary & | dict | ||
) |
Construct from dictionary.
Definition at line 167 of file faceToCell.C.
faceToCell | ( | const polyMesh & | mesh, |
Istream & | is | ||
) |
Construct from Istream.
Definition at line 180 of file faceToCell.C.
|
virtualdefault |
Destructor.
TypeName | ( | "faceToCell" | ) |
Runtime type information.
|
virtual |
Apply specified action to the topoSet.
Implements topoSetSource.
Definition at line 195 of file faceToCell.C.
References topoSetSource::ADD, Foam::ListListOps::combine(), Foam::flatOutput(), Foam::Info, topoSetSource::NEW, Foam::nl, and topoSetSource::SUBTRACT.