PatchGodunov.H

Go to the documentation of this file.

#ifdef CH_LANG_CC
/*
*      _______              __
*     / ___/ /  ___  __ _  / /  ___
*    / /__/ _ \/ _ \/  V \/ _ \/ _ \
*    \___/_//_/\___/_/_/_/_.__/\___/
*    Please refer to Copyright.txt, in Chombo's root directory.
*/
#endif

#ifndef _PATCHGODUNOV_H_
#define _PATCHGODUNOV_H_

#include "Box.H"
#include "IntVectSet.H"
#include "Vector.H"
#include "FluxBox.H"

#include "GodunovPhysics.H"
#include "GodunovUtilities.H"
#include "NamespaceHeader.H"

class HDF5HeaderData;


class PatchGodunov
{
public:

  PatchGodunov();


  virtual ~PatchGodunov();


  virtual void define(const ProblemDomain&        a_domain,
                      const Real&                 a_dx,
                      const GodunovPhysics* const a_gdnvPhysicsPtr,
                      const int&                  a_normalPredOrder,
                      const bool&                 a_useFourthOrderSlopes,
                      const bool&                 a_usePrimLimiting,
                      const bool&                 a_useCharLimiting,
                      const bool&                 a_useFlattening,
                      const bool&                 a_useArtificialViscosity,
                      const Real&                 a_artificialViscosity);


  virtual void setCurrentTime(const Real& a_currentTime);


  virtual void setCurrentBox(const Box& a_currentBox);


  virtual void updateState(FArrayBox&       a_U,
                           FluxBox&         a_F,
                           Real&            a_maxWaveSpeed,
                           const FArrayBox& a_S,
                           const Real&      a_dt,
                           const Box&       a_box);

  virtual void updateState(FArrayBox&       a_U,
                           FluxBox&         a_F,
                           FluxBox&         a_wHalf,
                           Real&            a_maxWaveSpeed,
                           const FArrayBox& a_S,
                           const Real&      a_dt,
                           const Box&       a_box);


  virtual void computeWHalf(FluxBox&         a_WHalf,
                            const FArrayBox& a_U,
                            const FArrayBox& a_S,
                            const Real&      a_dt,
                            const Box&       a_box);


  virtual void computeUpdate(FArrayBox&       a_dU,
                             FluxBox&         a_F,
                             const FArrayBox& a_U,
                             const FluxBox&   a_WHalf,
                             const Real&      a_dt,
                             const Box&       a_box);


  void computeFluxes(FluxBox&        a_F,
                     const FluxBox&  a_WHalf,
                     const Box&      a_box);


  void CTUNormalPred(FArrayBox&       a_WMinus,
                     FArrayBox&       a_WPlus,
                     const Real&      a_dt,
                     const Real&      a_dx,
                     const FArrayBox& a_W,
                     const FArrayBox& a_flat,
                     const int&       a_dir,
                     const Box&       a_box);


  void PLMNormalPred(FArrayBox&       a_WMinus,
                     FArrayBox&       a_WPlus,
                     const Real&      a_dt,
                     const Real&      a_dx,
                     const FArrayBox& a_W,
                     const FArrayBox& a_flat,
                     const int&       a_dir,
                     const Box&       a_box);


  void PPMNormalPred(FArrayBox&       a_WMinus,
                     FArrayBox&       a_WPlus,
                     const Real&      a_dt,
                     const Real&      a_dx,
                     const FArrayBox& a_W,
                     const FArrayBox& a_flat,
                     const int&       a_dir,
                     const Box&       a_box);


  GodunovPhysics* getGodunovPhysicsPtr();


  virtual bool isDefined() const;

  void highOrderLimiter(bool a_highOrderLimiter);

#ifdef CH_USE_HDF5
  virtual void expressions(HDF5HeaderData& a_holder) const {;}
#endif

protected:
  // Problem domain and grid spacing
  ProblemDomain m_domain;
  Real          m_dx;

  // Object providing physics information
  GodunovPhysics*  m_gdnvPhysics;

  // Object containing various methods for the Godunov computation
  GodunovUtilities m_util;

  // Order of the normal predictor (1 -> PLM, 2-> PPM)
  int m_normalPredOrder;

  // Use 4th order slope computations (otherwise, use 2nd order)
  bool m_useFourthOrderSlopes;

  // Do slope limiting in the primative or characteristic variables, respect.
  bool m_usePrimLimiting;
  bool m_useCharLimiting;

  // Do slope flattening - MUST BE USING 4th order slopes
  bool m_useFlattening;

  // Apply artificial viscosity of a set value
  bool m_useArtificialViscosity;
  Real m_artificialViscosity;

  // Current time and has it been set
  Real m_currentTime;
  bool m_isCurrentTimeSet;

  // Current box and has it been set
  Box  m_currentBox;
  bool m_isCurrentBoxSet;

  // Has this object been defined
  bool m_isDefined;

  // Use a high-order limiter?  (default false)
  bool m_highOrderLimiter;

private:
  // Disallowed for all the usual reasons
  void operator=(const PatchGodunov& a_input)
  {
    MayDay::Error("invalid operator");
  }

  // Disallowed for all the usual reasons
  PatchGodunov(const PatchGodunov& a_input)
  {
    MayDay::Error("invalid operator");
  }
};

#include "NamespaceFooter.H"
#endif

---