---

AMRLevel.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 _AMRLEVEL_H_
#define _AMRLEVEL_H_

#include "REAL.H"
#include "Box.H"
#include "DisjointBoxLayout.H"
#include "ProblemDomain.H"

class HDF5Handle;
class IntVectSet;
template <class TTYPE> class Vector;


class AMRLevel
{
public:

  AMRLevel ();



  virtual 
  ~AMRLevel ();


  virtual
  void
  define (AMRLevel* a_coarser_level_ptr,
          const Box& a_problem_domain,
          int a_level,
          int a_ref_ratio);


  virtual
  void
  define (AMRLevel* a_coarser_level_ptr,
          const ProblemDomain& a_problem_domain,
          int a_level,
          int a_ref_ratio);



  virtual
  void
  finerLevelPtr (AMRLevel* a_finer_level_ptr);


  virtual
  void
  dt (Real a_dt);


  virtual
  void
  time (Real a_time);



  virtual
  Real
  dt () const;


  virtual
  Real 
  time () const;


  virtual
  void
  initialDtMultiplier(Real a_initial_dt_multiplier);



  virtual
  Real 
  initialDtMultiplier() const;


  virtual
  const ProblemDomain&
  problemDomain () const;


  virtual
  Vector<Box>
  boxes () const;


  bool
  isDefined() const;


  virtual
  int
  refRatio () const;


  static
  void
  verbosity (int a_verbosity);


  static
  int
  verbosity ();



  virtual
  Real
  advance () = 0;


  virtual
  void
  postTimeStep () = 0;


  virtual
  void
  tagCells (IntVectSet& a_tags)  = 0;


  virtual
  void
  tagCellsInit (IntVectSet& a_tags)  = 0;


  virtual
  void
  regrid (const Vector<Box>& a_new_grids) = 0;






  virtual
  void 
  postRegrid (int a_base_level);




  virtual
  void
  initialGrid (const Vector<Box>& a_new_grids) = 0;


  virtual
  void
  initialData () = 0;


  virtual
  void
  postInitialize () = 0;


  virtual
  Real
  computeDt () = 0;


  virtual
  Real
  computeInitialDt () = 0;

#ifdef HDF5



  virtual
  void
  writeCheckpointHeader (HDF5Handle& a_handle) const = 0;


  virtual
  void
  writeCheckpointLevel (HDF5Handle& a_handle) const = 0;
 

  virtual
  void
  readCheckpointHeader (HDF5Handle& a_handle) = 0;


  virtual
  void
  readCheckpointLevel (HDF5Handle& a_handle) = 0;
 

  virtual
  void
  writePlotHeader (HDF5Handle& a_handle) const = 0;


  virtual
  void
  writePlotLevel (HDF5Handle& a_handle) const = 0;

#endif

protected:
  // the problem domain
  ProblemDomain m_problem_domain;
  //
  Vector<Box> m_level_grids;
  // the level
  int m_level;
  // refinement ratio
  int m_ref_ratio;
  // initial time step multipier
  Real m_initial_dt_multiplier;
  // time step
  Real m_dt;
  // time
  Real m_time;
  // pointer to next coarser level
  AMRLevel* m_coarser_level_ptr;
  // pointer to next finer level
  AMRLevel* m_finer_level_ptr;
  // verbosity level
  static int s_verbosity;
  bool m_isDefined;
};

#endif

---