Public Member Functions | List of all members
searchableSurfaceCollection Class Reference

Set of transformed searchableSurfaces. Does not do boolean operations. So when meshing might find parts 'inside'. More...

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

Public Member Functions

 TypeName ("searchableSurfaceCollection")
 Runtime type information. More...
 
 searchableSurfaceCollection (const IOobject &io, const dictionary &dict)
 Construct from dictionary (used by searchableSurface) More...
 
virtual ~searchableSurfaceCollection ()
 Destructor. More...
 
const vectorFieldscale () const
 Scaling vector per subsurface. More...
 
vectorFieldscale ()
 Scaling vector per subsurface. More...
 
const PtrList< coordinateSystem > & transform () const
 Coordinate system per subsurface. More...
 
PtrList< coordinateSystem > & transform ()
 Coordinate system per subsurface. 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...
 
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...
 
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 &) const
 WIP. From a set of hits (points and. More...
 
bool writeData (Ostream &) const
 Pure virtual writaData function. More...
 
- Public Member Functions inherited from searchableSurface
 TypeName ("searchableSurface")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, searchableSurface, dict,( const IOobject &io, const dictionary &dict ),(io, dict))
 
 searchableSurface (const IOobject &io)
 
virtual autoPtr< 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...
 
- 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 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)
 

Additional Inherited Members

- Public Types inherited from regIOobject
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Types of communications. More...
 
- Public Types inherited from IOobject
enum  objectState { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
- Static Public Member Functions inherited from searchableSurface
static autoPtr< 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...
 
- 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

Set of transformed searchableSurfaces. Does not do boolean operations. So when meshing might find parts 'inside'.

Source files

Definition at line 55 of file searchableSurfaceCollection.H.

Constructor & Destructor Documentation

searchableSurfaceCollection ( const IOobject io,
const dictionary dict 
)

Destructor.

Definition at line 283 of file searchableSurfaceCollection.C.

Member Function Documentation

TypeName ( "searchableSurfaceCollection"  )

Runtime type information.

const vectorField& scale ( ) const
inline

Scaling vector per subsurface.

Definition at line 142 of file searchableSurfaceCollection.H.

vectorField& scale ( )
inline

Scaling vector per subsurface.

Definition at line 148 of file searchableSurfaceCollection.H.

const PtrList<coordinateSystem>& transform ( ) const
inline

Coordinate system per subsurface.

Definition at line 154 of file searchableSurfaceCollection.H.

PtrList<coordinateSystem>& transform ( )
inline

Coordinate system per subsurface.

Definition at line 160 of file searchableSurfaceCollection.H.

References searchableSurfaceCollection::regions().

Here is the call graph for this function:

const Foam::wordList & regions ( ) const
virtual

Names of regions.

Implements searchableSurface.

Definition at line 289 of file searchableSurfaceCollection.C.

References DynamicList< T, SizeInc, SizeMult, SizeDiv >::append(), forAll, Foam::name(), List< T >::setSize(), DynamicList< T, SizeInc, SizeMult, SizeDiv >::shrink(), and List< T >::size().

Referenced by searchableSurfaceCollection::transform().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual bool hasVolumeType ( ) const
inlinevirtual

Whether supports volume type below.

Implements searchableSurface.

Definition at line 169 of file searchableSurfaceCollection.H.

References searchableSurfaceCollection::boundingSpheres(), searchableSurfaceCollection::coordinates(), searchableSurfaceCollection::points(), and searchableSurfaceCollection::size().

Here is the call graph for this function:

Foam::label size ( ) const
virtual

Range of local indices that can be returned.

Implements searchableSurface.

Definition at line 321 of file searchableSurfaceCollection.C.

Referenced by searchableSurfaceCollection::hasVolumeType().

Here is the caller graph for this function:

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 328 of file searchableSurfaceCollection.C.

References searchableSurfaceCollection::boundingSpheres(), Foam::cmptMultiply(), coordinates(), and forAll.

Referenced by searchableSurfaceCollection::hasVolumeType().

Here is the call graph for this function:

Here is the caller graph for this function:

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 358 of file searchableSurfaceCollection.C.

References Foam::cmptMax(), Foam::cmptMultiply(), forAll, List< T >::setSize(), and List< T >::size().

Referenced by searchableSurfaceCollection::coordinates(), and searchableSurfaceCollection::hasVolumeType().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Get the points that define the surface.

Implements searchableSurface.

Definition at line 395 of file searchableSurfaceCollection.C.

References Foam::cmptMultiply(), forAll, nPoints, and points.

Referenced by searchableSurfaceCollection::hasVolumeType().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual bool overlaps ( const boundBox bb) const
inlinevirtual
void findNearest ( const pointField sample,
const scalarField nearestDistSqr,
List< pointIndexHit > &  nearestInfo 
) const
virtual

Implements searchableSurface.

Definition at line 433 of file searchableSurfaceCollection.C.

References searchableSurfaceCollection::findLine().

Here is the call graph for this function:

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 454 of file searchableSurfaceCollection.C.

References Foam::abort(), Foam::cmptDivide(), Foam::cmptMultiply(), Foam::FatalError, FatalErrorIn, searchableSurfaceCollection::findLineAny(), forAll, Foam::mag(), n, s(), List< T >::setSize(), and List< T >::size().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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 553 of file searchableSurfaceCollection.C.

References searchableSurfaceCollection::findLineAll().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

References List< T >::clear(), forAll, searchableSurfaceCollection::getRegion(), List< T >::setSize(), and List< T >::size().

Referenced by searchableSurfaceCollection::findLineAny(), and searchableSurfaceCollection::overlaps().

Here is the call graph for this function:

Here is the caller graph for this function:

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 592 of file searchableSurfaceCollection.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

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 657 of file searchableSurfaceCollection.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

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 700 of file searchableSurfaceCollection.C.

References searchableSurfaceCollection::distribute(), Foam::exit(), Foam::FatalError, and FatalErrorIn.

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

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 from searchableSurface.

Definition at line 715 of file searchableSurfaceCollection.C.

References forAll.

Referenced by searchableSurfaceCollection::getVolumeType(), and searchableSurfaceCollection::overlaps().

Here is the caller graph for this function:

void setField ( const labelList values)
virtual

WIP. Store element-wise field.

Reimplemented from searchableSurface.

Definition at line 748 of file searchableSurfaceCollection.C.

References forAll, and searchableSurfaceCollection::getField().

Referenced by searchableSurfaceCollection::overlaps().

Here is the call graph for this function:

Here is the caller graph for this function:

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

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 from searchableSurface.

Definition at line 769 of file searchableSurfaceCollection.C.

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

Referenced by searchableSurfaceCollection::overlaps(), and searchableSurfaceCollection::setField().

Here is the call graph for this function:

Here is the caller graph for this function:

bool writeData ( Ostream ) const
inlinevirtual

Pure virtual writaData function.

Must be defined in derived types

Implements regIOobject.

Definition at line 281 of file searchableSurfaceCollection.H.

References notImplemented.


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