searchableBox Class Reference

Surface geometry with a rectangular box shape, aligned with the coordinate axes, which can be used with snappyHexMesh. 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...
 
 searchableBox (const searchableBox &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~searchableBox ()
 Destructor. More...
 
virtual const wordListregions () 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< pointFieldcoordinates () 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< pointFieldpoints () 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 &, List< volumeType > &) const
 Determine type (inside/outside/mixed) for point. unknown if. More...
 
bool writeData (Ostream &) const
 Pure virtual writaData function. More...
 
void operator= (const searchableBox &)=delete
 Disallow default bitwise assignment. 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)
 
 searchableSurface (const searchableSurface &)=delete
 Disallow default bitwise copy construction. More...
 
virtual autoPtr< searchableSurfaceclone () const
 Clone. More...
 
virtual ~searchableSurface ()
 Destructor. More...
 
const boundBoxbounds () const
 Return const reference to boundBox. More...
 
boundBoxbounds ()
 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< distributionMap > &faceMap, autoPtr< distributionMap > &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...
 
void operator= (const searchableSurface &)=delete
 Disallow default bitwise assignment. 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 &)
 Copy constructor. More...
 
 regIOobject (const regIOobject &&)
 Move constructor. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Copy constructor, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Copy constructor with new name, transferring registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Copy constructor with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
virtual bool global () const
 Return true if object is global, i.e. same for all processors. More...
 
virtual bool globalFile () const
 Return true if object is global, i.e. same for all processors. More...
 
const fileNamecaseName () const
 
fileName path () const
 Return complete path. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool registered () const
 Is this object registered with the 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...
 
labeleventNo ()
 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...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool read=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...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. 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 bool write) const
 Write using given format, version and compression. More...
 
virtual bool write (const bool write=true) 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 objectRegistry &registry)
 Construct from copy resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct from copy resetting name. More...
 
 IOobject (const IOobject &io)=default
 Copy constructor. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
boolregisterObject ()
 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
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
word modelName (const char *name) const
 Return the name of the object within this model. More...
 
const fileNamerootPath () const
 
const fileNamecaseName (const bool global) const
 
fileNameinstance () const
 Return the instance directory, constant, system, <time> etc. More...
 
void updateInstance () const
 If the instance is a time directory update to the current time. More...
 
const fileNamelocal () const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName relativePath () const
 Return the path relative to the case directory. More...
 
fileName relativeObjectPath () const
 Return complete relativePath + object name. More...
 
fileName filePath (const word &typeName, const bool global) const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read header of local object without type-checking. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. 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< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
template<class Name >
Foam::word modelName (Name name, const word &model)
 
- Public Member Functions inherited from treeBoundBox
 treeBoundBox ()
 Construct null setting points to zero. More...
 
 treeBoundBox (const boundBox &bb)
 Construct from a boundBox. More...
 
 treeBoundBox (const point &min, const point &max)
 Construct from components. More...
 
 treeBoundBox (const UList< point > &)
 Construct as the bounding box of the given pointField. More...
 
 treeBoundBox (const UList< point > &, const labelUList &indices)
 Construct as subset of points. More...
 
template<unsigned Size>
 treeBoundBox (const UList< point > &, const FixedList< label, Size > &indices)
 Construct as subset of points. More...
 
 treeBoundBox (Istream &)
 Construct from Istream. More...
 
scalar typDim () const
 Typical dimension length,height,width. More...
 
tmp< pointFieldpoints () const
 Vertex coordinates. In octant coding. More...
 
point corner (const direction) const
 Corner point given octant. More...
 
treeBoundBox subBbox (const direction) const
 Sub box given by octant number. 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 &) const
 Code position of point on bounding box faces. More...
 
direction posBits (const point &) 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 &) const
 Returns distance point to furthest away corner. More...
 
label distanceCmp (const point &, const treeBoundBox &other) const
 Compare distance to point with other bounding box. More...
 
treeBoundBox extend (const scalar s) const
 Return asymetrically extended bounding box, with guaranteed. More...
 
void writeOBJ (const fileName &fName) const
 
- Public Member Functions inherited from boundBox
 boundBox ()
 Construct null, setting points to zero. More...
 
 boundBox (const point &min, const point &max)
 Construct from components. More...
 
 boundBox (const UList< point > &, const bool doReduce=true)
 Construct as the bounding box of the given points. More...
 
 boundBox (const tmp< pointField > &, const bool doReduce=true)
 Construct as the bounding box of the given temporary pointField. More...
 
 boundBox (const UList< point > &, const labelUList &indices, const bool doReduce=true)
 Construct bounding box as subset of the pointField. More...
 
