---

NodeMaskAverage.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.
//

// petermc, Tue, Nov 28, 2000
// rewritten to call NodeMaskAverage2, petermc, 2 Aug 2001

#ifndef NODEMASKAVERAGE_H
#define NODEMASKAVERAGE_H

#include "REAL.H"
#include "NodeFArrayBox.H"
#include "LevelData.H"
#include "ProblemDomain.H"
#include "DisjointBoxLayout.H"
#include "NodeMaskAverage2.H"


class NodeMaskAverage
{
public:



  NodeMaskAverage();


  NodeMaskAverage(const DisjointBoxLayout& a_gridsFine,
                  const DisjointBoxLayout& a_gridsCoarse,
                  int                      a_numcomps,
                  int                      a_refRatio,
                  const ProblemDomain&     a_domainFine,
                  Real                     a_dx);

  NodeMaskAverage(const DisjointBoxLayout& a_gridsFine,
                  const DisjointBoxLayout& a_gridsCoarse,
                  int                      a_numcomps,
                  int                      a_refRatio,
                  const Box&               a_domainFine,
                  Real                     a_dx);
  

  NodeMaskAverage(const DisjointBoxLayout& a_gridsCoarse,
                  int                      a_numcomps,
                  int                      a_refRatio,
                  const ProblemDomain&     a_domainFine,
                  Real                     a_dx);
  
  NodeMaskAverage(const DisjointBoxLayout& a_gridsCoarse,
                  int                      a_numcomps,
                  int                      a_refRatio,
                  const Box&               a_domainFine,
                  Real                     a_dx);
  

  ~NodeMaskAverage();


  void define(const DisjointBoxLayout& a_gridsFine,
              const DisjointBoxLayout& a_gridsCoarse,
              int                      a_numcomps,
              int                      a_refRatio,
              const ProblemDomain&     a_domainFine,
              Real                     a_dx);

  void define(const DisjointBoxLayout& a_gridsFine,
              const DisjointBoxLayout& a_gridsCoarse,
              int                      a_numcomps,
              int                      a_refRatio,
              const Box&               a_domainFine,
              Real                     a_dx);


  void define(const DisjointBoxLayout& a_gridsCoarse,
              int                      a_numcomps,
              int                      a_refRatio,
              const ProblemDomain&     a_domainFine,
              Real                     a_dx);

  void define(const DisjointBoxLayout& a_gridsCoarse,
              int                      a_numcomps,
              int                      a_refRatio,
              const Box&               a_domainFine,
              Real                     a_dx);



  bool isDefined() const;
  



  //     this method would like to be const, but the work array is changed.
  //     this suggests that the work array should not be persistent.
  void averageToCoarse(LevelData<NodeFArrayBox>& a_coarse,
                       LevelData<NodeFArrayBox>& a_fine);

protected:
  //delete internal memory and set pointers to null
  void clearMemory();

  bool is_defined;

  // the refinement ratio
  int m_refRatio;

  // the number of coarsenings to be done:  this is log2(m_refRatio).
  int m_coarsenings;

  // data at intermediate coarsening levels.  length m_coarsenings-1.
  Vector< LevelData<NodeFArrayBox>* > m_inter;

  // vector of averaging objects.  length m_coarsenings.
  // m_avg2[i] averages refined versions of the SAME grids if i > 1,
  // and in general DIFFERENT grids if i == 0.
  Vector<NodeMaskAverage2*> m_avg2;
};

#endif

---