Searching on (optionally hollow) cone. More...

Inheritance diagram for searchableCone:

Collaboration diagram for searchableCone:

[legend]

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

	searchableCone (const IOobject &io, const point &point1, const scalar radius1, const scalar innerRadius1, const point &point2, const scalar radius2, const scalar innerRadius2)
	Construct from components. More...

	searchableCone (const IOobject &io, const dictionary &dict)
	Construct from dictionary (used by searchableSurface) More...

virtual	~searchableCone ()
	Destructor. More...

virtual const wordList &	regions () const
	Names of regions. More...

virtual bool	hasVolumeType () const
	Whether supports volume type below. More...

virtual label	size () const
	Range of local indices that can be returned. More...

virtual tmp< pointField >	coordinates () const
	Get representative set of element coordinates. More...

virtual void	boundingSpheres (pointField &centres, scalarField &radiusSqr) const
	Get bounding spheres (centre and radius squared), one per element. More...

virtual tmp< pointField >	points () const
	Get the points that define the surface. More...

virtual bool	overlaps (const boundBox &bb) const
	Does any part of the surface overlap the supplied bound box? More...

virtual void	findNearest (const pointField &sample, const scalarField &nearestDistSqr, List< pointIndexHit > &) const
	Find nearest point on cylinder. More...

virtual void	findLine (const pointField &start, const pointField &end, List< pointIndexHit > &) const
	Find nearest intersection on line from start to end. More...

virtual void	findLineAll (const pointField &start, const pointField &end, List< List< pointIndexHit > > &) const
	Find all intersections in order from start to end. More...

virtual void	findLineAny (const pointField &start, const pointField &end, List< pointIndexHit > &) const
	Find any intersection on line from start to end. More...

virtual void	getRegion (const List< pointIndexHit > &, labelList &region) const
	From a set of points and indices get the region. More...

virtual void	getNormal (const List< pointIndexHit > &, vectorField &normal) const
	From a set of points and indices get the normal. More...

virtual void	getVolumeType (const pointField &, List< volumeType > &) const
	Determine type (inside/outside/mixed) for point. unknown if. More...

virtual bool	writeData (Ostream &) const
	Pure virtual writaData function. More...

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

	declareRunTimeSelectionTable (autoPtr, searchableSurface, dict,(const IOobject &io, const dictionary &dict),(io, dict))

	searchableSurface (const IOobject &io)

virtual autoPtr< searchableSurface >	clone () const
	Clone. More...

virtual	~searchableSurface ()
	Destructor. More...

const boundBox &	bounds () const
	Return const reference to boundBox. More...

boundBox &	bounds ()
	Return non-const access to the boundBox to allow it to be set. More...

virtual label	globalSize () const
	Range of global indices that can be returned. More...

virtual void	findNearest (const pointField &samples, const scalarField &nearestDistSqr, const labelList &regionIndices, List< pointIndexHit > &info) const
	Find the nearest locations for the supplied points to a. More...

virtual void	findNearest (const pointField &sample, const scalarField &nearestDistSqr, List< pointIndexHit > &, vectorField &normal, labelList &region) const
	Find nearest, normal and region. Can be overridden with. More...

virtual void	distribute (const List< treeBoundBox > &, const bool keepNonLocal, autoPtr< mapDistribute > &faceMap, autoPtr< mapDistribute > &pointMap)
	Set bounds of surface. Bounds currently set as list of. More...

virtual void	setField (const labelList &values)
	WIP. Store element-wise field. More...

