---

AMRDerivedClass.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_DERIVED_CLASS_H_
#define _AMR_DERIVED_CLASS_H_

#include "FArrayBox.H"
#include "LevelData.H"
#include "AMRLevel.H"
#include "CoarseAverage.H"
#include "FineInterp.H"

class Box;
class IntVectSet;
template <class TTYPE> class Vector;
class DisjointBoxLayout;

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


  virtual
  ~AMRDerivedClass();


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

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


// advance by one timestep
  virtual
  Real
  advance();

// things to do after a timestep
  virtual  
  void
  postTimeStep();

// create tags
  virtual  
  void
  tagCells(IntVectSet& a_tags) ;

// create tags at initialization
  virtual  
  void
  tagCellsInit(IntVectSet& a_tags) ;

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

// initialize grids
  virtual  
  void
  initialGrid(const Vector<Box>& a_new_grids);

// initialize data
  virtual  
  void
  initialData();

// things to do after initialization
  virtual  
  void
  postInitialize();

// set data after regrid
// (regridData should be removed)
  virtual
  void
  regridData();

#ifdef 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

// compute dt
  virtual  
  Real
  computeDt();

// compute dt with initial data
  virtual
  Real
  computeInitialDt();

protected:
  DisjointBoxLayout
  loadBalance(const Vector<Box>& a_grids);

protected:
// state vector at old time
  LevelData<FArrayBox> m_state_old;
// state vector at new time
  LevelData<FArrayBox> m_state_new;
// number of components of m_state
  static const int s_num_comps = 2;
// names of components
  static const char* s_state_names[s_num_comps];
// grid spacing
  Real m_dx;

  CoarseAverage m_coarse_average;
  FineInterp m_fine_interp;
};

#endif

---