meshkernel::SampleInterpolator Class Reference

Interface for sample interpolation. More...

#include <SampleInterpolator.hpp>

Inheritance diagram for meshkernel::SampleInterpolator:

Public Member Functions
virtual	~SampleInterpolator ()=default
	Destructor.
void	SetData (const int propertyId, const std::span< const double > sampleData)
	Set sample data.
virtual UInt	Size () const =0
	Get the number of sample points.
bool	Contains (const int propertyId) const
	Determine if the SampleInterpolator already has this sample set.
virtual void	Interpolate (const int propertyId, const std::span< const Point > iterpolationNodes, std::span< double > result) const =0
	Interpolate the sample data set at the interpolation nodes.
virtual void	Interpolate (const int propertyId, const Mesh2D &mesh, const Location location, std::span< double > result) const =0
	Interpolate the sample data.
virtual double	InterpolateValue (const int propertyId, const Point &evaluationPoint) const =0
	Interpolate the sample data set at a single interpolation point.

Protected Member Functions
const std::vector< double > &	GetSampleData (const int propertyId) const
	Get the sample property data for the id.

Detailed Description

Interface for sample interpolation.

Member Function Documentation

Interpolate() [1/2]

virtual void meshkernel::SampleInterpolator::Interpolate ( const int  propertyId, const Mesh2D &  mesh, const Location  location, std::span< double >  result  ) const

pure virtual

Interpolate the sample data.

Implemented in meshkernel::SampleAveragingInterpolator, and meshkernel::SampleTriangulationInterpolator.

Interpolate() [2/2]

virtual void meshkernel::SampleInterpolator::Interpolate ( const int  propertyId, const std::span< const Point >  iterpolationNodes, std::span< double >  result  ) const

pure virtual

Interpolate the sample data set at the interpolation nodes.

Implemented in meshkernel::SampleAveragingInterpolator, and meshkernel::SampleTriangulationInterpolator.

InterpolateValue()

virtual double meshkernel::SampleInterpolator::InterpolateValue ( const int  propertyId, const Point &  evaluationPoint  ) const

pure virtual

Interpolate the sample data set at a single interpolation point.

If interpolation at multiple points is required then better performance can be obtained using the Interpolate function above.

Implemented in meshkernel::SampleAveragingInterpolator, and meshkernel::SampleTriangulationInterpolator.

Size()

virtual UInt meshkernel::SampleInterpolator::Size ( ) const

pure virtual

Get the number of sample points.

Implemented in meshkernel::SampleAveragingInterpolator, and meshkernel::SampleTriangulationInterpolator.

---

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

• /home/runner/work/MeshKernel/MeshKernel/libs/MeshKernel/include/MeshKernel/SampleInterpolator.hpp