cholmodSolver.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_CHOLMOD_SOLVER_H_
#define _GEMA_CHOLMOD_SOLVER_H_
 
#include "suiteSparseSolver.h"
 
#include <cholmod.h>
 
 
// Returns the int_32 version of a cholmod method (cholmod_analyze, for example)
#define CALL_CHOLMOD_I32(name) cholmod_ ## name
 
// Returns the int_64 version of a cholmod method (cholmod_l_analyze, for example)
#define CALL_CHOLMOD_I64(name) cholmod_l_ ## name
 
// Returns the int_32 or int_64 version of a cholmod method, depending on the SuiteSparseSolver::_i64 object attribute
// Should only be called from inside a CholmodSolver class method
#define CALL_CHOLMOD(name) (_i64 ? CALL_CHOLMOD_I64(name) : CALL_CHOLMOD_I32(name))
 
 
class CholmodSolver : public SuiteSparseSolver
{
public:
 
  enum SymOptions {
    SYMPD_AUTO,   
    SYMPD_TRUE,   
    SYMPD_FALSE,  
    SYMPD_FIRST,  
  };
 
  CholmodSolver(GmSimulationData* simulation, QString id, QString description, const GmLogCategory& logger);
  virtual ~CholmodSolver();
 
  // Comments on the base class
  virtual const char* pluginType() const { return "cholmod"; }
 
  virtual bool loadPrivateData(LuaTable& table);
 
  virtual bool solveImpl(GmSolverMatrix* A, const GmVector& b, GmVector& x, bool xIsGuess = false) const;
 
  virtual void printParameters(const GmLogCategory& logger);
 
  static QString errorStr(int status);
 
private:
  QString errorStr() const { return errorStr(_context.status); }
  QString selectedOrderMethod() const;
 
  mutable cholmod_common _context; 
 
  bool         _gpu;                
  bool         _refine;             
  QString      _ordering;           
  SymOptions   _symmetric;          
  bool         _LDL;                
  double       _symRelTol;          
  double       _symAbsTol;          
  mutable QMap<GmSolverMatrix*, bool> _matrixSymOptions; 
 
  static int _numSolvers;  
  int        _trackSolveRefineItem      = -1;
};
 
#endif