pyHarm.NonLinearSolver.ABCNonLinearSolver
=========================================

.. py:module:: pyHarm.NonLinearSolver.ABCNonLinearSolver


Classes
-------

.. autoapisummary::

   pyHarm.NonLinearSolver.ABCNonLinearSolver.ABCNLSolver


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

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

   Bases: :py:obj:`abc.ABC`


   This is the abstract class ruling the solver class. The system is responsible of solving the system starting at a given starting point.

   :param solver_options: dictionary containing other options for creation of the solver class.
   :type solver_options: dict
   :param residual: function that returns the residual vector of the system to be solved.
   :type residual: Callable
   :param jacobian: function that returns the jacobian matrix of the system to be solved.
   :type jacobian: Callable


   .. py:property:: factory_keyword
      :type: str

      :abstractmethod:


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


   .. py:attribute:: solver_options


   .. py:attribute:: residual


   .. py:attribute:: jacobian


   .. py:method:: __post_init__()


   .. py:method:: Solve(system_solution: pyHarm.Solver.SystemSolution) -> pyHarm.Solver.SystemSolution
      :abstractmethod:


      Runs the solver.

      :param system_solution: SystemSolution that contains the starting point.
      :type system_solution: SystemSolution