A topoSetSource to convert a faceSet to a faceZone (and associated faceSet). More...

Inheritance diagram for setToFaceZone:

Collaboration diagram for setToFaceZone:

Public Member Functions
	TypeName ("setToFaceZone")

	setToFaceZone (const polyMesh &mesh, const word &setName)

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

	setToFaceZone (const polyMesh &mesh, Istream &is)

virtual	~setToFaceZone ()=default

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

Public Member Functions inherited from topoSetFaceZoneSource
	declareRunTimeSelectionTable (autoPtr, topoSetFaceZoneSource, word,(const polyMesh &mesh, const dictionary &dict),(mesh, dict))

	declareRunTimeSelectionTable (autoPtr, topoSetFaceZoneSource, istream,(const polyMesh &mesh, Istream &is),(mesh, is))

	topoSetFaceZoneSource (const polyMesh &mesh)

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

autoPtr< topoSetFaceZoneSource >	clone () const

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

static autoPtr< topoSetFaceZoneSource >	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 topoSetSource to convert a faceSet to a faceZone (and associated faceSet).

Operands:

Operand	Type	Location
`input`	faceSet	$FOAM_CASE/constant/polyMesh/sets/<set>
`output` 1	faceSet	$FOAM_CASE/constant/polyMesh/sets/<set>
`output` 2	faceZone	$FOAM_CASE/constant/polyMesh/faceZones

Usage

Minimal example by using system/topoSetDict.actions:

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

    // Mandatory entries
    source      setToFaceZone;
    faceSet     <faceSetName>;
}

where the entries mean:

Property	Description	Type	Req'd	Dflt
`name`	Name of faceZone	word	yes	-
`type`	Type name: faceZoneSet	word	yes	-
`action`	Action applied on faces - see below	word	yes	-
`source`	Source name: setToFaceZone	word	yes	-
`faceSet`	Name of input faceSet	word	yes	-

Options for the action entry:

      new      | Create a new faceZone from selected faces of a faceSet
      add      | Add selected faces of a faceSet into this faceZone
      subtract | Remove selected faces of a faceSet from this faceZone

Note: The use of keyword faceSet is consistent with the setsToFaceZone, but inconsistent with setToCellZone and setToPointZone. Both of which use set instead.

See also