gmNumSolver.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_NUMSOLVER_H_
#define _GEMA_NUMSOLVER_H_
 
#include "gmPluginObject.h"
#include "gmPluginCategory.h"
#include "gmVector.h"
#include "gmSolverMatrix.h"
 
class  GmSolverMatrix;
 
class GMC_API_EXPORT GmNumSolver : public GmPluginObject
{
public:
  GmNumSolver(GmSimulationData* simulation, QString id, QString description, const GmLogCategory& logger);
  virtual ~GmNumSolver();
 
  // Comments on the base class
  virtual const char* pluginCategory() const { return GM_PLUGIN_NUMSOLVER; }
 
  virtual GmSolverMatrix* newMatrix(int nlin, int ncol, const GmSolverMatrix* sharedLayout,
                                    int numThreads = -1) const = 0;
 
  virtual bool setSolverTolerance(double tol) = 0;
 
  bool solve(GmSolverMatrix* A, const GmVector& b, GmVector& x, bool xIsGuess = false) const 
  {
    if(!checkNanInf(A, b)) 
      return false;
    return solveImpl(A, b, x, xIsGuess);
  }
    
  virtual void printParameters(const GmLogCategory& logger);
 
  virtual QString quickDescription() const = 0;
 
  virtual int trackItemId() const { return -1; }
 
protected:
        virtual bool solveImpl(GmSolverMatrix* A, const GmVector& b, GmVector& x, bool xIsGuess) const = 0;
 
private:  
  friend class GmNumSolverPrinter; // Allow access from GmNumSolverPrinter to the solver's simulation data and logger
 
  bool checkNanInf (const GmSolverMatrix* A, const GmVector& b) const;
 
        bool _checkNanInf; 
};
 
#endif