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

searchablePlane Class Reference

Searching on (infinite) plane. See plane.H. More...

#include <meshTools/searchablePlane.H>


Detailed Description

Searching on (infinite) plane. See plane.H.

Source files

Definition at line 52 of file searchablePlane.H.

Inheritance diagram for searchablePlane:
Collaboration diagram for searchablePlane:

List of all members.

Public Member Functions

 TypeName ("searchablePlane")
 Runtime type information.
 searchablePlane (const IOobject &io, const point &basePoint, const vector &normal)
 Construct from components.
 searchablePlane (const IOobject &io, const dictionary &dict)
 Construct from dictionary (used by searchableSurface)
virtual  ~searchablePlane ()
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

searchablePlane ( const IOobject &   io,
const point &   basePoint,
const vector &   normal  
)

Construct from components.

Definition at line 72 of file searchablePlane.C.

searchablePlane ( const IOobject &   io,
const dictionary &   dict  
)

Construct from dictionary (used by searchableSurface)

Definition at line 84 of file searchablePlane.C.

~searchablePlane (  ) [virtual]

Definition at line 96 of file searchablePlane.C.


Member Function Documentation

TypeName ( "searchablePlane"    )

Runtime type information.

const Foam::wordList & regions (  ) const [virtual]

Names of regions.

Implements searchableSurface.

Definition at line 102 of file searchablePlane.C.

References List< T >::setSize().

virtual bool hasVolumeType (  ) const [inline, virtual]

Whether supports volume type below.

Implements searchableSurface.

Definition at line 113 of file searchablePlane.H.

virtual label size (  ) const [inline, virtual]

Range of local indices that can be returned.

Implements searchableSurface.

Definition at line 119 of file searchablePlane.H.

virtual pointField coordinates (  ) const [inline, virtual]

Get representative set of element coordinates.

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

Implements searchableSurface.

Definition at line 126 of file searchablePlane.H.

References plane::refPoint().

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

Implements searchableSurface.

Definition at line 114 of file searchablePlane.C.

References forAll, Foam::magSqr(), 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 141 of file searchablePlane.C.

References forAll, 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 157 of file searchablePlane.C.

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 168 of file searchablePlane.C.

References List< T >::clear(), forAll, 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 194 of file searchablePlane.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 205 of file searchablePlane.C.

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

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 216 of file searchablePlane.C.

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

bool writeData ( Ostream &    ) const [inline, virtual]

Pure virtual writaData function.

Must be defined in derived types

Implements regIOobject.

Definition at line 189 of file searchablePlane.H.

References notImplemented.


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