Reaktoro
A unified framework for modeling chemically reactive systems

Reaktoro::NonlinearResidual Struct Reference
Detailed Description
A type that describes the evaluation result of a nonlinear residual function.
#include <NonlinearSolver.hpp>
Public Attributes  
Vector  val 
The residual vector of the nonlinear residual function evaluated at x .  
Matrix  jacobian 
The Jacobian matrix of the nonlinear residual function evaluated at x .  
bool  succeeded = true 
The boolean flag that indicates if the nonlinear function evaluation succeeded. More...  
Member Data Documentation
bool Reaktoro::NonlinearResidual::succeeded = true 
The boolean flag that indicates if the nonlinear function evaluation succeeded.
This should be set to false whenever the evaluation of the nonlinear 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:
 Reaktoro/Optimization/NonlinearSolver.hpp