hypreSolver.h

Go to the documentation of this file.

/************************************************************************
**
** Copyright (C) 2014 by Carlos Augusto Teixera Mendes
** All rights reserved.
**
** This file is part of the "GeMA" software. It's use should respect
** the terms in the license agreement that can be found together 
** with this source code.
** It is provided AS IS, with NO WARRANTY OF ANY KIND, 
** INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR 
** A PARTICULAR PURPOSE.
**
************************************************************************/
 
#ifndef _GEMA_HYPRE_SOLVER_H_
#define _GEMA_HYPRE_SOLVER_H_
 
#include <gmNumSolver.h>
#include <gmSparseMatrix.h>
#include <QObject>
 
#include <HYPRE.h>
#include <HYPRE_parcsr_ls.h>
 
typedef HYPRE_Solver HYPRE_SOLVER;
 
class GmRunProgress;
 
 
using HypreTolF = HYPRE_Int (*)(HYPRE_SOLVER, hypre_double);
using HypreMaxItF = HYPRE_Int(*)(HYPRE_SOLVER, HYPRE_Int);
using HypreSolveF = HYPRE_Int(*)(HYPRE_SOLVER, HYPRE_ParCSRMatrix, HYPRE_ParVector, HYPRE_ParVector);
using HypreSetupF = HYPRE_Int(*)(HYPRE_SOLVER, HYPRE_ParCSRMatrix, HYPRE_ParVector, HYPRE_ParVector);
using HypreSetPreconF = HYPRE_Int(*)(HYPRE_Solver, HYPRE_PtrToParSolverFcn, HYPRE_PtrToParSolverFcn, HYPRE_Solver);
using HypreGetResF = HYPRE_Int(*)(HYPRE_SOLVER, hypre_double*);
using HypreGetItCountF = HYPRE_Int(*)(HYPRE_SOLVER, HYPRE_Int*);
using HypreSetLogF = HYPRE_Int(*)(HYPRE_SOLVER, HYPRE_Int);
using HypreDestroyF = HYPRE_Int(*)(HYPRE_SOLVER);
 
struct HypreCommonFunc {
    HypreTolF setTol;
    HypreMaxItF setMaxIt;
    HypreSolveF solve;
    HypreSetupF setup;
    HypreSetPreconF setPrecon;
    HypreGetResF getRes;
    HypreGetItCountF getItCount;
    HypreSetLogF setLog;
    HypreDestroyF destroy;
};
 
class HypreSolver: public QObject, public GmNumSolver
{
 
public:
  enum SolverType {
    ILU = 0,
    PCG,
    BICGSTAB,
    GMRES,
    FLEXGMRES,
    LGMRES,
    COGMRES,
    HYBRID,
    BOOMERAMG,
    NONE,
    SOLVER_SIZE,
  };
 
  static HypreCommonFunc commonFunc[SOLVER_SIZE];
 
  static void libraryInit(const GmLogCategory& logger);
  static void libraryFinalize();
 
  HypreSolver(GmSimulationData* simulation, QString id, QString description, const GmLogCategory& logger);
  virtual ~HypreSolver();
 
  // Comments on the base class
  virtual const char* pluginName() const { return "HypreSolver"; }
 
  // Comments on the base class
  virtual const char* pluginType() const { return "hypre"; }
 
  virtual bool loadPrivateData(LuaTable& table);
 
  virtual GmSolverMatrix* newMatrix(int nlin, int ncol, const GmSolverMatrix* sharedLayout,
                                    int numThreads = -1) const;
 
  virtual bool setSolverTolerance(double tol);
 
  virtual bool solveImpl(GmSolverMatrix* A, const GmVector& b, GmVector& x, bool xIsGuess = false) const;
 
  virtual void printParameters(const GmLogCategory& logger);
 
  virtual QString quickDescription() const;
 
  // Comments on the base class
  virtual int trackItemId() const { return _trackSolveItem; }
 
private:
  void destroyHS(HYPRE_SOLVER s, SolverType type);
  int createHS(HYPRE_SOLVER* s, SolverType type);
  int  solveHS(HYPRE_ParCSRMatrix A, HYPRE_ParVector b, HYPRE_ParVector x) const;
  bool setSolverOpts(LuaTable& tab);
  bool setPrecon();
  bool parseOptions(HYPRE_SOLVER s, SolverType t, LuaTable& options);
 
  const char* typeToName(SolverType t) const ;
  SolverType nameToType(const QString& name) const;
 
  bool armadilloSolve(GmRunProgress* ps, GmSolverMatrix* A, const GmVector& b, GmVector& x, bool xIsGuess = false) const;
 
  void fetchSolveMetrics(GmRunProgress* ps) const;
 
  static int _maxThreads;      
  static int _numSolvers;      
 
  GmSparseMatrixOptions _hypreMatrixOptions;   
 
  HYPRE_SOLVER  _solver;        
  HYPRE_SOLVER  _precon;        
  SolverType    _stype;         
  SolverType    _ptype;         
  int         _nthreads;        
  QStringList _solverOptions;   
  bool        _printIterations; 
  bool        _printResidual;   
  bool        _printHypreMsgs;    
 
  int _trackSolveItem             = -1;
  int _trackSolveIterAttr         = -1;
  int _trackSolveResidualAttr     = -1;
  int _trackSolveInternalTimeAttr = -1;
 
  int _trackDetailedVectorMatrixSetupItem   = -1;
  int _trackDetailedVectorMatrixSolveItem   = -1;
};
 
#endif