Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

FluxBox.H

Go to the documentation of this file.
00001 /*   _______              __
00002     / ___/ /  ___  __ _  / /  ___
00003    / /__/ _ \/ _ \/  V \/ _ \/ _ \
00004    \___/_//_/\___/_/_/_/_.__/\___/
00005 */
00006 // CHOMBO Copyright (c) 2000-2004, The Regents of the University of
00007 // California, through Lawrence Berkeley National Laboratory (subject to
00008 // receipt of any required approvals from U.S. Dept. of Energy).  All
00009 // rights reserved.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are met:
00013 //
00014 // (1) Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 // (2) Redistributions in binary form must reproduce the above copyright
00017 // notice, this list of conditions and the following disclaimer in the
00018 // documentation and/or other materials provided with the distribution.
00019 // (3) Neither the name of Lawrence Berkeley National Laboratory, U.S.
00020 // Dept. of Energy nor the names of its contributors may be used to endorse
00021 // or promote products derived from this software without specific prior
00022 // written permission.
00023 //
00024 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00025 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
00026 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
00027 // PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
00028 // OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00029 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00030 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00031 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00032 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00033 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00034 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00035 //
00036 // You are under no obligation whatsoever to provide any bug fixes,
00037 // patches, or upgrades to the features, functionality or performance of
00038 // the source code ("Enhancements") to anyone; however, if you choose to
00039 // make your Enhancements available either publicly, or directly to
00040 // Lawrence Berkeley National Laboratory, without imposing a separate
00041 // written license agreement for such Enhancements, then you hereby grant
00042 // the following license: a non-exclusive, royalty-free perpetual license
00043 // to install, use, modify, prepare derivative works, incorporate into
00044 // other computer software, distribute, and sublicense such Enhancements or
00045 // derivative works thereof, in binary and source code form.
00046 //
00047 // TRADEMARKS. Product and company names mentioned herein may be the
00048 // trademarks of their respective owners.  Any rights not expressly granted
00049 // herein are reserved.
00050 //
00051 
00052 #ifndef _FLUXBOX_H_
00053 #define _FLUXBOX_H_
00054 
00055 #include "Box.H"
00056 #include "Vector.H"
00057 #include "FArrayBox.H"
00058 
00060 
00062 class FluxBox
00063 {
00064 
00065 public:
00067   FluxBox();
00068 
00070   FluxBox(const Box& bx, int n=1);
00071 
00073   ~FluxBox();
00074 
00076   void resize(const Box& bx, int n=1);
00077 
00079   void define(const Box& bx, int n=1);
00080 
00082   void clear();
00083 
00084   //  access functions
00085 
00087   int nComp() const;
00088 
00090   const Box& box() const;
00091 
00093   FArrayBox& getFlux(const int dir);
00094 
00096   const FArrayBox& getFlux(const int dir) const;
00097 
00099   FArrayBox& operator[] (const int dir);
00100 
00102   const FArrayBox& operator[] (const int dir) const;
00103 
00104   //  data modification functions
00105 
00107   void setVal(const Real val);
00108 
00110   void setVal(const Real val, const int dir);
00111 
00113   void setVal(const Real val, const int dir, const int startComp,
00114               const int nComp);
00115 
00117   void setVal(const Real val, const Box& bx);
00118 
00120 
00123   void setVal(const Real val, const Box& bx, const int dir,
00124               const int startComp, const int nComp);
00125 
00127   void copy(const FluxBox& src);
00128 
00130   void copy(const FluxBox& src, const int srcComp,
00131             const int destComp, const int numComp);
00132 
00134   void copy(const FluxBox& src, const int dir, const int srcComp,
00135             const int destComp, const int numComp);
00136 
00138 
00143   void copy(const Box& R, const Interval& Cdest,  const FluxBox& src,
00144             const Interval& Csrc);
00145 
00147 
00163   void copy (const Box&        srcbox,
00164              const Interval&   srccomps,
00165              const Box&        destbox,
00166              const FluxBox&    src,
00167              const Interval&    destcomps);
00168 
00170 
00175   FluxBox& negate (const Box& subbox,
00176                    int        comp=0,
00177                    int        numcomp=1);
00178 
00180 
00185   FluxBox& negate (int comp,
00186                    int numcomp=1);
00187 
00189 
00194   FluxBox& negate ();
00195 
00197   FluxBox& operator+= (Real r);
00198 
00200 
00205   FluxBox& operator+= (const FluxBox& f);
00206 
00208   FluxBox& operator-= (Real r);
00209 
00211 
00216   FluxBox& operator-= (const FluxBox& f);
00217 
00219   FluxBox& operator*= (Real r);
00220 
00222 
00227   FluxBox& operator*= (const FluxBox& f);
00228 
00230   FluxBox& shift (const IntVect& v);
00231 
00232   //  Linearization Functions
00233 
00235 
00240   int size(const Box& bx, const Interval& comps) const;
00241 
00243 
00248   void linearOut(void*buf, const Box& R, const Interval& comps) const;
00249 
00251 
00254   void linearIn(void*buf, const Box& R, const Interval& comps);
00255 
00257   static int preAllocatable() {return 0;}
00258 
00259 
00260 protected:
00264   Box m_bx;
00265 
00269   int m_nvar;
00270 
00274   Vector<FArrayBox*> m_fluxes;
00275 
00276 
00277 private:
00278   // these are disallowed
00279 
00281   FluxBox (const FluxBox&);
00283   FluxBox& operator = (const FluxBox&);
00284 
00285 };
00286 
00287 #endif

Generated on Wed Jan 19 17:51:24 2005 for Chombo&INSwithParticles by doxygen1.2.16