Return to dispatch_predictors.ads CVS log

Up to [local] / OpenXM_contrib / PHC / Ada / Continuation

Annotation of OpenXM_contrib/PHC/Ada/Continuation/dispatch_predictors.ads, Revision 1.1

1.1     ! maekawa     1: with Standard_Floating_Numbers;          use Standard_Floating_Numbers;
        !             2: with Standard_Complex_Numbers;           use Standard_Complex_Numbers;
        !             3: with Standard_Complex_Vectors;           use Standard_Complex_Vectors;
        !             4: with Standard_Complex_Matrices;          use Standard_Complex_Matrices;
        !             5: with Standard_Complex_Solutions;         use Standard_Complex_Solutions;
        !             6: with Continuation_Data;                  use Continuation_Data;
        !             7:
        !             8: package Dispatch_Predictors is
        !             9:
        !            10: -- DESCRIPTION :
        !            11: --   This package provides generic predictors.
        !            12:
        !            13:   generic
        !            14:
        !            15:     with function Norm ( x : Vector ) return double_float;
        !            16:     with function dH ( x : Vector; t : Complex_Number ) return Vector;
        !            17:           -- returns the derivatives of H(x,t) w.r.t. t in (x,t)
        !            18:     with function dH ( x : Vector; t : Complex_Number ) return Matrix;
        !            19:           -- returns the Jacobian matrix of H(x,t) at (x,t)
        !            20:
        !            21:   procedure Single_Predictor
        !            22:               ( s : in out Solu_Info; p : in Pred_Pars;
        !            23:                 prev_x,prev_v : in Vector; v : in out Vector;
        !            24:                 prev_t,target : in Complex_Number;
        !            25:                 step,tol : in double_float; trial : in out natural );
        !            26:
        !            27:   -- DESCRIPTION :
        !            28:   --   Generic predictor for one solution.
        !            29:
        !            30:   -- ON ENTRY :
        !            31:   --   s        information about the current solution;
        !            32:   --   p        parameters for the predictor;
        !            33:   --   prev_x   previous solution component (only for secant);
        !            34:   --   prev_t   previous value for t (only useful for secant);
        !            35:   --   target   target value for continuation parameter;
        !            36:   --   step     current step size;
        !            37:   --   tol      tolerance for floating equalities;
        !            38:   --   trial    number of consecutive trials (for complex predictor).
        !            39:
        !            40:   -- ON RETURN :
        !            41:   --   s        predicted value for solution.
        !            42:
        !            43:   generic
        !            44:
        !            45:     with function Norm ( x : Vector ) return double_float;
        !            46:     with function dH ( x : Vector; t : Complex_Number ) return Vector;
        !            47:           -- returns the derivatives of H(x,t) w.r.t. t in (x,t)
        !            48:     with function dH ( x : Vector; t : Complex_Number ) return Matrix;
        !            49:           -- returns the Jacobian matrix of H(x,t) at (x,t)
        !            50:
        !            51:   procedure Multiple_Predictor
        !            52:               ( s : in out Solu_Info_Array; p : in Pred_Pars;
        !            53:                 sa : in out Solution_Array; prev_sa : in Solution_Array;
        !            54:                 t : in out Complex_Number; prev_t,target : in Complex_Number;
        !            55:                 step,tol,dist : in double_float; trial : in natural );
        !            56:
        !            57:   -- DESCRIPTION :
        !            58:   --   Generic predictor for an array of solutions.
        !            59:
        !            60:   -- ON ENTRY :
        !            61:   --   s        array with information of current solutions;
        !            62:   --   sa       the current solutions;
        !            63:   --   p        parameters for the predictor;
        !            64:   --   prev_sa  previous solution component (only for secant);
        !            65:   --   t        current value for continuation parameter;
        !            66:   --   prev_t   previous value for t (only useful for secant);
        !            67:   --   target   target value for continuation parameter;
        !            68:   --   step     current step size;
        !            69:   --   tol      tolerance for floating equalities;
        !            70:   --   dist     tolerance for distance between solutions;
        !            71:   --   trial    number of consecutive trials (for complex predictor).
        !            72:
        !            73:   -- ON RETURN :
        !            74:   --   sa       predicted values for solutions;
        !            75:   --   t        predicted continuation parameter.
        !            76:
        !            77: end Dispatch_Predictors;