MultilevelLinearOp.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 _MULTILEVELLINEAROP_H_
#define _MULTILEVELLINEAROP_H_

#include <cmath>

#include "RefCountedPtr.H"
#include "Vector.H"
#include "RealVect.H"
#include "LevelData.H"
#include "LinearSolver.H"
#include "AMRMultiGrid.H"
#include "BiCGStabSolver.H"

#include "NamespaceHeader.H"


template <class T>
class MultilevelLinearOp : public LinearOp< Vector<LevelData<T>* > >
{

public:
  MultilevelLinearOp();


  void define(const Vector<DisjointBoxLayout>& a_vectGrids,
              const Vector<int>& a_refRatios,
              const Vector<ProblemDomain>& a_domains,
              const Vector<RealVect>& a_vectDx,
              RefCountedPtr<AMRLevelOpFactory<LevelData<T> > >& a_opFactory,
              int a_lBase);


  virtual ~MultilevelLinearOp();


  virtual void residual(  Vector<LevelData<T>* >& a_lhs,
                          const Vector<LevelData<T>* >& a_phi,
                          const Vector<LevelData<T>* >& a_rhs,
                          bool a_homogeneous = false);


  virtual void preCond(Vector<LevelData<T>* >& a_cor,
                       const Vector<LevelData<T>* >& a_residual);


  virtual void applyOp(Vector<LevelData<T>* >& a_lhs,
                       const Vector<LevelData<T>* >& a_phi,
                       bool a_homogeneous = false);


  virtual void create(Vector<LevelData<T>* >& a_lhs,
                      const Vector<LevelData<T>* >& a_rhs);


  virtual void clear(Vector<LevelData<T>* >& a_lhs);



  virtual void assign(Vector<LevelData<T>* >& a_lhs,
                      const Vector<LevelData<T>* >& a_rhs);


  virtual Real dotProduct(const Vector<LevelData<T>* >& a_1,
                          const Vector<LevelData<T>* >& a_2);


  virtual void incr  (Vector<LevelData<T>* >& a_lhs,
                      const Vector<LevelData<T>* >& a_x,
                      Real a_scale);


  virtual void axby(Vector<LevelData<T>* >& a_lhs,
                    const Vector<LevelData<T>* >& a_x,
                    const Vector<LevelData<T>* >& a_y,
                    Real a_a,
                    Real a_b);


  virtual void scale(Vector<LevelData<T>* >& a_lhs,
                     const Real& a_scale);


  virtual Real norm(const Vector<LevelData<T>* >& a_rhs,
                    int a_ord);


  virtual void setToZero(Vector<LevelData<T>* >& a_lhs);


  virtual void write(const Vector<LevelData<T>* >* a_data,
                     const char*                   a_filename);

  bool m_use_multigrid_preconditioner;

  int m_num_mg_iterations;

  int m_num_mg_smooth;

  int m_preCondSolverDepth;

  Vector<DisjointBoxLayout> m_vectGrids;

  Vector<int> m_refRatios;

  Vector<ProblemDomain> m_domains;

  // cell spacing
  Vector<RealVect> m_vectDx;

  Vector<RefCountedPtr<AMRLevelOp<LevelData<T> > > > m_vectOperators;

  int m_lBase;


  AMRMultiGrid<LevelData<T> > m_preCondSolver;

  LinearSolver<LevelData<T> >* m_precondBottomSolverPtr;

  bool m_isPrecondSolverInitialized;
};

#include "NamespaceFooter.H"

#include "MultilevelLinearOpI.H"
#endif /*_MULTILEVELLINEAROP_H_*/

---