AMRLevelSelfGravity.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.
//

#ifndef _AMR_LEVEL_SELFGRAVITY_H_
#define _AMR_LEVEL_SELFGRAVITY_H_

#include "Box.H"
#include "Vector.H"
#include "IntVectSet.H"
#include "DisjointBoxLayout.H"

#include "FArrayBox.H"
#include "AMRLevel.H"
#include "LevelData.H"
#include "LevelGodunov.H"

#include "CoarseAverage.H"
#include "FineInterp.H"
#include "LevelFluxRegister.H"
#include "RefCellTagger.H"
#include "PiecewiseLinearFillPatchFace.H"

#include "LevelSolver.H"
#include "PoissonOp.H"
#include "Gradient.H"
#include "SelfGravityPhysics.H"

#include "CodeUnits.H"

#include "CH_HDF5.H"
#include "CONSTANTS_C.H"

class AMRLevelSelfGravity : public AMRLevel
{
public:
  AMRLevelSelfGravity();

  virtual ~AMRLevelSelfGravity();

  virtual void define(AMRLevel*  a_coarserLevelPtr,
                      const Box& a_problemDomain,
                      int        a_level,
                      int        a_refRatio);

  virtual void define(AMRLevel*            a_coarserLevelPtr,
                      const ProblemDomain& a_problemDomain,
                      int                  a_level,
                      int                  a_refRatio);

  void defineParams(const Real&                 a_cfl,
                    const Real&                 a_domainLength,
                    const int&                  a_verbosity,
                    const int&                  a_tagBufferSize,
                    const int&                  a_maxInitRefLevel,
                    const Real&                 a_initialDtMultiplier,
                    const GodunovPhysics* const a_godunovPhysics,
                    const int&                  a_normalPredOrder,
                    const bool&                 a_useFourthOrderSlopes,
                    const bool&                 a_usePrimLimiting,
                    const bool&                 a_useCharLimiting,
                    const bool&                 a_useFlattening,
                    const bool&                 a_useArtificialViscosity,
                    const Real&                 a_artificialViscosity,
                    const RefCellTagger* const  a_refCellTagger,
                    const LevelOp* const        a_poissonOp,
                    const bool&                 a_useDeltaPhiCorr,
                    const StencilType&          a_stencil,
                    const CodeUnits&            a_codeUnits);

  virtual Real advance();

  virtual void postTimeStep();

  virtual void tagCells(IntVectSet& a_tags) ;

  virtual void tagCellsInit(IntVectSet& a_tags) ;

  virtual void regrid(const Vector<Box>& a_newGrids);

  virtual void postRegrid(int a_base_level);

  virtual void initialGrid(const Vector<Box>& a_newGrids);

  virtual void initialData();

  virtual void postInitialize();

  //virtual void setCosmology(const Cosmology& a_cosmology);

#ifdef CH_USE_HDF5

  virtual void writeCheckpointHeader(HDF5Handle& a_handle) const;

  virtual void writeCheckpointLevel(HDF5Handle& a_handle) const;

  virtual void readCheckpointHeader(HDF5Handle& a_handle);

  virtual void readCheckpointLevel(HDF5Handle& a_handle);

  virtual void writePlotHeader(HDF5Handle& a_handle) const;

  virtual void writePlotLevel(HDF5Handle& a_handle) const;

#endif

  virtual Real computeDt();

  virtual Real computeInitialDt();

  const LevelData<FArrayBox>& getStateNew() const;

  const LevelData<FArrayBox>& getStateOld() const;

  virtual LevelData<FArrayBox>* getPoissonRhs(const Real& a_time);

  virtual LevelData<FArrayBox>* getPhi(const Real& a_time);

  virtual void gravity(const int  a_baseLevel, const bool a_srceCorr = true);

  virtual void computeForce(); 

  virtual void postElliptic(const int a_baseLevel);
  
  virtual void secondOrderCorrection();

  virtual void isThisFinestLev(const bool a_isThisFinestLev);

  virtual bool isThisFinestLev() const;

  bool allDefined() const;

protected:
  // Create a load-balanced DisjointBoxLayout from a collection of Boxes
  DisjointBoxLayout loadBalance(const Vector<Box>& a_grids);

  // Setup menagerie of data structures
  void levelSetup();

  // Get the next coarser level
  AMRLevelSelfGravity* getCoarserLevel() const;

  // Get the next finer level
  AMRLevelSelfGravity* getFinerLevel() const;

  //
  void makePoissonRhs(LevelData<FArrayBox>&       a_rhs,
                      const LevelData<FArrayBox>& a_U,
                      const Real&                 a_time);

