---

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 <assert.h>
#include <cstdlib>
#include <REAL.H>
#include <IntVect.H>
#include <Box.H>
#include <DisjointBoxLayout.H>
#include <FArrayBox.H>
#include "GhostBC.H"
#include "LevelOp.H"
#include "QuadCFInterp.H"
#include "CFIVS.H"
#include "Copier.H"
#include "BaseBottomSmoother.H"



class HelmholtzOp: public LevelOp
{

public:

  void setHelmCoeff(Real helmcoeff_a);



  void scaleHelmCoeff(Real a_scale);


  LevelOp* new_levelop() const;


  void define(
              const DisjointBoxLayout& Ba,
              const DisjointBoxLayout* base_ba,
              Real  DxLevel, 
              int refratio,
              const Box& domf,
              bool a_homogeneousOnly= false,
              int a_ncomp = 1);



  void define(
              const DisjointBoxLayout& Ba,
              const DisjointBoxLayout* base_ba,
              Real  DxLevel, 
              int refratio,
              const ProblemDomain& domf,
              bool a_homogeneousOnly= false,
              int a_ncomp = 1);


  void define(
              const LevelOp* opfine,
              int refratio);

  HelmholtzOp();

  ~HelmholtzOp();


  void smooth(
              LevelData<FArrayBox>& phi,
              const LevelData<FArrayBox>& 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);


protected:
  // boundary conditons
  DomainGhostBC 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
   */
  BaseBottomSmoother* m_bottom_smoother_ptr;


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

  //intvectsets for coarse-fine interpolation

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

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

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


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

  void clearMemory();

  void setDefaultValues();

};

#endif

---