shapeToCell Class Reference

A topoSetCellSource to select cells based on the type of their cell shapes. More...

Inheritance diagram for shapeToCell:

Collaboration diagram for shapeToCell:

Public Member Functions
	TypeName ("shapeToCell")
	shapeToCell (const polyMesh &mesh, const word &shapeName)
	shapeToCell (const polyMesh &mesh, const dictionary &dict)
	shapeToCell (const polyMesh &mesh, Istream &is)
virtual	~shapeToCell ()=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< topoSetCellSource >	clone () 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< topoSetSource >	clone () const
virtual	~topoSetSource ()=default
const polyMesh &	mesh () const noexcept
bool	verbose () const noexcept
bool	verbose (bool on) noexcept
void	verbose (const dictionary &dict)

Static Public Attributes
static scalar	featureCos = Foam::cos(degToRad(10.0))
Static Public Attributes inherited from topoSetSource
static const Enum< setAction >	actionNames

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< topoSetCellSource >	New (const word &sourceType, const polyMesh &mesh, const dictionary &dict)
static autoPtr< topoSetCellSource >	New (const word &sourceType, const polyMesh &mesh, Istream &is)
Static Public Member Functions inherited from topoSetSource
static Istream &	checkIs (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 string &	usage (const word &name)
static autoPtr< topoSetSource >	New (const word &topoSetSourceType, const polyMesh &mesh, const dictionary &dict)
static autoPtr< topoSetSource >	New (const word &topoSetSourceType, const polyMesh &mesh, Istream &is)
static setAction	toAction (const word &actionName)
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 polyMesh &	mesh_
bool	verbose_
Static Protected Attributes inherited from topoSetSource
static const string	illegalSource_
static HashTable< string > *	usageTablePtr_ = nullptr

Detailed Description

A topoSetCellSource to select cells based on the type of their cell shapes.

Handles all types of cell shapes known from static collection in the cellModel (as shown below) and splitHex with 10 degrees feature angle.

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      shapeToCell;
    shape       <shapeTypeName>;
}

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: shapeToCell	word	yes	-
shape	Type of cell shape - see below	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

Options for the shape entry:

      splitHex   | Split-hexahedra cells
      hex        | Hexahedra cells
      wedge      | Wedge cells
      tetWedge   | Tetrahedra-wedge cells
      prism      | Prism cells
      pyr        | Pyramid cells
      tet        | Tetrahedra cells

Note

splitHex hardcoded with internal angle < 10 degrees.

See also

• Foam::topoSetSource
• Foam::topoSetCellSource

Source files

• shapeToCell.H
• shapeToCell.C

Definition at line 152 of file shapeToCell.H.

Constructor & Destructor Documentation

shapeToCell() [1/3]

shapeToCell	(	const polyMesh &	mesh,
		const word &	shapeName
	)

Definition at line 90 of file shapeToCell.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and cellModel::ptr().

Here is the call graph for this function:

shapeToCell() [2/3]

shapeToCell	(	const polyMesh &	mesh,
		const dictionary &	dict
	)

Definition at line 107 of file shapeToCell.C.

shapeToCell() [3/3]

shapeToCell	(	const polyMesh &	mesh,
		Istream &	is
	)

Definition at line 117 of file shapeToCell.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and cellModel::ptr().

Here is the call graph for this function:

~shapeToCell()

virtual ~shapeToCell ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"shapeToCell"

)

applyToSet()

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

virtual

Implements topoSetSource.

Definition at line 136 of file shapeToCell.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:

Member Data Documentation

featureCos

Foam::scalar featureCos = Foam::cos(degToRad(10.0))

static

Definition at line 179 of file shapeToCell.H.

---

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

• src/meshTools/sets/cellSources/shapeToCell/shapeToCell.H
• src/meshTools/sets/cellSources/shapeToCell/shapeToCell.C