template<unsigned Size>
 boundBox (const UList< point > &, const FixedList< label, Size > &indices, const bool doReduce=true)
 Construct bounding box as subset of the pointField. More...
 
 boundBox (Istream &)
 Construct from Istream. More...
 
const pointmin () const
 Minimum point defining the bounding box. More...
 
const pointmax () const
 Maximum point defining the bounding box. More...
 
pointmin ()
 Minimum point defining the bounding box, non-const access. More...
 
pointmax ()
 Maximum point defining the bounding box, non-const access. More...
 
point midpoint () const
 The midpoint of the bounding box. 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...
 
tmp< pointFieldpoints () const
 Return corner points in an order corresponding to a 'hex' cell. More...
 
void inflate (const scalar s)
 Inflate box by factor*mag(span) in all dimensions. More...
 
bool overlaps (const boundBox &) const
 Overlaps/touches boundingBox? More...
 
bool overlaps (const point &, const scalar radiusSqr) const
 Overlaps boundingSphere (centre + sqr(radius))? More...
 
bool contains (const point &) const
 Contains point? (inside or on edge) More...
 
bool contains (const boundBox &) const
 Fully contains other boundingBox? More...
 
bool containsInside (const point &) const
 Contains point? (inside only) More...
 
bool contains (const UList< point > &) const
 Contains all of the points? (inside or on edge) More...
 
bool contains (const UList< point > &, const labelUList &indices) const
 Contains all of the points? (inside or on edge) More...
 
template<unsigned Size>
bool contains (const UList< point > &, const FixedList< label, Size > &indices) const
 Contains all of the points? (inside or on edge) More...
 
bool containsAny (const UList< point > &) const
 Contains any of the points? (inside or on edge) More...
 
bool containsAny (const UList< point > &, const labelUList &indices) const
 Contains any of the points? (inside or on edge) More...
 
template<unsigned Size>
bool containsAny (const UList< point > &, const FixedList< label, Size > &indices) const
 Contains any of the points? (inside or on edge) More...
 
point nearest (const point &) const
 Return the nearest point on the boundBox to the supplied point. More...
 

Additional Inherited Members

- 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...
 
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Static Public Member Functions inherited from searchableSurface
static autoPtr< searchableSurfaceNew (const word &surfaceType, const IOobject &io, const dictionary &dict)
 Return a reference to the selected searchableSurface. More...
 
static const wordgeometryDir ()
 Return the geometry directory name. More...
 
static const wordgeometryDir (const Time &time)
 Check that the geometry directory exists and return. 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)
 
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...
 
template<class Name >
static word modelName (Name name, const word &model)
 Return the name of the object within the given model. More...
 
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 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 Member Functions inherited from boundBox
static faceList faces ()
 Return faces with correct point order. More...
 
- Static Public Attributes inherited from searchableSurface
static word geometryDir_
 Name of the directory for the geometry files. More...
 
- Static Public Attributes inherited from regIOobject
static float fileModificationSkew
 
- Static Public Attributes inherited from IOobject
static constexpr const char * foamFile = "FoamFile"
 Keyword for the FoamFile header sub-dictionary. More...
 
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
- Static Public Attributes inherited from treeBoundBox
static const scalar great
 The great value used for greatBox and invertedBox. More...
 
static const treeBoundBox greatBox
 As per boundBox::greatBox, but with great instead of vGreat. More...
 
static const treeBoundBox invertedBox
 As per boundBox::invertedBox, but with great instead of vGreat. More...
 
static const faceList faces
 Face to point addressing. More...
 
static const edgeList edges
 Edge to point addressing. More...
 
static const FixedList< vector, 6 > faceNormals
 Per face the unit normal. More...
 
- Static Public Attributes inherited from boundBox
static const scalar great
 The great value used for greatBox and invertedBox. More...
 
static const boundBox greatBox
 A very large boundBox: min/max == -/+ vGreat. More...
 
static const boundBox invertedBox
 A very large inverted boundBox: min/max == +/- vGreat. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
 Read header, check readOpt flags and read data if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &)
 Set the object state to bad. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType)
 Read header using typeGlobalFile to find file. More...
 

Detailed Description

Surface geometry with a rectangular box shape, aligned with the coordinate axes, which can be used with snappyHexMesh.

Usage
Property Description Required
min Minimum point of bounding box yes
max Maximum point of bounding box yes

Example specification in snappyHexMeshDict/geometry:

        type       searchableBox;
        min        (0  0  0);
        max        (10 10 10);
