HelmholtzOp.H

Go to the documentation of this file.

/*   _______              __
    / ___/ /  ___  __ _  / /  ___
   / /__/ _ \/ _ \/  ' \/ _ \/ _ \
   \___/_//_/\___/_/_/_/_.__/\___/
*/
//
// This software is copyright (C) by the Lawrence Berkeley
// National Laboratory.  Permission is granted to reproduce
// this software for non-commercial purposes provided that
// this notice is left intact.
//
// It is acknowledged that the U.S. Government has rights to
// this software under Contract DE-AC03-765F00098 between
// the U.S.  Department of Energy and the University of
// California.
//
// This software is provided as a professional and academic
// contribution for joint exchange. Thus it is experimental,
// is provided ``as is'', with no warranties of any kind
// whatsoever, no support, no promise of updates, or printed
// documentation. By using this software, you acknowledge
// that the Lawrence Berkeley National Laboratory and
// Regents of the University of California shall have no
// liability with respect to the infringement of other
// copyrights by any part of this software.
//
// DTGraves, Weds, July 21, 1999

#ifndef _HELMHOLTZOP_H_
#define _HELMHOLTZOP_H_

#include <iostream>
#include <cmath>
#include <cassert>
#include <cstdlib>

#include "REAL.H"
#include "IntVect.H"
#include "Box.H"
#include "DisjointBoxLayout.H"
#include "FArrayBox.H"
#include "QuadCFInterp.H"
#include "Copier.H"

#include "GhostBC.H"
#include "LevelOp.H"
#include "CFIVS.H"
#include "BaseBottomSmoother.H"
#include "BaseHelmholtzOp.H"


class HelmholtzOp: public BaseHelmholtzOp
{
public:
  void setHelmCoeff(Real a_helmcoeff);


  void scaleHelmCoeff(Real a_scale);

  void setAlpha(Real a_alpha);


  void scaleAlpha(Real a_scale);

  void scaleBeta(Real a_scale);


  LevelOp* new_levelop() const;


  void define(const DisjointBoxLayout& a_grids,
              const DisjointBoxLayout* a_baseBAPtr,
              Real                     a_dxLevel,
              int                      a_refRatio,
              const Box&               a_domain, 
              bool                     a_homogeneousOnly= false,
              int                      a_ncomp = 1);


  void define(
              const DisjointBoxLayout& a_grids,
              const DisjointBoxLayout* a_baseBAPtr,
              Real                     a_dxLevel,
              int                      a_refRatio,
              const ProblemDomain&     a_domain, 
              bool                     a_homogeneousOnly= false,
              int                      a_ncomp = 1);


  void define(const LevelOp* a_opfine,
              int            a_refToFine);

  HelmholtzOp();

  ~HelmholtzOp();


  void smooth(LevelData<FArrayBox>&       a_phi,
              const LevelData<FArrayBox>& a_rhs);


  virtual void levelPreconditioner(LevelData<FArrayBox>&       a_phihat,
                                   const LevelData<FArrayBox>& a_rhshat);


  void applyOpI(
                LevelData<FArrayBox>& phi,
                const LevelData<FArrayBox>* phiCoarse,
                LevelData<FArrayBox>& LOfPhi
                );


  void applyOpIcfHphys(
                       LevelData<FArrayBox>& phi,
                       const LevelData<FArrayBox>* phiCoarse,
                       LevelData<FArrayBox>& LOfPhi
                       );


  void applyOpH(
                LevelData<FArrayBox>& phi,
                LevelData<FArrayBox>& LOfPhi
                );


  void applyOpHcfIphys(
                       LevelData<FArrayBox>& phi,
                       LevelData<FArrayBox>& LOfPhi
                       );


  void CFInterp(
                LevelData<FArrayBox>& phi,
                const LevelData<FArrayBox>& phiCoarse
                );


  void homogeneousCFInterp(LevelData<FArrayBox>& phi);


  void setDomainGhostBC(const DomainGhostBC& a_dombcin);


  void setBottomSmoother(const BaseBottomSmoother& a_bottomSmoother);


  void
  homogeneousCFInterp(LevelData<FArrayBox>& phif,
                      const DataIndex& a_datIndex,
                      int idir,
                      Side::LoHiSide hiorlo);


  void bottomSmoother(LevelData<FArrayBox>& phi,
                      const LevelData<FArrayBox>& rhs);

  bool isDefined() const;


  void getFlux(
               FArrayBox& flux,
               const FArrayBox& data,
               const DataIndex& a_datInd,
               int dir);

  virtual void setConvergenceMetric(Real a_metric, int a_comp);

protected:
  DomainGhostBC m_domghostbc;

  ProblemDomain m_domain;

  DisjointBoxLayout m_grids;

  Copier m_exchangeCopier;

  DisjointBoxLayout m_baseBA;

  int m_refRatio;

  Real m_dxLevel;

  Real m_dxCrse;

  int m_ncomp;

  QuadCFInterp m_quadCFI;


  BaseBottomSmoother* m_bottomSmootherPtr;

  bool m_isDefined;

  bool m_isBCDefined;

  bool m_ihcfiEnabled;

  bool m_hcoeffDefined;

  LayoutData<CFIVS> m_loCFIVS[SpaceDim];
  LayoutData<CFIVS> m_hiCFIVS[SpaceDim];

  Real m_helmCoeff;

  Real m_alphaCoeff;

private:
  void levelGSRB(LevelData<FArrayBox>&       a_phi,
                 const LevelData<FArrayBox>& a_rhs);

//  void interpOnIVS(LevelData<FArrayBox>& a_phif,
//                   const FArrayBox&      a_phistar,
//                   const DataIndex&      a_datInd,
//                   const int             a_idir,
//                   const Side::LoHiSide  a_hiorlo,
//                   const IntVectSet&     a_interpIVS);

  void interpOnIVSHomo(LevelData<FArrayBox>& a_phif,
                       const DataIndex&      a_datInd,
                       const int             a_idir,
                       const Side::LoHiSide  a_hiorlo,
                       const IntVectSet&     a_interpIVS);

  void clearMemory();

  void setDefaultValues();
};

#endif

---