A topoSetPointSource to select points based on explicitly given point labels. More...

Inheritance diagram for labelToPoint:

Collaboration diagram for labelToPoint:

Public Member Functions
	TypeName ("labelToPoint")

	labelToPoint (const polyMesh &mesh, const labelList &labels)

	labelToPoint (const polyMesh &mesh, labelList &&labels)

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

	labelToPoint (const polyMesh &mesh, Istream &is)

virtual	~labelToPoint ()=default

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

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)

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

autoPtr< topoSetPointSource >	clone () const

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

static autoPtr< topoSetPointSource >	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 topoSetPointSource to select points based on explicitly given point labels.

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      labelToPoint;
    value
    (
        <pointLabel1>
        <pointLabel2>
        ...
    );
}

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: labelToPoint	word	yes	-
`value`	Input point labels	labelList	yes	-

Options for the action entry:

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

See also

Source files

Definition at line 139 of file labelToPoint.H.

Constructor & Destructor Documentation

◆ labelToPoint() [1/4]

labelToPoint	(	const polyMesh &	mesh,
		const labelList &	labels
	)

Definition at line 63 of file labelToPoint.C.

◆ labelToPoint() [2/4]

labelToPoint	(	const polyMesh &	mesh,
		labelList &&	labels
	)

Definition at line 74 of file labelToPoint.C.

◆ labelToPoint() [3/4]

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

Definition at line 85 of file labelToPoint.C.

◆ labelToPoint() [4/4]

labelToPoint	(	const polyMesh &	mesh,
		Istream &	is
	)

Definition at line 95 of file labelToPoint.C.

References Foam::check(), and mesh.

Here is the call graph for this function:

◆ ~labelToPoint()

virtual ~labelToPoint ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "labelToPoint" )

◆ applyToSet()

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

virtual

Implements topoSetSource.

Definition at line 110 of file labelToPoint.C.

References Foam::endl(), Foam::Info, and Foam::BitOps::set().