MeshKernel
Public Member Functions | Protected Attributes | List of all members
meshkernel::MeshInterpolation Class Referenceabstract

Interface for interpolation methods. More...

#include <MeshInterpolation.hpp>

Inheritance diagram for meshkernel::MeshInterpolation:
meshkernel::AveragingInterpolation meshkernel::BilinearInterpolationOnGriddedSamples< T >

Public Member Functions

virtual ~MeshInterpolation ()=default
 Virtual destructor.
 
virtual void Compute ()=0
 Compute.
 
double GetNodeResult (UInt node) const
 Gets the interpolation value at a specific node. More...
 
double GetEdgeResult (UInt edge) const
 Gets the interpolation value at a specific edge. More...
 
double GetFaceResult (UInt face) const
 Gets the interpolation value at a specific face. More...
 
const std::vector< double > & GetNodeResults () const
 Gets all interpolated values at nodes. More...
 
const std::vector< double > & GetEdgeResults () const
 Gets all interpolated values at edges. More...
 
const std::vector< double > & GetFaceResults () const
 Gets all interpolated values at faces. More...
 

Protected Attributes

std::vector< double > m_nodeResults
 The interpolation results at nodes.
 
std::vector< double > m_edgeResults
 The interpolation results at edges.
 
std::vector< double > m_faceResults
 The interpolation results at faces.
 

Detailed Description

Interface for interpolation methods.

Member Function Documentation

◆ GetEdgeResult()

double meshkernel::MeshInterpolation::GetEdgeResult ( UInt  edge) const
inline

Gets the interpolation value at a specific edge.

Parameters
[in]edgeThe edge index
Returns
The interpolated value

◆ GetEdgeResults()

const std::vector<double>& meshkernel::MeshInterpolation::GetEdgeResults ( ) const
inline

Gets all interpolated values at edges.

Returns
The interpolated values

◆ GetFaceResult()

double meshkernel::MeshInterpolation::GetFaceResult ( UInt  face) const
inline

Gets the interpolation value at a specific face.

Parameters
[in]faceThe face index
Returns
The interpolated value

◆ GetFaceResults()

const std::vector<double>& meshkernel::MeshInterpolation::GetFaceResults ( ) const
inline

Gets all interpolated values at faces.

Returns
The interpolated values

◆ GetNodeResult()

double meshkernel::MeshInterpolation::GetNodeResult ( UInt  node) const
inline

Gets the interpolation value at a specific node.

Parameters
[in]nodeThe node index
Returns
The interpolated value

◆ GetNodeResults()

const std::vector<double>& meshkernel::MeshInterpolation::GetNodeResults ( ) const
inline

Gets all interpolated values at nodes.

Returns
The interpolated values

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