planeToFaceZone Class Reference

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:

Collaboration diagram for planeToFaceZone:

Public Types
enum	faceAction { ALL, CLOSEST }
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 ("planeToFaceZone")
	planeToFaceZone ()=delete
	planeToFaceZone (const polyMesh &mesh, const point &basePoint, const vector &normal, const faceAction action=faceAction::ALL)
	planeToFaceZone (const polyMesh &mesh, const dictionary &dict)
	planeToFaceZone (const polyMesh &mesh, Istream &is)
virtual	~planeToFaceZone ()=default
virtual void	applyToSet (const topoSetSource::setAction action, topoSet &) 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
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 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

• planeToFaceZone.H
• planeToFaceZone.C

Definition at line 170 of file planeToFaceZone.H.

Member Enumeration Documentation

faceAction

enum faceAction

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

Definition at line 177 of file planeToFaceZone.H.

Constructor & Destructor Documentation

planeToFaceZone() [1/4]

planeToFaceZone ( )

delete

planeToFaceZone() [2/4]

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

Definition at line 362 of file planeToFaceZone.C.

planeToFaceZone() [3/4]

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

Definition at line 377 of file planeToFaceZone.C.

planeToFaceZone() [4/4]

planeToFaceZone	(	const polyMesh &	mesh,
		Istream &	is
	)

Definition at line 393 of file planeToFaceZone.C.

~planeToFaceZone()

virtual ~planeToFaceZone ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"planeToFaceZone"

)

applyToSet()

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

virtual

Implements topoSetSource.

Definition at line 408 of file planeToFaceZone.C.

References topoSetSource::ADD, Foam::ListListOps::combine(), Foam::endl(), Foam::Info, topoSetSource::NEW, Foam::BitOps::set(), 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/sets/faceZoneSources/planeToFaceZone/planeToFaceZone.H
• src/meshTools/sets/faceZoneSources/planeToFaceZone/planeToFaceZone.C