Public Member Functions | List of all members
boundaryToCell Class Reference

A topoSetCellSource to select all cells possessing at least a single face on all external boundaries. More...

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

Public Member Functions

 TypeName ("boundaryToCell")
 
 boundaryToCell (const polyMesh &mesh)
 
 boundaryToCell (const polyMesh &mesh, const dictionary &unused)
 
 boundaryToCell (const polyMesh &mesh, Istream &unused)
 
virtual ~boundaryToCell ()=default
 
virtual void applyToSet (const topoSetSource::setAction action, topoSet &set) const
 
- Public Member Functions inherited from topoSetCellSource
 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)
 
 topoSetCellSource (const polyMesh &mesh, const dictionary &dict)
 
autoPtr< topoSetCellSourceclone () const
 
virtual ~topoSetCellSource ()=default
 
virtual topoSetSource::sourceType setType () const
 
- Public Member Functions inherited from topoSetSource
 TypeName ("topoSetSource")
 
 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, bool verbose=true)
 
 topoSetSource (const polyMesh &mesh, const dictionary &dict)
 
autoPtr< topoSetSourceclone () const
 
virtual ~topoSetSource ()=default
 
const polyMeshmesh () const noexcept
 
bool verbose () const noexcept
 
bool verbose (bool on) noexcept
 
void verbose (const dictionary &dict)
 

Additional Inherited Members

- Public Types inherited from topoSetSource
enum  sourceType {
  UNKNOWN_SOURCE = 0, CELL_TYPE = 0x1, FACE_TYPE = 0x2, POINT_TYPE = 0x4,
  SET_SOURCE = 0x10, CELLSET_SOURCE = (CELL_TYPE | SET_SOURCE), FACESET_SOURCE = (FACE_TYPE | SET_SOURCE), POINTSET_SOURCE = (POINT_TYPE | SET_SOURCE),
  ZONE_SOURCE = 0x20, 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
}
 
enum  setAction {
  ADD, NEW, SUBTRACT, SUBSET,
  INVERT, CLEAR, REMOVE, LIST,
  DELETE = SUBTRACT
}
 
- Static Public Member Functions inherited from topoSetCellSource
static autoPtr< topoSetCellSourceNew (const word &sourceType, const polyMesh &mesh, const dictionary &dict)
 
static autoPtr< topoSetCellSourceNew (const word &sourceType, const polyMesh &mesh, Istream &is)
 
- Static Public Member Functions inherited from topoSetSource
static IstreamcheckIs (Istream &is)
 
static bool isSetSource (const sourceType t) noexcept
 
static bool isZoneSource (const sourceType t) noexcept
 
static bool isCell (const sourceType t) noexcept
 
static bool isFace (const sourceType t) noexcept
 
static bool isPoint (const sourceType t) noexcept
 
static const stringusage (const word &name)
 
static autoPtr< topoSetSourceNew (const word &topoSetSourceType, const polyMesh &mesh, const dictionary &dict)
 
static autoPtr< topoSetSourceNew (const word &topoSetSourceType, const polyMesh &mesh, Istream &is)
 
static setAction toAction (const word &actionName)
 
- Static Public Attributes inherited from topoSetSource
static const Enum< setActionactionNames
 
- Protected Member Functions inherited from topoSetSource
void addOrDelete (topoSet &set, const label id, const bool add) const
 
void addOrDelete (topoSet &set, const labelUList &labels, const bool add) const
 
void addOrDelete (topoSet &set, const bitSet &labels, const bool add) const
 
 topoSetSource (const topoSetSource &)=delete
 
void operator= (const topoSetSource &)=delete
 
- Static Protected Member Functions inherited from topoSetSource
static bool check (labelList &list, const label maxLabel)
 
- Protected Attributes inherited from topoSetSource
const polyMeshmesh_
 
bool verbose_
 
- Static Protected Attributes inherited from topoSetSource
static const string illegalSource_
 
static HashTable< string > * usageTablePtr_ = nullptr
 

Detailed Description

A topoSetCellSource to select all cells possessing at least a single face on all external boundaries.

Operands:

Operand Type Location
output cellSet $FOAM_CASE/constant/polyMesh/sets/<set>
Usage
Minimal example by using system/topoSetDict.actions:
{
    // Mandatory (inherited) entries
    name        <name>;
    type        cellSet;
    action      <action>;

    // Mandatory entries
    source      boundaryToCell;
}

where the entries mean:

Property Description Type Req'd Dflt
name Name of cellSet word yes -
type Type name: cellSet word yes -
action Action applied on cells - see below word yes -
source Source name: boundaryToCell word yes -

Options for the action entry:

      new      | Create a new cellSet from selected cells
      add      | Add selected cells into this cellSet
      subtract | Remove selected cells from this cellSet
See also
Source files

Definition at line 126 of file boundaryToCell.H.

Constructor & Destructor Documentation

◆ boundaryToCell() [1/3]

boundaryToCell ( const polyMesh mesh)

Definition at line 77 of file boundaryToCell.C.

◆ boundaryToCell() [2/3]

boundaryToCell ( const polyMesh mesh,
const dictionary unused 
)

Definition at line 84 of file boundaryToCell.C.

◆ boundaryToCell() [3/3]

boundaryToCell ( const polyMesh mesh,
Istream unused 
)

Definition at line 94 of file boundaryToCell.C.

◆ ~boundaryToCell()

virtual ~boundaryToCell ( )
virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "boundaryToCell"  )

◆ applyToSet()

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

Implements topoSetSource.

Definition at line 106 of file boundaryToCell.C.

References topoSetSource::ADD, Foam::ListListOps::combine(), Foam::endl(), Foam::Info, topoSetSource::NEW, Foam::BitOps::set(), and topoSetSource::SUBTRACT.

Here is the call graph for this function:

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