pyHarm.NonLinearSolver.FactoryNonLinearSolver

This module contains the factory of ABCNLSolver.

pyHarm.NonLinearSolver.FactoryNonLinearSolver.Solver_dico

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

Type:

dict

Attributes

Solver_dico

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

Functions

generateNonLinearSolver(...)

Factory function that creates a ABCNLSolver object.

Module Contents

pyHarm.NonLinearSolver.FactoryNonLinearSolver.Solver_dico

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

Type:

dict

pyHarm.NonLinearSolver.FactoryNonLinearSolver.generateNonLinearSolver(name_nonlinearsolver, residual, jacobian, nonlinearsolver_options) → pyHarm.NonLinearSolver.ABCNonLinearSolver.ABCNLSolver

Factory function that creates a ABCNLSolver object.

Parameters:

  • name_nonlinearsolver (str) – type of nonlinear solver to instantiate.

  • residual (Callable) – function that returns the residual of the system.

  • jacobian (Callable) – function that returns the jacobians of the system.

  • nonlinearsolver_options (dict) – dictionary containing the supplementary options for the nonlinear solver.

Returns:

Instance of the required ABCNLSolver class.

Return type:

ABCNLSolver