Searching on bounding box. More...

Inheritance diagram for searchableBox:

Collaboration diagram for searchableBox:

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

	searchableBox (const IOobject &io, const treeBoundBox &bb)
	Construct from components. More...

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

virtual	~searchableBox ()=default
	Destructor. More...

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

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

virtual volumeType	outsideVolumeType () const
	What is type of points outside bounds. 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	findNearestOnEdge (const point &sample, const scalar nearestDistSqr) const
	Calculate nearest point on edge. 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 &points, List< volumeType > &volType) const
	Determine type (inside/outside) for points. More...

bool	writeData (Ostream &) const
	Pure virtual writeData 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 ()=default
	Destructor. More...

virtual bool	global () const
	Is object global. More...

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

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

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

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

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

virtual volumeType	outsideVolumeType () const =0
	If surface supports volume queries, what is type of points outside. More...

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

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

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

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

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

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

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

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	findLine (const pointField &start, const pointField &end, List< pointIndexHit > &) const =0
	Find first intersection on segment from start to end. More...

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

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

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

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

virtual void	getVolumeType (const pointField &, List< volumeType > &) const =0
	Determine type (inside/outside) for point. 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 &io, const bool isTimeObject=false)

	regIOobject (const regIOobject &rio)
	Copy construct. More...

	regIOobject (const regIOobject &rio, bool registerCopy)

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)

	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry, if not already registered. More...

bool	checkOut ()
	Remove all file watches and remove object from registry. More...

virtual void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	registered () const noexcept

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

bool	store ()

void	release (const bool unregister=false) noexcept
	Set object as not ownedByRegistry. More...

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

label &	eventNo () noexcept
	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 as up-to-date. More...

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

const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr. More...

dictionary &	getMetaData () noexcept
	Get or create meta-data. More...

void	removeMetaData ()
	Remove meta-data. More...

virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing) More...

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

bool	headerOk ()
	Read and check header info. Does not check the headerClassName. More...

Istream &	readStream (const word &, const bool valid=true)
	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...

virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched. More...

const labelList &	watchIndices () const noexcept
	Read access to file-monitoring handles. More...

labelList &	watchIndices () noexcept
	Write access to file-monitoring handles. More...

virtual bool	modified () const

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

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

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const
	Write using stream options. More...

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

virtual bool	global () const
	Is object global. More...

void	operator= (const IOobject &io)
	Copy assignment. More...

virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
	Write using given format, version and compression. More...

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch) More...

	IOobject (const IOobject &)=default
	Copy construct. More...

virtual	~IOobject ()=default
	Destructor. More...

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

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

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

	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name. More...

	IOobject (const IOobject &io, const word &name, const fileName &local)
	Copy construct, resetting name and local component. More...

	IOobject (const IOobject &io, readOption rOpt, writeOption wOpt)
	Copy construct, resetting read/write options. More...

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

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

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

const Time &	time () const
	Return Time associated with the objectRegistry. More...

const word &	name () const noexcept
	Return the object name. More...

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

word &	headerClassName () noexcept
	Return non-constant access to the class name read from header. More...

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

string &	note () noexcept
	Modifiable access to the optional note. More...

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

bool	registerObject () const noexcept
	Should object created with this IOobject be registered? More...

bool	registerObject (bool on) noexcept
	Change registration preference, return previous value. More...

bool	globalObject () const noexcept
	Is object same for all processors? More...

bool	globalObject (bool on) noexcept
	Change global-object status, return previous value. More...

unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header. More...

unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header. More...

bool	hasHeaderClass () const noexcept
	True if headerClassName() is non-empty (after reading) More...

template<class Type >
bool	isHeaderClass () const
	Check if headerClassName() equals Type::typeName. More...

template<class Type >
bool	isHeaderClassName () const
	Same as isHeaderClass() More...

virtual const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data (if any) or nullptr. More...

readOption	readOpt () const noexcept
	The read option. More...

readOption	readOpt (readOption opt) noexcept
	Change the read option, return previous value. More...

writeOption	writeOpt () const noexcept
	The write option. More...

writeOption	writeOpt (writeOption opt) noexcept
	Change the write option, return previous value. More...

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

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

const fileName &	rootPath () const
	Return the Time::rootPath() More...

const fileName &	caseName () const
	Return the Time::caseName() More...

const fileName &	instance () const noexcept
	Read access to instance path component. More...

fileName &	instance () noexcept
	Write access to instance path component. More...

const fileName &	local () const noexcept
	Read access to local path component. More...

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

fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local. More...

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

fileName	objectRelPath () const
	The object path relative to the root. More...

fileName	localFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches up if in parallel. More...

