FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

searchableCylinder Class Reference

Searching on cylinder. More...

#include <meshTools/searchableCylinder.H>


Detailed Description

Searching on cylinder.

Source files

Definition at line 52 of file searchableCylinder.H.

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 wordList &  regions () 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.

Constructor & Destructor Documentation

searchableCylinder ( const IOobject &   io,
const point &   point1,
const point &   point2,
const scalar   radius  
)

Construct from components.

Definition at line 403 of file searchableCylinder.C.

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 [inline, virtual]

Whether supports volume type below.

Implements searchableSurface.

Definition at line 141 of file searchableCylinder.H.

virtual label size (  ) const [inline, virtual]

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< Cmpt >::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 [inline, virtual]

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: