FArrayBox.H

Go to the documentation of this file.

#ifdef CH_LANG_CC
/*
*      _______              __
*     / ___/ /  ___  __ _  / /  ___
*    / /__/ _ \/ _ \/  V \/ _ \/ _ \
*    \___/_//_/\___/_/_/_/_.__/\___/
*    Please refer to Copyright.txt, in Chombo's root directory.
*/
#endif

#ifndef _FARRAYBOX_H_
#define _FARRAYBOX_H_

#ifndef WRAPPER
#include <iostream>

// #include <Pointers.H>
#include "Box.H"
#include "BaseFab.H"
#endif

#include "REAL.H"
#include "SPACE.H"
#include "NamespaceHeader.H"


class FArrayBox: public BaseFab<Real>
{
public:


  FArrayBox ();


  FArrayBox(const Box& a_box,
            int        a_ncomp,
            Real*      a_alias = NULL);


  FArrayBox(const Interval& a_comps,
            FArrayBox&      a_original)
    :
    BaseFab<Real>(a_comps, a_original)
  {}


  virtual void define(const Box& a_box,
                      int        a_ncomp,
                      Real*      a_alias = NULL)
  {
    resize(a_box, a_ncomp, a_alias);
  }


  virtual ~FArrayBox ();


  virtual void define(const Interval& a_comps,
                      FArrayBox&      a_original)
  {
    BaseFab<Real>::define(a_comps, a_original);
  }


  virtual void define(const Interval& a_comps,
              BaseFab<Real>&      a_original)
  {
    BaseFab<Real>::define(a_comps, a_original);
  }


  explicit FArrayBox(std::istream& a_is);


  virtual Real norm(const Box& a_subbox,
                    int        a_p = 2,
                    int        a_comp = 0,
                    int        a_numcomp = 1) const;


  virtual Real norm(int a_p = 2,
                    int a_comp = 0,
                    int a_numcomp = 1) const;


  virtual Real sumPow(const Box& a_subbox,
                      int        a_p = 2,
                      int        a_comp = 0,
                      int        a_numcomp = 1) const;


  Real dotProduct(const FArrayBox& a_fab2) const;


  Real dotProduct(const FArrayBox& a_fab2, const Box& a_box) const;


  Real min(int a_comp = 0) const;


  Real min(const Box& a_subbox,
           int        a_comp = 0) const;


  Real max(int a_comp = 0) const;


  Real max(const Box& a_subbox,
           int        a_comp = 0) const;


  IntVect minIndex(int a_comp = 0) const;


  IntVect minIndex(const Box& a_subbox,
                   int        a_comp = 0) const;


  IntVect maxIndex(int a_comp = 0) const;


  IntVect maxIndex(const Box& a_subbox,
                   int        a_comp = 0) const;


  int maskLT(BaseFab<int>& a_mask,
             Real          a_val,
             int           a_comp = 0) const;


  int maskLE(BaseFab<int>& a_mask,
             Real          a_val,
             int           a_comp = 0) const;

  int maskEQ(BaseFab<int>& a_mask,
             Real          a_val,
             int           a_comp = 0) const;

  int maskGT(BaseFab<int>& a_mask,
             Real          a_val,
             int           a_comp = 0) const;


  int maskGE(BaseFab<int>& a_mask,
             Real          a_val,
             int           a_comp = 0) const;


  void abs();


  void abs(int a_comp,
           int a_numcomp = 1);


  void abs (const Box& a_subbox,
            int        a_comp = 0,
            int        a_numcomp = 1);


  Real sum(int a_comp,
           int a_numcomp = 1) const;


  Real sum(const Box& a_subbox,
           int        a_comp,
           int        a_numcomp = 1) const;


  FArrayBox& invert(Real a_r);


  FArrayBox& invert(Real a_r,
                    int  a_comp,
                    int  a_numcomp = 1);


  FArrayBox& invert(Real       a_r,
                    const Box& a_subbox,
                    int        a_comp = 0,
                    int        a_numcomp = 1);


  FArrayBox& negate(const Box& a_subbox,
                    int        a_comp = 0,
                    int        a_numcomp = 1);


  FArrayBox& negate(int a_comp,
                    int a_numcomp = 1);


  FArrayBox& negate();


  FArrayBox& plus(Real       a_r,
                  const Box& a_subbox,
                  int        a_comp = 0,
                  int        a_numcomp = 1);


  FArrayBox& plus(Real a_r,
                  int  a_comp,
                  int  a_numcomp = 1);


  FArrayBox& operator += (Real a_r);


  FArrayBox& operator += (const FArrayBox& a_x);


  FArrayBox& plus(Real a_r);

  FArrayBox& plus_real(Real a_r)
  {
    return this->plus(a_r);
  }


  FArrayBox& plus(const FArrayBox& a_x);