IOstreamOption	parseHeader (const dictionary &headerDict)

bool	readHeader (Istream &is)

bool	readHeader (dictionary &headerDict, Istream &is)

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (uses typeFilePath to find file) and check its info. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &os) const
	Write header with current type() More...

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

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const

bool	good () const noexcept
	Did last readHeader() succeed? More...

bool	bad () const noexcept
	Did last readHeader() fail? More...

InfoProxy< IOobject >	info () const
	Return info proxy, for printing information to a stream. More...

void	operator= (const IOobject &io)
	Copy assignment, copies all values (except the registry) More...

readOption &	readOpt () noexcept
	Access to the read option. More...

writeOption &	writeOpt () noexcept
	Access to the write option. More...

bool &	registerObject () noexcept
	Access to the register object option. More...

bool &	globalObject () noexcept
	Access to the global object option. More...

template<>
bool	isHeaderClass () const
	Specialization for `void` always returns true (no headerClassName check). More...

template<class StringType >
Foam::word	groupName (StringType base, const word &group)

Public Member Functions inherited from treeBoundBox
	treeBoundBox ()
	Construct without any points - an inverted bounding box. More...

	treeBoundBox (const boundBox &bb)
	Construct from a boundBox. More...

	treeBoundBox (const point &pt)
	Construct a bounding box containing a single initial point. More...

	treeBoundBox (const point &min, const point &max)
	Construct from components. More...

	treeBoundBox (const UList< point > &points)
	Construct as the bounding box of the given pointField. More...

	treeBoundBox (const UList< point > &points, const labelUList &indices)
	Construct as subset of points. More...

template<unsigned N>
	treeBoundBox (const UList< point > &points, const FixedList< label, N > &indices)
	Construct as subset of points. More...

	treeBoundBox (Istream &is)
	Construct from Istream. More...

scalar	typDim () const
	Typical dimension length,height,width. More...

tmp< pointField >	points () const
	Vertex coordinates. In octant coding. More...

point	corner (const direction octant) const
	Corner point of given octant. More...

treeBoundBox	subBbox (const direction octant) const
	Sub-box of given octant. Midpoint calculated. More...

treeBoundBox	subBbox (const point &mid, const direction) const
	Sub-box given by octant number. Midpoint provided. More...

direction	subOctant (const point &pt) const
	Returns octant number given point and the calculated midpoint. More...

direction	subOctant (const point &pt, bool &onEdge) const
	Returns octant number given point and the calculated midpoint. More...

void	searchOrder (const point &pt, FixedList< direction, 8 > &octantOrder) const
	Calculates optimal order to look for nearest to point. More...

bool	intersects (const point &overallStart, const vector &overallVec, const point &start, const point &end, point &pt, direction &ptBits) const
	Intersects segment; set point to intersection position and face,. More...

bool	intersects (const point &start, const point &end, point &pt) const
	Like above but does not return faces point is on. More...

bool	contains (const vector &dir, const point &) const
	Contains point (inside or on edge) and moving in direction. More...

direction	faceBits (const point &pt) const
	Code position of point on bounding box faces. More...

direction	posBits (const point &pt) const
	Position of point relative to bounding box. More...

void	calcExtremities (const point &pt, point &nearest, point &furthest) const
	Calculate nearest and furthest (to point) vertex coords of. More...

scalar	maxDist (const point &pt) const
	Returns distance point to furthest away corner. More...

label	distanceCmp (const point &pt, const treeBoundBox &other) const
	Compare distance to point with other bounding box. More...

treeBoundBox	extend (Random &rndGen, const scalar s) const
	Return slightly wider bounding box. More...

bool	overlaps (const boundBox &bb) const
	Overlaps other bounding box? More...

bool	overlaps (const point &centre, const scalar radiusSqr) const
	Overlaps other bounding box? More...

bool	contains (const point &pt) const
	Contains point or other bounding box? More...

bool	contains (const boundBox &bb) const
	Contains point or other bounding box? More...

bool	contains (const UList< point > &points) const
	Contains point or other bounding box? More...

template<unsigned N>
bool	contains (const UList< point > &points, const FixedList< label, N > &indices) const
	Contains point or other bounding box? More...

template<class IntContainer >
bool	contains (const UList< point > &points, const IntContainer &indices) const
	Contains point or other bounding box? More...

