Patches together many SquarePolynomialVectors to make a multidimensional polynomial spline. More...

#include <PolynomialPatch.h>

Inheritance diagram for interpolation::PolynomialPatch:

Collaboration diagram for interpolation::PolynomialPatch:

Public Member Functions
	PolynomialPatch (Mesh grid_points_, Mesh validity_region, std::vector< SquarePolynomialVector * > polynomials_)

	PolynomialPatch ()

	~PolynomialPatch ()

VectorMap *	clone () const

virtual void	function (const double point, double value) const

unsigned int	getPointDimension () const

unsigned int	getValueDimension () const

SquarePolynomialVector *	getPolynomialVector (const double *point) const

Mesh *	getMesh () const

std::vector< SquarePolynomialVector * >	getPolynomials () const

Public Member Functions inherited from interpolation::VectorMap
virtual void	function (const double point, double value) const =0

virtual void	function (const Mesh::Iterator &point, double *value) const

virtual void	functionAppend (const std::vector< std::vector< double > > &point_vec, std::vector< std::vector< double > > &value_vec) const

virtual bool	checkPoint (const std::vector< double > &point) const

virtual bool	checkValue (const std::vector< double > &value) const

virtual unsigned int	getPointDimension () const =0

virtual unsigned int	getValueDimension () const =0

virtual VectorMap *	clone () const =0

virtual	~VectorMap ()

virtual Mesh *	getMesh () const

Private Member Functions
	PolynomialPatch (const PolynomialPatch &rhs)

PolynomialPatch &	operator= (const PolynomialPatch &rhs)

Private Attributes
Mesh *	validity_region_

Mesh *	grid_points_

std::vector< SquarePolynomialVector * >	points_

unsigned int	point_dimension_

unsigned int	value_dimension_

Detailed Description

Patches together many SquarePolynomialVectors to make a multidimensional polynomial spline.

SquarePolynomialVectors are distributed on a mesh.

Parameters

grid_points_	The grid points on which patches are defined. SquarePolynomialVector owns this memory (deletes on destructor).
validity_region_	Defines whether a region is valid or not. This is defined as a mesh for compatibility with the SectorMagneticFieldMap (but possibly this is the wrong way to do it - better as a lookup, like bool is_valid(point), which could be inherited from the VectorMap class) SquarePolynomialVector owns this memory (deletes on destructor).
points_	The PolynomialVector data SquarePolynomialVector owns this memory (deletes on destructor).
point_dimension_	Dimension of the ordinate
value_dimension_	Dimension of the abscissa

Definition at line 55 of file PolynomialPatch.h.

Constructor & Destructor Documentation

◆ PolynomialPatch() [1/3]

interpolation::PolynomialPatch::PolynomialPatch	(	Mesh *	grid_points_,
		Mesh *	validity_region,
		std::vector< SquarePolynomialVector * >	polynomials_
	)

Construct the PolynomialPatch

Parameters

grid_points_	the mesh over which the polynomials are distributed. PolynomialPatch takes ownership of this memory.
validity_region	the mesh over which the grid points are valid; the validity region is defined by min/max values of the grid. PolynomialPatch takes ownership of this memory.
polynomials_	the set of polynomials which make up the patch. PolynomialPatch takes ownership of this memory.

Definition at line 34 of file PolynomialPatch.cpp.

References interpolation::Mesh::end(), end(), interpolation::Mesh::getPositionDimension(), grid_points_, point_dimension_, points_, validity_region_, and value_dimension_.

Here is the call graph for this function:

◆ PolynomialPatch() [2/3]

interpolation::PolynomialPatch::PolynomialPatch ( )

Default constructor leaves validity_region_ and grid_points_ as nullptr

Note it is not safe to call some member functions e.g. function(...) on default constructed PolynomialPatch.

Definition at line 105 of file PolynomialPatch.cpp.

Referenced by clone().

◆ ~PolynomialPatch()

interpolation::PolynomialPatch::~PolynomialPatch ( )

Destructor delets validity_region_, grid_points_ and points_

Definition at line 110 of file PolynomialPatch.cpp.

References grid_points_, points_, and validity_region_.

◆ PolynomialPatch() [3/3]

interpolation::PolynomialPatch::PolynomialPatch ( const PolynomialPatch & rhs )

private

Member Function Documentation

◆ clone()

VectorMap * interpolation::PolynomialPatch::clone ( ) const

virtual

Deep copy the PolynomialPatch

This is the polymorphic copy constructor. Always returns a PolynomialPatch.

Implements interpolation::VectorMap.

Definition at line 85 of file PolynomialPatch.cpp.

References interpolation::Mesh::clone(), grid_points_, points_, PolynomialPatch(), and validity_region_.

Here is the call graph for this function:

◆ function()

void interpolation::PolynomialPatch::function	(	const double *	point,
		double *	value
	)		const

virtual

Get the value at a given point

Parameters

point	array of length point_dimension_. Caller owns this memory. Not bound checked - it wants to be fast.
value	array of length value_dimension_. Data gets overwritten by PolynomialPatch. Caller owns this memory. Not bound checked.

Implements interpolation::VectorMap.

Definition at line 117 of file PolynomialPatch.cpp.

References interpolation::Mesh::getNearest(), interpolation::Mesh::Iterator::getPosition(), grid_points_, point_dimension_, points_, and interpolation::Mesh::Iterator::toInteger().

Referenced by PyOpal::PyPolynomialPatch::function().

Here is the call graph for this function: