Class SUNNonLinSolNewton¶
Defined in File sundials_linsol_wrapper.h
Inheritance Relationships¶
Base Type¶
public amici::SUNNonLinSolWrapper
(Class SUNNonLinSolWrapper)
Class Documentation¶
-
class
amici
::
SUNNonLinSolNewton
: public amici::SUNNonLinSolWrapper¶ SUNDIALS Newton non-linear solver to solve F (y) = 0.
Public Functions
-
SUNNonLinSolNewton
(N_Vector x)¶ Create Newton solver.
- Parameters
x
: A template for cloning vectors needed within the solver.
-
SUNNonLinSolNewton
(int count, N_Vector x)¶ Create Newton solver for enabled sensitivity analysis.
- Parameters
count
: Number of vectors in the nonlinear solve. When integrating a system containing Ns sensitivities the value of count is:Ns+1 if using a simultaneous corrector approach.
Ns if using a staggered corrector approach.
x
: A template for cloning vectors needed within the solver.
-
int
getSysFn
(SUNNonlinSolSysFn *SysFn) const¶ Get function to evaluate the nonlinear residual function F(y) = 0.
- Return
- Parameters
SysFn
:
-