A topoSetPointSource to select points based on whether they are inside box. More...

Inheritance diagram for boxToPoint:

Collaboration diagram for boxToPoint:

Public Member Functions
	TypeName ("boxToPoint")
	Runtime type information. More...

	boxToPoint (const polyMesh &mesh, const treeBoundBoxList &bbs)
	Construct from components, copying bounding boxes. More...

	boxToPoint (const polyMesh &mesh, treeBoundBoxList &&bbs)
	Construct from components, moving bounding boxes. More...

	boxToPoint (const polyMesh &mesh, const dictionary &dict)
	Construct from dictionary. More...

	boxToPoint (const polyMesh &mesh, Istream &is)
	Construct from stream - a single box. More...

virtual	~boxToPoint ()=default
	Destructor. More...

virtual void	applyToSet (const topoSetSource::setAction action, topoSet &set) const
	Apply specified action to the topoSet. More...

Public Member Functions inherited from topoSetPointSource
	TypeName ("topoSetPointSource")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, topoSetPointSource, word,(const polyMesh &mesh, const dictionary &dict),(mesh, dict))

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

	topoSetPointSource (const polyMesh &mesh)
	Construct from components. More...

autoPtr< topoSetPointSource >	clone () const
	Clone (disallowed) More...

virtual	~topoSetPointSource ()=default
	Destructor. More...

virtual topoSetSource::sourceType	setType () const
	The source category is a pointSet. More...

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< topoSetSource >	clone () const
	Clone (disallowed) More...

virtual	~topoSetSource ()=default
	Destructor. More...

const polyMesh &	mesh () const
	Reference to the mesh. More...

bool	verbose () const
	Return the current verbosity. More...

void	verbose (bool on)
	Set the current verbosity. More...

Additional Inherited Members
Public Types inherited from topoSetSource
enum	sourceType { UNKNOWN_SOURCE = 0, SET_SOURCE = 0x10, ZONE_SOURCE = 0x20, CELL_TYPE = 0x1, FACE_TYPE = 0x2, POINT_TYPE = 0x4, CELLSET_SOURCE = (CELL_TYPE \| SET_SOURCE), FACESET_SOURCE = (FACE_TYPE \| SET_SOURCE), POINTSET_SOURCE = (POINT_TYPE \| SET_SOURCE), 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 }
	Enumeration defining the types of sources. More...

enum	setAction { ADD, SUBTRACT, SUBSET, INVERT, CLEAR, NEW, REMOVE, LIST, DELETE = SUBTRACT }
	Enumeration defining the valid actions. More...

Static Public Member Functions inherited from topoSetPointSource
static autoPtr< topoSetPointSource >	New (const word &sourceType, const polyMesh &mesh, const dictionary &dict)
	Return a reference to the selected source type. More...

static autoPtr< topoSetPointSource >	New (const word &sourceType, const polyMesh &mesh, Istream &is)
	Return a reference to the selected source type. More...

Static Public Member Functions inherited from topoSetSource
static Istream &	checkIs (Istream &is)
	Check state of stream. More...

static bool	isSetSource (const sourceType t)
	True if a "set" source. More...

static bool	isZoneSource (const sourceType t)
	True if a "zone" source. More...

static bool	isCell (const sourceType t)
	True if "cell" geometric type. More...

static bool	isFace (const sourceType t)
	True if "face" geometric type. More...

static bool	isPoint (const sourceType t)
	True if "point" geometric type. More...

static const string &	usage (const word &name)

static autoPtr< topoSetSource >	New (const word &topoSetSourceType, const polyMesh &mesh, const dictionary &dict)
	Return a reference to the selected topoSetSource. More...

static autoPtr< topoSetSource >	New (const word &topoSetSourceType, const polyMesh &mesh, Istream &is)
	Return a reference to the selected topoSetSource. More...

static setAction	toAction (const word &actionName)
	Deprecated(2018-07) convert string to action. More...

Static Public Attributes inherited from topoSetSource
static const Enum< setAction >	actionNames
	The setActions text representations. More...

Protected Member Functions inherited from topoSetSource
void	addOrDelete (topoSet &set, const label id, const bool add) const
	Add or delete id from set. Add when 'add' is true. More...

void	addOrDelete (topoSet &set, const labelUList &labels, const bool add) const
	Add or delete labels from set. Add when 'add' is true. More...

void	addOrDelete (topoSet &set, const bitSet &labels, const bool add) const
	Add or delete labels from set. Add when 'add' is true. More...

	topoSetSource (const topoSetSource &)=delete
	No copy construct. More...

void	operator= (const topoSetSource &)=delete
	No copy assignment. More...

Static Protected Member Functions inherited from topoSetSource
static bool	check (labelList &list, const label maxLabel)
	Detect and remove any values less than 0 or ge maxLabel. More...

Protected Attributes inherited from topoSetSource
const polyMesh &	mesh_
	Reference to the mesh. More...

bool	verbose_
	Verbosity (default: true) More...

Static Protected Attributes inherited from topoSetSource
static const string	illegalSource_

static HashTable< string > *	usageTablePtr_ = nullptr
	A table of usage strings. More...

Detailed Description

A topoSetPointSource to select points based on whether they are inside box.

Dictionary parameters

Property	Description	Required
`boxes`	Multiple bounding boxes	partly
`box`	A single bounding box	partly
`min`	Minimum point for a single box	partly
`max`	Maximum point for a single box	partly

Note: Must specify "boxes", "box" or a "min/max" pair (compatibility with searchable box) - highest to lowest precedence.

Source files

Definition at line 90 of file boxToPoint.H.

Constructor & Destructor Documentation

◆ boxToPoint() [1/4]

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

Construct from components, copying bounding boxes.

Definition at line 90 of file boxToPoint.C.

◆ boxToPoint() [2/4]

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

Construct from components, moving bounding boxes.

Definition at line 101 of file boxToPoint.C.

◆ boxToPoint() [3/4]

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

Construct from dictionary.

Definition at line 112 of file boxToPoint.C.

References dict, dictionary::readEntry(), and dictionary::readIfPresent().

Here is the call graph for this function:

◆ boxToPoint() [4/4]

boxToPoint	(	const polyMesh &	mesh,
		Istream &	is
	)

Construct from stream - a single box.

Definition at line 134 of file boxToPoint.C.

◆ ~boxToPoint()

virtual ~boxToPoint ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "boxToPoint" )

Runtime type information.

◆ applyToSet()

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

virtual

Apply specified action to the topoSet.

Implements topoSetSource.

Definition at line 147 of file boxToPoint.C.

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