meshkernelapi::PropertyCalculator Class Reference

Base class for calculating properties for a mesh. More...

#include <PropertyCalculator.hpp>

Inheritance diagram for meshkernelapi::PropertyCalculator:

Public Member Functions
virtual	~PropertyCalculator ()=default
	Destructor.
virtual bool	IsValid (const MeshKernelState &state, const meshkernel::Location location) const =0
	Determine is the calculator can compute the desired results correctly.
virtual void	Calculate (const MeshKernelState &state, const meshkernel::Location location, const GeometryList &geometryList) const =0
	Calculate the property.
virtual int	Size (const MeshKernelState &state, const meshkernel::Location location) const =0
	Determine the size of the vector required to store the calculated properties.

Detailed Description

Base class for calculating properties for a mesh.

Member Function Documentation

Calculate()

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

pure virtual

Calculate the property.

Implemented in meshkernelapi::OrthogonalityPropertyCalculator, meshkernelapi::EdgeLengthPropertyCalculator, and meshkernelapi::InterpolatedSamplePropertyCalculator.

IsValid()

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

pure virtual

Determine is the calculator can compute the desired results correctly.

Implemented in meshkernelapi::OrthogonalityPropertyCalculator, meshkernelapi::EdgeLengthPropertyCalculator, and meshkernelapi::InterpolatedSamplePropertyCalculator.

Size()

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

pure virtual

Determine the size of the vector required to store the calculated properties.

Implemented in meshkernelapi::OrthogonalityPropertyCalculator, meshkernelapi::EdgeLengthPropertyCalculator, and meshkernelapi::InterpolatedSamplePropertyCalculator.

---

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

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