A topoSetPointSource to convert pointZone(s) to a pointSet. More...

Inheritance diagram for zoneToPoint:

Collaboration diagram for zoneToPoint:

Public Member Functions
	TypeName ("zoneToPoint")

	zoneToPoint (const polyMesh &mesh, const wordRes &zoneSelector)

	zoneToPoint (const polyMesh &mesh, const wordRe &zoneName)

	zoneToPoint (const polyMesh &mesh, const labelUList &zoneIDs)

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

	zoneToPoint (const polyMesh &mesh, Istream &is)

virtual	~zoneToPoint ()=default

const wordRes &	zones () const noexcept

void	zones (const wordRes &zoneSelector)

void	zones (const wordRe &zoneName)

void	zones (const labelUList &zoneIDs)

void	zones (const label zoneID)

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 convert pointZone(s) to a pointSet.

Operands:

Operand	Type	Location
`input`	pointZone(s)	$FOAM_CASE/constant/polyMesh/pointZones
`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      zoneToPoint;

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

    // Option-1
    zones
    (
        <pointZoneName0>
        <pointZoneName1>
        ...
    );

    // Option-2
    zone     <pointZoneName>;
}

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: zoneToPoint	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 points from this pointSet

Options for the conditional mandatory entries:

      Entry    | Description                | Type     | Req'd  | Dflt
      zones    | Names of input pointZones  | wordRes  | cond'l | -
      zone     | Name of input pointZone    | wordRe   | cond'l | -