virtual void	getField (const List< pointIndexHit > &, labelList &values) const
	WIP. From a set of hits (points and. More...

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

	regIOobject (const IOobject &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the. More...

	regIOobject (const regIOobject &)
	Construct as copy. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Construct as copy, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Construct as copy with new name, transfering registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Construct as copy with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry. More...

bool	checkOut ()
	Remove object from registry. More...

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

void	store ()
	Transfer ownership of this object to its registry. More...

void	release ()
	Release ownership of this object from its registry. More...

label	eventNo () const
	Event number at last update. More...

label &	eventNo ()
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set up to date (obviously) More...

virtual void	rename (const word &newName)
	Rename. More...

Istream &	readStream (const word &)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual bool	readData (Istream &)
	Virtual readData function. More...

virtual bool	read ()
	Read object. More...

label	watchIndex () const
	Return file-monitoring handle. More...

label &	watchIndex ()
	Return file-monitoring handle. More...

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) More...

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
	Write using given format, version and compression. More...

virtual bool	write () const
	Write using setting from DB. More...

void	operator= (const IOobject &)

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

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const word &name)
	Construct as copy resetting name. More...

Foam::autoPtr< IOobject >	clone () const
	Clone. More...

virtual	~IOobject ()
	Destructor. More...

const Time &	time () const
	Return time. More...

const objectRegistry &	db () const
	Return the local objectRegistry. More...

const word &	name () const
	Return name. More...

const word &	headerClassName () const
	Return name of the class name read from header. More...

string &	note ()
	Return non-constant access to the optional note. More...

const string &	note () const
	Return the optional note. More...

bool &	registerObject ()
	Register object created from this IOobject with registry if true. More...

bool	registerObject () const
	Register object created from this IOobject with registry if true. More...

readOption	readOpt () const

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const

fileName &	instance ()

const fileName &	local () const

fileName	path () const
	Return complete path. More...

fileName	path (const word &instance, const fileName &local="") const
	Return complete path with alternative instance and local. More...

fileName	objectPath () const
	Return complete path + object name. More...

fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	readHeader (Istream &)
	Read header. More...

bool	headerOk ()
	Read and check header info. More...

bool	writeHeader (Ostream &) const
	Write header. More...

bool	writeHeader (Ostream &, const word &objectType) const
	Write header. Allow override of type. More...

bool	good () const

bool	bad () const

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &)

template<class Name >
Foam::word	groupName (Name name, const word &group)

Private Member Functions
void	findNearestAndNormal (const point &sample, const scalar nearestDistSqr, pointIndexHit &nearInfo, vector &normal) const
	Find nearest point on cylinder. More...

void	findLineAll (const searchableCone &cone, const scalar innerRadius1, const scalar innerRadius2, const point &start, const point &end, pointIndexHit &near, pointIndexHit &far) const
	Find both intersections with cone. innerRadii supplied externally. More...

void	insertHit (const point &start, const point &end, List< pointIndexHit > &info, const pointIndexHit &hit) const
	Insert a hit if it differs (by a tolerance) from the existing ones. More...

boundBox	calcBounds () const
	Return the boundBox of the cylinder. More...

	searchableCone (const searchableCone &)
	Disallow default bitwise copy construct. More...

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

Static Private Member Functions
static scalar	radius2 (const searchableCone &cone, const point &pt)
	Determine radial coordinate (squared) More...

Private Attributes
const point	point1_
	'Left' point More...

const scalar	radius1_
	Outer radius at point1. More...

const scalar	innerRadius1_
	Inner radius at point1. More...

const point	point2_
	'Right' point More...

const scalar	radius2_
	Outer radius at point2. More...

const scalar	innerRadius2_
	Inner radius at point2. More...

const scalar	magDir_
	Length of vector point2-point1. More...

const vector	unitDir_
	Normalised vector point2-point1. More...

wordList	regions_
	Names of regions. More...

Additional Inherited Members
Public Types inherited from regIOobject
enum	fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Types of communications. More...

Public Types inherited from IOobject
enum	objectState { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
	Enumeration defining the read options. More...

enum	writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
	Enumeration defining the write options. More...

Static Public Member Functions inherited from searchableSurface
static autoPtr< searchableSurface >	New (const word &surfaceType, const IOobject &io, const dictionary &dict)
	Return a reference to the selected searchableSurface. More...

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *)
	Transfer ownership of the given object pointer to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &)
	Transfer ownership of the given object pointer to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class Name >
static word	groupName (Name name, const word &group)

