Contains the logic of the C++ static library. More...

Classes
class	AlgorithmError
	A class for throwing algorithm exceptions. More...

class	AveragingInterpolation
	The class used to interpolate based on averaging. More...

class	BilinearInterpolationOnGriddedSamples
	A class for performing bilinear interpolation on gridded samples. More...

class	Boolean
	Boolean value designed for use in std::vector. More...

class	BoundedStack
	A simple bounded stack. More...

class	BoundingBox
	A class defining a bounding box. More...

struct	Cartesian3DPoint
	A struct describing the three coordinates in a cartesian projection. More...

class	CasulliDeRefinement
	Compute the Casulli de-refinement for a mesh (derefine_mesh). More...

class	CasulliRefinement
	Compute the Casulli refinement for a mesh. More...

class	ConnectMeshes
	Connects grids across element faces. More...

class	ConstraintError
	An exception class thrown when an attempt is made that violates a range constraint. More...

class	Contacts
	A class describing an 1d-2d contacts. More...

class	ConvertCartesianToSpherical
	Converts points from spherical to Cartesian coordinate system. More...

class	ConvertCartesianToSphericalBase
	Converts points from spherical to Cartesian coordinate system. More...

class	ConvertCartesianToSphericalEPSG
	Converts points from spherical to Cartesian coordinate system using an EPSG code. More...

class	ConvertSphericalToCartesian
	Converts points from spherical to Cartesian coordinate system. More...

class	ConvertSphericalToCartesianBase
	Namespace alias for boost::geometry. More...

class	ConvertSphericalToCartesianEPSG
	Converts points from spherical to Cartesian coordinate system using an ESPG code. More...

struct	CurvilinearParameters
	A struct used to describe parameters for generating a curvilinear grid in a C-compatible manner. More...

struct	EdgeMeshPolyLineIntersection
	An intersection with a mesh edge. More...

class	ErrorCategory
	Contains error category information. More...

struct	FaceMeshPolyLineIntersection
	An intersection with a mesh face. More...

class	FlipEdges
	A class used to improve mesh connectivity. More...

class	FormatString
	Manages the format string and source location. More...

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

struct	FuncDistanceFromAPoint
	This structure is used to compute the point on a spline closest to another point. More...

class	Hessian
	The hessian values. More...

struct	InterpolationParameters
	Parameters used by the sample interpolation. More...

class	LandBoundaries
	A class describing land boundaries. These are used to visualise the land-water interface. More...

class	LandBoundary
	A class containing the land boundary polylines. More...

class	LinearAlgebraError
	A class for throwing linear algebra exceptions. More...

struct	MakeGridParameters
	This struct describes the necessary parameters to create a new curvilinear grid in a C-compatible manner. More...

class	Mesh
	A class describing an unstructured mesh. This class contains the shared functionality between 1d or 2d meshes. More...

class	Mesh1D
	A class derived from Mesh, which describes 1d meshes. More...

class	Mesh2D
	A class derived from Mesh, which describes unstructures 2d meshes. More...

class	Mesh2DGenerateGlobal
	Construct a global grid in spherical coordinates, as a base for later mesh refinements. More...

class	Mesh2DIntersections
	Compute the intersections of polygon inner and outer perimeters. More...

class	Mesh2DToCurvilinear
	Construct a curvilinear grid from an unstructured mesh. More...

class	MeshConversion
	Apply a conversion to nodes of a mesh. More...

class	MeshGeometryError
	A class for throwing mesh geometry errors. More...

class	MeshInterpolation
	Interface for interpolation methods. More...

class	MeshKernelError
	A class for throwing general MeshKernel exceptions. More...

class	MeshOrthogonality
	Compute the orthogonality value for the edges. More...

class	MeshRefinement
	A class used to refine a Mesh2D instance. More...

struct	MeshRefinementParameters
	A struct used to describe the mesh refinement parameters in a C-compatible manner. More...

class	MeshSmoothness
	Compute the smoothness value for the edges. More...

class	MeshTransformation
	Apply a transformation to a mesh. More...

class	MeshTriangulation
	Contains a mesh triangulated from a set of points. More...

class	Network1D
	A class describing a network 1d. More...

class	NotImplementedError
	A class for throwing not implemented exceptions. More...

class	OrthogonalizationAndSmoothing
	Orthogonalizion (optimize the aspect ratios) and mesh smoothing (optimize internal face angles or area). More...

struct	OrthogonalizationParameters
	A struct used to describe the orthogonalization parameters in a C-compatible manner. More...

class	Orthogonalizer
	Orthogonalizion (optimize the aspect ratios) and mesh smoothing (optimize internal face angles or area). More...

class	Point
	A struct describing a point in a two-dimensional space. More...

class	Polygon
	A closed polygon. More...

class	PolygonalEnclosure
	A region enclosed by a polygonal permieter. More...

class	Polygons
	A class containing a list of polygonaly enclosed regions. More...

class	RangeError
	A class for throwing range error exceptions. More...

class	RemoveDisconnectedRegions
	Removes any small regions that are disconnected from the main part of the domain. More...

class	RigidBodyTransformation
	A composition of translation and rotation transformations. More...

class	Rotation
	Apply a rotation transformation to a point or a vector. More...

class	Sample
	A struct describing a sample with two coordinates and a value. More...

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

class	SampleInterpolator
	Interface for sample interpolation. More...

class	SamplesHessianCalculator
	A class implementing the computation of the real component the local hessian eigenvalues. More...

class	SampleTriangulationInterpolator
	Interpolator for sample data on a triangulated grid. More...

class	Smoother
	Orthogonalizion (optimize the aspect ratios) and mesh smoothing (optimize internal face angles or area). More...

class	SplineAlgorithms
	Provide algorithms operating on splines. More...

class	Splines
	A class describing splines. More...

struct	SplinesToCurvilinearParameters
	A struct used to describe the spline to curvilinear grid parameters in a C-compatible manner. More...

class	SplitRowColumnOfMesh
	Split the row or column connected to the given edge. More...

class	Translation
	Apply a translation transformation to a point or a vector. More...

class	TriangulationInterpolation
	A class used for triangulation interpolation. More...

struct	TriangulationWrapper
	Wrapper around the Triangle library. More...

class	Vector
	A class defining a vector. More...

Typedefs
using	UInt = std::uint32_t
	Integer type used when indexing mesh graph entities.

using	Edge = std::pair< UInt, UInt >
	Describes an edge connecting two nodes.

using	EdgeFaces = std::array< UInt, 2 >
	Contains the ID's of elements either side of an edge.

using	HessianDimension = std::array< UInt, 3 >
	Array containing dimensions of the hessian.

using	MatrixColMajor = lin_alg::Matrix< double, Eigen::ColMajor >
	Define column major orientation.

Enumerations
enum class	Projection { cartesian = 0 , spherical = 1 , sphericalAccurate = 2 }
	Enumerator describing the supported projections.

enum class	TraversalDirection { Clockwise , AntiClockwise }
	Indicator for traversal direction of the points specifying a polygon. More...

enum class	Location { Faces = 0 , Nodes = 1 , Edges = 2 , Unknown = 3 }
	Mesh locations enumeration. More...

enum class	CurvilinearDirection { M , N }
	Direction to use in curvilinear grid algorithms. More...

enum class	InterpolationDataTypes { Short = 0 , Float = 1 , Int = 2 , Double = 3 }
	The possible types of the values to be interpolated in the gridded sample. More...

