Reaktoro
A unified framework for modeling chemically reactive systems
NonlinearResidual Struct Reference

A type that describes the evaluation result of a non-linear residual function. More...

#include <NonlinearSolver.hpp>

Public Attributes

Vector val
 The residual vector of the non-linear residual function evaluated at x.
 
Matrix jacobian
 The Jacobian matrix of the non-linear residual function evaluated at x.
 
bool succeeded = true
 The boolean flag that indicates if the non-linear function evaluation succeeded. More...
 

Detailed Description

A type that describes the evaluation result of a non-linear residual function.

Member Data Documentation

bool succeeded = true

The boolean flag that indicates if the non-linear function evaluation succeeded.

This should be set to false whenever the evaluation of the non-linear function fails. For example, when it produces inf or nan values, or when this function relies on more complicated ones that can fail.


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