A topoSetSource to selects points based on relation to surface. More...

Inheritance diagram for surfaceToPoint:

Collaboration diagram for surfaceToPoint:

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

	surfaceToPoint (const polyMesh &mesh, const fileName &surfName, const scalar nearDist, const bool includeInside, const bool includeOutside)
	Construct from components. More...

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

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

virtual	~surfaceToPoint ()
	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))

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

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

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

virtual	~topoSetSource ()
	Destructor. More...

const polyMesh &	mesh () const

Private Member Functions
void	combine (topoSet &set, const bool add) const
	Depending on surface add to or delete from pointSet. More...

void	checkSettings () const
	Check settings at construction time. More...

Private Attributes
const fileName	surfName_
	Name of surface file. More...

const scalar	nearDist_
	If > 0 : include points with distance to surface less than nearDist. More...

const bool	includeInside_
	Include all points on opposite sign of normal on nearest surface. More...

const bool	includeOutside_
	Include all points on this sign of normal on nearest surface. More...

Static Private Attributes
static addToUsageTable	usage_
	Add usage string. More...

Additional Inherited Members
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...

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

static Istream &	checkIs (Istream &is)
	Check state of stream. 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...

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_

Static Protected Attributes inherited from topoSetSource
static HashTable< string > *	usageTablePtr_ = NULL
	A table of usage strings. More...

Detailed Description

A topoSetSource to selects points based on relation to surface.

Select based on:

distance to surface
inside/outside status to surface (Uses normal of nearest surface triangle so requires valid surface topology!)

Source files

Definition at line 56 of file surfaceToPoint.H.

Constructor & Destructor Documentation

◆ surfaceToPoint() [1/3]

surfaceToPoint	(	const polyMesh &	mesh,
		const fileName &	surfName,
		const scalar	nearDist,
		const bool	includeInside,
		const bool	includeOutside
	)

Construct from components.

Definition at line 124 of file surfaceToPoint.C.

◆ surfaceToPoint() [2/3]

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

Construct from dictionary.

Definition at line 143 of file surfaceToPoint.C.

◆ surfaceToPoint() [3/3]

surfaceToPoint	(	const polyMesh &	mesh,
		Istream &	is
	)

Construct from Istream.

Definition at line 159 of file surfaceToPoint.C.

◆ ~surfaceToPoint()

~surfaceToPoint ( )

virtual

Destructor.

Definition at line 176 of file surfaceToPoint.C.

Member Function Documentation

◆ combine()

void combine	(	topoSet &	set,
		const bool	add
	)		const

private

Depending on surface add to or delete from pointSet.

Definition at line 58 of file surfaceToPoint.C.

References Foam::add(), topoSetSource::addOrDelete(), triSurfaceSearch::calcInside(), Foam::endl(), forAll, PointIndexHit< Point >::hit(), PointIndexHit< Point >::hitPoint(), surfaceToPoint::includeInside_, surfaceToPoint::includeOutside_, Foam::Info, Foam::mag(), topoSetSource::mesh_, surfaceToPoint::nearDist_, triSurfaceSearch::nearest(), polyMesh::points(), and surfaceToPoint::surfName_.

Here is the call graph for this function:

◆ checkSettings()

void checkSettings ( ) const

private

Check settings at construction time.

Definition at line 107 of file surfaceToPoint.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "surfaceToPoint" )

Runtime type information.

◆ setType()

virtual sourceType setType ( ) const

inlinevirtual

Implements topoSetSource.

Definition at line 125 of file surfaceToPoint.H.

References topoSetSource::POINTSETSOURCE.

◆ applyToSet()

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

virtual

Implements topoSetSource.

Definition at line 183 of file surfaceToPoint.C.

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

Here is the call graph for this function:

Field Documentation

◆ usage_

Foam::topoSetSource::addToUsageTable usage_

staticprivate

Add usage string.

Definition at line 64 of file surfaceToPoint.H.

◆ surfName_

const fileName surfName_

private

Name of surface file.

Definition at line 67 of file surfaceToPoint.H.

Referenced by surfaceToPoint::combine().

◆ nearDist_

const scalar nearDist_

private

If > 0 : include points with distance to surface less than nearDist.

Definition at line 70 of file surfaceToPoint.H.

Referenced by surfaceToPoint::combine().

◆ includeInside_

const bool includeInside_

private

Include all points on opposite sign of normal on nearest surface.

Definition at line 73 of file surfaceToPoint.H.

Referenced by surfaceToPoint::combine().

◆ includeOutside_

const bool includeOutside_

private

Include all points on this sign of normal on nearest surface.

Definition at line 76 of file surfaceToPoint.H.

Referenced by surfaceToPoint::combine().

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

src/meshTools/sets/pointSources/surfaceToPoint/surfaceToPoint.H
src/meshTools/sets/pointSources/surfaceToPoint/surfaceToPoint.C

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ surfaceToPoint() [1/3]

◆ surfaceToPoint() [2/3]

◆ surfaceToPoint() [3/3]

◆ ~surfaceToPoint()

Member Function Documentation

◆ combine()

◆ checkSettings()

◆ TypeName()

◆ setType()

◆ applyToSet()

Field Documentation

◆ usage_

◆ surfName_

◆ nearDist_

◆ includeInside_

◆ includeOutside_