Source files

Definition at line 78 of file searchableBox.H.

Constructor & Destructor Documentation

◆ searchableBox() [1/3]

searchableBox ( const IOobject io,
const treeBoundBox bb 
)

Construct from components.

Definition at line 165 of file searchableBox.C.

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

Here is the call graph for this function:

◆ searchableBox() [2/3]

searchableBox ( const IOobject io,
const dictionary dict 
)

Construct from dictionary (used by searchableSurface)

Definition at line 185 of file searchableBox.C.

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

Here is the call graph for this function:

◆ searchableBox() [3/3]

searchableBox ( const searchableBox )
delete

Disallow default bitwise copy construction.

◆ ~searchableBox()

~searchableBox ( )
virtual

Destructor.

Definition at line 206 of file searchableBox.C.

Member Function Documentation

◆ TypeName()

TypeName ( "searchableBox"  )

Runtime type information.

◆ regions()

const Foam::wordList & regions ( ) const
virtual

Names of regions.

Implements searchableSurface.

Definition at line 212 of file searchableBox.C.

References List< T >::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 141 of file searchableBox.H.

◆ size()

virtual label size ( ) const
inlinevirtual

Range of local indices that can be returned.

Implements searchableSurface.

Definition at line 147 of file searchableBox.H.

References searchableBox::boundingSpheres(), searchableBox::coordinates(), and searchableBox::points().

Here is the call graph for this function:

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

References searchableBox::boundingSpheres(), boundBox::faces(), forAll, treeBoundBox::points(), and tmp< T >::ref().

Referenced by searchableBox::size().

Here is the call graph for this function:
Here is the caller 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 241 of file searchableBox.C.

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

Referenced by searchableBox::coordinates(), and searchableBox::size().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ points()

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

Get the points that define the surface.

Implements searchableSurface.

Definition at line 275 of file searchableBox.C.

References treeBoundBox::points().

Referenced by searchableBox::size().

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

References searchableBox::findLine(), searchableBox::findLineAll(), searchableBox::findLineAny(), searchableBox::findNearestOnEdge(), searchableBox::getNormal(), searchableBox::getRegion(), searchableBox::getVolumeType(), Foam::ln(), and boundBox::overlaps().

Here is the call graph for this function:

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

References searchableBox::findNearestOnEdge().

Here is the call graph for this function:

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

References Foam::cmptMag(), SortableList< T >::indices(), Foam::magSqr(), Foam::max(), Foam::min(), VectorSpace< Vector< scalar >, scalar, 3 >::nComponents, PointIndexHit< Point >::rawPoint(), PointIndexHit< Point >::setIndex(), PointIndexHit< Point >::setMiss(), and SortableList< T >::sort().

Referenced by searchableBox::findNearest(), and searchableBox::overlaps().

Here is the call graph for this function:
Here is the caller 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 362 of file searchableBox.C.

References searchableBox::findLine(), and NotImplemented.

Here is the call graph for this function:

◆ findLine() [1/2]

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

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

Referenced by searchableBox::findLine(), and searchableBox::overlaps().

Here is the caller graph for this function:

◆ findNearest() [3/3]

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

Implements searchableSurface.

Definition at line 447 of file searchableBox.C.

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

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

References searchableBox::findLineAll(), forAll, List< T >::setSize(), and List< 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

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

References searchableBox::getNormal(), List< T >::setSize(), and List< T >::size().

Referenced by searchableBox::findLineAll(), and searchableBox::overlaps().

Here is the call graph for this function:
Here is the caller 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 576 of file searchableBox.C.

References treeBoundBox::faceNormals, forAll, searchableBox::getVolumeType(), List< T >::setSize(), List< T >::size(), and Foam::Zero.

Referenced by searchableBox::getRegion(), and searchableBox::overlaps().

Here is the call graph for this function:
Here is the caller 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 599 of file searchableBox.C.

References forAll, volumeType::inside, Foam::max(), Foam::min(), VectorSpace< Vector< scalar >, scalar, 3 >::nComponents, volumeType::outside, List< T >::setSize(), and List< T >::size().

Referenced by searchableBox::getNormal(), and searchableBox::overlaps().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream ) const
inlinevirtual

Pure virtual writaData function.

Must be defined in derived types

Implements regIOobject.

Definition at line 283 of file searchableBox.H.

References NotImplemented, and searchableBox::operator=().

Here is the call graph for this function:

◆ operator=()

void operator= ( const searchableBox )
delete

Disallow default bitwise assignment.

Referenced by searchableBox::writeData().

Here is the caller graph for this function:

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