---

RegHelmholtzOp.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 _REGHELMHOLTZOP_H_
#define _REGHELMHOLTZOP_H_

#include <iostream>
#include <cmath>
#include <assert.h>
#include <cstdlib>

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

#include "RegCFIVS.H"
#include "RegGhostBC.H"

#include "RegLevelOp.H"
#include "GenBaseBottomSmoother.H"


class RegHelmholtzOp: public RegLevelOp
{
public:
  RegHelmholtzOp();

  ~RegHelmholtzOp();


  RegHelmholtzOp* newOp() const;

  bool isDefined() 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 RegLevelOp* a_opfinePtr,
              int               a_refToFine);


  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);


  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>&       a_phi,
                const LevelData<FArrayBox>* a_phicPtr,
                LevelData<FArrayBox>&       a_LOfPhi);


  void applyOpHcfIphys(LevelData<FArrayBox>& a_phi,
                       LevelData<FArrayBox>& a_LOfPhi);


  void applyOpIcfHphys(LevelData<FArrayBox>&       a_phi,
                       const LevelData<FArrayBox>* a_phicPtr,
                       LevelData<FArrayBox>&       a_LOfPhi);


  void applyOpH(LevelData<FArrayBox>& a_phi,
                LevelData<FArrayBox>& a_LOfPhi);

  void setBottomSmoother(const GenBaseBottomSmoother<LevelData<FArrayBox> >& a_bottomSmoother);


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


  void CFInterp(LevelData<FArrayBox>&       a_phif,
                const LevelData<FArrayBox>& a_phic);


  void homogeneousCFInterp(LevelData<FArrayBox>& a_phif);


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

  void setDomainGhostBC(const RegDomainGhostBC& a_dombcin);


  void getFlux(FArrayBox&       a_fineFlux, 
               const FArrayBox& a_data, 
               const DataIndex& a_datInd,
               int              a_dir);

protected:
  // boundary conditons
  RegDomainGhostBC m_domghostbc;

  // domain of fine grid
  ProblemDomain m_domain;

  // the grids at the current level
  DisjointBoxLayout m_grids;

  // Copier object that knows how to perform exchange operations on 
  // LevelData objects defined on m_grids
  Copier m_exchangeCopier;

  /* DisjointBoxLayout for next coarser level
     this is == NULL if there is no coarser level */
  DisjointBoxLayout m_baseBA;

  // refinement ratio between this and the next coarser level
  int m_refRatio;

  // mesh spacing at this level
  Real m_dxLevel;

  // mesh spacing at the next coarser level
  Real m_dxCrse;

  // number of components
  int m_ncomp;

  /*
    coarse-fine information between this level
    and the next coarser level
  */
  QuadCFInterp m_quadCFI;

  /* bottom smoother object
   */
  GenBaseBottomSmoother<LevelData<FArrayBox> >* m_bottomSmootherPtr;

  // has full define function been called?
  bool m_isDefined;

  // has full define function been called?
  bool m_isBCDefined;

  // is inhomogeneous CF interpolation possible?
  bool m_ihcfiEnabled;

  // is the helmholtz coefficient defined?
  bool m_hcoeffDefined;

  // the beta in (alpha*I + beta*laplacian)phi = rho
  Real m_helmCoeff;

  // the alpha in (alpha*I + beta*laplacian)phi = rho
  Real m_alphaCoeff;

  // intvectsets for coarse-fine interpolation
  LayoutData<RegCFIVS> m_loCFIVS[SpaceDim];
  LayoutData<RegCFIVS> m_hiCFIVS[SpaceDim];

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

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

// 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 clearMemory();

  void setDefaultValues();
};

#endif

---