Searching on a rotated box. More...

Inheritance diagram for searchableRotatedBox:

Collaboration diagram for searchableRotatedBox:

[legend]

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

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

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

pointIndexHit	findNearest (const point &sample, const scalar nearestDistSqr) const
	Calculate nearest point on surface. More...

pointIndexHit	findNearest (const linePointRef &ln, treeBoundBox &tightest, point &linePoint) const
	Find nearest to segment. More...

pointIndexHit	findLine (const point &start, const point &end) const
	Find nearest intersection of line between start and end. More...

pointIndexHit	findLineAny (const point &start, const point &end) const
	Find any intersection of line between start and end. More...

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

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

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

virtual void	findLineAll (const pointField &start, const pointField &end, List< List< pointIndexHit > > &) const
	Get all intersections in order 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...

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

virtual void	findNearest (const pointField &sample, const scalarField &nearestDistSqr, List< pointIndexHit > &) const=0
	Inherit findNearest from searchableSurface. More...

virtual void	findNearest (const pointField &samples, const scalarField &nearestDistSqr, const labelList &regionIndices, List< pointIndexHit > &info) const
	Inherit findNearest from searchableSurface. More...

virtual void	findNearest (const pointField &sample, const scalarField &nearestDistSqr, List< pointIndexHit > &, vectorField &normal, labelList &region) const
	Inherit findNearest from searchableSurface. 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
	searchableRotatedBox (const searchableRotatedBox &)
	Disallow default bitwise copy construct. More...

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

Private Attributes
searchableBox	box_
	box in local coordinate system More...

coordinateSystem	transform_
	transformation from local to global coordinates More...

pointField	points_
	(global) corner points (in treeBoundBox order) 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 a rotated box.

Box defined as min and max coordinate. Rotation by coordinate system at box middle.

E.g. box with sides 1 1 1 rotated 45 degrees around z-axis at origin (0.5 0.5 0.5)

    span     (1 1 1);
    origin  (0.5 0.5 0.5);
    e1      (1 1 0);
    e3      (0 0 1);

Source files

Definition at line 62 of file searchableRotatedBox.H.

Constructor & Destructor Documentation

◆ searchableRotatedBox() [1/2]

searchableRotatedBox ( const searchableRotatedBox & )

private

Disallow default bitwise copy construct.

◆ searchableRotatedBox() [2/2]

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

Construct from dictionary (used by searchableSurface)

Definition at line 42 of file searchableRotatedBox.C.

◆ ~searchableRotatedBox()

~searchableRotatedBox ( )

virtual

Destructor.

Definition at line 76 of file searchableRotatedBox.C.

Member Function Documentation

◆ operator=()

void operator= ( const searchableRotatedBox & )

private

Disallow default bitwise assignment.

◆ TypeName()

TypeName ( "searchableRotatedBox" )

Runtime type information.

◆ regions()

const Foam::wordList & regions ( ) const

virtual

Names of regions.

Implements searchableSurface.

Definition at line 82 of file searchableRotatedBox.C.

◆ hasVolumeType()

virtual bool hasVolumeType ( ) const

inlinevirtual

Whether supports volume type below.

Implements searchableSurface.

Definition at line 114 of file searchableRotatedBox.H.

◆ size()

virtual label size ( ) const

inlinevirtual

Range of local indices that can be returned.

Implements searchableSurface.

Definition at line 120 of file searchableRotatedBox.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 88 of file searchableRotatedBox.C.

◆ 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 95 of file searchableRotatedBox.C.

◆ points()

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

virtual

Get the points that define the surface.

Implements searchableSurface.

Definition at line 105 of file searchableRotatedBox.C.

◆ overlaps()

bool overlaps ( const boundBox & bb ) const

virtual

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

Implements searchableSurface.

Definition at line 111 of file searchableRotatedBox.C.

References boundBox::containsAny(), PointHit::distance(), Foam::e, treeBoundBox::edges, f(), treeBoundBox::faces, forAll, intersection::HALF_RAY, PointHit::hit(), treeBoundBox::intersects(), boundBox::overlaps(), and boundBox::points().

Here is the call graph for this function:

◆ findNearest() [1/6]

Foam::pointIndexHit findNearest	(	const point &	sample,
		const scalar	nearestDistSqr
	)		const

Calculate nearest point on surface.

Returns

bool : any point found nearer than nearestDistSqr
label: relevant index in surface (=face 0..5)
point: actual nearest point found

Definition at line 183 of file searchableRotatedBox.C.