  FArrayBox& plus(const FArrayBox& a_src,
                  const Real&      a_scale);


  FArrayBox& plus(const FArrayBox& a_src,
                  const Real&      a_scale,
                  int              a_srccomp,
                  int              a_destcomp,
                  int              a_numcomp = 1);


  FArrayBox& plus(const FArrayBox& a_src,
                  int              a_srccomp,
                  int              a_destcomp,
                  int              a_numcomp = 1);


  FArrayBox& plus(const FArrayBox& a_src,
                  const Box&       a_subbox,
                  int              a_srccomp,
                  int              a_destcomp,
                  int              a_numcomp = 1);


  FArrayBox& plus(const FArrayBox& a_src,
                  const Box&       a_srcbox,
                  const Box&       a_destbox,
                  int              a_srccomp,
                  int              a_destcomp,
                  int              a_numcomp = 1);

  FArrayBox& plus(const FArrayBox& a_src,
                  const Box&       a_srcbox,
                  const Box&       a_destbox,
                  const Real&      a_scale,
                  int              a_srccomp,
                  int              a_destcomp,
                  int              a_numcomp = 1);


  FArrayBox& operator -= (Real a_r);


  FArrayBox& operator -= (const FArrayBox& a_x);


  FArrayBox& minus(const FArrayBox& a_x);

  FArrayBox& minus(const FArrayBox& a_src,
                   int              a_srccomp,
                   int              a_destcomp,
                   int              a_numcomp = 1);

  FArrayBox& minus(const FArrayBox& a_src,
                   const Box&       a_subbox,
                   int              a_srccomp,
                   int              a_destcomp,
                   int              a_numcomp = 1);


  FArrayBox& minus(const FArrayBox& a_src,
                   const Box&       a_srcbox,
                   const Box&       a_destbox,
                   int              a_srccomp,
                   int              a_destcomp,
                   int              a_numcomp = 1);


  FArrayBox& operator *= (Real a_r);


  FArrayBox& mult(Real a_r);


  FArrayBox& mult(Real a_r,
                  int  a_comp,
                  int  a_numcomp = 1);


  FArrayBox& mult(Real       a_r,
                  const Box& a_subbox,
                  int        a_comp = 0,
                  int        a_numcomp = 1);


  FArrayBox& operator *= (const FArrayBox& a_x);


  FArrayBox& mult(const FArrayBox& a_x);


  FArrayBox& mult(const FArrayBox& a_src,
                  int              a_srccomp,
                  int              a_destcomp,
                  int              a_numcomp = 1);


  FArrayBox& mult(const FArrayBox& a_src,
                  const Box&       a_subbox,
                  int              a_srccomp,
                  int              a_destcomp,
                  int              a_numcomp = 1);


  FArrayBox& mult(const FArrayBox& a_src,
                  const Box&       a_srcbox,
                  const Box&       a_destbox,
                  int              a_srccomp,
                  int              a_destcomp,
                  int              a_numcomp = 1);


  FArrayBox& operator /= (Real a_r);


  FArrayBox& divide(Real a_r);


  FArrayBox& divide(Real a_r,
                    int  a_comp,
                    int  a_numcomp = 1);


  FArrayBox& divide(Real       a_r,
                    const Box& a_subbox,
                    int        a_comp = 0,
                    int        a_numcomp = 1);


  FArrayBox& operator /= (const FArrayBox& a_x);


  FArrayBox& divide(const FArrayBox& a_x);


  FArrayBox& divide(const FArrayBox& a_src,
                    int              a_srccomp,
                    int              a_destcomp,
                    int              a_numcomp = 1);


  FArrayBox& divide(const FArrayBox& a_src,
                    const Box&       a_subbox,
                    int              a_srccomp,
                    int              a_destcomp,
                    int              a_numcomp = 1);


  FArrayBox& divide(const FArrayBox& a_src,
                    const Box&       a_srcbox,
                    const Box&       a_destbox,
                    int              a_srccomp,
                    int              a_destcomp,
                    int              a_numcomp = 1);

  Real get(const IntVect& a_iv,
           int            a_comp) const
  {
    return this->operator()(a_iv, a_comp);
  }

  void set(const IntVect& a_iv,
           int            a_comp,
           Real           a_val)
  {
    this->operator()(a_iv, a_comp) = a_val;
  }


protected:
  virtual void performCopy(const BaseFab<Real>& a_src,
                           const Box&           a_srcbox,
                           int                  a_srccomp,
                           const Box&           a_destbox,
                           int                  a_destcomp,
                           int                  a_numcomp);


private:
  //
  // These are disallowed.
  //
  FArrayBox (const FArrayBox&);
  FArrayBox& operator = (const FArrayBox&);
};

#include "NamespaceFooter.H"
#endif

---