AMR.H

Go to the documentation of this file.

/*   _______              __
    / ___/ /  ___  __ _  / /  ___
   / /__/ _ \/ _ \/  V \/ _ \/ _ \
   \___/_//_/\___/_/_/_/_.__/\___/
*/
// CHOMBO Copyright (c) 2000-2004, The Regents of the University of
// California, through Lawrence Berkeley National Laboratory (subject to
// receipt of any required approvals from U.S. Dept. of Energy).  All
// rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// (1) Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// (2) Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// (3) Neither the name of Lawrence Berkeley National Laboratory, U.S.
// Dept. of Energy nor the names of its contributors may be used to endorse
// or promote products derived from this software without specific prior
// written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
// PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
// OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// You are under no obligation whatsoever to provide any bug fixes,
// patches, or upgrades to the features, functionality or performance of
// the source code ("Enhancements") to anyone; however, if you choose to
// make your Enhancements available either publicly, or directly to
// Lawrence Berkeley National Laboratory, without imposing a separate
// written license agreement for such Enhancements, then you hereby grant
// the following license: a non-exclusive, royalty-free perpetual license
// to install, use, modify, prepare derivative works, incorporate into
// other computer software, distribute, and sublicense such Enhancements or
// derivative works thereof, in binary and source code form.
//
// TRADEMARKS. Product and company names mentioned herein may be the
// trademarks of their respective owners.  Any rights not expressly granted
// herein are reserved.
//

#ifndef _AMR_H_
#define _AMR_H_

#include <iostream>
#include <string>
#include <ctime>

#include "REAL.H"
#include "Vector.H"
#include "AMRLevel.H"
#include "AMRLevelFactory.H"
#include "BRMeshRefine.H"
#include "ProblemDomain.H"
#include "Box.H"
#include "CH_HDF5.H"
#ifdef CH_USE_TIMER
#include "CH_Timer.H"
#endif


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 CH_USE_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 maxBaseGridSize(int a_max_base_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;


  int maxBaseGridSize() const;


  void verbosity (int a_verbosity);


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


  int verbosity () const;


  void maxDtGrow(Real a_dtGrowFactor);


  void timeEps(Real a_timeEps);


  Real maxDtGrow() const;


  Real timeEps() const;


  void fixedDt(Real a_dt);


  Real fixedDt() const;


  Vector<AMRLevel*> getAMRLevels();


  void initialTime(Real a_initialTime);


  Real getCurrentTime() const;

#ifdef CH_USE_TIMER


  Chombo::Timer * timer(Chombo::Timer *a_timer = NULL );
#endif

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 a_coarseTimeBoundary);

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

  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;
  int  m_max_base_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;
  Real         m_time_eps;

  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;
#ifdef CH_USE_TIMER
  Chombo::Timer *m_timer;  //assumes the application manages the memory
#endif
};

#endif

---