A zoneGenerator which selects 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 plane:

[legend]

Collaboration diagram for plane:

[legend]

Public Types
enum class	include { all , closest }
	Enumeration for what to include. More...

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

	plane (const word &name, const polyMesh &mesh, const dictionary &dict)
	Construct from dictionary. More...

virtual	~plane ()
	Destructor. More...

virtual zoneSet	generate () const
	Generate and return the zoneSet. More...

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

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

	zoneGenerator (const word &name, const polyMesh &mesh, const dictionary &dict)
	Construct from name, polyMesh and dictionary. More...

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

virtual	~zoneGenerator ()
	Destructor. More...

const word &	name () const

const word &	zoneName () const

bool	moveUpdate () const
	Return true if the zoneGenerator updates any of the zones. More...

virtual zoneSet	movePoints () const
	Regenerate the zoneSet following mesh point motion. More...

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

Static Public Attributes
static const NamedEnum< include, 2 >	includeNames
	Include option names. More...

Additional Inherited Members
Static Public Member Functions inherited from zoneGenerator
static autoPtr< zoneGenerator >	New (const word &name, const polyMesh &mesh, const dictionary &dict)
	Select constructed from name, mesh and dictionary. More...

static autoPtr< zoneGenerator >	New (const word &name, const zoneTypes &zoneType, const polyMesh &mesh, const dictionary &dict)
	Select constructed from name, zoneType, mesh and dictionary. More...

static autoPtr< zoneGenerator >	New (const polyMesh &mesh, const dictionary &dict)
	Select constructed from mesh and first valid dictionary. More...

static labelList	indices (const boolList &selected)
	Return the list of selected indices. More...

Protected Attributes inherited from zoneGenerator
const word	name_
	Name of zone generator. More...

const dictionary	dict_
	Dictionary cached for error context. More...

const word	zoneName_
	Name of the zone (defaults to the name of the generator) More...

const polyMesh &	mesh_
	Reference to the polyMesh. More...

bool	moveUpdate_
	Switch to update the zones if the mesh points are moved. More...

Detailed Description

A zoneGenerator which selects 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.

The returned faceZone is oriented and provides the corresponding flipMap.

Usage

Property	Description	Required	Default value
`type`	Type: face	yes
`name`	Name of the zone	no	zoneGenerator name
`point`	Point on plane	yes
`normal`	Normal to plane	yes
`include`	Include option: all or closest	yes
`moveUpdate`	Switch to update after mesh motion	no	false

To create the faceZone mid containing the faces based on the adjacent cell centres spanning a given plane:

        mid
        {
            type        plane;
            point       (0.41 0 0);
            normal      (1 0 0);
        }

Source files

plane_zoneGenerator.H plane_
zoneGenerator.C

Definition at line 117 of file plane_zoneGenerator.H.

Member Enumeration Documentation

◆ include

enum include

strong

Enumeration for what to include.

Enumerator
all
closest

Definition at line 126 of file plane_zoneGenerator.H.

Constructor & Destructor Documentation

◆ plane()

plane	(	const word &	name,
		const polyMesh &	mesh,
		const dictionary &	dict
	)

Construct from dictionary.

Definition at line 59 of file plane_zoneGenerator.C.

References Foam::all.

◆ ~plane()

~plane ( )

virtual

Destructor.

Definition at line 75 of file plane_zoneGenerator.C.

Member Function Documentation

◆ TypeName()

TypeName ( "plane" )

Runtime type information.

◆ generate()

Foam::zoneSet generate ( ) const

virtual

Generate and return the zoneSet.

Implements zoneGenerator.

Definition at line 81 of file plane_zoneGenerator.C.

References Foam::constant::universal::c, Foam::endl(), Foam::findIndices(), Foam::findMin(), forAll, forAllConstIter, Pstream::gatherList(), Foam::identityMap(), Foam::Info, UList< T >::last(), Pstream::listCombineGather(), Pstream::listCombineScatter(), Foam::mag(), PatchTools::markZones(), Foam::min(), UPstream::myProcNo(), PrimitivePatch< FaceList, PointField >::nEdges(), UPstream::nProcs(), patchi, List< T >::resize(), Foam::returnReduce(), Pstream::scatterList(), List< T >::size(), syncTools::swapBoundaryCellPositions(), syncTools::syncEdgeList(), syncTools::syncFaceList(), and Foam::Zero.

Here is the call graph for this function:

Member Data Documentation

◆ includeNames

const Foam::NamedEnum< Foam::zoneGenerators::plane::include, 2 > includeNames

static

Initial value:

{
    "all",
    "closest"
}

Include option names.

Definition at line 133 of file plane_zoneGenerator.H.

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

src/meshTools/zoneGenerators/face/plane/plane_zoneGenerator.H
src/meshTools/zoneGenerators/face/plane/plane_zoneGenerator.C

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members