gmpArmadilloSolver.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_PLUGIN_ARMADILLO_SOLVER_H_
#define _GEMA_PLUGIN_ARMADILLO_SOLVER_H_
 
 
#include <gmNumSolver.h>
#include <gmSparseMatrix.h>
 
class GmpArmadilloSolver : public QObject, public GmNumSolver
{
public:
  GmpArmadilloSolver(GmSimulationData* simulation, QString id, QString description, const GmLogCategory& logger);
  virtual ~GmpArmadilloSolver();
 
  // Comments on the base class
  virtual const char* pluginName() const { return "ArmadilloSolver"; }
 
  // Comments on the base class
  virtual const char* pluginType() const { return "ns"; }
 
  virtual bool loadPrivateData(LuaTable& table);
 
  virtual GmSolverMatrix* newMatrix(int nlin, int ncol, const GmSolverMatrix* sharedLayout,
                                    int numThreads = -1) const;
 
  // Comments on the base class
  virtual bool setSolverTolerance(double tol) { Q_UNUSED(tol); return false; }
 
  virtual bool solveImpl(GmSolverMatrix* A, const GmVector& b, GmVector& x, bool xIsGuess = false) const;
 
  virtual void printParameters(const GmLogCategory& logger);
 
  // TODO: This should be removed. Used to temporarily help crisms to get hold of a 
  // native Armadillo matrix
  const arma::sp_mat& armaMatrix(GmSolverMatrix* A) const;
 
  // Comments on the base class
  virtual QString quickDescription() const { return tr("Armadillo (%1) direct solver [%2]").arg(_useSparseMatrices ? "SuperLU" : "Lapack").arg(id()); }
 
  // Comments on the base class
  virtual int trackItemId() const { return _trackSolveItem; }
 
private:
#ifdef ENABLE_TESTS
  friend Q_DECL_EXPORT void TEST_GmpArmadilloSolver(const GmLogCategory&, GmLogLevel);
#endif
 
  bool                  _useSparseMatrices;  
  GmSparseMatrixOptions _armaMatrixOptions;  
  arma::superlu_opts    _superLuOptions;     
  bool                  _hasUserOptions;     
 
  static int _numSolvers;      
  int _trackSolveItem = -1;
};
 
#endif