FreeFOAM The Cross-Platform CFD Toolkit
searchableCylinder Class Reference

Searching on cylinder. More...

#include <meshTools/searchableCylinder.H>


Detailed Description

+ Inheritance diagram for searchableCylinder:
+ Collaboration diagram for searchableCylinder:

List of all members.

Public Member Functions

 TypeName ("searchableCylinder")
 Runtime type information.
 searchableCylinder (const IOobject &io, const point &, const point &, const scalar radius)
 Construct from components.
 searchableCylinder (const IOobject &io, const dictionary &dict)
 Construct from dictionary (used by searchableSurface)
virtual ~searchableCylinder ()
virtual const wordListregions () const
 Names of regions.
virtual bool hasVolumeType () const
 Whether supports volume type below.
virtual label size () const
 Range of local indices that can be returned.
virtual pointField coordinates () const
 Get representative set of element coordinates.
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.
virtual void findLineAny (const pointField &start, const pointField &end, List< pointIndexHit > &) const
 Return any intersection on segment from start to end.
virtual void findLineAll (const pointField &start, const pointField &end, List< List< pointIndexHit > > &) const
 Get all intersections in order from start to end.
virtual void getRegion (const List< pointIndexHit > &, labelList &region) const
 From a set of points and indices get the region.
virtual void getNormal (const List< pointIndexHit > &, vectorField &normal) const
 From a set of points and indices get the normal.
virtual void getVolumeType (const pointField &, List< volumeType > &) const
 Determine type (inside/outside/mixed) for point. unknown if.
bool writeData (Ostream &) const
 Pure virtual writaData function.
- Public Member Functions inherited from searchableSurface
 TypeName ("searchableSurface")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, searchableSurface, dict,(const IOobject &io, const dictionary &dict),(io, dict))
 searchableSurface (const IOobject &io)
virtual autoPtr
< searchableSurface
clone () const
 Clone.
virtual ~searchableSurface ()
virtual label globalSize () const
 Range of global indices that can be returned.
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.
virtual void setField (const labelList &values)
 WIP. Store element-wise field.
virtual void getField (const List< pointIndexHit > &, labelList &values) const
 WIP. From a set of hits (points and.
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information.
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the.
 regIOobject (const regIOobject &)
 Construct as copy.
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, and transferring registry registration to copy.
virtual ~regIOobject ()
bool checkIn ()
 Add object to registry.
bool checkOut ()
 Remove object from registry.
bool ownedByRegistry () const
 Is this object owned by the registry?
void store ()
 Transfer ownership of this object to its registry.
void release ()
 Release ownership of this object from its registry.
label eventNo () const
 Event number at last update.
label & eventNo ()
 Event number at last update.
bool upToDate (const word &) const
 Am I uptodate with respect to other regIOobjects.
bool upToDate (const word &, const word &) const
bool upToDate (const word &, const word &, const word &) const
bool upToDate (const word &, const word &, const word &, const word &) const
void setUpToDate ()
 Flag me as up to date.
virtual void rename (const word &newName)
 Rename.
IstreamreadStream (const word &)
 Return Istream and check object type against that given.
void close ()
 Close Istream.
virtual bool readData (Istream &)
 Virtual readData function.
virtual bool read ()
 Read object.
virtual bool modified () const
 Return true if the object's file has been modified.
virtual bool readIfModified ()
 Read object if modified.
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
 Write using given format, version and compression.
virtual bool write () const
 Write using setting from DB.
void operator= (const IOobject &)
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information.
 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.
 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.
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options.
virtual ~IOobject ()
const Timetime () const
 Return time.
const objectRegistrydb () const
 Return the local objectRegistry.
const wordname () const
 Return name.
const wordheaderClassName () const
 Return name of the class name read from header.
stringnote ()
 Return non-constant access to the optional note.
const stringnote () const
 Return the optional note.
bool registerObject () const
 Register object created from this IOobject with registry if true.
readOption readOpt () const
readOptionreadOpt ()
writeOption writeOpt () const
writeOptionwriteOpt ()
const fileNamerootPath () const
const fileNamecaseName () const
const fileNameinstance () const
fileNameinstance ()
const fileNamelocal () const
fileName path () const
 Return complete path.
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local.
fileName objectPath () const
 Return complete path + object name.
fileName filePath () const
 Return complete path + object name if the file exists.
bool readHeader (Istream &)
 Read header.
bool headerOk ()
 Read and check header info.
bool writeHeader (Ostream &) const
 Write header.
bool good () const
bool bad () const
InfoProxy< IOobjectinfo () const
 Return info proxy.

Additional Inherited Members

- Public Types inherited from searchableSurface
enum  volumeType { UNKNOWN = 0, MIXED = 1, INSIDE = 2, OUTSIDE = 3 }
 volume types 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.
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry.
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry.
- 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.
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner.
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider.
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider.

Constructor & Destructor Documentation

searchableCylinder ( const IOobject io,
const point ,
const point ,
const scalar  radius 
)

Construct from components.

searchableCylinder ( const IOobject io,
const dictionary dict 
)

Construct from dictionary (used by searchableSurface)

Definition at line 420 of file searchableCylinder.C.

~searchableCylinder ( )
virtual

Definition at line 436 of file searchableCylinder.C.


Member Function Documentation

TypeName ( "searchableCylinder"  )

Runtime type information.

const Foam::wordList & regions ( ) const
virtual

Names of regions.

Implements searchableSurface.

Definition at line 442 of file searchableCylinder.C.

References List< T >::setSize().

virtual bool hasVolumeType ( ) const
inlinevirtual

Whether supports volume type below.

Implements searchableSurface.

Definition at line 141 of file searchableCylinder.H.

virtual label size ( ) const
inlinevirtual

Range of local indices that can be returned.

Implements searchableSurface.

Definition at line 147 of file searchableCylinder.H.

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 42 of file searchableCylinder.C.

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

Implements searchableSurface.

Definition at line 454 of file searchableCylinder.C.

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

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 470 of file searchableCylinder.C.

References b, forAll, PointIndexHit< Point >::hit(), List< T >::setSize(), and List< T >::size().

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 492 of file searchableCylinder.C.

References b, forAll, PointIndexHit< Point >::hit(), List< T >::setSize(), and List< T >::size().

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 514 of file searchableCylinder.C.

References List< T >::clear(), forAll, PointIndexHit< Point >::hit(), List< T >::setSize(), and List< T >::size().

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 558 of file searchableCylinder.C.

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

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 569 of file searchableCylinder.C.

References forAll, Foam::mag(), List< T >::setSize(), List< T >::size(), and Vector< scalar >::zero.

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 606 of file searchableCylinder.C.

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

bool writeData ( Ostream ) const
inlinevirtual

Pure virtual writaData function.

Must be defined in derived types

Implements regIOobject.

Definition at line 213 of file searchableCylinder.H.

References notImplemented.


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