Diffpack Documentation

---

              Search  

---

LinEqSolver.h

Go to the documentation of this file.

class LinEqSolver : public virtual HandleId

{
protected:

  Handle(LinEqSolver_prm)  slvprm;
  Handle(LinEqSystem)      msys;

  int   alg_work;          
  real  alg_storage;       

  real start_time;
  real stop_time;
  CPUclock cl;

  
  
  bool building_framework;

  void startTime ();
  void stopTime ();

  LinEqSolver ();
  LinEqSolver (const LinEqSolver_prm& p);

  virtual bool redim (LinEqSystem& system); 


public:

  virtual ~LinEqSolver ();

  virtual bool ok () const =0;

  virtual String prm2name () const;
  virtual void name2prm (LinEqSolver_prm& prm, const String& name);
  
  
  virtual String description () const;

  real getCPUtime  () const;

  virtual int  getWork
    (const LinEqSysWork work_tp = TOTAL_WORK) const =0;

  virtual real getStorage
    (const LinEqSysStorage storage_tp = TOTAL_STORAGE) const =0;

  virtual void performance (LinEqStatBlk& performance_status);

  virtual bool solve (LinEqSystem& system) =0;

  virtual void debugPrint (Os os, int amount_of_output = 1) const =0;

  virtual String getCategory () const =0;
  virtual bool inCategory (const String& baseclass_name) const;

  CLASS_INFO

  DEF_VIRTUAL_CAST(DirectSolver)
  DEF_VIRTUAL_CAST(IterativeSolver)
  DEF_VIRTUAL_CAST(BasicItSolver)
  DEF_VIRTUAL_CAST(KrylovItSolver)
  DEF_VIRTUAL_CAST(MLIter)
};


class DirectSolver : public LinEqSolver

{

protected:

  DirectSolver ()
    : LinEqSolver () {}

  DirectSolver (const LinEqSolver_prm& pm)
    : LinEqSolver (pm) {}

  virtual bool redim (LinEqSystem& system); 

  virtual void init ();  
  virtual void exit ();  

public:

  virtual void performance (LinEqStatBlk& performance_status);

  virtual void debugPrint (Os os, int amount_of_output = 1) const;

  virtual String getCategory () const;
  virtual bool inCategory  (const String& baseclass_name) const;

  CLASS_INFO

  VIRTUAL_CAST(DirectSolver)
};


class IterativeSolver : public LinEqSolver

{
protected:

  
  Handle(ConvMonitorList)  monitors;

  
  Handle(EigenEstimator)   eigest;
  String                   eigest_id;

  bool convflag;           

  int   max_iterations;    
  int   niterations;       
  int   restartCount;      


  
  
  
  
  
  
  

  Handle(LinEqCommBlk) communication;
  String               communication_id;


  
  
  
  
  Handle(LinEqVector) prev_x;   


  
  Handle(SubdCommAdm) comm_adm;



  

  IterativeSolver ();
  IterativeSolver (const LinEqSolver_prm& pm);

  void initGuess     (const StartVectorMode startmode);    

  virtual void init (const LinEqPrecMode algprec_mode) =0; 

  virtual void exit    ();  

  virtual void restart ();  

  bool satisfied       ();  


  

  virtual void initDefaultCriterion ();            

  virtual void initEigEst    ();                   

  virtual void initCommBlk   () =0;                

  virtual void updateCommBlk ();


public:

 ~IterativeSolver ();

  
  virtual bool ok      () const;

  bool converged       () const { return convflag; }
  int  getItCount      () const { return niterations; }
  int  getRestartCount () const { return restartCount; }

  void attach (ConvMonitorList_prm& mon_prm);
  void attach (ConvMonitorList& monitors);
  void attach (ConvMonitor& monitor);

  int  getConvMonitors (Handle(ConvMonitorList)& monitors_) const;

  int  getWork
    (const LinEqSysWork work_tp = TOTAL_WORK) const;

  real getStorage
    (const LinEqSysStorage storage_tp = TOTAL_STORAGE) const;

  void plotMonitorData (CurvePlotFile& file, const String& comment,
                        bool logplot = true,
                        bool genPSfiles = false,
                        const char* psFileDir = NULL);

  virtual void performance (LinEqStatBlk& performance_status);

  virtual void debugPrint (Os os, int amount_of_output = 1) const;

  virtual String getCategory () const;
  virtual bool inCategory  (const String& baseclass_name) const;

  void attachCommAdm (const SubdCommAdm& adm_);
  NUMT inner (LinEqVector& x, LinEqVector& y);


  CLASS_INFO

  VIRTUAL_CAST(IterativeSolver)
};


class BasicItSolver : public IterativeSolver

{

protected:

  

  BasicItSolver ();
  BasicItSolver (const LinEqSolver_prm& pm);

  virtual void init (const LinEqPrecMode algprec_mode);  


  

  virtual bool redim (LinEqSystem& system);  

  virtual void initDefaultCriterion ();         

  virtual void initCommBlk   ();                


public:

 ~BasicItSolver ();

  
  virtual bool ok      () const;

  virtual bool solve (LinEqSystem& system);

  virtual String getCategory () const;
  virtual bool inCategory (const String& baseclass_name) const;

  CLASS_INFO

  VIRTUAL_CAST(BasicItSolver)
};


class KrylovItSolver : public IterativeSolver

{

protected:
  
  
  
  
  
  
  
  
  
  Handle(LinEqVector) r;   
  Handle(LinEqVector) s;   
  Handle(LinEqVector) z;   

  bool use_svector;        
  bool use_zvector;        
                           

  
  
  

  Handle(LinEqVector) prev_r;   
  Handle(LinEqVector) prev_s;   
  Handle(LinEqVector) prev_z;   



  

  KrylovItSolver ();
  KrylovItSolver (const LinEqSolver_prm& pm);


  
  void prepare (Residual_type residual_tp);
  void grabResidualVector(Residual_type residual_tp, Handle(LinEqVector)& v);

  void initResiduals ();                                

  virtual void init (const LinEqPrecMode algprec_mode); 

  virtual void restart  ();  



  

  virtual bool redim (LinEqSystem& system);  

  virtual void initCommBlk   ();             


public:

 ~KrylovItSolver ();

  
  virtual bool ok      () const;

  virtual bool solve (LinEqSystem& system);

  virtual void debugPrint (Os os, int amount_of_output = 1) const;

  virtual String getCategory () const;
  virtual bool inCategory (const String& baseclass_name) const;

  CLASS_INFO

  VIRTUAL_CAST(KrylovItSolver)
};

---