Public Member Functions inherited from boundBox
	boundBox ()
	Construct without any points - an inverted bounding box. More...

	boundBox (const point &pt)
	Construct a bounding box containing a single initial point. More...

	boundBox (const point &min, const point &max)
	Construct from components. More...

	boundBox (const UList< point > &points, bool doReduce=true)
	Construct as the bounding box of the given points. More...

	boundBox (const tmp< pointField > &tpoints, bool doReduce=true)
	Construct as the bounding box of the given temporary pointField. More...

	boundBox (const UList< point > &points, const labelUList &indices, bool doReduce=true)
	Construct bounding box as an indirect subset of the points. More...

template<unsigned N>
	boundBox (const UList< point > &points, const FixedList< label, N > &indices, bool doReduce=true)
	Construct bounding box as an indirect subset of the points. More...

	boundBox (Istream &is)
	Construct from Istream. More...

bool	empty () const
	Bounding box is inverted, contains no points. More...

bool	valid () const
	Bounding box is non-inverted. More...

const point &	min () const
	Minimum describing the bounding box. More...

const point &	max () const
	Maximum describing the bounding box. More...

point &	min ()
	Minimum describing the bounding box, non-const access. More...

point &	max ()
	Maximum describing the bounding box, non-const access. More...

point	centre () const
	The centre (midpoint) of the bounding box. More...

point	midpoint () const
	The midpoint (centre) of the bounding box. Identical to centre() More...

vector	span () const
	The bounding box span (from minimum to maximum) More...

scalar	mag () const
	The magnitude of the bounding box span. More...

scalar	volume () const
	The volume of the bound box. More...

scalar	minDim () const
	Smallest length/height/width dimension. More...

scalar	maxDim () const
	Largest length/height/width dimension. More...

scalar	avgDim () const
	Average length/height/width dimension. More...

label	nDim () const
	Count the number of positive, non-zero dimensions. More...

tmp< pointField >	points () const
	Corner points in an order corresponding to a 'hex' cell. More...

tmp< pointField >	faceCentres () const
	Face midpoints. More...

point	faceCentre (const direction facei) const
	Face centre of given face index. More...

void	clear ()
	Clear bounding box and make it an inverted box. More...

void	add (const boundBox &bb)
	Extend to include the second box. More...

void	add (const point &pt)
	Extend to include the point. More...

void	add (const UList< point > &points)
	Extend to include the points. More...

void	add (const tmp< pointField > &tpoints)
	Extend to include the points from the temporary point field. More...

template<unsigned N>
void	add (const FixedList< point, N > &points)
	Extend to include the points. More...

template<unsigned N>
void	add (const UList< point > &points, const FixedList< label, N > &indices)
	Extend to include a (subsetted) point field. More...

template<class IntContainer >
void	add (const UList< point > &points, const IntContainer &indices)
	Extend to include a (subsetted) point field. More...

void	inflate (const scalar s)
	Inflate box by factor*mag(span) in all dimensions. More...

void	reduce ()
	Parallel reduction of min/max values. More...

bool	intersect (const boundBox &bb)
	Intersection (union) with the second box. More...

bool	intersects (const plane &pln) const
	Does plane intersect this bounding box. More...

bool	overlaps (const boundBox &bb) const
	Overlaps/touches boundingBox? More...

bool	overlaps (const point &centre, const scalar radiusSqr) const
	Overlaps boundingSphere (centre + sqr(radius))? More...

bool	contains (const point &pt) const
	Contains point? (inside or on edge) More...

bool	contains (const boundBox &bb) const
	Fully contains other boundingBox? More...

bool	containsInside (const point &pt) const
	Contains point? (inside only) More...

bool	contains (const UList< point > &points) const
	Contains all points? (inside or on edge) More...

template<unsigned N>
bool	contains (const UList< point > &points, const FixedList< label, N > &indices) const
	Contains all of the (subsetted) points? (inside or on edge) More...

template<class IntContainer >
bool	contains (const UList< point > &points, const IntContainer &indices) const
	Contains all of the (subsetted) points? (inside or on edge) More...

bool	containsAny (const UList< point > &points) const
	Contains any of the points? (inside or on edge) More...

template<unsigned N>
bool	containsAny (const UList< point > &points, const FixedList< label, N > &indices) const
	Contains any of the (subsetted) points? (inside or on edge) More...

template<class IntContainer >
bool	containsAny (const UList< point > &points, const IntContainer &indices) const
	Contains any of the (subsetted) points? (inside or on edge) More...

point	nearest (const point &pt) const
	Return the nearest point on the boundBox to the supplied point. More...

void	operator+= (const boundBox &bb)
	Extend box to include the second box, as per the add() method. More...

Additional Inherited Members
Public Types inherited from IOobject
enum	readOption : char { NO_READ = 0 , MUST_READ = 1 , MUST_READ_IF_MODIFIED = 3 , READ_IF_PRESENT = 4 }
	Enumeration defining the read options. More...

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

