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

Inheritance diagram for searchablePlane:

Collaboration diagram for searchablePlane:

Public Member Functions
	TypeName ("searchablePlane")
	Runtime type information. More...

	searchablePlane (const IOobject &io, const point &basePoint, const vector &normal)
	Construct from components. More...

	searchablePlane (const IOobject &io, const dictionary &dict)
	Construct from dictionary (used by searchableSurface) More...

	searchablePlane (const searchablePlane &)=delete
	Disallow default bitwise copy construction. More...

virtual	~searchablePlane ()
	Destructor. More...

virtual const wordList &	regions () 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< pointField >	coordinates () 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< pointField >	points () 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...

bool	writeData (Ostream &) const
	Pure virtual writaData function. More...

void	operator= (const searchablePlane &)=delete
	Disallow default bitwise assignment. 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)

	searchableSurface (const searchableSurface &)=delete
	Disallow default bitwise copy construction. More...

virtual autoPtr< searchableSurface >	clone () const
	Clone. More...

virtual	~searchableSurface ()
	Destructor. More...

const boundBox &	bounds () const
	Return const reference to boundBox. More...

boundBox &	bounds ()
	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...

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 &values) const
	WIP. From a set of hits (points and. More...

void	operator= (const searchableSurface &)=delete
	Disallow default bitwise assignment. 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 &)
	Copy constructor. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Copy constructor, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy constructor with new name, transferring registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Copy constructor with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry. More...

bool	checkOut ()
	Remove object from registry. More...

void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) 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...

label &	eventNo ()
	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...

virtual fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool read=true)
	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...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. 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	global () const
	Is object same for all processors. More...

virtual bool	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
	Write using given format, version and compression. More...

virtual bool	write (const bool write=true) 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...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Construct from copy resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Construct from copy resetting name. More...

	IOobject (const IOobject &io)=default
	Copy constructor. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

virtual	~IOobject ()
	Destructor. More...

const Time &	time () const
	Return time. More...

const objectRegistry &	db () const
	Return the local objectRegistry. More...

const word &	name () const
	Return name. More...

const word &	headerClassName () const
	Return name of the class name read from header. More...

word &	headerClassName ()
	Return name of the class name read from header. More...

string &	note ()
	Return non-constant access to the optional note. More...

const string &	note () 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

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

word	modelName (const char *name) const
	Return the name of the object within this model. More...

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const

fileName &	instance ()

const fileName &	local () 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	localPath () const
	Return the path relative to the case. More...

fileName	objectPath () const
	Return complete path + object name. More...

fileName	localObjectPath () const
	Return complete localPath + object name. More...

fileName	localFilePath (const word &typeName) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName) const
	Helper for filePath that searches up if in parallel. More...

bool	readHeader (Istream &)
	Read header. More...

template<class Type >
bool	typeHeaderOk (const bool checkType=true)
	Read header (uses typeFilePath to find file) and check header. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. 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< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &)

template<class Name >
Foam::word	groupName (Name name, const word &group)

template<class Name >
Foam::word	modelName (Name name, const word &model)

Public Member Functions inherited from plane
	plane (const vector &normalVector)
	Construct from normal vector through the origin. More...

	plane (const point &basePoint, const vector &normalVector)
	Construct from normal vector and point in plane. More...

	plane (const point &point1, const point &point2, const point &point3)
	Construct from three points in plane. More...

	plane (const scalarList &C)
	Construct from coefficients for the. More...

	plane (const dictionary &planeDict)
	Construct from dictionary. More...

	plane (Istream &is)
	Construct from Istream. Assumes the base + normal notation. More...

const vector &	normal () const
	Return plane normal. More...

const point &	refPoint () const
	Return or return plane base point. More...

FixedList< scalar, 4 >	planeCoeffs () const
	Return coefficients for the. More...

point	aPoint () const
	Return a point on the plane. More...

point	nearestPoint (const point &p) const
	Return nearest point in the plane for the given point. More...

scalar	distance (const point &p) const
	Return distance from the given point to the plane. More...

scalar	normalIntersect (const point &pnt0, const vector &dir) const
	Return cut coefficient for plane and line defined by. More...

scalar	normalIntersect (const ray &r) const
	Return cut coefficient for plane and ray. More...

template<class Point , class PointRef >
scalar	lineIntersect (const line< Point, PointRef > &l) const
	Return the cutting point between the plane and. More...

ray	planeIntersect (const plane &) const
	Return the cutting line between this plane and another. More...

point	planePlaneIntersect (const plane &, const plane &) const
	Return the cutting point between this plane and two other planes. More...

side	sideOfPlane (const point &p) const
	Return the side of the plane that the point is on. More...

point	mirror (const point &p) const
	Mirror the supplied point in the plane. Return the mirrored point. More...

void	writeDict (Ostream &) const
	Write to dictionary. More...

Additional Inherited Members
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...

enum	fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Enumeration defining the file checking options. More...

Public Types inherited from plane
enum	side { NORMAL, FLIP }
	Side of the plane. More...

Static Public Member Functions inherited from searchableSurface
static autoPtr< searchableSurface >	New (const word &surfaceType, const IOobject &io, const dictionary &dict)
	Return a reference to the selected searchableSurface. More...