enum class	MeshNodeType : std::int8_t { Hanging = -1 , Unspecified , Internal , Boundary , Corner }
	Possible unstructured node types. More...

enum class	Property { Orthogonality = 0 , EdgeLength = 1 , FaceCircumcenter = 2 }
	Enumerator for different properties on a 2D mesh.

enum	ExitCode { Success = 0 , MeshKernelErrorCode = 1 , NotImplementedErrorCode = 2 , AlgorithmErrorCode = 3 , ConstraintErrorCode = 4 , MeshGeometryErrorCode = 5 , LinearAlgebraErrorCode = 6 , RangeErrorCode = 7 , StdLibExceptionCode = 8 , UnknownExceptionCode = 9 }
	Enumeration of exit codes. More...

enum class	Interpolants { AveragingInterpolation = 0 , BilinearInterpolationOnGriddedSamples = 1 }
	The interpolant types.

Functions
double	separationDistance (const Cartesian3DPoint &p1, const Cartesian3DPoint &p2)
	Compute the separation distance of two points in 3D Cartesian coordinate system,.

std::tuple< double, double, double >	ComputeSphericalCoordinatesFromLatitudeAndLongitude (const Point &point)
	Converts geographic coordinates (latitude and longitude) to 3D spherical Cartesian coordinates.

Cartesian3DPoint	VectorProduct (const Cartesian3DPoint &a, const Cartesian3DPoint &b)
	Defines vector product for cartesian 3D-space.

double	InnerProduct (const Cartesian3DPoint &a, const Cartesian3DPoint &b)
	Defines inner product in cartesian 3D-space.

Cartesian3DPoint	operator* (const Cartesian3DPoint &p, const double value)
	Multiply Cartesian point p by a scalar value.

Cartesian3DPoint	operator* (const double value, const Cartesian3DPoint &p)
	Multiply Cartesian point p by a scalar value.

Cartesian3DPoint	operator/ (const Cartesian3DPoint &p, const double value)
	Divide Cartesian point p by a scalar value.

Cartesian3DPoint	operator+ (const Cartesian3DPoint &p1, const Cartesian3DPoint &p2)
	Add Cartesian point p2 to p1.

Cartesian3DPoint	operator- (const Cartesian3DPoint &p1, const Cartesian3DPoint &p2)
	Subtract Cartesian point p2 from p1.

Cartesian3DPoint	SphericalToCartesian3D (const Point &sphericalPoint)
	Transforms 2D point in spherical coordinates to 3D cartesian coordinates.

Point	Cartesian3DToSpherical (const Cartesian3DPoint &cartesianPoint, double referenceLongitude)
	Transforms 3D cartesian coordinates to 2D point in spherical coordinates.

const std::vector< int > &	GetValidProjections ()
	Gets the valid projectionbs as vector of integers.

const std::vector< int > &	GetValidDeletionOptions ()
	Gets the valid deletion options as vector of integers.

Projection	GetProjectionValue (int projection)
	Convert an integer value to the Projection enumeration type.

const std::string &	ProjectionToString (Projection projection)
	Get the string representation of the Projection enumeration values.

CurvilinearDirection	GetCurvilinearDirectionValue (int direction)
	Convert an integer value to the CurvilinearDirection enumeration type.

const std::string &	CurvilinearDirectionToString (CurvilinearDirection direction)
	Get the string representation of the CurvilinearDirection enumeration values.

template<typename T >
void	ResizeAndFill2DVector (std::vector< std::vector< T > > &v, UInt const &firstDimension, UInt const &secondDimension, bool fill=false, const T &fillValue={})
	Resizes and fills a two dimensional vector.

template<typename T >
void	ResizeAndFill3DVector (std::vector< std::vector< std::vector< T > > > &v, UInt const &firstDimension, UInt const &secondDimension, UInt const &thirdDim, bool fill=false, const T &fillValue={})
	Resizes and fills a three dimensional vector.

template<typename T >
UInt	FindIndex (const std::vector< T > &vec, T el)
	Find index of a certain element.

template<typename T >
UInt	FindNextIndex (const std::vector< T > &vec, UInt current)
	Find the next index in the vector, wraps around when current is the last index.

template<typename T >
UInt	FindPreviousIndex (const std::vector< T > &vec, UInt current)
	Find the previous index in the vector, wraps around when current is the first index.

std::vector< std::pair< UInt, UInt > >	FindIndices (const std::vector< Point > &vec, size_t start, size_t end, double separator)
	Find all start-end positions in a vector separated by a separator.

UInt	InvalidPointCount (const std::vector< Point > &points)
	Determine if the number of invalid points in the point array.

UInt	InvalidPointCount (const std::vector< Point > &points, size_t start, size_t end)
	Determine if the number of invalid points in the section of the point array.

template<typename T >
std::vector< UInt >	SortedIndices (const std::vector< T > &v)
	Sort a vector and return the sorted indices.

template<typename T >
auto	ReorderVector (const std::vector< T > &v, const std::vector< UInt > &order)
	Reorder vector accordingly to a specific order.

template<typename F >
double	FindFunctionRootWithGoldenSectionSearch (F func, double min, double max)
	Algorithm performing the zero's search using the golden section algorithm's.

UInt	NextCircularForwardIndex (UInt currentIndex, UInt size)
	Get the next forward index, for a range in 0 .. size-1.

UInt	NextCircularBackwardIndex (UInt currentIndex, UInt size)
	Get the next backward index, for a range in 0 .. size-1.

bool	IsPointOnPole (const Point &point)
	Determines if a point is close to the poles (latitude close to 90 degrees).

double	crossProduct (const Point &firstSegmentFirstPoint, const Point &firstSegmentSecondPoint, const Point &secondSegmentFirstPoint, const Point &secondSegmentSecondPoint, const Projection &projection)
	Computes the cross product between two segments (duitpl)

bool	IsPointInPolygonNodes (const Point &point, const std::vector< Point > &polygonNodes, const Projection &projection, Point polygonCenter={constants::missing::doubleValue, constants::missing::doubleValue}, UInt startNode=constants::missing::uintValue, UInt endNode=constants::missing::uintValue)
	Checks if a point is in polygonNodes using the winding number method.

bool	IsPointInPolygonNodes (const Point &point, const std::vector< Point > &polygonNodes, const Projection &projection, const BoundingBox &boundingBox, Point polygonCenter={constants::missing::doubleValue, constants::missing::doubleValue}, UInt startNode=constants::missing::uintValue, UInt endNode=constants::missing::uintValue)
	Checks if a point is in polygonNodes using the winding number method.

bool	IsPointInTriangle (const Point &point, const std::span< const Point > triangleNodes, const Projection &projection)
	Checks if a point is in triangle using the winding number method.

void	ComputeThreeBaseComponents (const Point &point, std::array< double, 3 > &exxp, std::array< double, 3 > &eyyp, std::array< double, 3 > &ezzp)
	Computes three base components.

void	ComputeTwoBaseComponents (const Point &point, double(&elambda)[3], double(&ephi)[3])
	Computes two base components.

double	GetDx (const Point &firstPoint, const Point &secondPoint, const Projection &projection)
	Gets dx for the given projection.

Vector	GetDelta (const Point &firstPoint, const Point &secondPoint, const Projection &projection)
	Get the delta (dx, dy) for the given projection.

Vector	ComputeNormalToline (const Point &start, const Point &end, const Projection projection)
	Get the normal to the line described by the two points.

