Classes | Public Member Functions | Static Public Member Functions | List of all members
searchableSurface Class Referenceabstract

Base class of (analytical or triangulated) surface. Encapsulates all the search routines. WIP. More...

Inheritance diagram for searchableSurface:
Inheritance graph
[legend]
Collaboration diagram for searchableSurface:
Collaboration graph
[legend]

Classes

class  iNew
 Class used for the read-construction of. More...
 

Public Member Functions

 TypeName ("searchableSurface")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, searchableSurface, dict,( const IOobject &io, const dictionary &dict ),(io, dict))
 
 searchableSurface (const IOobject &io)
 
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 const wordListregions () const =0
 Names of regions. More...
 
virtual bool hasVolumeType () const =0
 Whether supports volume type below. 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< pointFieldcoordinates () 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< pointFieldpoints () 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. unknown if. 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...
 
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...
 
IstreamreadStream (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...
 
labelwatchIndex ()
 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 writeData (Ostream &) const =0
 Pure virtual writaData function. 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...
 
Foam::autoPtr< IOobjectclone () const
 Clone. 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...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () 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
 
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...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () 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< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 

Static Public Member Functions

static autoPtr< searchableSurfaceNew (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...
 

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 Attributes inherited from regIOobject
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static int fileModificationSkew
 
static fileCheckTypes fileModificationChecking
 
- Protected Member Functions inherited from IOobject
IstreamobjectStream ()
 Construct and return an IFstream for the object. More...
 
IstreamobjectStream (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

Base class of (analytical or triangulated) surface. Encapsulates all the search routines. WIP.

Information returned is usually a pointIndexHit:

Source files

Definition at line 66 of file searchableSurface.H.

Constructor & Destructor Documentation

searchableSurface ( const IOobject io)

Definition at line 68 of file searchableSurface.C.

~searchableSurface ( )
virtual

Destructor.

Definition at line 76 of file searchableSurface.C.

References searchableSurface::findNearest().

Referenced by searchableSurface::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

TypeName ( "searchableSurface"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
searchableSurface  ,
dict  ,
( const IOobject &io, const dictionary &dict ,
(io, dict  
)
virtual autoPtr<searchableSurface> clone ( ) const
inlinevirtual

Clone.

Definition at line 137 of file searchableSurface.H.

References searchableSurface::New(), notImplemented, and searchableSurface::~searchableSurface().

Here is the call graph for this function:

Foam::autoPtr< Foam::searchableSurface > New ( const word surfaceType,
const IOobject io,
const dictionary dict 
)
static

Return a reference to the selected searchableSurface.

Definition at line 40 of file searchableSurface.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, and FatalErrorIn.

Referenced by searchableSurface::clone(), searchableSurface::iNew::operator()(), searchableSurfaces::searchableSurfaces(), regionCoupledBase::surfPtr(), cyclicAMIPolyPatch::surfPtr(), and mappedPatchBase::surfPtr().

Here is the call graph for this function:

Here is the caller graph for this function:

const boundBox& bounds ( ) const
inline
boundBox& bounds ( )
inline

Return non-const access to the boundBox to allow it to be set.

Definition at line 168 of file searchableSurface.H.

References searchableSurface::hasVolumeType(), searchableSurface::regions(), and searchableSurface::size().

Here is the call graph for this function:

virtual const wordList& regions ( ) const
pure virtual
virtual bool hasVolumeType ( ) const
pure virtual
virtual label size ( ) const
pure virtual
virtual label globalSize ( ) const
inlinevirtual

Range of global indices that can be returned.

Reimplemented in distributedTriSurfaceMesh.

Definition at line 183 of file searchableSurface.H.

References searchableSurface::boundingSpheres(), searchableSurface::coordinates(), searchableSurface::findNearest(), searchableSurface::overlaps(), searchableSurface::points(), and searchableSurface::size().

Referenced by refinementSurfaces::setMinLevelFields(), and searchableSurfaces::writeStats().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual tmp<pointField> coordinates ( ) const
pure virtual

Get representative set of element coordinates.

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

Implemented in triSurfaceMesh, searchableSurfaceCollection, searchableCylinder, searchableSurfaceWithGaps, searchablePlate, searchableDisk, searchableSphere, searchableBox, and searchablePlane.

Referenced by searchableSurface::globalSize(), and searchableSurfaceWithGaps::size().

Here is the caller graph for this function:

virtual void boundingSpheres ( pointField centres,
scalarField radiusSqr 
) const
pure virtual

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

Any point on element is guaranteed to be inside.

Implemented in triSurfaceMesh, searchableSurfaceCollection, searchableCylinder, searchableSurfaceWithGaps, searchablePlate, searchableDisk, searchableSphere, searchableBox, and searchablePlane.

Referenced by searchableSurfaceWithGaps::boundingSpheres(), searchableSurface::globalSize(), and refinementSurfaces::setMinLevelFields().

Here is the caller graph for this function:

virtual tmp<pointField> points ( ) const
pure virtual
virtual bool overlaps ( const boundBox bb) const
pure virtual

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

Implemented in triSurfaceMesh, searchableSurfaceCollection, searchableSurfaceWithGaps, searchableCylinder, searchableDisk, searchablePlate, searchableSphere, searchablePlane, and searchableBox.

Referenced by searchableSurface::globalSize(), and searchableSurfaceWithGaps::points().

Here is the caller graph for this function:

virtual void findNearest ( const pointField sample,
const scalarField nearestDistSqr,
List< pointIndexHit > &   
) const
pure virtual
virtual void findNearest ( const pointField samples,
const scalarField nearestDistSqr,
const labelList regionIndices,
List< pointIndexHit > &  info 
) const
inlinevirtual

Find the nearest locations for the supplied points to a.

particular region in the searchable surface.

Reimplemented in triSurfaceMesh.

Definition at line 273 of file searchableSurface.H.

References searchableSurface::distribute(), searchableSurface::findLine(), searchableSurface::findLineAll(), searchableSurface::findLineAny(), searchableSurface::findNearest(), searchableSurface::getNormal(), searchableSurface::getRegion(), and searchableSurface::getVolumeType().

Here is the call graph for this function:

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

Find first intersection on segment from start to end.

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

Implemented in distributedTriSurfaceMesh, triSurfaceMesh, searchableBox, searchableSurfaceCollection, searchableSurfaceWithGaps, searchableCylinder, searchableDisk, searchablePlate, searchableSphere, and searchablePlane.

Referenced by searchableSurface::findNearest(), and refinementSurfaces::findNearestIntersection().

Here is the caller graph for this function:

virtual void findLineAny ( const pointField start,
const pointField end,
List< pointIndexHit > &   
) const
pure virtual
virtual void findLineAll ( const pointField start,
const pointField end,
List< List< pointIndexHit > > &   
) const
pure virtual
virtual void getRegion ( const List< pointIndexHit > &  ,
labelList region 
) const
pure virtual
virtual void getNormal ( const List< pointIndexHit > &  ,
vectorField normal 
) const
pure virtual
virtual void getVolumeType ( const pointField ,
List< volumeType > &   
) const
pure virtual

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

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

Implemented in distributedTriSurfaceMesh, triSurfaceMesh, searchableBox, searchableSurfaceCollection, searchableSurfaceWithGaps, searchableCylinder, searchableDisk, searchablePlate, searchableSphere, and searchablePlane.

Referenced by refinementSurfaces::findInside(), searchableSurface::findNearest(), and searchableSurfaceWithGaps::getVolumeType().

Here is the caller graph for this function:

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

Find nearest, normal and region. Can be overridden with.

optimised implementation

Definition at line 83 of file searchableSurface.C.

References searchableSurface::findNearest(), searchableSurface::getNormal(), and searchableSurface::getRegion().

Here is the call graph for this function:

virtual void distribute ( const List< treeBoundBox > &  ,
const bool  keepNonLocal,
autoPtr< mapDistribute > &  faceMap,
autoPtr< mapDistribute > &  pointMap 
)
inlinevirtual

Set bounds of surface. Bounds currently set as list of.

bounding boxes. The bounds are hints to the surface as for the range of queries it can expect. faceMap/pointMap can be set if the surface has done any redistribution.

Reimplemented in distributedTriSurfaceMesh, and searchableSurfaceCollection.

Definition at line 350 of file searchableSurface.H.

Referenced by searchableSurface::findNearest().

Here is the caller graph for this function:

virtual void setField ( const labelList values)
inlinevirtual

WIP. Store element-wise field.

Reimplemented in searchableSurfaceWithGaps, searchableSurfaceCollection, and triSurfaceMesh.

Definition at line 359 of file searchableSurface.H.

References List< T >::clear(), and searchableSurface::getField().

Here is the call graph for this function:

virtual void getField ( const List< pointIndexHit > &  ,
labelList values 
) const
inlinevirtual

WIP. From a set of hits (points and.

indices) get the specified field. Misses do not get set. Return empty field if not supported.

Reimplemented in distributedTriSurfaceMesh, searchableSurfaceWithGaps, searchableSurfaceCollection, and triSurfaceMesh.

Definition at line 365 of file searchableSurface.H.

Referenced by refinementSurfaces::findHigherIntersection(), searchableSurfaceWithGaps::getField(), and searchableSurface::setField().

Here is the caller graph for this function:


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