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

AMRLevelSelfGravityFactory.H

Go to the documentation of this file.
00001 /* _______              __
00002   / ___/ /  ___  __ _  / /  ___
00003  / /__/ _ \/ _ \/  ' \/ _ \/ _ \
00004  \___/_//_/\___/_/_/_/_.__/\___/
00005 */
00006 //
00007 // This software is copyright (C) by the Lawrence Berkeley
00008 // National Laboratory.  Permission is granted to reproduce
00009 // this software for non-commercial purposes provided that
00010 // this notice is left intact.
00011 //
00012 // It is acknowledged that the U.S. Government has rights to
00013 // this software under Contract DE-AC03-765F00098 between
00014 // the U.S.  Department of Energy and the University of
00015 // California.
00016 //
00017 // This software is provided as a professional and academic
00018 // contribution for joint exchange. Thus it is experimental,
00019 // is provided ``as is'', with no warranties of any kind
00020 // whatsoever, no support, no promise of updates, or printed
00021 // documentation. By using this software, you acknowledge
00022 // that the Lawrence Berkeley National Laboratory and
00023 // Regents of the University of California shall have no
00024 // liability with respect to the infringement of other
00025 // copyrights by any part of this software.
00026 //
00027 
00028 #ifndef _AMR_LEVEL_SELFGRAVITY_FACTORY_H_
00029 #define _AMR_LEVEL_SELFGRAVITY_FACTORY_H_
00030 
00031 #include "AMRLevelFactory.H"
00032 #include "AMRLevelSelfGravity.H"
00033 
00035 class AMRLevelSelfGravityFactory : public AMRLevelFactory
00036 {
00037 public:
00039   AMRLevelSelfGravityFactory();
00040 
00042   virtual AMRLevel* new_amrlevel() const;
00043 
00045   virtual ~AMRLevelSelfGravityFactory();
00046 
00048   virtual void define(const Real&                 a_cfl,
00049                      const Real&                 a_domainLength,
00050                      const int&                  a_verbosity,
00051                      const int&                  a_tagBufferSize,
00052                      const int&                  a_maxInitRefLevel,
00053                      const Real&                 a_initialDtMultiplier,
00054                      const GodunovPhysics* const a_godunovPhysics,
00055                      const int&                  a_normalPredOrder,
00056                      const bool&                 a_useFourthOrderSlopes,
00057                      const bool&                 a_usePrimLimiting,
00058                      const bool&                 a_useCharLimiting,
00059                      const bool&                 a_useFlattening,
00060                      const bool&                 a_useArtificialViscosity,
00061                      const Real&                 a_artificialViscosity,
00062                      const RefCellTagger* const  a_refCellTagger,
00063                      const LevelOp* const        a_poissonOp,
00064                      const bool&                 a_useDeltaPhiCorr,
00065                       const StencilType&          a_stencil);
00066 
00068   bool isDefined() const;
00069 
00070 protected:
00071   // Some default values
00072   void setDefaultValues();
00073 
00074   //
00075   int m_verbosity;
00076 
00077   // CFL numbers for hydro
00078   Real m_cfl;
00079 
00080   // Physical dimension of the longest side of the domain
00081   Real m_domainLength;
00082 
00083   // max level of refinement at start
00084   int m_maxInitRefLevel;
00085 
00086   // Tag buffer size
00087   int  m_tagBufferSize;
00088 
00089   // Initial dt multiplier 
00090   Real m_initialDtMultiplier;
00091 
00092   // Order of the normal predictor (1 -> PLM, 2 -> PPM)
00093   int m_normalPredOrder;
00094 
00095   // Use 4th other slope computations (otherwise, use 2nd order)
00096   bool m_useFourthOrderSlopes;
00097 
00098   // Do slope limiting in the primitive or characteristic variables, respect.
00099   bool m_usePrimLimiting;
00100   bool m_useCharLimiting;
00101 
00102   // Do slope flattening - MUST BE USING 4th order slopes
00103   bool m_useFlattening;
00104 
00105   // Apply artificial viscosity of a set value
00106   bool m_useArtificialViscosity;
00107   Real m_artificialViscosity;
00108 
00109   // stencil for the derivative (eg to get F from phi)
00110   StencilType m_stencil;
00111 
00112   // whether or not the deltaPhi correction should be applied
00113   bool m_useDeltaPhiCorr;
00114 
00115   // Pointer to the object that supplies the physics needed by the integrator
00116   // (used as a factory)
00117   const GodunovPhysics* m_godunovPhysics;
00118 
00119   //
00120   const LevelOp* m_poissonOp;
00121 
00122   // 
00123   const RefCellTagger* m_refCellTagger;
00124 
00125   // is all defined
00126   bool m_isDefined;
00127 
00128 private:
00129   // Disallowed for all the usual reasons
00130   void operator=(const AMRLevelSelfGravityFactory& a_input)
00131   {
00132     MayDay::Error("invalid operator");
00133   }
00134 
00135   // Disallowed for all the usual reasons
00136   AMRLevelSelfGravityFactory(const AMRLevelSelfGravityFactory& a_input)
00137   {
00138     MayDay::Error("invalid operator");
00139   }
00140 };
00141 
00142 #endif

Generated on Wed Oct 19 13:33:47 2005 for Chombo&AMRSelfGravity by doxygen 1.3.2