pyHarm.NonLinearSolver.NewtonRaphson
====================================

.. py:module:: pyHarm.NonLinearSolver.NewtonRaphson


Classes
-------

.. autoapisummary::

   pyHarm.NonLinearSolver.NewtonRaphson.Solver_NewtonRaphson


Module Contents
---------------

.. py:class:: Solver_NewtonRaphson(residual, jacobian, solver_options)

   Bases: :py:obj:`pyHarm.NonLinearSolver.ABCNonLinearSolver.ABCNLSolver`


   This nonlinear solver is an implementation of iterative Newton Raphson solving procedure.

   .. attribute:: factory_keyword

      keyword that is used to call the creation of this class in the system factory.

      :type: str

   .. attribute:: solver_options

      dictionary containing other options for creation of the solver class.

      :type: dict

   .. attribute:: residual

      function that returns the residual vector of the system to be solved.

      :type: Callable

   .. attribute:: jacobian

      function that returns the jacobian matrix of the system to be solved.

      :type: Callable

   .. attribute:: solver_options_root

      dictionary containing options for the root function.

      :type: dict

   .. attribute:: extcall

      root function of scipy.optimize.

      :type: Callable


   .. py:attribute:: factory_keyword
      :type:  str
      :value: 'NewtonRaphson'


      keyword that is used to call the creation of this class in the system factory.

      :type: str


   .. py:attribute:: default

      dictionary containing the default solver_options

      :type: dict


   .. py:method:: __post_init__()


   .. py:method:: Solve(sol: pyHarm.Solver.SystemSolution, SolList: list) -> pyHarm.Solver.SystemSolution

      Runs the solver.

      :param sol: SystemSolution that contains the starting point.
      :type sol: SystemSolution
      :param SolList: list of previously solved solutions.
      :type SolList: SystemSolution

      :returns: SystemSolution solved and completed with the output information.
      :rtype: sol (SystemSolution)



   .. py:method:: CompleteSystemSolution(sol, SolList)

      Function that allows to retrieve information of interest

      :param sol: SystemSolution that contains the starting point.
      :type sol: SystemSolution
      :param SolList: list of previously solved solutions.
      :type SolList: SystemSolution



   .. py:method:: linSysdeltak()

      Calculation of the 'deltak' correction to apply to the current iteration in order to converge towards the solution.

      :returns: Correction 'deltak'
      :rtype: self.extcall_newton(matA,matB)