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

Inheritance diagram for zoneToPoint:

Collaboration diagram for zoneToPoint:

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

	zoneToPoint (const polyMesh &mesh, const wordRes &zoneSelector)
	Construct from mesh and zones selector. More...

	zoneToPoint (const polyMesh &mesh, const wordRe &zoneName)
	Construct from mesh and single zone selector. More...

	zoneToPoint (const polyMesh &mesh, const labelUList &zoneIDs)
	Construct from mesh and specified zone IDs. More...

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

	zoneToPoint (const polyMesh &mesh, Istream &is)
	Construct from Istream. More...

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

const wordRes &	zones () const noexcept
	Return the current zones selector. More...

void	zones (const wordRes &zoneSelector)
	Define the zones selector. More...

void	zones (const wordRe &zoneName)
	Define the zones selector with a single zone selector. More...

void	zones (const labelUList &zoneIDs)
	Define the pointZone IDs to use (must exist). More...

void	zones (const label zoneID)
	Define the pointZone ID to use (must exist). 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...

virtual sourceType	setType () const =0
	The source category (cell/face/point combined with set/zone) More...

virtual void	applyToSet (const topoSetSource::setAction action, topoSet &set) const =0
	Apply specified action to the topoSet. 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

static const Enum< setAction >	combineNames

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 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 | -

Note: The order of precedence among the conditional mandatory entries from the highest to the lowest is zones, and zone.

See also

Source files

Definition at line 160 of file zoneToPoint.H.

Constructor & Destructor Documentation

◆ zoneToPoint() [1/5]

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

Construct from mesh and zones selector.

Definition at line 145 of file zoneToPoint.C.

◆ zoneToPoint() [2/5]

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

Construct from mesh and single zone selector.

Definition at line 156 of file zoneToPoint.C.

◆ zoneToPoint() [3/5]

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

Construct from mesh and specified zone IDs.

Definition at line 167 of file zoneToPoint.C.

◆ zoneToPoint() [4/5]

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

Construct from dictionary.

Definition at line 179 of file zoneToPoint.C.

References dict, UList< T >::first(), dictionary::getCompat(), dictionary::readIfPresent(), and List< T >::resize().

Here is the call graph for this function:

◆ zoneToPoint() [5/5]

zoneToPoint	(	const polyMesh &	mesh,
		Istream &	is
	)

Construct from Istream.

Definition at line 198 of file zoneToPoint.C.

◆ ~zoneToPoint()

virtual ~zoneToPoint ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "zoneToPoint" )

Runtime type information.

◆ zones() [1/5]

const Foam::wordRes & zones ( ) const

noexcept

Return the current zones selector.

Definition at line 210 of file zoneToPoint.C.

◆ zones() [2/5]

void zones ( const wordRes & zoneSelector )

Define the zones selector.

Definition at line 216 of file zoneToPoint.C.

References List< T >::clear().

Here is the call graph for this function:

◆ zones() [3/5]

void zones ( const wordRe & zoneName )

Define the zones selector with a single zone selector.

Definition at line 223 of file zoneToPoint.C.

References wordRe::clear(), and List< T >::resize().

Here is the call graph for this function:

◆ zones() [4/5]

void zones ( const labelUList & zoneIDs )

Define the pointZone IDs to use (must exist).

Clears the zone name matcher

Definition at line 231 of file zoneToPoint.C.

References List< T >::clear(), and zoneIDs.

Here is the call graph for this function:

◆ zones() [5/5]

void zones ( const label zoneID )

Define the pointZone ID to use (must exist).

Clears the zone name matcher

Definition at line 238 of file zoneToPoint.C.

References List< T >::clear(), and zoneID.

Here is the call graph for this function:

◆ applyToSet()

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

virtual

Apply specified action to the topoSet.

Implements topoSetSource.

Definition at line 246 of file zoneToPoint.C.

References topoSetSource::ADD, Foam::endl(), Foam::flatOutput(), 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/zoneToPoint/zoneToPoint.H
src/meshTools/topoSet/pointSources/zoneToPoint/zoneToPoint.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ zoneToPoint() [1/5]

◆ zoneToPoint() [2/5]

◆ zoneToPoint() [3/5]

◆ zoneToPoint() [4/5]

◆ zoneToPoint() [5/5]

◆ ~zoneToPoint()

Member Function Documentation

◆ TypeName()

◆ zones() [1/5]

◆ zones() [2/5]

◆ zones() [3/5]

◆ zones() [4/5]

◆ zones() [5/5]

◆ applyToSet()