A topoSetSource to select faces based on the adjacent cell centres spanning a given plane. The plane is defined by a point and normal vector. More...

Inheritance diagram for planeToFaceZone:

[legend]

Collaboration diagram for planeToFaceZone:

[legend]

Public Types
enum	faceAction { ALL , CLOSEST }
	Enumeration defining the valid options. More...

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

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

	planeToFaceZone ()=delete
	No default construct. More...

	planeToFaceZone (const polyMesh &mesh, const point &basePoint, const vector &normal, const faceAction action=faceAction::ALL)
	Construct from components. More...

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

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

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

virtual void	applyToSet (const topoSetSource::setAction action, topoSet &) const
	Apply specified action to the topoSet. More...

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)
	Construct from mesh. More...

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

autoPtr< topoSetFaceZoneSource >	clone () const
	Clone (disallowed) More...

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

virtual topoSetSource::sourceType	setType () const
	The source category is a faceZone. 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
Static Public Member Functions inherited from topoSetFaceZoneSource
static autoPtr< topoSetFaceZoneSource >	New (const word &sourceType, const polyMesh &mesh, const dictionary &dict)
	Return a reference to the selected source type. More...

static autoPtr< topoSetFaceZoneSource >	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 topoSetSource to select faces based on the adjacent cell centres spanning a given plane. The plane is defined by a point and normal vector.

Operands:

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

Usage

Minimal example by using system/topoSetDict.actions:

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

    // Mandatory entries
    source      planeToFaceZone;
    point       (<px> <py> <pz>);
    normal      (<nx> <ny> <nz>);

    // Optional entries
    option      <option>;
}

where the entries mean:

Property	Description	Type	Reqd	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: planeToFaceZone	word	yes	-
`point`	A point on the input plane	vector	yes	-
`normal`	Normal vector to the input plane	vector	yes	-
`option`	Plane selection method - see below	word	no	all

Options for the action entry:

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

Options for the option entry:

      all      | Select all faces that meet the criteria
      closest  | Select faces that belong to the closest contiguous plane

Note

Additionally, an include entry can be specified. When omitted or set to "all", then all faces that meet the criteria are included in the set. When set to "closest", just the faces that belong to the closest contiguous region to the plane point are included. This latter setting is useful when defining face zones through channels on which the flow rate is to be computed, as it keeps the set local to a single channel.

See also

Foam::topoSetSource

Source files

Definition at line 174 of file planeToFaceZone.H.

Member Enumeration Documentation

◆ faceAction

enum faceAction

Enumeration defining the valid options.

Enumerator
ALL	Select all faces that meet the criteria.
CLOSEST	Select faces belong to the closest contiguous plane.

Definition at line 181 of file planeToFaceZone.H.

Constructor & Destructor Documentation

◆ planeToFaceZone() [1/4]

planeToFaceZone ( )

delete

No default construct.

◆ planeToFaceZone() [2/4]

planeToFaceZone	(	const polyMesh &	mesh,
		const point &	basePoint,
		const vector &	normal,
		const faceAction	action = `faceAction::ALL`
	)

Construct from components.

Definition at line 370 of file planeToFaceZone.C.

◆ planeToFaceZone() [3/4]

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

Construct from dictionary.

Definition at line 385 of file planeToFaceZone.C.

◆ planeToFaceZone() [4/4]

planeToFaceZone	(	const polyMesh &	mesh,
		Istream &	is
	)

Construct from Istream.

Definition at line 401 of file planeToFaceZone.C.

◆ ~planeToFaceZone()

virtual ~planeToFaceZone ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "planeToFaceZone" )

Runtime type information.

◆ applyToSet()

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

virtual

Apply specified action to the topoSet.

Implements topoSetSource.

Definition at line 416 of file planeToFaceZone.C.

References topoSetSource::ADD, Foam::endl(), Foam::Info, topoSetSource::NEW, topoSetSource::SUBTRACT, and WarningInFunction.

Here is the call graph for this function:

The documentation for this class was generated from the following files:

src/meshTools/topoSet/faceZoneSources/planeToFaceZone/planeToFaceZone.H
src/meshTools/topoSet/faceZoneSources/planeToFaceZone/planeToFaceZone.C

Public Types

Public Member Functions

Additional Inherited Members