double	GetDy (const Point &firstPoint, const Point &secondPoint, const Projection &projection)
	Gets dy for the given projection.

double	OuterProductTwoSegments (const Point &firstPointFirstSegment, const Point &secondPointFirstSegment, const Point &firstPointSecondSegment, const Point &secondPointSecondSegment, const Projection &projection)
	Outer product of two segments (dprodout)

Point	ComputeMiddlePoint (const Point &firstPoint, const Point &secondPoint, const Projection &projection)
	Computes the middle point.

Point	ComputeMiddlePointAccountingForPoles (const Point &firstPoint, const Point &secondPoint, const Projection &projection)
	Computes the middle point (account for poles, latitudes close to 90 degrees)

Point	NormalVector (const Point &firstPoint, const Point &secondPoint, const Point &insidePoint, const Projection &projection)
	Normalized vector of a segment in direction 1 -> 2 with the insidePoint orientation.

double	ComputeArea (const std::vector< Point > &polygon, const Projection projection)
	Compute the area of the polygon described by the closed sequence of points.

void	TransformGlobalVectorToLocal (const Point &reference, const Point &globalCoordinates, const Point &globalComponents, const Projection &projection, Point &localComponents)
	Transforms vector with components in global spherical coordinate directions(xglob, yglob) to local coordinate directions(xloc, yloc) around reference point(xref, yref)

Point	NormalVectorOutside (const Point &firstPoint, const Point &secondPoint, const Projection &projection)
	Computes the normal vector outside (normalout)

void	NormalVectorInside (const Point &firstPoint, const Point &secondPoint, const Point &insidePoint, Point &normal, bool &flippedNormal, const Projection &projection)
	Computes the normal vector to a line 1-2, which is outward w.r.t. an 'inside' point 3.

void	AddIncrementToPoint (const Point &normal, double increment, const Point &referencePoint, const Projection &projection, Point &point)
	Moves a point by adding an increment vector to it.

void	TranslateSphericalCoordinates (std::vector< Point > &polygon)
	For a given polygon the function may shift the input coordinates.

Point	ReferencePoint (const std::vector< Point > &polygon, const Projection &projection)
	For a given polygon compute a reference point.

Point	ReferencePoint (const std::vector< Point > &nodes, const std::vector< UInt > &polygonIndices, const Projection &projection)
	For a given polygon compute a reference point.

double	ComputeSquaredDistance (const Point &firstPoint, const Point &secondPoint, const Projection &projection)
	Computes the squared distance between two points This is faster than ComputeDistance because it does not take the square root.

double	ComputeDistance (const Point &firstPoint, const Point &secondPoint, const Projection &projection)
	Computes the distance between two points (dbdistance)

std::tuple< double, Point, double >	DistanceFromLine (const Point &point, const Point &firstNode, const Point &secondNode, const Projection &projection)
	Computes the perpendicular distance of a point from a segment firstNode - secondNode (dlinedis3)

double	InnerProductTwoSegments (const Point &firstPointFirstSegment, const Point &secondPointFirstSegment, const Point &firstPointSecondSegment, const Point &secondPointSecondSegment, const Projection &projection)
	Inner product of two segments (dprodin)

double	NormalizedInnerProductTwoSegments (const Point &firstPointFirstSegment, const Point &secondPointFirstSegment, const Point &firstPointSecondSegment, const Point &secondPointSecondSegment, const Projection &projection)
	The normalized inner product of two segments (dcosphi)

UInt	CountNumberOfValidEdges (const std::vector< UInt > &edgesNumFaces, UInt numNodes)
	Count the number of valid edges in list.

void	ComputeMidPointsAndNormals (const std::vector< Point > &polygon, const std::vector< UInt > &edgesNumFaces, const UInt numNodes, std::array< Point, constants::geometric::maximumNumberOfNodesPerFace > &middlePoints, std::array< Point, constants::geometric::maximumNumberOfNodesPerFace > &normals, UInt &pointCount, const Projection &projection)
	Compute mid point and normal of polygon segment.

std::tuple< bool, Point, double, double, double >	AreSegmentsCrossing (const Point &firstSegmentFirstPoint, const Point &firstSegmentSecondPoint, const Point &secondSegmentFirstPoint, const Point &secondSegmentSecondPoint, bool adimensionalCrossProduct, const Projection &projection)
	Determines if two segments are crossing (cross, cross3D)

template<typename T >
T	ComputePointOnSplineAtAdimensionalDistance (const std::vector< T > &coordinates, const std::vector< T > &coordinatesDerivatives, double pointAdimensionalCoordinate)
	Computes the coordinate of a point on a spline, given the dimensionless distance from the first corner point (splint)

std::tuple< std::vector< double >, double >	ComputeAdimensionalDistancesFromPointSerie (const std::vector< Point > &v, const Projection &projection)
	Computes dimensionless distances of a vector of points such as the first entry has distance 0 and the last entry has distance 1.

template<typename T >
int	sgn (T val)
	Computes the sign of a type.

lin_alg::Matrix< Point >	DiscretizeTransfinite (const std::vector< Point > &leftDiscretization, const std::vector< Point > &rightDiscretization, const std::vector< Point > &bottomDiscretization, const std::vector< Point > &upperDiscretization, const Projection &projection, UInt numM, UInt numN)
	Computes the transfinite discretization inside the area defined by 4 sides, each one discretized with a series of points (tranfn2).

std::vector< Point >	ComputeEdgeCenters (const std::vector< Point > &nodes, const std::vector< Edge > &edges)
	Computes the edge centers.

double	LinearInterpolationInTriangle (const Point &interpolationPoint, const std::vector< Point > &polygon, const std::vector< double > &values, const Projection &projection)
	Given a triangles with values on each node, computes the interpolated value inside the triangle, using linear interpolation.

Point	ComputeAverageCoordinate (const std::span< const Point > points, const Projection &projection)
	Given a series of point computes the average coordinate.

std::tuple< Point, double, bool >	OrthogonalProjectionOnSegment (Point const &firstNode, Point const &secondNode, Point const &pointToProject)
	Cartesian projection of a point on a segment defined by other two points.

UInt	AbsoluteDifference (UInt number_1, UInt number_2)
	Calculates the absolute difference between to `Index` numbers.

std::vector< Point >	ComputePolyLineDiscretization (std::vector< Point > const &polyline, std::vector< double > &chainages, Projection projection)
	Computes the discretization points along a polyline.

std::vector< double >	ComputePolyLineNodalChainages (std::vector< Point > const &polyline, Projection projection)
	Computes the chainages of each polyline node.

std::vector< double >	ComputePolyLineEdgesLengths (std::vector< Point > const &polyline, Projection projection)
	Computes the lengths of each polyline segment.

double	MatrixNorm (const std::vector< double > &x, const std::vector< double > &y, const std::vector< double > &matCoefficients)
	Compute the matrix norm.

void	IncrementValidValue (UInt &value, const UInt increment)
	Increment a valid value by an increment.

double	lengthSquared (const Point &p1)
	Compute the dot product of a point with itself.

double	dot (const Point &p1, const Point &p2)
	Compute the dot product of two points.

double	dot (const Point &p, const Vector &v)
	Compute the dot product of a point and a vector.

double	dot (const Vector &v, const Point &p)
	Compute the dot product of a point and a vector.

double	cross (const Point &p1, const Point &p2)
	Compute the cross product of two points (as vectors).

Point	operator- (const Point &pnt)
	Unary minus.

Point	operator+ (const Point &p1, const Point &p2)
	Add two points.

