MeshKernel
Public Member Functions | List of all members
meshkernel::Hessian Class Reference

The hessian values. More...

#include <Hessian.hpp>

Public Member Functions

 Hessian ()=default
 Default constructor.
 
 Hessian (const UInt dim1, const UInt dim2, const UInt dim3)
 Constructor taking 3 parameters.
 
void resize (const UInt dim1, const UInt dim2, const UInt dim3)
 Resize taking 3 parameters.
 
UInt size (const UInt dim) const
 Get the dimension for each dimension. More...
 
const HessianDimensionsize () const
 Get all the Hessian dimensions.
 
UInt get1DIndex (const UInt dim2, const UInt dim3) const
 Get the 1-dimension index of.
 
double operator() (const UInt dim1, const UInt dim2, const UInt dim3) const
 Get the value of the hessian.
 
double & operator() (const UInt dim1, const UInt dim2, const UInt dim3)
 Get the value of the hessian.
 
double operator() (const UInt dim1, const UInt dim2) const
 Access the matrix in 'dim1' as though it were a 1 dimensional array. More...
 
const MatrixColMajorgetMatrix (const UInt dim) const
 Get the matrix for a dimension.
 
MatrixColMajorgetMatrix (const UInt dim)
 Get the matrix for a dimension.
 
void zero ()
 Set all entries to zero.
 

Detailed Description

The hessian values.

Implemented as an array of matrices. Not sure what is the best implementation yet for performance.

Member Function Documentation

◆ operator()()

double meshkernel::Hessian::operator() ( const UInt  dim1,
const UInt  dim2 
) const
inline

Access the matrix in 'dim1' as though it were a 1 dimensional array.

dim2 = i + size(1) * j?

◆ size()

meshkernel::UInt meshkernel::Hessian::size ( const UInt  dim) const
inline

Get the dimension for each dimension.

Parameters
[in]dimFor which dimension is the size required, dim in range [0,2]

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