pyHarm.Predictors.PredictorPreviousSolution
===========================================

.. py:module:: pyHarm.Predictors.PredictorPreviousSolution


Classes
-------

.. autoapisummary::

   pyHarm.Predictors.PredictorPreviousSolution.PredictorPreviousSolution


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

.. py:class:: PredictorPreviousSolution(sign_ds, **kwargs)

   Bases: :py:obj:`pyHarm.Predictors.ABCPredictor.ABCPredictor`


   Defines the previous solution type of predictor. Uses the previous solution for the displacement and puts the step purely on the angular frequency.



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


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

      :type: str


   .. py:attribute:: predictor_name
      :value: 'Previous Solution Predictor'



   .. py:method:: predict(sollist: list[pyHarm.Solver.SystemSolution], ds: float, k_imposed=None) -> tuple[numpy.ndarray, pyHarm.Solver.SystemSolution, float]

      Predicts the next starting point by taking the previous solution and making a step in angular frequency.

      :param sollist: list of SystemSolution already solved during the analysis.
      :type sollist: list[SystemSolution]
      :param ds: step size for the prediction.
      :type ds: float
      :param k_imposed: if not None, uses the k_imposed as the index of the last solution pointer.
      :type k_imposed: None | int

      :returns: next predicted starting point.
                SystemSolution: last accepted point in the list of solutions.
                float: sign of the prediction used (-1 | 1)
      :rtype: np.ndarray