lisSolver.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_LIS_SOLVER_H_
#define _GEMA_LIS_SOLVER_H_
 
#include <gmNumSolver.h>
#include <gmSparseMatrix.h>
#include <QObject>
 
struct LIS_SOLVER_STRUCT;
typedef struct LIS_SOLVER_STRUCT* LIS_SOLVER;
 
class GmRunProgress;
 
class LisSolver: public QObject, public GmNumSolver
{
public:
 
  static void libraryInit(const GmLogCategory& logger);
  static void libraryFinalize();
 
  LisSolver(GmSimulationData* simulation, QString id, QString description, const GmLogCategory& logger);
  virtual ~LisSolver();
 
  // Comments on the base class
  virtual const char* pluginName() const { return "LisSolver"; }
 
  // Comments on the base class
  virtual const char* pluginType() const { return "lis"; }
 
  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:
 
  bool armadilloSolve(GmRunProgress* ps, GmSolverMatrix* A, const GmVector& b, GmVector& x, bool xIsGuess = false) const;
 
  bool loadLisParameters(LuaTable& table);
  void fetchSolveMetrics(GmRunProgress* ps) const;
 
  static int _maxThreads;      
  static int _numSolvers;      
 
  GmSparseMatrixOptions _lisMatrixOptions;   
 
  LIS_SOLVER  _solver;          
  int         _nthreads;        
  QStringList _solverOptions;   
  bool        _printIterations; 
  bool        _printResidual;   
  bool        _printTimes;      
  bool        _printLisMsgs;    
  bool        _lisAlwaysInitx;  
 
  int _trackSolveItem             = -1;
  int _trackSolveIterAttr         = -1;
  int _trackSolveResidualAttr     = -1;
  int _trackSolveInternalTimeAttr = -1;
 
  int _trackDetailedVectorMatrixSetupItem   = -1;
  int _trackDetailedVectorMatrixSolveItem   = -1;
};
 
#endif