pyHarm.NonLinearSolver.FactoryNonLinearSolver
=============================================

.. py:module:: pyHarm.NonLinearSolver.FactoryNonLinearSolver

.. autoapi-nested-parse::

   This module contains the factory of ABCNLSolver.

   .. attribute:: Solver_dico

      Dictionary containing all the available ABCNLSolvers as values, and their factory_keyword attribute as key.

      :type: dict



Attributes
----------

.. autoapisummary::

   pyHarm.NonLinearSolver.FactoryNonLinearSolver.Solver_dico


Functions
---------

.. autoapisummary::

   pyHarm.NonLinearSolver.FactoryNonLinearSolver.generateNonLinearSolver


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

.. py:data:: Solver_dico

   Dictionary containing all the available ABCNLSolvers as values, and their factory_keyword attribute as key.

   :type: dict

.. py:function:: generateNonLinearSolver(name_nonlinearsolver, residual, jacobian, nonlinearsolver_options) -> pyHarm.NonLinearSolver.ABCNonLinearSolver.ABCNLSolver

   Factory function that creates a ABCNLSolver object.

   :param name_nonlinearsolver: type of nonlinear solver to instantiate.
   :type name_nonlinearsolver: str
   :param residual: function that returns the residual of the system.
   :type residual: Callable
   :param jacobian: function that returns the jacobians of the system.
   :type jacobian: Callable
   :param nonlinearsolver_options: dictionary containing the supplementary options for the nonlinear solver.
   :type nonlinearsolver_options: dict

   :returns: Instance of the required ABCNLSolver class.
   :rtype: ABCNLSolver