meshkernel::FuncAdimensionalToDimensionalDistanceOnSpline Struct Reference

This structure is used to create a function for converting an adimensional distance on a spline to a dimensional one. More...

#include <Splines.hpp>

Public Member Functions
	FuncAdimensionalToDimensionalDistanceOnSpline (const Splines &splines, UInt splineIndex, bool isSpacingCurvatureAdapted, double h)
	Constructor. More...
	FuncAdimensionalToDimensionalDistanceOnSpline (const Splines &splines, UInt splineIndex, bool isSpacingCurvatureAdapted, double h, double distance)
	Constructor. More...
void	SetDimensionalDistance (double distance)
	Set dimensional distance. More...
double	operator() (double adimensionalDistanceReferencePoint) const
	This is the function we want to find the root of.

Public Attributes
const Splines &	m_spline
	Reference to splines.
UInt	m_splineIndex
	Spline index.
bool	m_isSpacingCurvatureAdapted
	Is spacing curvature adapted.
double	m_h
	When accounting for curvature, the height to use.
UInt	m_numSamples = 10
	Number of samples.
double	m_DimensionalDistance = 0.0
	Dimensional distance.

Detailed Description

This structure is used to create a function for converting an adimensional distance on a spline to a dimensional one.

Constructor & Destructor Documentation

FuncAdimensionalToDimensionalDistanceOnSpline() [1/2]

meshkernel::FuncAdimensionalToDimensionalDistanceOnSpline::FuncAdimensionalToDimensionalDistanceOnSpline ( const Splines &  splines, UInt  splineIndex, bool  isSpacingCurvatureAdapted, double  h  )

inline

Constructor.

Parameters

[in]	splines	A pointer to splines
[in]	splineIndex	The index of the current spline
[in]	isSpacingCurvatureAdapted	Is spacing curvature adapted
[in]	h	When accounting for curvature, the height to use

FuncAdimensionalToDimensionalDistanceOnSpline() [2/2]

meshkernel::FuncAdimensionalToDimensionalDistanceOnSpline::FuncAdimensionalToDimensionalDistanceOnSpline ( const Splines &  splines, UInt  splineIndex, bool  isSpacingCurvatureAdapted, double  h, double  distance  )

inline

Constructor.

Parameters

[in]	splines	A pointer to splines
[in]	splineIndex	The index of the current spline
[in]	isSpacingCurvatureAdapted	Is spacing curvature adapted
[in]	h	When accounting for curvature, the height to use
[in]	distance	The dimensional distance

Member Function Documentation

SetDimensionalDistance()

void meshkernel::FuncAdimensionalToDimensionalDistanceOnSpline::SetDimensionalDistance ( double  distance )

inline

Set dimensional distance.

Parameters

[in]

distance

distance

---

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

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