FluxBox.H

Go to the documentation of this file.

/* _______              __
  / ___/ /  ___  __ _  / /  ___
 / /__/ _ \/ _ \/  ' \/ _ \/ _ \
 \___/_//_/\___/_/_/_/_.__/\___/ 
*/

// FluxBox.H

//
// 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.
//
// Dan Martin, Fri, Jan 14, 2000

#ifndef _FluxBox_H_
#define _FluxBox_H_

#include "Box.H"
#include "Vector.H"
#include "FArrayBox.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 Box& R, const Interval& Cdest,  const FluxBox& src,
            const Interval& Csrc);


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

  

  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&);

};

  

#endif

---