pointToFace Class Reference

A topoSetFaceSource to select faces based on use of points. More...

Inheritance diagram for pointToFace:
[legend]
Collaboration diagram for pointToFace:
[legend]

Public Types

enum  pointAction { ANY, ALL, EDGE }
 Enumeration defining the valid options. More...
 
- Public Types inherited from topoSetSource
enum  sourceType {
  UNKNOWN_SOURCE = 0, SET_SOURCE = 0x10, ZONE_SOURCE = 0x20, CELL_TYPE = 0x1,
  FACE_TYPE = 0x2, POINT_TYPE = 0x4, CELLSET_SOURCE = (CELL_TYPE | SET_SOURCE), FACESET_SOURCE = (FACE_TYPE | SET_SOURCE),
  POINTSET_SOURCE = (POINT_TYPE | SET_SOURCE), 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, SUBSET, INVERT,
  CLEAR, NEW, REMOVE, LIST,
  DELETE = SUBTRACT
}
 Enumeration defining the valid actions. More...
 

Public Member Functions

 TypeName ("pointToFace")
 Runtime type information. More...
 
 pointToFace (const polyMesh &mesh, const word &setName, const pointAction option)
 Construct from components. More...
 
 pointToFace (const polyMesh &mesh, const dictionary &dict)
 Construct from dictionary. More...
 
 pointToFace (const polyMesh &mesh, Istream &is)
 Construct from Istream. More...
 
virtual ~pointToFace ()=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 topoSetFaceSource
 TypeName ("topoSetFaceSource")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, topoSetFaceSource, word,(const polyMesh &mesh, const dictionary &dict),(mesh, dict))
 
 declareRunTimeSelectionTable (autoPtr, topoSetFaceSource, istream,(const polyMesh &mesh, Istream &is),(mesh, is))
 
 topoSetFaceSource (const polyMesh &mesh)
 Construct from components. More...
 
autoPtr< topoSetFaceSourceclone () const
 Clone (disallowed) More...
 
virtual ~topoSetFaceSource ()=default
 Destructor. More...
 
virtual topoSetSource::sourceType setType () const
 The source category is a faceSet. 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)
 Construct from components. More...
 
autoPtr< topoSetSourceclone () const
 Clone (disallowed) More...
 
virtual ~topoSetSource ()=default
 Destructor. More...
 
const polyMeshmesh () const
 Reference to the mesh. More...
 
bool verbose () const
 Return the current verbosity. More...
 
void verbose (bool on)
 Set the current verbosity. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from topoSetFaceSource
static autoPtr< topoSetFaceSourceNew (const word &sourceType, const polyMesh &mesh, const dictionary &dict)
 Return a reference to the selected source type. More...
 
static autoPtr< topoSetFaceSourceNew (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 IstreamcheckIs (Istream &is)
 Check state of stream. More...
 
static bool isSetSource (const sourceType t)
 True if a "set" source. More...
 
static bool isZoneSource (const sourceType t)
 True if a "zone" source. More...
 
static bool isCell (const sourceType t)
 True if "cell" geometric type. More...
 
static bool isFace (const sourceType t)
 True if "face" geometric type. More...
 
static bool isPoint (const sourceType t)
 True if "point" geometric type. More...
 
static const stringusage (const word &name)
 
static autoPtr< topoSetSourceNew (const word &topoSetSourceType, const polyMesh &mesh, const dictionary &dict)
 Return a reference to the selected topoSetSource. More...
 
static autoPtr< topoSetSourceNew (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< setActionactionNames
 The setActions text representations. 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 polyMeshmesh_
 Reference to the mesh. More...
 
bool verbose_
 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...
 

Detailed Description

A topoSetFaceSource to select faces based on use of points.


Dictionary parameters

Property Description Required Default
sets The pointSet names to use possibly
set The pointSet name to use possibly
option Selection type (all/any/edge) yes
Note
Must specify "sets" or "set" (highest to lowest precedence).
Source files

Definition at line 83 of file pointToFace.H.

Member Enumeration Documentation

◆ pointAction

Enumeration defining the valid options.

Enumerator
ANY 
ALL 
EDGE 

Definition at line 91 of file pointToFace.H.

Constructor & Destructor Documentation

◆ pointToFace() [1/3]

pointToFace ( const polyMesh mesh,
const word setName,
const pointAction  option 
)

Construct from components.

Definition at line 165 of file pointToFace.C.

◆ pointToFace() [2/3]

pointToFace ( const polyMesh mesh,
const dictionary dict 
)

Construct from dictionary.

Definition at line 178 of file pointToFace.C.

References dict, dictionary::readEntry(), and dictionary::readIfPresent().

Here is the call graph for this function:

◆ pointToFace() [3/3]

pointToFace ( const polyMesh mesh,
Istream is 
)

Construct from Istream.

Definition at line 197 of file pointToFace.C.

◆ ~pointToFace()

virtual ~pointToFace ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "pointToFace"  )

Runtime type information.

◆ applyToSet()

void applyToSet ( const topoSetSource::setAction  action,
topoSet set 
) const
virtual

Apply specified action to the topoSet.

Implements topoSetSource.

Definition at line 211 of file pointToFace.C.

References topoSetSource::ADD, Foam::ListListOps::combine(), Foam::flatOutput(), Foam::Info, topoSetSource::NEW, Foam::nl, and topoSetSource::SUBTRACT.

Here is the call graph for this function:

The documentation for this class was generated from the following files: