---

AMR.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_H_
#define _AMR_H_

#include <iostream>
#include <string>

#include "REAL.H"
#include "Vector.H"
#include "AMRLevel.H"
#include "AMRLevelFactory.H"
#include "BRMeshRefine.H"
#include "ProblemDomain.H"
#include "Box.H"
#include "HDF5.H"

#include <time.h>


class AMR
{
public:


  AMR();


  ~AMR();


  void define(int a_max_level, 
              const Vector<int>& a_ref_ratios,
              const Box& a_prob_domain,
              const AMRLevelFactory* const a_amrLevelFact);



  void define(int a_max_level, 
              const Vector<int>& a_ref_ratios,
              const ProblemDomain& a_prob_domain,
              const AMRLevelFactory* const a_amrLevelFact);





  bool isDefined() const;


  bool isSetUp() const;

#ifdef HDF5


  void
  setupForRestart(HDF5Handle& a_handle);
#endif


  void
  setupForNewAMRRun();

  void
  setupForFixedHierarchyRun(const Vector<Vector<Box> >& a_amr_grids,
                            int a_proper_nest = 1);


  void
  conclude() const;


  void
  run(Real a_max_time, int a_max_step);



  void
  plotPrefix(const std::string& a_plotfile_prefix);


  void
  checkpointPrefix(const std::string& a_checkpointfile_prefix);


  void
  plotInterval(int a_plot_interval);


  void
  checkpointInterval(int a_checkpoint_interval);


  void
  maxGridSize(int a_max_grid_size);


  void
  dtToleranceFactor(Real a_dt_tolerance_factor);


  void
  fillRatio(Real a_fillRat);


  void 
  blockFactor(int a_blockFactor);


  void 
  gridBufferSize(int a_grid_buffer_size);

  int
  maxGridSize() const;


  void
  verbosity (int a_verbosity);


  void 
  regridIntervals(const Vector<int>& a_regridIntervals);


  int
  verbosity () const;


  void
  maxDtGrow(Real a_dtGrowFactor);


  Real
  maxDtGrow() const;


  void
  fixedDt(Real a_dt);


  Real
  fixedDt() const;
 
  Vector<AMRLevel*> getAMRLevels();

  Real getCurrentTime() const;
protected:
  // advance by dt on this level and all finer levels and return the
  // number of steps left - given the number of steps left on entry.
  int
  timeStep(int a_level, int a_stepsLeft, bool timeBoundary);

  //intenal use only 
  void
  clearMemory();
  // make new grids.
  void
  regrid(int a_base_level);

  // make initial grids.
  // not an accurate name, since there are no grids to re.
  void
  initialGrid();

  void
  writePlotFile() const;

  void
  writeCheckpointFile() const;

  // computes maximum stable time step given the maximum stable time
  // step on the individual levels.
  void
  assignDt();

  // whether regridding should be done now.
  bool
  needToRegrid(int a_level, int a_numStepsLeft) const;

  void
  makeBaseLevelMesh (Vector<Box>& a_grids) const;

  void setDefaultValues();

protected:
  int m_blockFactor;
  Real m_fillRatio;
  int m_max_level;
  int m_finest_level_old;
  int m_finest_level;
  int m_checkpoint_interval;
  int m_plot_interval;
  int m_max_grid_size;
  Real m_dt_tolerance_factor;
  Real m_fixedDt;

  bool m_isDefined;
  bool m_isSetUp;
  Vector<AMRLevel*> m_amrlevels;
  Vector<int> m_ref_ratios;
  Vector<int> m_reduction_factor;
  Vector<int> m_regrid_intervals;
  Real m_dt_base;
  // New (maximum) dt
  Vector<Real> m_dt_new;
  // Current dt
  Vector<Real> m_dt_cur;
  Real m_maxDtGrow;

  BRMeshRefine m_mesh_refine;
  bool m_use_meshrefine;

  Vector<Vector<Box> > m_amr_grids;

  int m_cur_step;
  int m_restart_step;
  int m_lastcheck_step;

  Real m_cur_time;
  Vector<int> m_steps_since_regrid;
  Vector<long> m_cell_updates;

  std::string m_plotfile_prefix;
  std::string m_checkpointfile_prefix;

  int m_verbosity;
};
#endif

---