Point	operator+ (const Point &pnt, const Vector &vec)
	Add vector to a point.

Point	operator+ (const Point &p, const double x)
	Add points and scalar.

Point	operator+ (const double x, const Point &p)
	Add points and scalar.

Point	operator- (const Point &p1, const Point &p2)
	Subtract two points.

Point	operator- (const Point &pnt, const Vector &vec)
	Subtract vector from a point.

Point	operator- (const Point &p, const double x)
	Subtract scalar from point.

Point	operator- (const double x, const Point &p)
	Subtract point from scalar.

Point	operator* (const Point &p1, const Point &p2)
	Multiply point by a point.

Point	operator* (const double x, const Point &p)
	Multiply point by a scalar.

Point	operator* (const Point &p, const double x)
	Multiply point by a scalar.

Point	operator/ (const Point &p1, const Point &p2)
	Divide point by a point.

Point	operator/ (const Point &p, const double x)
	Divide point by a scalar.

bool	operator== (const Point &p1, const Point &p2)
	Test points for equality using a default tolerance.

bool	operator!= (const Point &p1, const Point &p2)
	Test points for equality using a default tolerance.

bool	IsEqual (const Point &p1, const Point &p2, const double epsilon)
	Test points for equality upto a tolerance.

Point	PointAlongLine (const Point &startPoint, const Point &endPoint, const double lambda)
	Compute the point at some position along the line connecting start- and end-point.

double	GetDeltaXCartesian (const Point &p1, const Point &p2)
	Get the delta-x in Cartesian coordinate system.

double	GetDeltaYCartesian (const Point &p1, const Point &p2)
	Get the delta-y in Cartesian coordinate system.

Vector	GetDeltaCartesian (const Point &p1, const Point &p2)
	Get the delta-x and -y in Cartesian coordinate system.

void	Triangulation (int jatri, double const const xs, double const const ys, int ns, int const index, int const numtri, int const edgeidx, int const numedge, int const triedge, double const xs3, double const ys3, int const ns3, double trisize)
	Function of the Triangle library.

Vector	normalise (const Vector &vec)
	Return the normalised vector.

double	dot (const Vector &v1, const Vector &v2)
	Compute the dot product of two vectors.

double	angleBetween (const Vector &v1, const Vector &v2)
	Compute the angle between two vector.

Vector	operator- (const Vector &vec)
	Unary minus.

Vector	operator+ (const Vector &v1, const Vector &v2)
	Add two vectors.

Vector	operator- (const Vector &v1, const Vector &v2)
	Subtract vector from another.

Vector	operator* (const double alpha, const Vector &vec)
	Multiply vector by a scalar.

Vector	operator* (const Vector &vec, const double alpha)
	Multiply vector by a scalar.

Vector	operator/ (const Vector &vec, const double alpha)
	Divide vector by a scalar.

Detailed Description

Contains the logic of the C++ static library.

Enumeration Type Documentation

◆ CurvilinearDirection

enum class meshkernel::CurvilinearDirection

strong

Direction to use in curvilinear grid algorithms.

Enumerator
M	M-direction.
N	N-direction.

◆ ExitCode

enum meshkernel::ExitCode

Enumeration of exit codes.

Enumerator
Success	Success.
MeshKernelErrorCode	MehKernel error.
NotImplementedErrorCode	Not implemented error.
AlgorithmErrorCode	Algorithm error.
ConstraintErrorCode	Constraint error.
MeshGeometryErrorCode	Geometry error.
LinearAlgebraErrorCode	Linear algebra error.
RangeErrorCode	Range error.
StdLibExceptionCode	Standrad library exception.
UnknownExceptionCode	Unknown exception.

◆ InterpolationDataTypes

enum class meshkernel::InterpolationDataTypes

strong

The possible types of the values to be interpolated in the gridded sample.

Enumerator
Short	short type
Float	float type
Int	int type
Double	double type

◆ Location

enum class meshkernel::Location

strong

Mesh locations enumeration.

Enumerator
Faces	Faces.
Nodes	Nodes.
Edges	Edges.
Unknown	Unknown.

◆ MeshNodeType

enum class meshkernel::MeshNodeType : std::int8_t

strong

Possible unstructured node types.

Enumerator
Hanging	Hanging node.
Unspecified	Initial value, unspecified or invalid nodes.
Internal	Nodes in interior of domain.
Boundary	Nodes on boundary of domain, except corners.
Corner	Nodes at corners.

◆ TraversalDirection

enum class meshkernel::TraversalDirection

strong

Indicator for traversal direction of the points specifying a polygon.

Enumerator
Clockwise	Points define a clockwise traversal of the polygon.
AntiClockwise	Points define a anti-clockwise (counter-clockwise) traversal of the polygon.

Function Documentation

◆ AbsoluteDifference()

UInt meshkernel::AbsoluteDifference	(	UInt	number_1,
		UInt	number_2
	)

Calculates the absolute difference between to Index numbers.

Parameters

[in]	number_1	The first number
[in]	number_2	The second number

◆ AddIncrementToPoint()

void meshkernel::AddIncrementToPoint	(	const Point &	normal,
		double	increment,
		const Point &	referencePoint,
		const Projection &	projection,
		Point &	point
	)

Moves a point by adding an increment vector to it.

Parameters

[in]	normal	The increment direction.
[in]	increment	The increment to use.
[in]	referencePoint	The reference point containing the reference latitude to use.
[in]	projection	The coordinate system projection.
[in,out]	point	The point to be incremented.

◆ AreSegmentsCrossing()

std::tuple< bool, Point, double, double, double > meshkernel::AreSegmentsCrossing	(	const Point &	firstSegmentFirstPoint,
		const Point &	firstSegmentSecondPoint,
		const Point &	secondSegmentFirstPoint,
		const Point &	secondSegmentSecondPoint,
		bool	adimensionalCrossProduct,
		const Projection &	projection
	)

Determines if two segments are crossing (cross, cross3D)

Parameters

[in]	firstSegmentFirstPoint	The first point of the first segment
[in]	firstSegmentSecondPoint	The second point of the first segment
[in]	secondSegmentFirstPoint	The first point of the second segment
[in]	secondSegmentSecondPoint	The second point of the second segment
[in]	adimensionalCrossProduct	Whether to compute the dimensionless cross product
[in]	projection	The coordinate system projection

Returns: A tuple with: If the two segments are crossing The intersection point The cross product of the intersection The distance of the intersection from the first node of the first segment, expressed as a ratio of the segment length The distance of the intersection from the first node of the second segment, expressed as a ratio of the segment length

◆ Cartesian3DToSpherical()

Point meshkernel::Cartesian3DToSpherical	(	const Cartesian3DPoint &	cartesianPoint,
		double	referenceLongitude
	)

Transforms 3D cartesian coordinates to 2D point in spherical coordinates.

Parameters

[in]	cartesianPoint	The 3d cartesian point
[in]	referenceLongitude	The reference longitude

Returns: The spherical coordinate

◆ ComputeAdimensionalDistancesFromPointSerie()

std::tuple< std::vector< double >, double > meshkernel::ComputeAdimensionalDistancesFromPointSerie	(	const std::vector< Point > &	v,
		const Projection &	projection
	)

Computes dimensionless distances of a vector of points such as the first entry has distance 0 and the last entry has distance 1.

Parameters

[in]	v	The vector of points
[in]	projection	The projection to use.

Returns: The dimensionless distances and the dimensional total distance (used for normalization)