  // Compute force from a potential. 
  void computeForce(LevelData<ForceBox>&  a_force,
                    LevelData<FArrayBox>& a_phi, 
                    const Real&           a_time);

  // compute source term
  void setupSourceTerm(LevelData<FArrayBox>&       a_source,
                       const LevelData<FArrayBox>& a_U,
                       const LevelData<ForceBox>&  a_force,
                       const Real&                 a_time,
                       const Real&                 a_dt);

protected:
  // Conserved state, U, at old and new time
  LevelData<FArrayBox> m_UOld,m_UNew;

  // Gravitational potential Phi for projection at old and new time
  LevelData<FArrayBox> m_phiOld,m_phiNew,m_deltaPhi;

  //
  LevelData<ForceBox> m_forceOld, m_forceNew;

  // grad(Phi)=Rhs = 1.5*rho_gas
  LevelData<FArrayBox> m_rhs;
  LevelData<FArrayBox> m_rhsCrseNew, m_rhsCrseOld;

  //
  Real m_rhsOffset;

  // CFL number
  Real m_cfl;

  // Grid spacing
  Real m_dx;

  // New and Old time step
  Real m_dtNew, m_dtOld;

  // Number of converved states
  int m_numStates;

  // Names of conserved states
  Vector<string> m_stateNames;

  // Names of plot variables
  Vector<string> m_plotNames;

  // Number of ghost cells (in each direction)
  int m_numGhost;

  // Number of ghost cells (in each direction) for RHS to Poisson eq.
  int m_numRhsGhost;

  // Number of ghost for the potential; always 1 except for 4 pts stencil
  int m_numPhiGhost;

  // Number of ghost cells where it's necessary to compute the force
  int m_numForceGhost;

  // Number of components to define the levelData of Force. When the
  // force is staggered, this is 1 because we use a FluxBox which is a
  // Vector<*FAB> of dimension SpaceDim. Otherwise, this is SpaceDim.
  int m_nLevForceComp;

  // Physical dimension of the longest side of the domain
  Real m_domainLength;

  // code units class
  CodeUnits m_units;

  // whether or not the deltaPhi correction should be applied
  bool m_useDeltaPhiCorr;

  // Interpolation from coarse to fine level
  FineInterp m_fineInterp;

  // Averaging from fine to coarse level
  CoarseAverage m_coarseAverage;

  // Interpolation from coarse to fine level
  FineInterp m_fineInterpPhi;

  // Averaging from fine to coarse level
  CoarseAverage m_coarseAveragePhi;

  // Interpolator for filling in ghost cells from the next coarser level
  PiecewiseLinearFillPatch m_patcher;

  // 2nd order interpolant for filling in ghost cells from next coarser level
  QuadCFInterp m_quadCFInterp;

  // Interpolator for filling in force ghost cells from the next coarser level
  PiecewiseLinearFillPatch     m_forcePatcher;

  // Level integrator for hydro
  LevelGodunov m_levelGodunov;

  // Level solver for elliptic problems
  LevelSolver m_levelSolver;

  // Flux register
  LevelFluxRegister m_fluxRegister;

  // gradient operator
  Gradient* m_gradient;

  // Patch integrator
  SelfGravityPhysics* m_gdnvPhysics;

  // Poisson operator
  LevelOp* m_poissonOp;

  // Class that tags cells for refinement
  RefCellTagger* m_refCellTagger;

  // max level of refinement at start
  int m_maxInitRefLevel;

  // Tag buffer size
  int m_tagBufferSize;

  // Flag coarser and finer levels
  bool m_hasCoarser;
  bool m_hasFiner;

  // boolean stating whether or not this is the FINEst lev.
  bool m_isThisFinestLev;

  // Order of the normal predictor (1 -> PLM, 2-> PPM)
  int m_normalPredOrder;

  // Use 4th order slope computations (otherwise, use 2nd order)
  bool m_useFourthOrderSlopes;

  // Do slope limiting in the primitive or characteristic variables, respect.
  bool m_usePrimLimiting;
  bool m_useCharLimiting;

  // Do slope flattening - MUST BE USING 4th order slopes
  bool m_useFlattening;

  // Apply artificial viscosity of a set value
  bool m_useArtificialViscosity;
  Real m_artificialViscosity;

  //
  DisjointBoxLayout m_grids;

  // True if all the parameters for this object are defined
  bool m_paramsDefined;

private:
  // Disallowed for all the usual reasons
  void operator=(const AMRLevelSelfGravity& a_input)
  {
    MayDay::Error("invalid operator");
  }

  // Disallowed for all the usual reasons
  AMRLevelSelfGravity(const AMRLevelSelfGravity& a_input)
  {
    MayDay::Error("invalid operator");
  }
};

#endif

---