A topoSetCellSource
to select cells based on relation to a surface given by an external file.
More...
Public Member Functions | |
TypeName ("surfaceToCell") | |
Runtime type information. More... | |
surfaceToCell (const polyMesh &mesh, const fileName &surfName, const pointField &outsidePoints, const bool includeCut, const bool includeInside, const bool includeOutside, const bool useSurfaceOrientation, const scalar nearDist, const scalar curvature) | |
Construct from components. More... | |
surfaceToCell (const polyMesh &mesh, const fileName &surfName, const triSurface &surf, const triSurfaceSearch &querySurf, const pointField &outsidePoints, const bool includeCut, const bool includeInside, const bool includeOutside, const bool useSurfaceOrientation, const scalar nearDist, const scalar curvature) | |
Construct from components (supplied surface, surfaceSearch) More... | |
surfaceToCell (const polyMesh &mesh, const dictionary &dict) | |
Construct from dictionary. More... | |
surfaceToCell (const polyMesh &mesh, Istream &is) | |
Construct from Istream. More... | |
virtual | ~surfaceToCell () |
Destructor. More... | |
virtual void | applyToSet (const topoSetSource::setAction action, topoSet &) 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 | |
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< 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 relation to a surface given by an external file.
surfaceToCell
can select:
useSurfaceOrientation
, requires closed surface)Operands:
Operand | Type | Location |
---|---|---|
input | triSurface | $FOAM_CASE/constant/triSurface/<file> |
output | cellSet | $FOAM_CASE/constant/polyMesh/sets/<set> |
system/topoSetDict.actions
: { // Mandatory (inherited) entries name <name>; type cellSet; action <action>; // Mandatory entries source surfaceToCell; file <surfaceFileName>; outsidePoints ( (<p1x> <p1y> <p1z>) (<p2x> <p2y> <p2z>) ... ); includeCut false; includeInside false; includeOutside true; nearDistance 0.5; curvature 1.0; // Optional entries useSurfaceOrientation false; fileType stl; scale 2.0; }
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: surfaceToCell | word | yes | - |
file | The surface "filename" | word | yes | - |
outsidePoints | List of points that define outside of the surface | vectorList | yes | - |
includeCut | Flag to include cut cells | bool | yes | - |
includeInside | Flag to include inside cells | bool | yes | - |
includeOutside | Flag to include outside cells | bool | yes | - |
useSurfaceOrientation | Flag to use inherently the orientation of the surface | bool | no | false |
nearDistance | Near distance to the surface | scalar | yes | - |
curvature | Surface curvature | scalar | yes | - |
fileType | The format of the surface file | word | no | "" |
scale | Surface scaling factor | scalar | no | -1 |
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
Definition at line 238 of file surfaceToCell.H.
surfaceToCell | ( | const polyMesh & | mesh, |
const fileName & | surfName, | ||
const pointField & | outsidePoints, | ||
const bool | includeCut, | ||
const bool | includeInside, | ||
const bool | includeOutside, | ||
const bool | useSurfaceOrientation, | ||
const scalar | nearDist, | ||
const scalar | curvature | ||
) |
Construct from components.
Definition at line 367 of file surfaceToCell.C.
surfaceToCell | ( | const polyMesh & | mesh, |
const fileName & | surfName, | ||
const triSurface & | surf, | ||
const triSurfaceSearch & | querySurf, | ||
const pointField & | outsidePoints, | ||
const bool | includeCut, | ||
const bool | includeInside, | ||
const bool | includeOutside, | ||
const bool | useSurfaceOrientation, | ||
const scalar | nearDist, | ||
const scalar | curvature | ||
) |
Construct from components (supplied surface, surfaceSearch)
Definition at line 397 of file surfaceToCell.C.
surfaceToCell | ( | const polyMesh & | mesh, |
const dictionary & | dict | ||
) |
Construct from dictionary.
Definition at line 429 of file surfaceToCell.C.
surfaceToCell | ( | const polyMesh & | mesh, |
Istream & | is | ||
) |
Construct from Istream.
Definition at line 463 of file surfaceToCell.C.
|
virtual |
Destructor.
Definition at line 487 of file surfaceToCell.C.
References Foam::deleteDemandDrivenData().
TypeName | ( | "surfaceToCell" | ) |
Runtime type information.
|
virtual |
Apply specified action to the topoSet.
Implements topoSetSource.
Definition at line 500 of file surfaceToCell.C.
References topoSetSource::ADD, Foam::ListListOps::combine(), Foam::endl(), Foam::Info, topoSetSource::NEW, and topoSetSource::SUBTRACT.