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

GhostBC.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 // DTGraves, Mon, July 19, 1999
00053 
00054 #ifndef _GHOSTBC_H_
00055 #define _GHOSTBC_H_
00056 
00057 #include "Box.H"
00058 #include "FArrayBox.H"
00059 #include "REAL.H"
00060 #include "SPACE.H"
00061 #include "List.H"
00062 #include "Tuple.H"
00063 
00064 #include "Interval.H"
00065 #include "Vector.H"
00066 #include "LoHiSide.H"
00067 #include "ProblemDomain.H"
00068 
00070 
00080 class BoxGhostBC
00081 {
00082 public:
00083   friend class DomainGhostBC;
00084 
00086   BoxGhostBC()
00087     :
00088     m_components(-1,-1)
00089   {
00090   }
00091 
00093   virtual ~BoxGhostBC()
00094   {
00095   }
00096 
00098   BoxGhostBC(int            a_dir,
00099              Side::LoHiSide a_sd);
00100 
00102   BoxGhostBC(int             a_dir,
00103              Side::LoHiSide  a_sd,
00104              const Interval& a_comps);
00105 
00106 protected:
00110   virtual BoxGhostBC* new_boxghostbc() const = 0;
00111 
00115   void define(int            a_dir,
00116               Side::LoHiSide a_sd);
00117 
00119 
00122   void define(int             a_dir,
00123               Side::LoHiSide  a_sd,
00124               const Interval& a_comps);
00125 
00127 
00132   virtual void applyInhomogeneousBCs(FArrayBox& a_state,
00133                                      const Box& a_domain,
00134                                      Real       a_dx) const;
00135 
00137 
00142   virtual void applyHomogeneousBCs(FArrayBox& a_state,
00143                                    const Box& a_domain,
00144                                    Real       a_dx) const;
00145 
00147 
00151   virtual void applyInhomogeneousBCs(FArrayBox&           a_state,
00152                                      const ProblemDomain& a_domain,
00153                                      Real                 a_dx) const;
00154 
00156 
00160   virtual void applyHomogeneousBCs(FArrayBox&           a_state,
00161                                    const ProblemDomain& a_domain,
00162                                    Real                 a_dx) const;
00163 
00165 
00168   virtual void fillBCValues(FArrayBox& a_neumfac,
00169                             FArrayBox& a_dircfac,
00170                             FArrayBox& a_inhmval,
00171                             Real       a_dx,
00172                             const Box& a_domain) const = 0;
00173 
00175 
00180   virtual void applyBCs(const Box&       a_bcbox,
00181                         FArrayBox&       a_state,
00182                         const FArrayBox& a_neumfac,
00183                         const FArrayBox& a_dircfac,
00184                         const FArrayBox& a_inhmval,
00185                         Real             a_dx) const;
00186 
00188 
00195   virtual void fillBCValues(FArrayBox&           a_neumfac,
00196                             FArrayBox&           a_dircfac,
00197                             FArrayBox&           a_inhmval,
00198                             Real                 a_dx,
00199                             const ProblemDomain& a_domain) const = 0;
00200 
00204   Side::LoHiSide m_side;
00205 
00209   int m_direction;
00210 
00214   Interval m_components;
00215 
00216 private:
00217   BoxGhostBC(const BoxGhostBC&)
00218     :
00219     m_components(-1,-1)
00220   {
00221   }
00222 
00223   virtual void operator=(const BoxGhostBC&)
00224   {
00225   }
00226 };
00227 
00229 
00243 class DomainGhostBC
00244 {
00245 public:
00247   DomainGhostBC();
00248 
00250   ~DomainGhostBC();
00251 
00253 
00257   void setBoxGhostBC(const BoxGhostBC& a_ghostBC);
00258 
00260   const List<BoxGhostBC*>& operator()(int            a_direction,
00261                                       Side::LoHiSide a_side) const;
00262 
00264 
00266   void applyHomogeneousBCs(FArrayBox& a_state,
00267                            const Box& a_domain,
00268                            Real       a_dx) const;
00269 
00271 
00273   void applyHomogeneousBCs(FArrayBox&           a_state,
00274                            const ProblemDomain& a_domain,
00275                            Real                 a_dx) const;
00276 
00278 
00280   void applyInhomogeneousBCs(FArrayBox& a_state,
00281                              const Box& a_domain,
00282                              Real       a_dx) const;
00283 
00285 
00287   void applyInhomogeneousBCs(FArrayBox&           a_state,
00288                              const ProblemDomain& a_domain,
00289                              Real                 a_dx) const;
00290 
00292   DomainGhostBC& operator=(const DomainGhostBC& a_dgbcin);
00293 
00295   DomainGhostBC(const DomainGhostBC& a_dgbcin);
00296 
00297 protected:
00301   bool isBCDefined(const int            a_dir,
00302                    const Side::LoHiSide a_side) const;
00303 
00308   void resetBoxGhostBC(const int            a_dir,
00309                        const Side::LoHiSide a_side);
00310 
00314   Tuple<List<BoxGhostBC*>, SpaceDim> m_loGhostBC;
00318   Tuple<List<BoxGhostBC*>, SpaceDim> m_hiGhostBC;
00319 
00320 private:
00321 };
00322 
00323 #endif

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