enum	objectState : char { GOOD , BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	fileCheckTypes : char { timeStamp , timeStampMaster , inotify , inotifyMaster }
	Enumeration defining the file checking options. More...

Public Types inherited from treeBoundBox
enum	octantBit : direction { RIGHTHALF = 0x1 , TOPHALF = 0x2 , FRONTHALF = 0x4 }
	Bits used for octant/point encoding. More...

enum	faceId { LEFT = 0 , RIGHT = 1 , BOTTOM = 2 , TOP = 3 , BACK = 4 , FRONT = 5 }

enum	faceBit : direction { NOFACE = 0 , LEFTBIT = 0x1 << LEFT , RIGHTBIT = 0x1 << RIGHT , BOTTOMBIT = 0x1 << BOTTOM , TOPBIT = 0x1 << TOP , BACKBIT = 0x1 << BACK , FRONTBIT = 0x1 << FRONT }
	Bits used for face encoding. More...

enum	edgeId { E01 = 0 , E13 = 1 , E23 = 2 , E02 = 3 , E45 = 4 , E57 = 5 , E67 = 6 , E46 = 7 , E04 = 8 , E15 = 9 , E37 = 10 , E26 = 11 }
	Edges codes. More...

Public Types inherited from boundBox
enum	directionBit : direction { XDIR = 0x1 , YDIR = 0x2 , ZDIR = 0x4 }
	Bits used for (x/y/z) direction encoding. 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 *p)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner. More...

static bool	bannerEnabled (bool on) noexcept
	Enable/disable output file banner. More...

static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class StringType >
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string. More...

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

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

static word	scopedName (const std::string &scope, const word &name)
	Create scope:name or scope_name string. More...

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name. More...

static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider. More...

static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider. More...

Static Public Member Functions inherited from treeBoundBox
static direction	subOctant (const point &mid, const point &pt)
	Returns octant number given point and midpoint. More...

static direction	subOctant (const point &mid, const point &pt, bool &onEdge)
	Returns octant number given point and midpoint. More...

static direction	subOctant (const point &mid, const vector &dir, const point &pt, bool &onEdge)
	Returns octant number given intersection and midpoint. More...

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes. More...

static char	scopeSeparator
	Character for scoping object names (':' or '_') More...

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

static float	fileModificationSkew
	Time skew (seconds) for file modification checks. More...

static int	maxFileModificationPolls
	Max number of times to poll for file modification changes. More...

Static Public Attributes inherited from treeBoundBox
static const faceList	faces
	Face to point addressing. More...

static const edgeList	edges
	Edge to point addressing. More...

Static Public Attributes inherited from boundBox
static const boundBox	greatBox
	A large boundBox: min/max == -/+ ROOTVGREAT. More...

static const boundBox	invertedBox
	A large inverted boundBox: min/max == +/- ROOTVGREAT. More...

static const faceList	faces
	Faces to point addressing, as per a 'hex' cell. More...

static const FixedList< vector, 6 >	faceNormals
	The unit normal per face. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
	Helper: check readOpt flags and read if necessary. More...

Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad. More...

Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)

static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)

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

Detailed Description

Searching on bounding box.

Dictionary parameters

Property	Description	Required
`type`	box	selector
`min`	Minimum point for bounding box	yes
`max`	Maximum point for bounding box	yes
`span`	Box width	cond'l

Note: The order of precedence from the highest to the lowest is min-max or min-span pair; Longer type name : searchableBox

Source files

Definition at line 93 of file searchableBox.H.

Constructor & Destructor Documentation

◆ searchableBox() [1/2]

searchableBox	(	const IOobject &	io,
		const treeBoundBox &	bb
	)

Construct from components.

Definition at line 196 of file searchableBox.C.

References searchableSurface::bounds(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, and interfaceEntry::valid().

Here is the call graph for this function:

◆ searchableBox() [2/2]

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

Construct from dictionary (used by searchableSurface)

Definition at line 217 of file searchableBox.C.

References searchableSurface::bounds(), dict, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, Foam::readBoxDim(), and interfaceEntry::valid().

Here is the call graph for this function:

◆ ~searchableBox()

virtual ~searchableBox ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "searchableBox" )

Runtime type information.

◆ regions()

const Foam::wordList & regions ( ) const

virtual

Names of regions.

Implements searchableSurface.

Definition at line 242 of file searchableBox.C.

References List< T >::resize().

Here is the call graph for this function:

◆ hasVolumeType()

virtual bool hasVolumeType ( ) const

inlinevirtual

Whether surface supports volume type (below)

Reimplemented from searchableSurface.

