fieldToCell Class Reference

A topoSetCellSource to select cells based on field values. More...

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

Public Member Functions

 TypeName ("fieldToCell")
 Runtime type information. More...
 
 fieldToCell (const polyMesh &mesh, const word &fieldName, const scalar min, const scalar max)
 Construct from components. More...
 
 fieldToCell (const polyMesh &mesh, const dictionary &dict)
 Construct from dictionary. More...
 
 fieldToCell (const polyMesh &mesh, Istream &is)
 Construct from Istream. More...
 
virtual ~fieldToCell ()=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
 TypeName ("topoSetCellSource")
 Runtime type information. More...
 
 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 components. More...
 
autoPtr< topoSetCellSourceclone () 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)
 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

- 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 Member Functions inherited from topoSetCellSource
static autoPtr< topoSetCellSourceNew (const word &sourceType, const polyMesh &mesh, const dictionary &dict)
 Return a reference to the selected source type. More...
 
static autoPtr< topoSetCellSourceNew (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 topoSetCellSource to select cells based on field values.


Dictionary parameters

Property Description Required Default
field The (scalar, vector) field to use yes
min The min value for the subset yes
max The max value for the subset yes
Source files

Definition at line 80 of file fieldToCell.H.

Constructor & Destructor Documentation

◆ fieldToCell() [1/3]

fieldToCell ( const polyMesh mesh,
const word fieldName,
const scalar  min,
const scalar  max 
)

Construct from components.

Definition at line 123 of file fieldToCell.C.

◆ fieldToCell() [2/3]

fieldToCell ( const polyMesh mesh,
const dictionary dict 
)

Construct from dictionary.

Definition at line 138 of file fieldToCell.C.

◆ fieldToCell() [3/3]

fieldToCell ( const polyMesh mesh,
Istream is 
)

Construct from Istream.

Definition at line 154 of file fieldToCell.C.

◆ ~fieldToCell()

virtual ~fieldToCell ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "fieldToCell"  )

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 169 of file fieldToCell.C.

References IOobject::AUTO_WRITE, Foam::endl(), IOobject::headerClassName(), Foam::mag(), mesh, IOobject::MUST_READ, fvMesh::time(), timeName, Time::timeName(), IOobject::typeHeaderOk(), and WarningInFunction.

Here is the call graph for this function:

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