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

#include "REAL.H"
#include "Box.H"
#include "DisjointBoxLayout.H"
#include "ProblemDomain.H"
#include "DataIterator.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 CH_USE_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

---