MeshRefine.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 _MESHREFINE_H_
#define _MESHREFINE_H_

#include <climits>

#include "Vector.H"
#include "Box.H"
#include "IntVectSet.H"
#include "REAL.H"
#include "ProblemDomain.H"

// Constants:

class MeshRefine
{
public:
  MeshRefine();

  MeshRefine(
               const Box& a_baseDomain,
               const Vector<int>& a_refRatios,
               const Real a_fillRatio,
               const int a_blockFactor,
               const int a_bufferSize,
               const int a_maxSize);

  MeshRefine(
               const ProblemDomain& a_baseDomain,
               const Vector<int>& a_refRatios,
               const Real a_fillRatio,
               const int a_blockFactor,
               const int a_bufferSize,
               const int a_maxSize);

  virtual ~MeshRefine();

  void define(
              const Box& a_baseDomain,
              const Vector<int>& a_refRatios,
              const Real a_fillRatio,
              const int a_blockFactor,
              const int a_bufferSize,
              const int a_maxSize);

  void define(
              const ProblemDomain& a_baseDomain,
              const Vector<int>& a_refRatios,
              const Real a_fillRatio,
              const int a_blockFactor,
              const int a_bufferSize,
              const int a_maxSize);


  virtual int regrid(
                     Vector<Vector<Box> >& a_newmeshes,
                     const IntVectSet& a_tags,
                     const int a_baseLevel,
                     const int a_topLevel,
                     const Vector<Vector<Box> >& a_oldMeshes) const;


  virtual int regrid(
                     Vector<Vector<Box> >& a_newmeshes,
                     const Vector<IntVectSet>& a_tags,
                     const int a_baseLevel,
                     const int a_topLevel,
                     const Vector<Vector<Box> >& a_oldMeshes) const;

  // Access functions

  const Vector<int>& refRatios() const;

  Real fillRatio() const;

  int blockFactor() const;

  int bufferSize() const;

  int maxSize() const;

  void refRatios(const Vector<int>& a_nRefVect);

  void fillRatio(const Real a_fill_ratio);

  void blockFactor(const int a_block_factor);

  void bufferSize(const int a_buffer_size);

  void  maxSize(const int a_max_size);

  bool isDefined() const;

  void granularity(int a_granularity);


  virtual void
  makeBoxes(
            Vector<Box>&      a_mesh,
            const IntVectSet& a_tags,
            const IntVectSet& a_pnd,
            const ProblemDomain& a_domain,
            const int         a_maxSize) const = 0;


protected:


  virtual void
  computeLocalBlockFactors();


  virtual void
  makePNDs(
           Vector<IntVectSet>& a_pnds,
           const int           a_baseLevel,
           const int           a_topLevel,
           const Vector<ProblemDomain>&  a_domains,
           const IntVectSet&   a_baseMesh,
           const Vector<int>&  a_bufferSize ) const;

  // local data members

  bool m_isDefined;

  Vector<ProblemDomain> m_vectDomains;

  Vector<int> m_nRefVect;

  Real m_fillRatio;

  int m_blockFactor;

  Vector<int> m_level_blockfactors;

  int m_bufferSize;

  int m_maxSize;

  int m_granularity;

};

#endif

---