Return to drivers_for_poly_continuation.ads CVS log

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

Annotation of OpenXM_contrib/PHC/Ada/Continuation/drivers_for_poly_continuation.ads, Revision 1.1.1.1

1.1       maekawa     1: with text_io;                            use text_io;
                      2: with Standard_Complex_Numbers;           use Standard_Complex_Numbers;
                      3: with Standard_Complex_Poly_Systems;      use Standard_Complex_Poly_Systems;
                      4: with Standard_Complex_Solutions;         use Standard_Complex_Solutions;
                      5:
                      6: package Drivers_for_Poly_Continuation is
                      7:
                      8: -- DESCRIPTION :
                      9: --   This package contains three drivers for two types of homotopies:
                     10: --   artificial and natural parameter.
                     11:
                     12:   procedure Driver_for_Process_io ( file : in file_type; oc : out natural );
                     13:
                     14:   -- DESCRIPTION :
                     15:   --   Choice of kind of output information during continuation.
                     16:
                     17:   -- ON ENTRY :
                     18:   --   file     must be opened for output.
                     19:
                     20:   -- ON RETURN :
                     21:   --   oc       number between 0 and 8 indicating the output code:
                     22:   --              0 : no intermediate output information during continuation;
                     23:   --              1 : only the final solutions at the end of the paths;
                     24:   --              2 : intermediate solutions at each step along the paths;
                     25:   --              3 : information of the predictor: t and step length;
                     26:   --              4 : information of the corrector: corrections and residuals;
                     27:   --              5 : intermediate solutions and information of the predictor;
                     28:   --              6 : intermediate solutions and information of the corrector;
                     29:   --              7 : information of predictor and corrector;
                     30:   --              8 : intermediate solutions, info of predictor and corrector.
                     31:
                     32:   procedure Driver_for_Continuation_Parameters ( file : in file_type );
                     33:
                     34:   -- DESCRIPTION :
                     35:   --   This procedure allows the user to determine all relevant parameters
                     36:   --   for the continuation.
                     37:
                     38:   procedure Check_Continuation_Parameter ( sols : in out Solution_List );
                     39:
                     40:   -- DESCRIPTION ;
                     41:   --   Reads the value of the continuation parameter for the first solution.
                     42:   --   If different from zero, the user is given the opportunity to change it.
                     43:
                     44:   procedure Driver_for_Polynomial_Continuation
                     45:                 ( file : in file_type; p : in Poly_Sys;
                     46:                   sols : out Solution_list; target : out Complex_Number );
                     47:
                     48:   -- DESCRIPTION :
                     49:   --   This is a driver for the polynomial continuation routine
                     50:   --   with an artificial parameter homotopy.
                     51:   --   It reads the start system and start solutions and enables the
                     52:   --   user to determine all relevant parameters.
                     53:
                     54:   -- ON ENTRY :
                     55:   --   file       to write diagnostics and results on;
                     56:   --   p          a polynomial system.
                     57:
                     58:   -- ON RETURN :
                     59:   --   sols       the computed solutions.
                     60:
                     61:   procedure Driver_for_Polynomial_Continuation
                     62:                 ( file : in file_type; p : in Poly_Sys; k : in natural;
                     63:                   target : in Complex_Number; sols : out Solution_list );
                     64:
                     65:   -- DESCRIPTION :
                     66:   --   This is a driver for the polynomial continuation routine
                     67:   --   with a natural parameter homotopy.
                     68:   --   The start solutions will be read from file.
                     69:   --   A gentle interface makes it possible for the user to determine
                     70:   --   all relevant parameters.
                     71:
                     72:   -- ON ENTRY :
                     73:   --   file       to write diagnostics and results on;
                     74:   --   p          a polynomial system, with n equations and n+1 unknowns;
                     75:   --   k          index of t = xk;
                     76:   --   target     target value for the continuation parameter.
                     77:
                     78:   -- ON RETURN :
                     79:   --   sols       the computed solutions.
                     80:
                     81:   procedure Driver_for_Polynomial_Continuation
                     82:                 ( file : in file_type; sols : in out Solution_List;
                     83:                   proj : in boolean; target : Complex_Number := Create(1.0) );
                     84:
                     85:   -- DESCRIPTION :
                     86:   --   Given a homotopy, contained in the package Homotopy,
                     87:   --   the continuation procedure will be be carried out.
                     88:   --   The user may tune all continuation paramters.
                     89:
                     90:   -- ON ENTRY :
                     91:   --   file       to write intermediate results and diagnostics on;
                     92:   --   sols       start solutions for the continuation;
                     93:   --   proj       true when a projective-perpendicular corrector will be used;
                     94:   --   target     target value for the continuation parameter.
                     95:
                     96:   -- ON RETURN :
                     97:   --   sols       the computed solutions.
                     98:
                     99: end Drivers_for_Poly_Continuation;