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	include { all , closest }
	Enumeration for what to include. More...

Public Types inherited from topoSetSource
enum	sourceType { CELLSETSOURCE , FACESETSOURCE , POINTSETSOURCE , CELLZONESOURCE , FACEZONESOURCE , POINTZONESOURCE }
	Enumeration defining the types of sources. More...

enum	setAction { CLEAR , NEW , INVERT , ADD , DELETE , SUBSET , LIST , REMOVE }
	Enumeration defining the valid actions. More...

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

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

virtual	~planeToFaceZone ()
	Destructor. More...

virtual sourceType	setType () const

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

Public Member Functions inherited from topoSetSource
	TypeName ("topoSetSource")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, topoSetSource, word,(const polyMesh &mesh, const dictionary &dict),(mesh, dict))

	topoSetSource (const polyMesh &mesh)
	Construct from components. More...

	topoSetSource (const topoSetSource &)=delete
	Disallow default bitwise copy construction. More...

autoPtr< topoSetSource >	clone () const
	Clone. More...

virtual	~topoSetSource ()
	Destructor. More...

const polyMesh &	mesh () const

void	operator= (const topoSetSource &)=delete
	Disallow default bitwise assignment. More...

Static Public Attributes
static const NamedEnum< include, 2 >	includeNames_
	Included region names. More...

Additional Inherited Members
Static Public Member Functions inherited from topoSetSource
static setAction	toAction (const word &actionName)
	Convert string to action. More...

static autoPtr< topoSetSource >	New (const word &topoSetSourceType, const polyMesh &mesh, const dictionary &dict)
	Return a reference to the selected topoSetSource. More...

Protected Member Functions inherited from topoSetSource
void	addOrDelete (topoSet &set, const label celli, const bool) const
	Add (if bool) celli to set or delete celli from set. More...

Protected Attributes inherited from topoSetSource
const polyMesh &	mesh_

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.

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.

Source files

Definition at line 58 of file planeToFaceZone.H.

Member Enumeration Documentation

◆ include

enum include

Enumeration for what to include.

Enumerator
all
closest

Definition at line 65 of file planeToFaceZone.H.

Constructor & Destructor Documentation

◆ planeToFaceZone()

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

Construct from dictionary.

Definition at line 339 of file planeToFaceZone.C.

◆ ~planeToFaceZone()

~planeToFaceZone ( )

virtual

Destructor.

Definition at line 364 of file planeToFaceZone.C.

Member Function Documentation

◆ TypeName()

TypeName ( "planeToFaceZone" )

Runtime type information.

◆ setType()

virtual sourceType setType ( ) const

inlinevirtual

Implements topoSetSource.

Definition at line 116 of file planeToFaceZone.H.

References topoSetSource::FACESETSOURCE.

◆ applyToSet()

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

virtual

Implements topoSetSource.

Definition at line 370 of file planeToFaceZone.C.

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

Here is the call graph for this function:

Member Data Documentation

◆ includeNames_

const Foam::NamedEnum< Foam::planeToFaceZone::include, 2 > includeNames_

static

Included region names.

Definition at line 72 of file planeToFaceZone.H.

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

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members