template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider. More...

template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider. More...

static void	replaceFileName (const word &from, const word &to)

Static Public Attributes inherited from regIOobject
static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static int	fileModificationSkew

static fileCheckTypes	fileModificationChecking

Protected Member Functions inherited from IOobject
Istream *	objectStream ()
	Construct and return an IFstream for the object. More...

Istream *	objectStream (const fileName &)
	Construct and return an IFstream for the object given the. More...

void	setBad (const string &)
	Set the object state to bad. More...

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. More...

Detailed Description

Searching on (optionally hollow) cone.

Function object usage

Property	Description	Required	Default value
`point1`	coordinate of endpoint	yes
`radius1`	radius at point1	yes	yes
`innerRadius1`	inner radius at point1	no
`point2`	coordinate of endpoint	yes
`radius2`	radius at point2	yes	yes
`innerRadius2`	inner radius at point2	no

Note: Initial implementation, might suffer from robustness (e.g. radius1==radius2)

Source files

Definition at line 97 of file searchableCone.H.

Constructor & Destructor Documentation

◆ searchableCone() [1/3]

searchableCone ( const searchableCone & )

private

Disallow default bitwise copy construct.

◆ searchableCone() [2/3]

searchableCone	(	const IOobject &	io,
		const point &	point1,
		const scalar	radius1,
		const scalar	innerRadius1,
		const point &	point2,
		const scalar	radius2,
		const scalar	innerRadius2
	)

Construct from components.

Definition at line 709 of file searchableCone.C.

◆ searchableCone() [3/3]

searchableCone	(	const IOobject &	io,
		const dictionary &	dict
	)

Construct from dictionary (used by searchableSurface)

Definition at line 734 of file searchableCone.C.

◆ ~searchableCone()

~searchableCone ( )

virtual

Destructor.

Definition at line 755 of file searchableCone.C.

Member Function Documentation

◆ findNearestAndNormal()

void findNearestAndNormal	(	const point &	sample,
		const scalar	nearestDistSqr,
		pointIndexHit &	nearInfo,
		vector &	normal
	)		const

private

Find nearest point on cylinder.

Definition at line 87 of file searchableCone.C.

References Foam::constant::physicoChemical::b, Foam::findMin(), Foam::mag(), Foam::magSqr(), Foam::max(), Foam::min(), PointIndexHit< Point >::rawPoint(), PointIndexHit< Point >::setHit(), PointIndexHit< Point >::setIndex(), PointIndexHit< Point >::setPoint(), and Vector< scalar >::zero.

Here is the call graph for this function:

◆ radius2()

Foam::scalar radius2	(	const searchableCone &	cone,
		const point &	pt
	)

staticprivate

Determine radial coordinate (squared)

Definition at line 312 of file searchableCone.C.

References searchableCone::point1_, searchableCone::unitDir_, and x.

◆ findLineAll() [1/2]

void findLineAll	(	const searchableCone &	cone,
		const scalar	innerRadius1,
		const scalar	innerRadius2,
		const point &	start,
		const point &	end,
		pointIndexHit &	near,
		pointIndexHit &	far
	)		const

private

Find both intersections with cone. innerRadii supplied externally.

Definition at line 325 of file searchableCone.C.

References Foam::constant::physicoChemical::b, Foam::constant::universal::c, Foam::mag(), searchableCone::magDir_, p, searchableCone::point1_, searchableCone::point2_, searchableCone::radius1_, searchableCone::radius2_, s(), PointIndexHit< Point >::setHit(), PointIndexHit< Point >::setIndex(), PointIndexHit< Point >::setMiss(), PointIndexHit< Point >::setPoint(), Foam::sqr(), Foam::sqrt(), Foam::Swap(), searchableCone::unitDir_, x, and y.

Here is the call graph for this function:

◆ insertHit()

void insertHit	(	const point &	start,
		const point &	end,
		List< pointIndexHit > &	info,
		const pointIndexHit &	hit
	)		const

private