◆ ComputeAverageCoordinate()

Point meshkernel::ComputeAverageCoordinate	(	const std::span< const Point >	points,
		const Projection &	projection
	)

Given a series of point computes the average coordinate.

Parameters

[in]	points	The point series.
[in]	projection	The projection to use.

Returns: The average coordinate.

◆ ComputeDistance()

double meshkernel::ComputeDistance	(	const Point &	firstPoint,
		const Point &	secondPoint,
		const Projection &	projection
	)

Computes the distance between two points (dbdistance)

Parameters

[in]	firstPoint	The first point.
[in]	secondPoint	The second point.
[in]	projection	The coordinate system projection.

Returns: The distance

◆ ComputeEdgeCenters()

std::vector< Point > meshkernel::ComputeEdgeCenters	(	const std::vector< Point > &	nodes,
		const std::vector< Edge > &	edges
	)

Computes the edge centers.

Parameters

[in]	nodes	The vector of edge nodes.
[in]	edges	The vector of edge indices.

Returns: The vector containing the edge centers.

◆ ComputeMiddlePoint()

Point meshkernel::ComputeMiddlePoint	(	const Point &	firstPoint,
		const Point &	secondPoint,
		const Projection &	projection
	)

Computes the middle point.

Parameters

[in]	firstPoint	The first point of the segment.
[in]	secondPoint	The second point of the segment.
[in]	projection	The coordinate system projection.

Returns: The middle point.

◆ ComputeMiddlePointAccountingForPoles()

Point meshkernel::ComputeMiddlePointAccountingForPoles	(	const Point &	firstPoint,
		const Point &	secondPoint,
		const Projection &	projection
	)

Computes the middle point (account for poles, latitudes close to 90 degrees)

Parameters

[in]	firstPoint	The first point of the segment.
[in]	secondPoint	The second point of the segment.
[in]	projection	The coordinate system projection.

Returns: The middle point.

◆ ComputeNormalToline()

Vector meshkernel::ComputeNormalToline	(	const Point &	start,
		const Point &	end,
		const Projection	projection
	)

Get the normal to the line described by the two points.

The vector is normalised.

Parameters

[in]	start	Point at the start of the line
[in]	end	Point at the end of the line
[in]	projection	The coordinate system projection.

◆ ComputePointOnSplineAtAdimensionalDistance()

template<typename T >

T meshkernel::ComputePointOnSplineAtAdimensionalDistance	(	const std::vector< T > &	coordinates,
		const std::vector< T > &	coordinatesDerivatives,
		double	pointAdimensionalCoordinate
	)

Computes the coordinate of a point on a spline, given the dimensionless distance from the first corner point (splint)

Parameters

[in]	coordinates	The spline node coordinates
[in]	coordinatesDerivatives	The spline nodal derivatives
[in]	pointAdimensionalCoordinate	The adimensinal coordinate where to perform the interpolation

Returns: The interpolated point

◆ ComputePolyLineDiscretization()

std::vector< Point > meshkernel::ComputePolyLineDiscretization	(	std::vector< Point > const &	polyline,
		std::vector< double > &	chainages,
		Projection	projection
	)

Computes the discretization points along a polyline.

Parameters

polyline	A polyline described by its nodes
chainages	The chainages used for dicretizing the current polyline
projection	The projection to use

Returns: The discretized polyline

◆ ComputePolyLineEdgesLengths()

std::vector< double > meshkernel::ComputePolyLineEdgesLengths	(	std::vector< Point > const &	polyline,
		Projection	projection
	)

Computes the lengths of each polyline segment.

Parameters

polyline	A polyline described by its nodes
projection	The projection to use

Returns: A vector containing the lengths of each polyline segment

◆ ComputePolyLineNodalChainages()

std::vector< double > meshkernel::ComputePolyLineNodalChainages	(	std::vector< Point > const &	polyline,
		Projection	projection
	)

Computes the chainages of each polyline node.

Parameters

polyline	A polyline described by its nodes
projection	The projection to use

Returns: A vector containing the chainage volau of the polyline nodes

◆ ComputeSphericalCoordinatesFromLatitudeAndLongitude()

std::tuple< double, double, double > meshkernel::ComputeSphericalCoordinatesFromLatitudeAndLongitude ( const Point & point )

Converts geographic coordinates (latitude and longitude) to 3D spherical Cartesian coordinates.

Parameters

[in] point The input point specified in latitude and longitude (in degrees).

Returns: A tuple containing the corresponding (x, y, z) coordinates on the sphere.

◆ ComputeSquaredDistance()

double meshkernel::ComputeSquaredDistance	(	const Point &	firstPoint,
		const Point &	secondPoint,
		const Projection &	projection
	)

Computes the squared distance between two points This is faster than ComputeDistance because it does not take the square root.

Parameters

[in]	firstPoint	The first point.
[in]	secondPoint	The second point.
[in]	projection	The coordinate system projection.

Returns: The squared distance

◆ cross()

double meshkernel::cross	(	const Point &	p1,
		const Point &	p2
	)

inline

Compute the cross product of two points (as vectors).

This is mainly a convenience function

◆ crossProduct()

double meshkernel::crossProduct	(	const Point &	firstSegmentFirstPoint,
		const Point &	firstSegmentSecondPoint,
		const Point &	secondSegmentFirstPoint,
		const Point &	secondSegmentSecondPoint,
		const Projection &	projection
	)

Computes the cross product between two segments (duitpl)

Parameters

[in]	firstSegmentFirstPoint	The first point of the first segment
[in]	firstSegmentSecondPoint	The second point of the first segment
[in]	secondSegmentFirstPoint	The second point of the second segment
[in]	secondSegmentSecondPoint	The second point of the second segment
[in]	projection	The coordinate system projection

Returns: The cross product value

◆ DiscretizeTransfinite()

lin_alg::Matrix< Point > meshkernel::DiscretizeTransfinite	(	const std::vector< Point > &	leftDiscretization,
		const std::vector< Point > &	rightDiscretization,
		const std::vector< Point > &	bottomDiscretization,
		const std::vector< Point > &	upperDiscretization,
		const Projection &	projection,
		UInt	numM,
		UInt	numN
	)

Computes the transfinite discretization inside the area defined by 4 sides, each one discretized with a series of points (tranfn2).

Parameters

[in]	leftDiscretization	The discretization of the left side.
[in]	rightDiscretization	The discretization of the right side.
[in]	bottomDiscretization	The discretization of the bottom.
[in]	upperDiscretization	The discretization of the upper side.
[in]	projection	The projection to use.
[in]	numM	The number of columns to generate.
[in]	numN	The number of rows to generate.

Returns: The resulting dicretization (expressed as number of points).

◆ DistanceFromLine()

std::tuple< double, Point, double > meshkernel::DistanceFromLine	(	const Point &	point,
		const Point &	firstNode,
		const Point &	secondNode,
		const Projection &	projection
	)

Computes the perpendicular distance of a point from a segment firstNode - secondNode (dlinedis3)

Parameters

[in]	point	The point to consider in the distance calculation.
[in]	firstNode	The first point of the segment.
[in]	secondNode	The second point of the segment.
[in]	projection	The coordinate system projection.

Returns: The normal distance from the segment, the intersection of the normal projection on the segment, the distance from the first node, expressed as ratio of the segment length

◆ dot() [1/3]

double meshkernel::dot	(	const Point &	p,
		const Vector &	v
	)

inline

Compute the dot product of a point and a vector.

This is mainly a convenience function

