A topoSetPointSource to select all points based on usage in given faceSet(s). More...

Inheritance diagram for faceToPoint:

Collaboration diagram for faceToPoint:

Public Types
enum	faceAction { ALL }

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 }

Public Member Functions
	TypeName ("faceToPoint")

	faceToPoint (const polyMesh &mesh, const word &setName, const faceAction option)

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

	faceToPoint (const polyMesh &mesh, Istream &is)

virtual	~faceToPoint ()=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
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 all points based on usage in given faceSet(s).

Operands:

Operand	Type	Location
`input`	faceSet(s)	$FOAM_CASE/constant/polyMesh/sets/<set>
`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      faceToPoint;
    option      <option>;

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

    // Option-1
    sets
    (
        <faceSetName0>
        <faceSetName1>
        ...
    );

    // Option-2
    set     <faceSetName>;
}

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: faceToPoint	word	yes	-
`option`	Selection type - see below	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 option entry:

      all       | Select all points of faces in the faceSet

Options for the conditional mandatory entries:

      Entry    | Description                | Type     | Req'd  | Dflt
      sets     | Names of input faceSets    | wordList | cond'l | -
      set      | Name of input faceSet      | word     | cond'l | -

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

See also

Source files

Definition at line 170 of file faceToPoint.H.

Member Enumeration Documentation

◆ faceAction

enum faceAction

Enumerator
ALL

Definition at line 177 of file faceToPoint.H.

Constructor & Destructor Documentation

◆ faceToPoint() [1/3]

faceToPoint	(	const polyMesh &	mesh,
		const word &	setName,
		const faceAction	option
	)

Definition at line 81 of file faceToPoint.C.

◆ faceToPoint() [2/3]

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

Definition at line 94 of file faceToPoint.C.

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

Here is the call graph for this function:

◆ faceToPoint() [3/3]

faceToPoint	(	const polyMesh &	mesh,
		Istream &	is
	)

Definition at line 113 of file faceToPoint.C.

◆ ~faceToPoint()

virtual ~faceToPoint ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "faceToPoint" )

◆ applyToSet()

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

virtual

Implements topoSetSource.

Definition at line 127 of file faceToPoint.C.

References topoSetSource::ADD, Foam::ListListOps::combine(), Foam::flatOutput(), Foam::Info, topoSetSource::NEW, Foam::nl, Foam::BitOps::set(), and topoSetSource::SUBTRACT.