Reaktoro
A unified framework for modeling chemically reactive systems
NonlinearSolver Class Reference

A type that implements the Newton algorithm for solving non-linear problems. More...

#include <NonlinearSolver.hpp>

Public Member Functions

 NonlinearSolver ()
 Construct a default NonlinearSolver instance.
 
 NonlinearSolver (const NonlinearSolver &other)
 Construct a copy of an NonlinearSolver instance.
 
virtual ~NonlinearSolver ()
 Destroy this NonlinearSolver instance.
 
auto operator= (NonlinearSolver other) -> NonlinearSolver &
 Assign an NonlinearSolver instance to this.
 
auto solve (const NonlinearProblem &problem, VectorRef x) -> NonlinearResult
 Solve a non-linear problem. More...
 
auto solve (const NonlinearProblem &problem, VectorRef x, const NonlinearOptions &options) -> NonlinearResult
 Solve a non-linear problem with given options. More...
 

Detailed Description

A type that implements the Newton algorithm for solving non-linear problems.

Member Function Documentation

◆ solve() [1/2]

auto solve ( const NonlinearProblem problem,
VectorRef  x 
) -> NonlinearResult

Solve a non-linear problem.

Parameters
problemThe definition of the non-linear problem.
x[in,out]The initial guess and the final solution of the calculation.

◆ solve() [2/2]

auto solve ( const NonlinearProblem problem,
VectorRef  x,
const NonlinearOptions options 
) -> NonlinearResult

Solve a non-linear problem with given options.

Parameters
problemThe definition of the non-linear problem.
x[in,out]The initial guess and the final solution of the calculation.
optionsThe options for the calculation.

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