A topoSetSource to select faces based on the adjacent cell centres spanning a given plane. The plane is defined by a point and normal vector. More...
Public Types | |
enum | include { all, closest } |
Enumeration for what to include. More... | |
![]() | |
enum | sourceType { CELLSETSOURCE, FACESETSOURCE, POINTSETSOURCE, CELLZONESOURCE, FACEZONESOURCE, POINTZONESOURCE } |
Enumeration defining the types of sources. More... | |
enum | setAction { CLEAR, NEW, INVERT, ADD, DELETE, SUBSET, LIST, REMOVE } |
Enumeration defining the valid actions. More... | |
Public Member Functions | |
TypeName ("planeToFaceZone") | |
Runtime type information. More... | |
planeToFaceZone (const polyMesh &mesh, const dictionary &dict) | |
Construct from dictionary. More... | |
planeToFaceZone (const polyMesh &mesh, Istream &) | |
Construct from Istream. More... | |
virtual | ~planeToFaceZone () |
Destructor. More... | |
virtual sourceType | setType () const |
virtual void | applyToSet (const topoSetSource::setAction action, topoSet &) const |
![]() | |
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) | |
Construct from components. More... | |
topoSetSource (const topoSetSource &)=delete | |
Disallow default bitwise copy construction. More... | |
autoPtr< topoSetSource > | clone () const |
Clone. More... | |
virtual | ~topoSetSource () |
Destructor. More... | |
const polyMesh & | mesh () const |
void | operator= (const topoSetSource &)=delete |
Disallow default bitwise assignment. More... | |
Static Public Attributes | |
static const NamedEnum< include, 2 > | includeNames_ |
Included region names. More... | |
Additional Inherited Members | |
![]() | |
static setAction | toAction (const word &actionName) |
Convert string to action. More... | |
static Istream & | checkIs (Istream &is) |
Check state of stream. 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... | |
![]() | |
void | addOrDelete (topoSet &set, const label celli, const bool) const |
Add (if bool) celli to set or delete celli from set. More... | |
![]() | |
const polyMesh & | mesh_ |
![]() | |
static HashTable< string > * | usageTablePtr_ = nullptr |
A table of usage strings. More... | |
A topoSetSource to select faces based on the adjacent cell centres spanning a given plane. The plane is defined by a point and normal vector.
Additionally, an include entry can be specified. When omitted or set to "all", then all faces that meet the criteria are included in the set. When set to "closest", just the faces that belong to the closest contiguous region to the plane point are included. This latter setting is useful when defining face zones through channels on which the flow rate is to be computed, as it keeps the set local to a single channel.
Definition at line 58 of file planeToFaceZone.H.
enum include |
Enumeration for what to include.
Enumerator | |
---|---|
all | |
closest |
Definition at line 65 of file planeToFaceZone.H.
planeToFaceZone | ( | const polyMesh & | mesh, |
const dictionary & | dict | ||
) |
Construct from dictionary.
Definition at line 350 of file planeToFaceZone.C.
Referenced by NamedEnum< compressibleField, 8 >::names().
planeToFaceZone | ( | const polyMesh & | mesh, |
Istream & | is | ||
) |
Construct from Istream.
Definition at line 373 of file planeToFaceZone.C.
|
virtual |
Destructor.
Definition at line 387 of file planeToFaceZone.C.
References planeToFaceZone::applyToSet().
TypeName | ( | "planeToFaceZone" | ) |
Runtime type information.
|
inlinevirtual |
Implements topoSetSource.
Definition at line 125 of file planeToFaceZone.H.
References planeToFaceZone::applyToSet(), and topoSetSource::FACESETSOURCE.
|
virtual |
Implements topoSetSource.
Definition at line 394 of file planeToFaceZone.C.
References topoSetSource::ADD, Foam::ListListOps::combine(), topoSetSource::DELETE, Foam::endl(), Foam::Info, topoSetSource::NEW, and WarningInFunction.
Referenced by planeToFaceZone::setType(), and planeToFaceZone::~planeToFaceZone().
|
static |
Included region names.
Definition at line 72 of file planeToFaceZone.H.
Referenced by NamedEnum< compressibleField, 8 >::names().