A topoSetPointSource to select all points above the specified plane. More...

Inheritance diagram for clipPlaneToPoint:

Collaboration diagram for clipPlaneToPoint:

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

	clipPlaneToPoint ()=delete
	No default construct. More...

	clipPlaneToPoint (const polyMesh &mesh, const point &basePoint, const vector &normal)
	Construct from components. More...

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

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

virtual	~clipPlaneToPoint ()=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
	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 mesh. More...

	topoSetPointSource (const polyMesh &mesh, const dictionary &dict)
	Construct from mesh, use "verbose" entry if present. 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, bool verbose=true)
	Construct from mesh, with preferred verbosity. More...

	topoSetSource (const polyMesh &mesh, const dictionary &dict)
	Construct from mesh, use "verbose" entry if present. More...

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

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

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

bool	verbose () const noexcept
	Get output verbosity. More...

bool	verbose (bool on) noexcept
	Enable/disable verbose output. More...

void	verbose (const dictionary &dict)
	Use "verbose" entry (if present) to enable/disable verbose output. More...

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 }
	Enumeration defining the types of sources. More...

enum	setAction { ADD, SUBTRACT, NEW, SUBSET, INVERT, CLEAR, REMOVE, LIST, IGNORE, DELETE = SUBTRACT }
	Enumeration defining various 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) noexcept
	True if a "set" source. More...

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

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

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

static bool	isPoint (const sourceType t) noexcept
	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 enum text. Names: "new", add", "subtract", "subset", "invert", "clear", "remove", "list", "ignore". More...

static const Enum< setAction >	combineNames
	The setAction enum text when combining selections. Names: "use", "add", "subtract", "subset", "invert", "ignore". 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_
	Output 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 all points above the specified plane.

Operands:

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

Usage

Minimal example by using system/topoSetDict.actions:

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

    // Mandatory entries
    source      clipPlaneToPoint;

    point  (x y z);
    normal (x y z);
}

where the entries mean:

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

Options for the action entry:

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

Options for the conditional mandatory entries:

      Entry    | Description                        | Type   | Req'd  | Dflt
      point    | The reference point for the plane  | vector | yes    | -
      normal   | The unit normal of the plane       | vector | yes    | -

See also

Source files

Definition at line 136 of file clipPlaneToPoint.H.

Constructor & Destructor Documentation

◆ clipPlaneToPoint() [1/4]

clipPlaneToPoint ( )

delete

No default construct.

◆ clipPlaneToPoint() [2/4]

clipPlaneToPoint	(	const polyMesh &	mesh,
		const point &	basePoint,
		const vector &	normal
	)

Construct from components.

Definition at line 80 of file clipPlaneToPoint.C.

◆ clipPlaneToPoint() [3/4]

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

Construct from dictionary.

Definition at line 93 of file clipPlaneToPoint.C.

◆ clipPlaneToPoint() [4/4]

clipPlaneToPoint	(	const polyMesh &	mesh,
		Istream &	is
	)

Construct from stream - a single box.

Definition at line 108 of file clipPlaneToPoint.C.

◆ ~clipPlaneToPoint()

virtual ~clipPlaneToPoint ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "clipPlaneToPoint" )

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 122 of file clipPlaneToPoint.C.

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

Here is the call graph for this function:

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

src/meshTools/topoSet/pointSources/clipPlaneToPoint/clipPlaneToPoint.H
src/meshTools/topoSet/pointSources/clipPlaneToPoint/clipPlaneToPoint.C

Public Member Functions

Additional Inherited Members