static const word &	geometryDir ()
	Return the geometry directory name. More...

static const word &	geometryDir (const Time &time)
	Check that the geometry directory exists and return. 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)

static word	group (const word &name)
	Return group (extension part of name) More...

static word	member (const word &name)
	Return member (name without the extension) More...

template<class Name >
static word	modelName (Name name, const word &model)
	Return the name of the object within the given model. More...

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 searchableSurface
static word	geometryDir_
	Name of the directory for the geometry files. More...

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static constexpr const char *	foamFile = "FoamFile"
	Keyword for the FoamFile header sub-dictionary. More...

static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
	Read header, check readOpt flags and read data if necessary. More...

Protected Member Functions inherited from IOobject
void	setBad (const string &)
	Set the object state to bad. More...

Detailed Description

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

Source files

Definition at line 51 of file searchablePlane.H.

Constructor & Destructor Documentation

◆ searchablePlane() [1/3]

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

Construct from components.

Definition at line 92 of file searchablePlane.C.

◆ searchablePlane() [2/3]

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

Construct from dictionary (used by searchableSurface)

Definition at line 106 of file searchablePlane.C.

◆ searchablePlane() [3/3]

searchablePlane ( const searchablePlane & )

delete

Disallow default bitwise copy construction.

◆ ~searchablePlane()

~searchablePlane ( )

virtual

Destructor.

Definition at line 120 of file searchablePlane.C.

Member Function Documentation

◆ TypeName()

TypeName ( "searchablePlane" )

Runtime type information.

◆ regions()

const Foam::wordList & regions ( ) const

virtual

Names of regions.

Implements searchableSurface.

Definition at line 126 of file searchablePlane.C.

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

Here is the call graph for this function:

◆ hasVolumeType()

virtual bool hasVolumeType ( ) const

inlinevirtual

Whether supports volume type below.

Implements searchableSurface.

Definition at line 109 of file searchablePlane.H.

◆ size()

virtual label size ( ) const

inlinevirtual

Range of local indices that can be returned.

Implements searchableSurface.

Definition at line 115 of file searchablePlane.H.

References searchablePlane::boundingSpheres(), searchablePlane::coordinates(), and plane::refPoint().

Here is the call graph for this function:

◆ coordinates()

virtual tmp<pointField> coordinates ( ) const

inlinevirtual

Get representative set of element coordinates.

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

Implements searchableSurface.

Definition at line 122 of file searchablePlane.H.

Referenced by searchablePlane::points(), and searchablePlane::size().

Here is the caller graph for this function:

◆ boundingSpheres()

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. Note: radius limited to sqr(great)

Implements searchableSurface.

Definition at line 138 of file searchablePlane.C.

References searchablePlane::findNearest(), List< T >::setSize(), and Foam::sqr().

Referenced by searchablePlane::regions(), and searchablePlane::size().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ points()

virtual tmp<pointField> points ( ) const

inlinevirtual

Get the points that define the surface.

Implements searchableSurface.

Definition at line 138 of file searchablePlane.H.

References searchablePlane::coordinates().

Here is the call graph for this function:

◆ overlaps()

virtual bool overlaps ( const boundBox & bb ) const

inlinevirtual

Does any part of the surface overlap the supplied bound box?

Implements searchableSurface.

Definition at line 144 of file searchablePlane.H.

References searchablePlane::findLineAll(), searchablePlane::findLineAny(), searchablePlane::findNearest(), searchablePlane::getNormal(), searchablePlane::getRegion(), searchablePlane::getVolumeType(), and NotImplemented.

Here is the call graph for this function:

◆ findNearest()

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

virtual

Implements searchableSurface.

Definition at line 152 of file searchablePlane.C.

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

Referenced by searchablePlane::boundingSpheres(), and searchablePlane::overlaps().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findLine()

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

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

Here is the call graph for this function:

◆ findLineAny()

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

References searchablePlane::findLineAll().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findLineAll()

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRegion()

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNormal()

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getVolumeType()

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream & ) const

inlinevirtual

Pure virtual writaData function.

Must be defined in derived types

Implements regIOobject.

Definition at line 208 of file searchablePlane.H.

References NotImplemented, and searchablePlane::operator=().

Here is the call graph for this function:

◆ operator=()

void operator= ( const searchablePlane & )

delete

Disallow default bitwise assignment.

Referenced by searchablePlane::writeData().

Here is the caller graph for this function:

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

src/meshTools/searchableSurfaces/searchablePlane/searchablePlane.H
src/meshTools/searchableSurfaces/searchablePlane/searchablePlane.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ searchablePlane() [1/3]

◆ searchablePlane() [2/3]

◆ searchablePlane() [3/3]

◆ ~searchablePlane()

Member Function Documentation

◆ TypeName()

◆ regions()

◆ hasVolumeType()

◆ size()

◆ coordinates()

◆ boundingSpheres()

◆ points()

◆ overlaps()

◆ findNearest()

◆ findLine()

◆ findLineAny()

◆ findLineAll()

◆ getRegion()

◆ getNormal()

◆ getVolumeType()

◆ writeData()

◆ operator=()