meshkernel::SampleAveragingInterpolator Class Reference

Interpolator for sample data using an averaging scheme. More...

#include <SampleAveragingInterpolator.hpp>

Inheritance diagram for meshkernel::SampleAveragingInterpolator:

Public Member Functions
	SampleAveragingInterpolator (const std::span< const double > xNodes, const std::span< const double > yNodes, const Projection projection, const InterpolationParameters &interpolationParameters)
	Constructor.
	SampleAveragingInterpolator (const std::span< const Point > nodes, const Projection projection, const InterpolationParameters &interpolationParameters)
	Constructor.
UInt	Size () const override
	Get the number of nodes of size of the sample data.
void	Interpolate (const int propertyId, const std::span< const Point > iterpolationNodes, std::span< double > result) const override
	Interpolate the sample data set at the interpolation nodes.
void	Interpolate (const int propertyId, const Mesh2D &mesh, const Location location, std::span< double > result) const override
	Interpolate the sample data set at the locationd defined.
double	InterpolateValue (const int propertyId, const Point &evaluationPoint) const override
	Interpolate the sample data set at a single interpolation point.
Public Member Functions inherited from meshkernel::SampleInterpolator
virtual	~SampleInterpolator ()=default
	Destructor.
void	SetData (const int propertyId, const std::span< const double > sampleData)
	Set sample data.
bool	Contains (const int propertyId) const
	Determine if the SampleInterpolator already has this sample set.

Additional Inherited Members
Protected Member Functions inherited from meshkernel::SampleInterpolator
const std::vector< double > &	GetSampleData (const int propertyId) const
	Get the sample property data for the id.

Detailed Description

Interpolator for sample data using an averaging scheme.

Member Function Documentation

Interpolate() [1/2]

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

overridevirtual

Interpolate the sample data set at the locationd defined.

Implements meshkernel::SampleInterpolator.

Interpolate() [2/2]

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

overridevirtual

Interpolate the sample data set at the interpolation nodes.

Implements meshkernel::SampleInterpolator.

InterpolateValue()

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

overridevirtual

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.

Implements meshkernel::SampleInterpolator.

Size()

meshkernel::UInt meshkernel::SampleAveragingInterpolator::Size ( ) const

inlineoverridevirtual

Get the number of nodes of size of the sample data.

Implements meshkernel::SampleInterpolator.

---

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

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