A topoSetFaceSource to select faces whose surface normal aligned with a given direction. More...

Inheritance diagram for normalToFace:

Collaboration diagram for normalToFace:

Public Member Functions
	TypeName ("normalToFace")

	normalToFace (const polyMesh &mesh, const vector &normal, const scalar tol)

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

	normalToFace (const polyMesh &mesh, Istream &)

virtual	~normalToFace ()=default

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

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

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

	topoSetFaceSource (const polyMesh &mesh)

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

autoPtr< topoSetFaceSource >	clone () const

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

static autoPtr< topoSetFaceSource >	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 topoSetFaceSource to select faces whose surface normal aligned with a given direction.

Operands:

Operand	Type	Location
`output`	faceSet	$FOAM_CASE/constant/polyMesh/sets/<set>

Usage

Minimal example by using system/topoSetDict.actions:

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

    // Mandatory entries
    source      normalToFace;
    normal      (1 0 0);
    cos         0.01;
}

where the entries mean:

Property	Description	Type	Req'd	Dflt
`name`	Name of faceSet	word	yes	-
`type`	Type name: faceSet	word	yes	-
`action`	Action applied on faces - see below	word	yes	-
`source`	Source name: normalToFace	word	yes	-
`normal`	The surface normal direction	vector	yes	-
`cos`	Tolerance angle (range -1, +1), i.e. cosine of angle between the input normal and face normal	scalar	yes	-

Options for the action entry:

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

See also

Source files

Definition at line 145 of file normalToFace.H.

Constructor & Destructor Documentation

◆ normalToFace() [1/3]

normalToFace	(	const polyMesh &	mesh,
		const vector &	normal,
		const scalar	tol
	)

Definition at line 80 of file normalToFace.C.

◆ normalToFace() [2/3]

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

Definition at line 94 of file normalToFace.C.

◆ normalToFace() [3/3]

normalToFace	(	const polyMesh &	mesh,
		Istream &	is
	)

Definition at line 107 of file normalToFace.C.

◆ ~normalToFace()

virtual ~normalToFace ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "normalToFace" )

◆ applyToSet()

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

virtual

Implements topoSetSource.

Definition at line 120 of file normalToFace.C.

References topoSetSource::ADD, DynamicList::append(), Foam::endl(), forAll, Foam::Info, Foam::mag(), n, topoSetSource::NEW, Foam::normalised(), Foam::BitOps::set(), and topoSetSource::SUBTRACT.

Here is the call graph for this function:

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

src/meshTools/sets/faceSources/normalToFace/normalToFace.H
src/meshTools/sets/faceSources/normalToFace/normalToFace.C

Public Member Functions

Additional Inherited Members