Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes
boxToCell Class Reference

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

Inheritance diagram for boxToCell:
Inheritance graph
[legend]
Collaboration diagram for boxToCell:
Collaboration graph
[legend]

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...
 
autoPtr< topoSetSourceclone () const
 Clone. More...
 
virtual ~topoSetSource ()
 Destructor. More...
 
const polyMeshmesh () const
 

Private Member Functions

void combine (topoSet &set, const bool add) const
 

Private Attributes

treeBoundBoxList bbs_
 Bounding box. More...
 

Static Private Attributes

static addToUsageTable usage_
 Add usage string. 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_ = NULL
 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 77 of file boxToCell.C.

◆ boxToCell() [2/3]

boxToCell ( const polyMesh mesh,
const dictionary dict 
)

Construct from dictionary.

Definition at line 89 of file boxToCell.C.

◆ boxToCell() [3/3]

boxToCell ( const polyMesh mesh,
Istream is 
)

Construct from Istream.

Definition at line 106 of file boxToCell.C.

◆ ~boxToCell()

~boxToCell ( )
virtual

Destructor.

Definition at line 117 of file boxToCell.C.

Member Function Documentation

◆ combine()

void combine ( topoSet set,
const bool  add 
) const
private

Definition at line 55 of file boxToCell.C.

References Foam::add(), topoSetSource::addOrDelete(), boxToCell::bbs_, primitiveMesh::cellCentres(), forAll, and topoSetSource::mesh_.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "boxToCell"  )

Runtime type information.

◆ setType()

virtual sourceType setType ( ) const
inlinevirtual

Implements topoSetSource.

Definition at line 104 of file boxToCell.H.

References topoSetSource::CELLSETSOURCE.

◆ applyToSet()

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

Implements topoSetSource.

Definition at line 124 of file boxToCell.C.

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

Here is the call graph for this function:

Field Documentation

◆ usage_

Add usage string.

Definition at line 57 of file boxToCell.H.

◆ bbs_

treeBoundBoxList bbs_
private

Bounding box.

Definition at line 61 of file boxToCell.H.

Referenced by boxToCell::combine().


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