A topoSetFaceSource to select all faces whose face centre inside given bounding box(es). More...

Inheritance diagram for boxToFace:

Collaboration diagram for boxToFace:

Public Member Functions
	TypeName ("boxToFace")

	boxToFace (const polyMesh &mesh, const treeBoundBoxList &bbs)

	boxToFace (const polyMesh &mesh, treeBoundBoxList &&bbs)

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

	boxToFace (const polyMesh &mesh, Istream &is)

virtual	~boxToFace ()=default

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

Public Member Functions inherited from topoSetFaceSource
	declareRunTimeSelectionTable (autoPtr, topoSetFaceSource, word,(const polyMesh &mesh, const dictionary &dict),(mesh, dict))

	declareRunTimeSelectionTable (autoPtr, topoSetFaceSource, istream,(const polyMesh &mesh, Istream &is),(mesh, is))

	topoSetFaceSource (const polyMesh &mesh)

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

autoPtr< topoSetFaceSource >	clone () const

virtual	~topoSetFaceSource ()=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)

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 topoSetFaceSource
static autoPtr< topoSetFaceSource >	New (const word &sourceType, const polyMesh &mesh, const dictionary &dict)

static autoPtr< topoSetFaceSource >	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)

Static Public Attributes inherited from topoSetSource
static const Enum< setAction >	actionNames

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 topoSetFaceSource to select all faces whose face centre inside given bounding box(es).

Operands:

Operand	Type	Location
`output`	faceSet	$FOAM_CASE/constant/polyMesh/sets/<set>

Usage

Minimal example by using system/topoSetDict.actions:

{
    // Mandatory (inherited) entries
    name        <name>;
    type        faceSet;
    action      <action>;

    // Mandatory entries
    source      boxToFace;

    // Conditional mandatory entries
    // Select either of the below

    // Option-1
    boxes
    (
        (<minX> <minY> <minZ>) (<maxX> <maxY> <maxZ>) // box-1
        (<minX> <minY> <minZ>) (<maxX> <maxY> <maxZ>) // box-2
        ...
    );

    // Option-2
    box (<minX> <minY> <minZ>) (<maxX> <maxY> <maxZ>);

    // Option-3
    min (<minX> <minY> <minZ>);
    max (<maxX> <maxY> <maxZ>);

    // Option-4
    min  (<minX> <minY> <minZ>);
    span (<sizeX> <sizeY> <sizeZ>);
}

where the entries mean:

Property	Description	Type	Req'd	Dflt
`name`	Name of faceSet	word	yes	-
`type`	Type name: faceSet	word	yes	-
`action`	Action applied on faces - see below	word	yes	-
`source`	Source name: boxToFace	word	yes	-

Options for the action entry:

      new      | Create a new faceSet from selected cells
      add      | Add selected cells into this faceSet
      subtract | Remove selected cells from this faceSet

Options for the conditional mandatory entries:

      Entry    | Description                    | Type       | Req'd  | Dflt
      boxes    | Multiple bounding boxes        | vectorList | cond'l | -
      box      | A single bounding box          | vectors    | cond'l | -
      min      | Minimum point (single box)     | vector     | cond'l | -
      max      | Maximum point (single box)     | vector     | cond'l | -
      span     | Box width (single box)         | vector     | cond'l | -

Note: The order of precedence among the conditional mandatory entries from the highest to the lowest is boxes, box, min-max or min-span pair (compatibility with searchableBox).

See also

Source files

Definition at line 164 of file boxToFace.H.

Constructor & Destructor Documentation

◆ boxToFace() [1/4]

boxToFace	(	const polyMesh &	mesh,
		const treeBoundBoxList &	bbs
	)

Definition at line 103 of file boxToFace.C.

◆ boxToFace() [2/4]

boxToFace	(	const polyMesh &	mesh,
		treeBoundBoxList &&	bbs
	)

Definition at line 114 of file boxToFace.C.

◆ boxToFace() [3/4]

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

Definition at line 125 of file boxToFace.C.

References dict, Foam::readBoxDim(), and dictionary::readIfPresent().

Here is the call graph for this function:

◆ boxToFace() [4/4]

boxToFace	(	const polyMesh &	mesh,
		Istream &	is
	)

Definition at line 146 of file boxToFace.C.

◆ ~boxToFace()

virtual ~boxToFace ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "boxToFace" )

◆ applyToSet()

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

virtual

Implements topoSetSource.

Definition at line 159 of file boxToFace.C.

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