LinearSolver.H

Go to the documentation of this file.

#ifdef CH_LANG_CC
/*
*      _______              __
*     / ___/ /  ___  __ _  / /  ___
*    / /__/ _ \/ _ \/  V \/ _ \/ _ \
*    \___/_//_/\___/_/_/_/_.__/\___/
*    Please refer to Copyright.txt, in Chombo's root directory.
*/
#endif

// BVS, June 18, 2003

// We can assume that template class T has null construction.

#ifndef _LINEARSOLVER_H_
#define _LINEARSOLVER_H_

#include "REAL.H"
#include "Box.H"
#include <cmath>
#include "NamespaceHeader.H"


template <class T>
class LinearOp
{
public:
  virtual ~LinearOp(){;}


  virtual void residual(  T& a_lhs, const T& a_phi, const T& a_rhs, bool a_homogeneous = false) = 0;


  virtual void preCond(   T& a_cor, const T& a_residual)       = 0;


  virtual void applyOp(   T& a_lhs, const T& a_phi, bool a_homogeneous = false) = 0;


  virtual void create(    T& a_lhs, const T& a_rhs) = 0;



  virtual void clear(T& a_lhs) {;}



  virtual void assign(    T& a_lhs, const T& a_rhs)       = 0;

  virtual void assignLocal(T& a_lhs, const T& a_rhs)
  {
    this->assign(a_lhs, a_rhs);
  }

  virtual Real dotProduct(const T& a_1, const T& a_2)     = 0;


  virtual void incr  (    T& a_lhs, const T& a_x, Real a_scale) = 0;


  virtual void axby(      T& a_lhs, const T& a_x, const T& a_y, Real a_a, Real a_b) = 0;


  virtual void scale(     T& a_lhs, const Real& a_scale)  = 0;


  virtual Real norm(const T& a_rhs, int a_ord) = 0;


  virtual void setToZero(T& a_lhs) = 0;


  virtual void write(const T* a, const char* filename)
  {
    MayDay::Warning("LinearOp::write not implemented");
  }

};


template <class T>
class LinearSolver
{
public:
  virtual ~LinearSolver(){;}


  virtual void setHomogeneous(bool a_homogeneous) = 0;


  virtual void define(LinearOp<T>* a_operator, bool a_homogeneous = false) = 0;


  virtual void solve(T& a_phi, const T& a_rhs) = 0;



  virtual void setConvergenceMetrics(Real a_metric, Real a_tolerance) {;};
};

#include "NamespaceFooter.H"
#endif /*_LINEARSOLVER_H_*/

---