pyHarm.NonLinearSolver.ABCNonLinearSolver

Classes

ABCNLSolver

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

Module Contents

class pyHarm.NonLinearSolver.ABCNonLinearSolver.ABCNLSolver(residual, jacobian, solver_options)

Bases: 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.

Parameters:

  • solver_options (dict) – dictionary containing other options for creation of the solver class.

  • residual (Callable) – function that returns the residual vector of the system to be solved.

  • jacobian (Callable) – function that returns the jacobian matrix of the system to be solved.

property factory_keyword: str
Abstractmethod:

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

solver_options
residual
jacobian
__post_init__()
abstractmethod Solve(system_solution: pyHarm.Solver.SystemSolution) → pyHarm.Solver.SystemSolution

Runs the solver.

Parameters:

system_solution (SystemSolution) – SystemSolution that contains the starting point.