topoSetFaceZoneSource Class Reference

The topoSetFaceZoneSource is a intermediate class for handling topoSet sources for selecting face zones. More...

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

Public Member Functions

 declareRunTimeSelectionTable (autoPtr, topoSetFaceZoneSource, word,(const polyMesh &mesh, const dictionary &dict),(mesh, dict))
 
 declareRunTimeSelectionTable (autoPtr, topoSetFaceZoneSource, istream,(const polyMesh &mesh, Istream &is),(mesh, is))
 
 topoSetFaceZoneSource (const polyMesh &mesh)
 Construct from components. More...
 
autoPtr< topoSetFaceZoneSourceclone () const
 Clone (disallowed) More...
 
virtual ~topoSetFaceZoneSource ()=default
 Destructor. More...
 
virtual topoSetSource::sourceType setType () const
 The source category is a faceZone. 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...
 
virtual void applyToSet (const topoSetSource::setAction action, topoSet &set) const =0
 Apply specified action to the topoSet. More...
 

Static Public Member Functions

static autoPtr< topoSetFaceZoneSourceNew (const word &sourceType, const polyMesh &mesh, const dictionary &dict)
 Return a reference to the selected source type. More...
 
static autoPtr< topoSetFaceZoneSourceNew (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...
 

Additional Inherited Members

- 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...
 
- 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

The topoSetFaceZoneSource is a intermediate class for handling topoSet sources for selecting face zones.

The class is not an executable topoSet itself, yet a provider for common entries to its derived topoSet.

Source files

Definition at line 57 of file topoSetFaceZoneSource.H.

Constructor & Destructor Documentation

◆ topoSetFaceZoneSource()

topoSetFaceZoneSource ( const polyMesh mesh)
explicit

Construct from components.

Definition at line 42 of file topoSetFaceZoneSource.C.

◆ ~topoSetFaceZoneSource()

virtual ~topoSetFaceZoneSource ( )
virtualdefault

Destructor.

Member Function Documentation

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable ( autoPtr  ,
topoSetFaceZoneSource  ,
word  ,
(const polyMesh &mesh, const dictionary &dict ,
(mesh, dict  
)

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable ( autoPtr  ,
topoSetFaceZoneSource  ,
istream  ,
(const polyMesh &mesh, Istream &is)  ,
(mesh, is)   
)

◆ clone()

autoPtr<topoSetFaceZoneSource> clone ( ) const
inline

Clone (disallowed)

Definition at line 98 of file topoSetFaceZoneSource.H.

References NotImplemented.

◆ New() [1/2]

Foam::autoPtr< Foam::topoSetFaceZoneSource > New ( const word sourceType,
const polyMesh mesh,
const dictionary dict 
)
static

Return a reference to the selected source type.

Definition at line 52 of file topoSetFaceZoneSource.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and mesh.

Here is the call graph for this function:

◆ New() [2/2]

Foam::autoPtr< Foam::topoSetFaceZoneSource > New ( const word sourceType,
const polyMesh mesh,
Istream is 
)
static

Return a reference to the selected source type.

Definition at line 77 of file topoSetFaceZoneSource.C.

References Foam::exit(), Foam::FatalError, FatalErrorInLookup, and mesh.

Here is the call graph for this function:

◆ setType()

virtual topoSetSource::sourceType setType ( ) const
inlinevirtual

The source category is a faceZone.

Implements topoSetSource.

Definition at line 131 of file topoSetFaceZoneSource.H.

References topoSetSource::FACEZONE_SOURCE.


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