◆ dot() [2/3]

double meshkernel::dot	(	const Point &	p1,
		const Point &	p2
	)

inline

Compute the dot product of two points.

This is mainly a convenience function

◆ dot() [3/3]

double meshkernel::dot	(	const Vector &	v,
		const Point &	p
	)

inline

Compute the dot product of a point and a vector.

This is mainly a convenience function

◆ FindFunctionRootWithGoldenSectionSearch()

template<typename F >

double meshkernel::FindFunctionRootWithGoldenSectionSearch	(	F	func,
		double	min,
		double	max
	)

Algorithm performing the zero's search using the golden section algorithm's.

Parameters

[in]	func	Function to search for a root
[in]	min	The minimum value of the interval
[in]	max	The maximum value of the interval

Returns: The value where the function is approximately 0

◆ FindIndex()

template<typename T >

UInt meshkernel::FindIndex	(	const std::vector< T > &	vec,
		T	el
	)

Find index of a certain element.

Parameters

[in]	vec	The vector to search in
[in]	el	The element to search for

Returns: The index of element

◆ FindIndices()

std::vector< std::pair< UInt, UInt > > meshkernel::FindIndices	(	const std::vector< Point > &	vec,
		size_t	start,
		size_t	end,
		double	separator
	)

Find all start-end positions in a vector separated by a separator.

Parameters

[in]	vec	The vector with separator
[in]	start	The start of the range to search for
[in]	end	The end of the range to search for
[in]	separator	The value of the separator

Returns: Indices of elements

◆ GetCurvilinearDirectionValue()

CurvilinearDirection meshkernel::GetCurvilinearDirectionValue ( int direction )

Convert an integer value to the CurvilinearDirection enumeration type.

If the integer direction value does not correspond to an enumeration value then a ConstraintError will be thrown

◆ GetDelta()

Vector meshkernel::GetDelta	(	const Point &	firstPoint,
		const Point &	secondPoint,
		const Projection &	projection
	)

Get the delta (dx, dy) for the given projection.

Parameters

[in]	firstPoint
[in]	secondPoint
[in]	projection	The coordinate system projection.

◆ GetDx()

double meshkernel::GetDx	(	const Point &	firstPoint,
		const Point &	secondPoint,
		const Projection &	projection
	)

Gets dx for the given projection.

Parameters

[in]	firstPoint
[in]	secondPoint
[in]	projection	The coordinate system projection.

◆ GetDy()

double meshkernel::GetDy	(	const Point &	firstPoint,
		const Point &	secondPoint,
		const Projection &	projection
	)

Gets dy for the given projection.

Parameters

[in]	firstPoint
[in]	secondPoint
[in]	projection	The coordinate system projection.

◆ GetProjectionValue()

Projection meshkernel::GetProjectionValue ( int projection )

Convert an integer value to the Projection enumeration type.

If the integer projection value does not correspond to an enumeration value then a ConstraintError will be thrown

◆ InnerProduct()

double meshkernel::InnerProduct	(	const Cartesian3DPoint &	a,
		const Cartesian3DPoint &	b
	)

inline

Defines inner product in cartesian 3D-space.

Parameters

[in]	a	The first cartesian 3D point
[in]	b	The second cartesian 3D point

Returns: The resulting inner product

◆ InnerProductTwoSegments()

double meshkernel::InnerProductTwoSegments	(	const Point &	firstPointFirstSegment,
		const Point &	secondPointFirstSegment,
		const Point &	firstPointSecondSegment,
		const Point &	secondPointSecondSegment,
		const Projection &	projection
	)

Inner product of two segments (dprodin)

Parameters

[in]	firstPointFirstSegment	The first point of the first segment
[in]	secondPointFirstSegment	The second point of the first segment
[in]	firstPointSecondSegment	The first point of the second segment
[in]	secondPointSecondSegment	The second point of the second segment
[in]	projection	The coordinate system projection

Returns: The resulting inner product

◆ InvalidPointCount()

UInt meshkernel::InvalidPointCount	(	const std::vector< Point > &	points,
		size_t	start,
		size_t	end
	)

Determine if the number of invalid points in the section of the point array.

Parameters

[in]	points	The array of points
[in]	start	The start of the range in which to search
[in]	end	The end of the range in which to search

◆ IsEqual()

bool meshkernel::IsEqual	(	const Point &	p1,
		const Point &	p2,
		const double	epsilon
	)

inline

Test points for equality upto a tolerance.

Parameters

[in]	p1	First point to compare
[in]	p2	Second point to compare
[in]	epsilon	Relative tolerance to which the values are compared.

Returns: Boolean value indicating where the points p1 and p2 are equal upto a relative tolerance.

◆ IsPointInPolygonNodes() [1/2]

bool meshkernel::IsPointInPolygonNodes	(	const Point &	point,
		const std::vector< Point > &	polygonNodes,
		const Projection &	projection,
		const BoundingBox &	boundingBox,
		Point	polygonCenter = `{constants::missing::doubleValue, constants::missing::doubleValue}`,
		UInt	startNode = `constants::missing::uintValue`,
		UInt	endNode = `constants::missing::uintValue`
	)

Checks if a point is in polygonNodes using the winding number method.

Parameters

[in]	point	The point to check
[in]	polygonNodes	A series of closed polygons
[in]	projection	The coordinate system projection.
[in]	boundingBox	The bounding box of the polygon nodes
[in]	startNode	The start index in polygonNodes
[in]	endNode	The end index in polygonNodes
[in]	polygonCenter	A coordinate needed in case of sphericalAccurate projection

Returns: If point is inside the designated polygon

◆ IsPointInPolygonNodes() [2/2]

bool meshkernel::IsPointInPolygonNodes	(	const Point &	point,
		const std::vector< Point > &	polygonNodes,
		const Projection &	projection,
		Point	polygonCenter = `{constants::missing::doubleValue, constants::missing::doubleValue}`,
		UInt	startNode = `constants::missing::uintValue`,
		UInt	endNode = `constants::missing::uintValue`
	)

Checks if a point is in polygonNodes using the winding number method.

Parameters

[in]	point	The point to check
[in]	polygonNodes	A series of closed polygons
[in]	startNode	The start index in polygonNodes
[in]	endNode	The end index in polygonNodes
[in]	projection	The coordinate system projection.
[in]	polygonCenter	A coordinate needed in case of sphericalAccurate projection

Returns: If point is inside the designated polygon

◆ IsPointInTriangle()

bool meshkernel::IsPointInTriangle	(	const Point &	point,
		const std::span< const Point >	triangleNodes,
		const Projection &	projection
	)

Checks if a point is in triangle using the winding number method.

Parameters

[in]	point	The point to check
[in]	triangleNodes	A series of node forming an open triangle
[in]	projection	The coordinate system projection.

Returns: If point is inside the designated triangle

◆ IsPointOnPole()

bool meshkernel::IsPointOnPole ( const Point & point )

Determines if a point is close to the poles (latitude close to 90 degrees).

Parameters

[in] point The current point.

Returns: If the point is on the pole.

◆ lengthSquared()

double meshkernel::lengthSquared ( const Point & p1 )

inline

Compute the dot product of a point with itself.

This is mainly a convenience function

◆ LinearInterpolationInTriangle()

double meshkernel::LinearInterpolationInTriangle	(	const Point &	interpolationPoint,
		const std::vector< Point > &	polygon,
		const std::vector< double > &	values,
		const Projection &	projection
	)

Given a triangles with values on each node, computes the interpolated value inside the triangle, using linear interpolation.

Parameters

[in]	interpolationPoint	The point where to interpolate.
[in]	polygon	The polygon containing the triangle nodes.
[in]	values	The values at each node.
[in]	projection	The projection to use.

Returns: The interpolated value.

◆ MatrixNorm()

double meshkernel::MatrixNorm	(	const std::vector< double > &	x,
		const std::vector< double > &	y,
		const std::vector< double > &	matCoefficients
	)

Compute the matrix norm.

x [in] To be detailed

y [in] To be detailed

matCoefficients [in] To be detailed

Returns: The computed matrix norm

◆ NextCircularBackwardIndex()

UInt meshkernel::NextCircularBackwardIndex	(	UInt	currentIndex,
		UInt	size
	)

Get the next backward index, for a range in 0 .. size-1.

Parameters

[in]	currentIndex	The current index.
[in]	size	The size of the vector.

Returns: The next backward index.

◆ NextCircularForwardIndex()

UInt meshkernel::NextCircularForwardIndex	(	UInt	currentIndex,
		UInt	size
	)

Get the next forward index, for a range in 0 .. size-1.

Parameters

[in]	currentIndex	The current index.
[in]	size	The size of the vector.

Returns: The next forward index.

◆ normalise()

meshkernel::Vector meshkernel::normalise ( const Vector & vec )

inline

Return the normalised vector.

Note: No check is made that the length is 0

◆ NormalizedInnerProductTwoSegments()

double meshkernel::NormalizedInnerProductTwoSegments	(	const Point &	firstPointFirstSegment,
		const Point &	secondPointFirstSegment,
		const Point &	firstPointSecondSegment,
		const Point &	secondPointSecondSegment,
		const Projection &	projection
	)

The normalized inner product of two segments (dcosphi)

Parameters

[in]	firstPointFirstSegment	The first point of the first segment
[in]	secondPointFirstSegment	The second point of the first segment
[in]	firstPointSecondSegment	The first point of the second segment
[in]	secondPointSecondSegment	The second point of the second segment
[in]	projection	The coordinate system projection

Returns: The resulting normalized inner product

◆ NormalVector()

Point meshkernel::NormalVector	(	const Point &	firstPoint,
		const Point &	secondPoint,
		const Point &	insidePoint,
		const Projection &	projection
	)

Normalized vector of a segment in direction 1 -> 2 with the insidePoint orientation.

Parameters

[in]	firstPoint	The first point of the segment.
[in]	secondPoint	The second point of the segment.
[in]	insidePoint	The inside point of the segment
[in]	projection	The coordinate system projection.

Returns: The Normal vector

◆ NormalVectorInside()

void meshkernel::NormalVectorInside	(	const Point &	firstPoint,
		const Point &	secondPoint,
		const Point &	insidePoint,
		Point &	normal,
		bool &	flippedNormal,
		const Projection &	projection
	)

Computes the normal vector to a line 1-2, which is outward w.r.t. an 'inside' point 3.

Similar to NormalVectorOutside, except that the normal vector may be flipped based on the 'inside' point.

◆ NormalVectorOutside()

Point meshkernel::NormalVectorOutside	(	const Point &	firstPoint,
		const Point &	secondPoint,
		const Projection &	projection
	)

Computes the normal vector outside (normalout)

See also: NormalVectorInside

◆ operator!=()

bool meshkernel::operator!=	(	const Point &	p1,
		const Point &	p2
	)

inline

Test points for equality using a default tolerance.

Returns: \( p1.x = p2.x \wedge p1.y = p2.y)\)

◆ operator*() [1/3]

meshkernel::Point meshkernel::operator*	(	const double	x,
		const Point &	p
	)

inline

Multiply point by a scalar.

Returns: \( (p.x * x, p.y * x)\)

◆ operator*() [2/3]

meshkernel::Point meshkernel::operator*	(	const Point &	p,
		const double	x
	)

inline

Multiply point by a scalar.

Returns: \( (p.x * x, p.y * x)\)

◆ operator*() [3/3]

meshkernel::Point meshkernel::operator*	(	const Point &	p1,
		const Point &	p2
	)

inline

Multiply point by a point.

Computes a point-wise product.

Returns: \( (p1.x * p2.x, p1.y * p2.y)\)

◆ operator+() [1/4]

meshkernel::Point meshkernel::operator+	(	const double	x,
		const Point &	p
	)

inline

Add points and scalar.

Returns: \( (p.x + x, p.y + x)\)

◆ operator+() [2/4]

meshkernel::Point meshkernel::operator+	(	const Point &	p,
		const double	x
	)

inline

Add points and scalar.

Returns: \( (p.x + x, p.y + x)\)

◆ operator+() [3/4]

meshkernel::Point meshkernel::operator+	(	const Point &	p1,
		const Point &	p2
	)

inline

Add two points.

Returns: \( (p1.x + p2.x, p1.y + p2.y)\)

◆ operator+() [4/4]

meshkernel::Point meshkernel::operator+	(	const Point &	pnt,
		const Vector &	vec
	)

inline

Add vector to a point.

Returns: \( (p.x + v.x, p.y + v.y)\)

◆ operator-() [1/6]

meshkernel::Point meshkernel::operator-	(	const double	x,
		const Point &	p
	)

inline

Subtract point from scalar.

Returns: \( (x - p.x, x - p.y)\)

◆ operator-() [2/6]

meshkernel::Point meshkernel::operator-	(	const Point &	p,
		const double	x
	)

inline

Subtract scalar from point.

Returns: \( (p.x - x, p.y - x)\)

◆ operator-() [3/6]

meshkernel::Point meshkernel::operator-	(	const Point &	p1,
		const Point &	p2
	)

inline

Subtract two points.

Returns: \( (p1.x - p2.x, p1.y - p2.y)\)

◆ operator-() [4/6]

meshkernel::Point meshkernel::operator- ( const Point & pnt )

inline

Unary minus.

Returns: \( (-p1.x, -p1.y)\)

◆ operator-() [5/6]

meshkernel::Point meshkernel::operator-	(	const Point &	pnt,
		const Vector &	vec
	)

inline

Subtract vector from a point.

Returns: \( (p.x - v.x, p.y - v.y)\)

◆ operator-() [6/6]

meshkernel::Vector meshkernel::operator- ( const Vector & vec )

inline

Unary minus.

Returns: \( (-vec.x, -vec.y)\)

◆ operator/() [1/2]

meshkernel::Point meshkernel::operator/	(	const Point &	p,
		const double	x
	)

inline

Divide point by a scalar.

Note: No check is made to determine is divisor is zero.

Returns: \( (p.x / x, p.y / x)\)

◆ operator/() [2/2]

meshkernel::Point meshkernel::operator/	(	const Point &	p1,
		const Point &	p2
	)

inline

Divide point by a point.

Computes a point-wise division.

Returns: \( (p1.x / p2.x, p1.y / p2.y)\)

Note: No check is made to determine is divisors are zero.

◆ operator==()

bool meshkernel::operator==	(	const Point &	p1,
		const Point &	p2
	)

inline

Test points for equality using a default tolerance.

Returns: \( p1.x = p2.x \wedge p1.y = p2.y)\)

◆ OrthogonalProjectionOnSegment()

std::tuple< Point, double, bool > meshkernel::OrthogonalProjectionOnSegment	(	Point const &	firstNode,
		Point const &	secondNode,
		Point const &	pointToProject
	)

Cartesian projection of a point on a segment defined by other two points.

Parameters

firstNode	The first node of the segment
secondNode	The second node of the segment
pointToProject	The point to project

Returns: The projected point, the distance of the projection from the first point (expressed as a ratio), a boolean indicating if the projected point is within the first and second point.

◆ PointAlongLine()

meshkernel::Point meshkernel::PointAlongLine	(	const Point &	startPoint,
		const Point &	endPoint,
		const double	lambda
	)

inline

Compute the point at some position along the line connecting start- and end-point.

\( r = (1-\lambda) s + \lambda e \)

◆ ReferencePoint() [1/2]

Point meshkernel::ReferencePoint	(	const std::vector< Point > &	nodes,
		const std::vector< UInt > &	polygonIndices,
		const Projection &	projection
	)

For a given polygon compute a reference point.

Parameters

[in]	nodes	The input nodes
[in]	polygonIndices	The polygon node indices.
[in]	projection	The coordinate system projection.

Returns: The reference point

◆ ReferencePoint() [2/2]

Point meshkernel::ReferencePoint	(	const std::vector< Point > &	polygon,
		const Projection &	projection
	)

For a given polygon compute a reference point.

Parameters

[in]	polygon	The input polygon.
[in]	projection	The coordinate system projection.

Returns: The reference point

◆ ReorderVector()

template<typename T >

auto meshkernel::ReorderVector	(	const std::vector< T > &	v,
		const std::vector< UInt > &	order
	)

Reorder vector accordingly to a specific order.

Parameters

[in]	v	The vector to reorder
[in]	order	The order to use

Returns: The reordered vector

◆ ResizeAndFill2DVector()

template<typename T >

void meshkernel::ResizeAndFill2DVector	(	std::vector< std::vector< T > > &	v,
		UInt const &	firstDimension,
		UInt const &	secondDimension,
		bool	fill = `false`,
		const T &	fillValue = `{}`
	)

Resizes and fills a two dimensional vector.

Template Parameters

T	The type of the vector elements

Parameters

[in]	v	The input two dimensional vector
[in]	firstDimension	The first new dimension
[in]	secondDimension	The second new dimension
[in]	fill	Whatever fill or not fill the vector with missing values
[in]	fillValue	The fill value

◆ ResizeAndFill3DVector()

template<typename T >

void meshkernel::ResizeAndFill3DVector	(	std::vector< std::vector< std::vector< T > > > &	v,
		UInt const &	firstDimension,
		UInt const &	secondDimension,
		UInt const &	thirdDim,
		bool	fill = `false`,
		const T &	fillValue = `{}`
	)

Resizes and fills a three dimensional vector.

Template Parameters

T	The type of the vector elements

Parameters

[in]	v	The input three dimensional vector
[in]	firstDimension	The first new dimension
[in]	secondDimension	The second new dimension
[in]	thirdDim	The third new dimension
[in]	fill	Whatever fill or not fill the vector with missing values
[in]	fillValue	The fill value

◆ sgn()

template<typename T >

int meshkernel::sgn ( T val )

Computes the sign of a type.

Template Parameters

T	A signed type

Parameters

[in] val the value to use for computing a sign

Returns: -1 for negatives and +1 for positives

◆ SortedIndices()

template<typename T >

std::vector< UInt > meshkernel::SortedIndices ( const std::vector< T > & v )

Sort a vector and return the sorted indices.

Parameters

[in] v The vector to sort

Returns: The indices of elements

◆ SphericalToCartesian3D()

Cartesian3DPoint meshkernel::SphericalToCartesian3D ( const Point & sphericalPoint )

Transforms 2D point in spherical coordinates to 3D cartesian coordinates.

Parameters

[in] sphericalPoint The current spherical point (2 coordinates).

Returns: The converted cartesian 3d point.

◆ TranslateSphericalCoordinates()

void meshkernel::TranslateSphericalCoordinates ( std::vector< Point > & polygon )

For a given polygon the function may shift the input coordinates.

Parameters

[in,out] polygon The input polygon.

Note: To be called for spherical coordinate system only

◆ Triangulation()

void meshkernel::Triangulation	(	int	jatri,
		double const *const	xs,
		double const *const	ys,
		int	ns,
		int *const	index,
		int *const	numtri,
		int *const	edgeidx,
		int *const	numedge,
		int *const	triedge,
		double *const	xs3,
		double *const	ys3,
		int *const	ns3,
		double	trisize
	)

Function of the Triangle library.

See also: https://www.cs.cmu.edu/~quake/triangle.html

◆ VectorProduct()

Cartesian3DPoint meshkernel::VectorProduct	(	const Cartesian3DPoint &	a,
		const Cartesian3DPoint &	b
	)

Defines vector product for cartesian 3D-space.

Parameters

[in]	a	The first cartesian 3D point
[in]	b	The second cartesian 3D point

Returns: The vector product

Classes

Typedefs

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ CurvilinearDirection

◆ ExitCode

◆ InterpolationDataTypes

◆ Location

◆ MeshNodeType

◆ TraversalDirection

Function Documentation

◆ AbsoluteDifference()

◆ AddIncrementToPoint()

◆ AreSegmentsCrossing()

◆ Cartesian3DToSpherical()

◆ ComputeAdimensionalDistancesFromPointSerie()

◆ ComputeAverageCoordinate()

◆ ComputeDistance()

◆ ComputeEdgeCenters()

◆ ComputeMiddlePoint()

◆ ComputeMiddlePointAccountingForPoles()

◆ ComputeNormalToline()

◆ ComputePointOnSplineAtAdimensionalDistance()

◆ ComputePolyLineDiscretization()

◆ ComputePolyLineEdgesLengths()

◆ ComputePolyLineNodalChainages()

◆ ComputeSphericalCoordinatesFromLatitudeAndLongitude()

◆ ComputeSquaredDistance()

◆ cross()

◆ crossProduct()

◆ DiscretizeTransfinite()

◆ DistanceFromLine()

◆ dot() [1/3]

◆ dot() [2/3]

◆ dot() [3/3]

◆ FindFunctionRootWithGoldenSectionSearch()

◆ FindIndex()

◆ FindIndices()

◆ GetCurvilinearDirectionValue()

◆ GetDelta()

◆ GetDx()

◆ GetDy()

◆ GetProjectionValue()

◆ InnerProduct()

◆ InnerProductTwoSegments()

◆ InvalidPointCount()

◆ IsEqual()

◆ IsPointInPolygonNodes() [1/2]

◆ IsPointInPolygonNodes() [2/2]

◆ IsPointInTriangle()

◆ IsPointOnPole()

◆ lengthSquared()

◆ LinearInterpolationInTriangle()

◆ MatrixNorm()

◆ NextCircularBackwardIndex()

◆ NextCircularForwardIndex()

◆ normalise()

◆ NormalizedInnerProductTwoSegments()

◆ NormalVector()

◆ NormalVectorInside()

◆ NormalVectorOutside()

◆ operator!=()

◆ operator*() [1/3]

◆ operator*() [2/3]

◆ operator*() [3/3]

◆ operator+() [1/4]

◆ operator+() [2/4]

◆ operator+() [3/4]

◆ operator+() [4/4]

◆ operator-() [1/6]

◆ operator-() [2/6]

◆ operator-() [3/6]

◆ operator-() [4/6]

◆ operator-() [5/6]

◆ operator-() [6/6]

◆ operator/() [1/2]

◆ operator/() [2/2]

◆ operator==()