FluxBox.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 _FLUXBOX_H_
#define _FLUXBOX_H_

#include "Box.H"
#include "Vector.H"
#include "FArrayBox.H"
#include "NamespaceHeader.H"


class FluxBox
{

public:
  FluxBox();

  FluxBox(const Box& bx, int n=1);

  ~FluxBox();

  void resize(const Box& bx, int n=1);

  void define(const Box& bx, int n=1);

  void clear();

  //  access functions

  int nComp() const;

  const Box& box() const;

  FArrayBox& getFlux(const int dir);

  const FArrayBox& getFlux(const int dir) const;

  FArrayBox& operator[] (const int dir);

  const FArrayBox& operator[] (const int dir) const;

  //  data modification functions

  void setVal(const Real val);

  void setVal(const Real val, const int dir);

  void setVal(const Real val, const int dir, const int startComp,
              const int nComp);

  void setVal(const Real val, const Box& bx);


  void setVal(const Real val, const Box& bx, const int dir,
              const int startComp, const int nComp);

  void copy(const FluxBox& src);

  void copy(const FluxBox& src, const int srcComp,
            const int destComp, const int numComp);

  void copy(const FluxBox& src, const int dir, const int srcComp,
            const int destComp, const int numComp);

  void copy(const FluxBox& a_src,
            const Box&     a_destbox);



  void copy(const Box& R, const Interval& Cdest,  const FluxBox& src,
            const Interval& Csrc);


  void copy (const Box&        srcbox,
             const Interval&   destcomps,
             const Box&        destbox,
             const FluxBox&    src,
             const Interval&   srccomps);


  FluxBox& negate (const Box& subbox,
                   int        comp=0,
                   int        numcomp=1);


  FluxBox& negate (int comp,
                   int numcomp=1);


  FluxBox& negate ();



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



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



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



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

  FluxBox& operator+= (Real r);


  FluxBox& operator+= (const FluxBox& f);

  FluxBox& operator-= (Real r);


  FluxBox& operator-= (const FluxBox& f);

  FluxBox& operator*= (Real r);


  FluxBox& operator*= (const FluxBox& f);

  FluxBox& shift (const IntVect& v);

  //  Linearization Functions


  int size(const Box& bx, const Interval& comps) const;


  void linearOut(void*buf, const Box& R, const Interval& comps) const;


  void linearIn(void*buf, const Box& R, const Interval& comps);

  static int preAllocatable() {return 0;}


protected:
  Box m_bx;

  int m_nvar;

  Vector<FArrayBox*> m_fluxes;


private:
  // these are disallowed

  FluxBox (const FluxBox&);
  FluxBox& operator = (const FluxBox&);

};

#include "NamespaceFooter.H"
#endif

---