meshkernelapi::EdgeLengthPropertyCalculator Class Reference

Calculator for the edge lengths for a mesh. More...

#include <PropertyCalculator.hpp>

Inheritance diagram for meshkernelapi::EdgeLengthPropertyCalculator:

Public Member Functions
virtual bool	IsValid (const MeshKernelState &state, const meshkernel::Location location) const override
	Determine is the calculator can compute the desired results correctly.
void	Calculate (const MeshKernelState &state, const meshkernel::Location location, const GeometryList &geometryList) const override
	Calculate the edge-length for a mesh.
int	Size (const MeshKernelState &state, const meshkernel::Location location) const override
	Determine the size of the edge-length vector required.
Public Member Functions inherited from meshkernelapi::PropertyCalculator
virtual	~PropertyCalculator ()=default
	Destructor.

Detailed Description

Calculator for the edge lengths for a mesh.

Member Function Documentation

Calculate()

void meshkernelapi::EdgeLengthPropertyCalculator::Calculate ( const MeshKernelState &  state, const meshkernel::Location  location, const GeometryList &  geometryList  ) const

overridevirtual

Calculate the edge-length for a mesh.

Note

This calculator is for mesh edges only

Implements meshkernelapi::PropertyCalculator.

IsValid()

virtual bool meshkernelapi::EdgeLengthPropertyCalculator::IsValid ( const MeshKernelState &  state, const meshkernel::Location  location  ) const

overridevirtual

Determine is the calculator can compute the desired results correctly.

This has a default of checking that the mesh2d is valid and the location is at edges

Implements meshkernelapi::PropertyCalculator.

Size()

int meshkernelapi::EdgeLengthPropertyCalculator::Size ( const MeshKernelState &  state, const meshkernel::Location  location  ) const

overridevirtual

Determine the size of the edge-length vector required.

Implements meshkernelapi::PropertyCalculator.

---

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

• /home/runner/work/MeshKernel/MeshKernel/libs/MeshKernelApi/include/MeshKernelApi/PropertyCalculator.hpp