Go to the documentation of this file.
49 #ifndef searchablePlane_H
50 #define searchablePlane_H
66 public searchableSurface,
107 const point& basePoint,
141 virtual label
size()
const
185 virtual void findLine
vectorField pointField
pointField is a vectorField.
Field< scalar > scalarField
Specialisation of Field<T> for scalar.
Defines the attributes of an object for which implicit objectRegistry management is supported,...
virtual ~searchablePlane()=default
Destructor.
const vector & normal() const
The plane unit normal.
virtual void getVolumeType(const pointField &, List< volumeType > &) const
Determine type (inside/outside/mixed) for point.
virtual bool overlaps(const boundBox &bb) const
Does any part of the surface overlap the supplied bound box?
A class for managing temporary objects.
virtual label size() const
Range of local indices that can be returned.
virtual void boundingSpheres(pointField ¢res, scalarField &radiusSqr) const
Get bounding spheres (centre and radius squared), one per element.
Geometric class that creates a 3D plane and can return the intersection point between a line and the ...
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
This class describes the interaction of (usually) a face and a point. It carries the info of a succes...
virtual volumeType outsideVolumeType() const
What is type of points outside bounds.
An enumeration wrapper for classification of a location as being inside/outside of a volume.
Base class of (analytical or triangulated) surface. Encapsulates all the search routines....
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
constexpr auto end(C &c) -> decltype(c.end())
Return iterator to the end of the container c.
virtual void findNearest(const pointField &sample, const scalarField &nearestDistSqr, List< pointIndexHit > &) const
const point & origin() const
The plane base point.
virtual tmp< pointField > points() const
Get the points that define the surface.
bool writeData(Ostream &) const
Pure virtual writeData function.
virtual const wordList & regions() const
Names of regions.
static tmp< T > New(Args &&... args)
Construct tmp of T with forwarding arguments.
virtual void getRegion(const List< pointIndexHit > &, labelList ®ion) const
From a set of points and indices get the region.
A bounding box defined in terms of min/max extrema points.
TypeName("searchablePlane")
Runtime type information.
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
virtual bool hasVolumeType() const
Whether supports volume type below.
Searching on (infinite) plane. The dictionary specifications are identical to the Foam::plane require...
virtual void findLineAny(const pointField &start, const pointField &end, List< pointIndexHit > &) const
Return any intersection on segment from start to end.
virtual void getNormal(const List< pointIndexHit > &, vectorField &normal) const
From a set of points and indices get the normal.
virtual void findLineAll(const pointField &start, const pointField &end, List< List< pointIndexHit >> &) const
Get all intersections in order from start to end.
virtual tmp< pointField > coordinates() const
Get representative set of element coordinates.
Minimal example by using system/controlDict.functions: