Template Class Kinsol

Inheritance Relationships

Base Type

Class Documentation

template<class ScalarT, typename IdxT>
class Kinsol : public AnalysisManager::SteadyStateSolver<ScalarT, IdxT>

Public Functions

int runSimulation(std::span<ScalarT> values, ResidualFunction residual, bool line_search = true)

Use the given values as the initial guess and return the accepted solution in the same vector.

Parameters:

  • values – [inout] initial guess, overwritten with the solution

  • residual – function that fills the residual for trial values and returns zero on success

  • line_search – whether or not to use KINSOL’s backtracking line search

void setFunctionError(RealT error)

Estimated relative error of residual evaluations.

This is used to choose finite-difference perturbations.

void setJacobianUpdateInterval(long int iterations)

Maximum number of Newton iterations between Jacobian evaluations.