suiteSparseSolver.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_SUITESPARSE_SOLVER_H_
#define _GEMA_SUITESPARSE_SOLVER_H_
 
#include <gmNumSolver.h>
#include <gmSparseMatrix.h>
#include <QObject>
 
#include "suiteSparseMatrix.h"
 
 
class GmRunProgress;
 
class SuiteSparseSolver : public QObject, public GmNumSolver
{
public:
 
  SuiteSparseSolver(GmSimulationData* simulation, QString id, QString description, const GmLogCategory& logger)
    : GmNumSolver(simulation, id, description, logger), 
      _matrixOptions(simulation, GM_ARMADILLO_TRIPLET_LIST), 
      _i64(false), _normType(2), _printResidual(false) {}
 
  virtual ~SuiteSparseSolver() {}
 
  // Comments on the base class
  virtual const char* pluginName() const { return "SuiteSparseSolver"; }
 
  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 void printParameters(const GmLogCategory& logger);
 
  virtual QString quickDescription() const;
 
  // Comments on the base class
  virtual int trackItemId() const { return _trackSolveItem; }
 
protected:
  bool initTracking(GmSimulationData* simulation, QString solverId, const char* itemName, int numSolvers);
 
  cholmod_sparse* cholmodMatrix       (GmSolverMatrix* A ) const;
  void            releaseCholmodMatrix(cholmod_sparse* cA) const;
 
  bool _i64;            
  int  _normType;       
  bool _printResidual;  
 
  GmSparseMatrixOptions _matrixOptions;      
  int _trackSolveItem            = -1;
  int _trackSolveAnalyzeItem     = -1;
  int _trackSolveFactorizeItem   = -1;
  int _trackSolveSolveItem       = -1;
  int _trackSolveResidualAttr    = -1;
  int _trackSolveInternalMemAttr = -1;
 
};
 
#endif