References PointIndexHit< Point >::rawPoint().

Here is the call graph for this function:

◆ findNearest() [2/6]

Foam::pointIndexHit findNearest	(	const linePointRef &	ln,
		treeBoundBox &	tightest,
		point &	linePoint
	)		const

Find nearest to segment.

Returns

bool : any point found?
label: relevant index in shapes (=face 0..5)
point: actual nearest point found sets:
tightest : bounding box
linePoint : corresponding nearest point on line

Definition at line 204 of file searchableRotatedBox.C.

References NotImplemented.

◆ findLine() [1/2]

Foam::pointIndexHit findLine	(	const point &	start,
		const point &	end
	)		const

Find nearest intersection of line between start and end.

Definition at line 216 of file searchableRotatedBox.C.

References PointIndexHit< Point >::rawPoint().

Here is the call graph for this function:

◆ findLineAny() [1/2]

Foam::pointIndexHit findLineAny	(	const point &	start,
		const point &	end
	)		const

Find any intersection of line between start and end.

Definition at line 237 of file searchableRotatedBox.C.

◆ findNearest() [3/6]

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

virtual

Implements searchableSurface.

Definition at line 247 of file searchableRotatedBox.C.

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

Here is the call graph for this function:

◆ findLine() [2/2]

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

virtual

Find first intersection on segment from start to end.

Note: searchableSurfacesQueries expects no intersection to be found if start==end. Is problem?

Implements searchableSurface.

Definition at line 263 of file searchableRotatedBox.C.

References forAll, and List::setSize().

Here is the call graph for this function:

◆ findLineAny() [2/2]

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

virtual

Return any intersection on segment from start to end.

Implements searchableSurface.

Definition at line 279 of file searchableRotatedBox.C.

References forAll, and List::setSize().

Here is the call graph for this function:

◆ findLineAll()

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

virtual

Get all intersections in order from start to end.

Implements searchableSurface.

Definition at line 295 of file searchableRotatedBox.C.

References DynamicList::append(), DynamicList::clear(), List::clear(), forAll, PointIndexHit< Point >::hit(), PointIndexHit< Point >::hitPoint(), PointIndexHit< Point >::index(), Foam::magSqr(), List::setSize(), Foam::sqrt(), and List::transfer().

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 363 of file searchableRotatedBox.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 374 of file searchableRotatedBox.C.

◆ 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 387 of file searchableRotatedBox.C.

References points.

◆ writeData()

bool writeData ( Ostream & ) const

inlinevirtual

Pure virtual writaData function.

Must be defined in derived types

Implements regIOobject.

Definition at line 245 of file searchableRotatedBox.H.

References NotImplemented.

◆ findNearest() [4/6]

virtual void findNearest

Inherit findNearest from searchableSurface.

◆ findNearest() [5/6]

virtual void findNearest

inline

Inherit findNearest from searchableSurface.

Definition at line 273 of file searchableSurface.H.

◆ findNearest() [6/6]

void findNearest

Inherit findNearest from searchableSurface.

Definition at line 80 of file searchableSurface.C.

Field Documentation

◆ box_

searchableBox box_

private

box in local coordinate system

Definition at line 71 of file searchableRotatedBox.H.

◆ transform_

coordinateSystem transform_

private

transformation from local to global coordinates

Definition at line 74 of file searchableRotatedBox.H.

◆ points_

pointField points_

private

(global) corner points (in treeBoundBox order)

Definition at line 77 of file searchableRotatedBox.H.

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

src/meshTools/searchableSurface/searchableRotatedBox.H
src/meshTools/searchableSurface/searchableRotatedBox.C

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ searchableRotatedBox() [1/2]

◆ searchableRotatedBox() [2/2]

◆ ~searchableRotatedBox()

Member Function Documentation

◆ operator=()

◆ TypeName()

◆ regions()

◆ hasVolumeType()

◆ size()

◆ coordinates()

◆ boundingSpheres()

◆ points()

◆ overlaps()

◆ findNearest() [1/6]

◆ findNearest() [2/6]

◆ findLine() [1/2]

◆ findLineAny() [1/2]

◆ findNearest() [3/6]

◆ findLine() [2/2]

◆ findLineAny() [2/2]

◆ findLineAll()

◆ getRegion()

◆ getNormal()

◆ getVolumeType()

◆ writeData()

◆ findNearest() [4/6]

◆ findNearest() [5/6]

◆ findNearest() [6/6]

Field Documentation

◆ box_

◆ transform_

◆ points_