boxToCell Class Reference

A topoSetSource to select cells based on cell centres inside box(es). More...

Inheritance diagram for boxToCell:
Collaboration diagram for boxToCell:

Public Member Functions

 TypeName ("boxToCell")
 Runtime type information. More...
 
 boxToCell (const polyMesh &mesh, const treeBoundBoxList &bbs)
 Construct from components. More...
 
 boxToCell (const polyMesh &mesh, const dictionary &dict)
 Construct from dictionary. More...
 
 boxToCell (const polyMesh &mesh, Istream &)
 Construct from Istream. More...
 
virtual ~boxToCell ()
 Destructor. More...
 
virtual sourceType setType () const
 
virtual void applyToSet (const topoSetSource::setAction action, topoSet &) const
 
- 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...
 
 topoSetSource (const topoSetSource &)=delete
 Disallow default bitwise copy construction. More...
 
autoPtr< topoSetSourceclone () const
 Clone. More...
 
virtual ~topoSetSource ()
 Destructor. More...
 
const polyMeshmesh () const
 
void operator= (const topoSetSource &)=delete
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Public Types inherited from topoSetSource
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...
 
- Static Public Member Functions inherited from topoSetSource
static setAction toAction (const word &actionName)
 Convert string to action. More...
 
static IstreamcheckIs (Istream &is)
 Check state of stream. 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...
 
- Protected Member Functions inherited from topoSetSource
void addOrDelete (topoSet &set, const label celli, const bool) const
 Add (if bool) celli to set or delete celli from set. More...
 
- Protected Attributes inherited from topoSetSource
const polyMeshmesh_
 
- Static Protected Attributes inherited from topoSetSource
static HashTable< string > * usageTablePtr_ = nullptr
 A table of usage strings. More...
 

Detailed Description

A topoSetSource to select cells based on cell centres inside box(es).

Source files

Definition at line 49 of file boxToCell.H.

Constructor & Destructor Documentation

◆ boxToCell() [1/3]

boxToCell ( const polyMesh mesh,
const treeBoundBoxList bbs 
)

Construct from components.

Definition at line 71 of file boxToCell.C.

Referenced by boxToCell::boxToCell().

Here is the caller graph for this function:

◆ boxToCell() [2/3]

boxToCell ( const polyMesh mesh,
const dictionary dict 
)

Construct from dictionary.

Definition at line 82 of file boxToCell.C.

References boxToCell::boxToCell().

Here is the call graph for this function:

◆ boxToCell() [3/3]

boxToCell ( const polyMesh mesh,
Istream is 
)

Construct from Istream.

Definition at line 98 of file boxToCell.C.

◆ ~boxToCell()

~boxToCell ( )
virtual

Destructor.

Definition at line 110 of file boxToCell.C.

References boxToCell::applyToSet().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "boxToCell"  )

Runtime type information.

◆ setType()

virtual sourceType setType ( ) const
inlinevirtual

Implements topoSetSource.

Definition at line 102 of file boxToCell.H.

References boxToCell::applyToSet(), and topoSetSource::CELLSETSOURCE.

Here is the call graph for this function:

◆ applyToSet()

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

Implements topoSetSource.

Definition at line 117 of file boxToCell.C.

References topoSetSource::ADD, Foam::ListListOps::combine(), topoSetSource::DELETE, Foam::endl(), Foam::Info, and topoSetSource::NEW.

Referenced by boxToCell::setType(), and boxToCell::~boxToCell().

Here is the call graph for this function:
Here is the caller graph for this function:

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