Insert a hit if it differs (by a tolerance) from the existing ones.

Definition at line 612 of file searchableCone.C.

References forAll, PointIndexHit< Point >::hitPoint(), Foam::magSqr(), List::setSize(), and List::size().

Here is the call graph for this function:

◆ calcBounds()

Foam::boundBox calcBounds ( ) const

private

Return the boundBox of the cylinder.

Definition at line 652 of file searchableCone.C.

References Foam::max(), Foam::min(), Foam::sqr(), and Foam::sqrt().

Here is the call graph for this function:

◆ operator=()

void operator= ( const searchableCone & )

private

Disallow default bitwise assignment.

◆ TypeName()

TypeName ( "searchableCone" )

Runtime type information.

◆ regions()

const Foam::wordList & regions ( ) const

virtual

Names of regions.

Implements searchableSurface.

Definition at line 761 of file searchableCone.C.

References List::setSize().

Here is the call graph for this function:

◆ hasVolumeType()

virtual bool hasVolumeType ( ) const

inlinevirtual

Whether supports volume type below.

Implements searchableSurface.

Definition at line 217 of file searchableCone.H.

◆ size()

virtual label size ( ) const

inlinevirtual

Range of local indices that can be returned.

Implements searchableSurface.

Definition at line 223 of file searchableCone.H.

◆ coordinates()

Foam::tmp< Foam::pointField > coordinates ( ) const

virtual

Get representative set of element coordinates.

Usually the element centres (should be of length size()).

Implements searchableSurface.

Definition at line 42 of file searchableCone.C.

References searchableCone::point1_, and searchableCone::point2_.

◆ boundingSpheres()

void boundingSpheres	(	pointField &	centres,
		scalarField &	radiusSqr
	)		const

virtual

Get bounding spheres (centre and radius squared), one per element.

Any point on element is guaranteed to be inside.

Implements searchableSurface.

Definition at line 51 of file searchableCone.C.

References Foam::magSqr(), and Foam::sqr().

Here is the call graph for this function:

◆ points()

Foam::tmp< Foam::pointField > points ( ) const

virtual

Get the points that define the surface.

Implements searchableSurface.

Definition at line 74 of file searchableCone.C.

◆ overlaps()

virtual bool overlaps ( const boundBox & bb ) const

inlinevirtual

Does any part of the surface overlap the supplied bound box?

Implements searchableSurface.

Definition at line 244 of file searchableCone.H.

References NotImplemented.

◆ findNearest()

void findNearest	(	const pointField &	sample,
		const scalarField &	nearestDistSqr,
		List< pointIndexHit > &	info
	)		const

virtual

Find nearest point on cylinder.

Implements searchableSurface.

Definition at line 773 of file searchableCone.C.

References forAll, samples(), and List::setSize().

Here is the call graph for this function:

◆ findLine()

void findLine	(	const pointField &	start,
		const pointField &	end,
		List< pointIndexHit > &	info
	)		const

virtual

Find nearest intersection on line from start to end.

Implements searchableSurface.

Definition at line 789 of file searchableCone.C.

References Foam::constant::physicoChemical::b, forAll, PointIndexHit< Point >::hit(), Foam::name(), IOobject::rename(), and List::setSize().

Here is the call graph for this function:

◆ findLineAll() [2/2]

void findLineAll	(	const pointField &	start,
		const pointField &	end,
		List< List< pointIndexHit > > &	info
	)		const

virtual

Find all intersections in order from start to end.

Implements searchableSurface.

Definition at line 939 of file searchableCone.C.

References List::clear(), forAll, PointIndexHit< Point >::hit(), Foam::name(), IOobject::rename(), and List::setSize().

Here is the call graph for this function:

◆ findLineAny()

void findLineAny	(	const pointField &	start,
		const pointField &	end,
		List< pointIndexHit > &	info
	)		const

virtual

Find any intersection on line from start to end.

Implements searchableSurface.

Definition at line 871 of file searchableCone.C.