Definition at line 161 of file searchableBox.H.

◆ outsideVolumeType()

virtual volumeType outsideVolumeType ( ) const

inlinevirtual

What is type of points outside bounds.

Implements searchableSurface.

Definition at line 166 of file searchableBox.H.

References volumeType::OUTSIDE.

◆ size()

virtual label size ( ) const

inlinevirtual

Range of local indices that can be returned.

Implements searchableSurface.

Definition at line 172 of file searchableBox.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 253 of file searchableBox.C.

References treeBoundBox::faces, forAll, Time::New(), and treeBoundBox::points().

Here is the call graph for this function:

◆ 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 270 of file searchableBox.C.

References f(), treeBoundBox::faces, forAll, Foam::magSqr(), Foam::max(), treeBoundBox::points(), List< T >::setSize(), Foam::sqr(), and Foam::Zero.

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 305 of file searchableBox.C.

References treeBoundBox::points().

Referenced by searchableRotatedBox::searchableRotatedBox().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 193 of file searchableBox.H.

References PDRparams::overlaps.

◆ findNearest() [1/3]

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 311 of file searchableBox.C.

◆ findNearestOnEdge()

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

Calculate nearest point on edge.

Returns

bool : any point found nearer than nearestDistSqr
label: relevant index in surface(=?)
point: actual nearest point found

Definition at line 321 of file searchableBox.C.

References Foam::cmptMag(), SortableList< T >::indices(), Foam::magSqr(), Foam::max(), Foam::min(), pTraits< bool >::nComponents, PointIndexHit< PointType >::rawPoint(), PointIndexHit< PointType >::setIndex(), PointIndexHit< PointType >::setMiss(), and SortableList< T >::sort().

Here is the call graph for this function:

◆ findNearest() [2/3]

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 391 of file searchableBox.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 403 of file searchableBox.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, PointIndexHit< PointType >::index(), Foam::max(), Foam::min(), pTraits< bool >::nComponents, PointIndexHit< PointType >::rawPoint(), PointIndexHit< PointType >::setHit(), and PointIndexHit< PointType >::setIndex().

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 466 of file searchableBox.C.

◆ findNearest() [3/3]

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

virtual

Implements searchableSurface.

Definition at line 476 of file searchableBox.C.

References forAll, samples(), List< T >::setSize(), and UList< T >::size().

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 494 of file searchableBox.C.

References forAll, List< T >::setSize(), and UList< T >::size().

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 510 of file searchableBox.C.

References forAll, List< T >::setSize(), and UList< T >::size().

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 526 of file searchableBox.C.

References DynamicList< T, SizeMin >::append(), DynamicList< T, SizeMin >::clear(), forAll, PointIndexHit< PointType >::hit(), PointIndexHit< PointType >::hitPoint(), PointIndexHit< PointType >::index(), UList< T >::last(), Foam::magSqr(), UList< T >::size(), and List< T >::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 593 of file searchableBox.C.

References List< T >::setSize(), and UList< T >::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 604 of file searchableBox.C.

References boundBox::faceNormals, forAll, List< T >::setSize(), UList< T >::size(), and Foam::Zero.

Here is the call graph for this function:

◆ getVolumeType()

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

virtual

Determine type (inside/outside) for points.

Implements searchableSurface.

Definition at line 627 of file searchableBox.C.

References forAll, volumeType::INSIDE, Foam::max(), Foam::min(), pTraits< bool >::nComponents, volumeType::OUTSIDE, points, List< T >::setSize(), and UList< T >::size().

Here is the call graph for this function:

◆ writeData()

bool writeData ( Ostream & ) const

inlinevirtual

Pure virtual writeData function.

Must be defined in derived types

Implements regIOobject.

Definition at line 307 of file searchableBox.H.

References NotImplemented.

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

src/meshTools/searchableSurfaces/searchableBox/searchableBox.H
src/meshTools/searchableSurfaces/searchableBox/searchableBox.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ searchableBox() [1/2]

◆ searchableBox() [2/2]

◆ ~searchableBox()

Member Function Documentation

◆ TypeName()

◆ regions()

◆ hasVolumeType()

◆ outsideVolumeType()

◆ size()

◆ coordinates()

◆ boundingSpheres()

◆ points()

◆ overlaps()

◆ findNearest() [1/3]

◆ findNearestOnEdge()

◆ findNearest() [2/3]

◆ findLine() [1/2]

◆ findLineAny() [1/2]

◆ findNearest() [3/3]

◆ findLine() [2/2]

◆ findLineAny() [2/2]

◆ findLineAll()

◆ getRegion()

◆ getNormal()

◆ getVolumeType()

◆ writeData()