FluxBox.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 _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& negate (const Box& subbox,
                   int        comp=0,
                   int        numcomp=1);


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


  FluxBox& negate ();

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

};

#endif

---