References Foam::constant::physicoChemical::b, forAll, Foam::name(), IOobject::rename(), and List::setSize().

Here is the call graph for this function:

◆ getRegion()

void getRegion	(	const List< pointIndexHit > &	info,
		labelList &	region
	)		const

virtual

From a set of points and indices get the region.

Implements searchableSurface.

Definition at line 1033 of file searchableCone.C.

References List::setSize(), and List::size().

Here is the call graph for this function:

◆ getNormal()

void getNormal	(	const List< pointIndexHit > &	info,
		vectorField &	normal
	)		const

virtual

From a set of points and indices get the normal.

Implements searchableSurface.

Definition at line 1044 of file searchableCone.C.

References forAll, List::size(), Foam::sqr(), and Vector< scalar >::zero.

Here is the call graph for this function:

◆ getVolumeType()

void getVolumeType	(	const pointField &	points,
		List< volumeType > &	volType
	)		const

virtual

Determine type (inside/outside/mixed) for point. unknown if.

cannot be determined (e.g. non-manifold surface)

Implements searchableSurface.

Definition at line 1070 of file searchableCone.C.

References forAll, volumeType::INSIDE, Foam::mag(), volumeType::OUTSIDE, points, and List::setSize().

Here is the call graph for this function:

◆ writeData()

virtual bool writeData ( Ostream & ) const

inlinevirtual

Pure virtual writaData function.

Must be defined in derived types

Implements regIOobject.

Definition at line 310 of file searchableCone.H.

References NotImplemented.

Field Documentation

◆ point1_

const point point1_

private

'Left' point

Definition at line 104 of file searchableCone.H.

Referenced by searchableCone::coordinates(), searchableCone::findLineAll(), and searchableCone::radius2().

◆ radius1_

const scalar radius1_

private

Outer radius at point1.

Definition at line 107 of file searchableCone.H.

Referenced by searchableCone::findLineAll().

◆ innerRadius1_

const scalar innerRadius1_

private

Inner radius at point1.

Definition at line 110 of file searchableCone.H.

◆ point2_

const point point2_

private

'Right' point

Definition at line 114 of file searchableCone.H.

Referenced by searchableCone::coordinates(), and searchableCone::findLineAll().

◆ radius2_

const scalar radius2_

private

Outer radius at point2.

Definition at line 117 of file searchableCone.H.

Referenced by searchableCone::findLineAll().

◆ innerRadius2_

const scalar innerRadius2_

private

Inner radius at point2.

Definition at line 120 of file searchableCone.H.

◆ magDir_

const scalar magDir_

private

Length of vector point2-point1.

Definition at line 124 of file searchableCone.H.

Referenced by searchableCone::findLineAll().

◆ unitDir_

const vector unitDir_

private

Normalised vector point2-point1.

Definition at line 127 of file searchableCone.H.

Referenced by searchableCone::findLineAll(), and searchableCone::radius2().

◆ regions_

wordList regions_

mutableprivate

Names of regions.

Definition at line 131 of file searchableCone.H.

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

src/meshTools/searchableSurface/searchableCone.H
src/meshTools/searchableSurface/searchableCone.C

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ searchableCone() [1/3]

◆ searchableCone() [2/3]

◆ searchableCone() [3/3]

◆ ~searchableCone()

Member Function Documentation

◆ findNearestAndNormal()

◆ radius2()

◆ findLineAll() [1/2]

◆ insertHit()

◆ calcBounds()

◆ operator=()

◆ TypeName()

◆ regions()

◆ hasVolumeType()

◆ size()

◆ coordinates()

◆ boundingSpheres()

◆ points()

◆ overlaps()

◆ findNearest()

◆ findLine()

◆ findLineAll() [2/2]

◆ findLineAny()

◆ getRegion()

◆ getNormal()

◆ getVolumeType()

◆ writeData()

Field Documentation

◆ point1_

◆ radius1_

◆ innerRadius1_

◆ point2_

◆ radius2_

◆ innerRadius2_

◆ magDir_

◆ unitDir_

◆ regions_