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

PhysIBC.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 //
00053 //  PhysIBC.H
00054 // ============
00055 //
00056 // Virtual base class through which a user specifies the initial and boundary
00057 // conditions for a hyperbolic system of PDEs.
00058 //
00059 
00060 #ifndef _PHYSIBC_H_
00061 #define _PHYSIBC_H_
00062 
00063 #include "FArrayBox.H"
00064 #include "REAL.H"
00065 #include "LevelData.H"
00066 #include "ProblemDomain.H"
00067 
00069 
00073 class PhysIBC
00074 {
00075 public:
00077 
00079   PhysIBC();
00080 
00082 
00084   virtual ~PhysIBC();
00085 
00087 
00091   virtual void define(const ProblemDomain& a_domain,
00092                       const Real&          a_dx);
00093 
00095 
00099   virtual PhysIBC* new_physIBC() = 0;
00100 
00102 
00104   virtual void initialize(LevelData<FArrayBox>& a_U) = 0;
00105 
00107 
00109   virtual void primBC(FArrayBox&            a_WGdnv,
00110                       const FArrayBox&      a_Wextrap,
00111                       const FArrayBox&      a_W,
00112                       const int&            a_dir,
00113                       const Side::LoHiSide& a_side,
00114                       const Real&           a_time) = 0;
00115 
00117 
00122   virtual
00123   void setBdrySlopes(FArrayBox&       a_dW,
00124                      const FArrayBox& a_W,
00125                      const int&       a_dir,
00126                      const Real&      a_time) = 0;
00127 
00129 
00131   virtual
00132   void artViscBC(FArrayBox&       a_F,
00133                  const FArrayBox& a_U,
00134                  const FArrayBox& a_divVel,
00135                  const int&       a_dir,
00136                  const Real&      a_time) = 0;
00137 
00138 
00139 protected:
00140   // Has this object been defined
00141   bool          m_isDefined;
00142 
00143   // The current level's problem domain
00144   ProblemDomain m_domain;
00145 
00146   // The current level's grid spacing
00147   Real          m_dx;
00148 
00149 
00150 private:
00151   // Disallowed for all the usual reasons
00152   void operator=(const PhysIBC& a_input)
00153   {
00154     MayDay::Error("invalid operator");
00155   }
00156 
00157   // Disallowed for all the usual reasons
00158   PhysIBC(const PhysIBC& a_input)
00159   {
00160     MayDay::Error("invalid operator");
00161   }
00162 };
00163 
00164 #endif

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