vtkm::NewtonsMethodResult< ScalarType, Size > Struct Template Reference

An object returned from NewtonsMethod() that contains the result and other information about the final state. More...

#include <NewtonsMethod.h>

Public Attributes
bool	Valid
	True if Newton's method ran into a singularity. More...
bool	Converged
	True if Newton's method converted to below the convergence value. More...
vtkm::Vec< ScalarType, Size >	Solution
	The solution found by Newton's method. More...

Detailed Description

template<typename ScalarType, vtkm::IdComponent Size>
struct vtkm::NewtonsMethodResult< ScalarType, Size >

An object returned from NewtonsMethod() that contains the result and other information about the final state.

Member Data Documentation

Converged

template<typename ScalarType , vtkm::IdComponent Size>

bool vtkm::NewtonsMethodResult< ScalarType, Size >::Converged

True if Newton's method converted to below the convergence value.

Solution

template<typename ScalarType , vtkm::IdComponent Size>

vtkm::Vec<ScalarType, Size> vtkm::NewtonsMethodResult< ScalarType, Size >::Solution

The solution found by Newton's method.

If Converged is false, then this value is likely inaccurate. If Valid is false, then this value is undefined.

Valid

template<typename ScalarType , vtkm::IdComponent Size>

bool vtkm::NewtonsMethodResult< ScalarType, Size >::Valid

True if Newton's method ran into a singularity.

---

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

• NewtonsMethod.h