GodunovPhysics.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 _GODUNOVPHYSICS_H_
#define _GODUNOVPHYSICS_H_

#include <string>
using std::string;

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

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

class HDF5HeaderData;


class GodunovPhysics
{
public:

  GodunovPhysics();


  PhysIBC* getPhysIBC() const;


  void setPhysIBC(PhysIBC* a_bc);


  virtual ~GodunovPhysics();


  virtual void define(const ProblemDomain& a_domain,
                      const Real&          a_dx);


  virtual void setCurrentBox(const Box& a_currentBox);


  virtual Real getMaxWaveSpeed(const FArrayBox& a_U,
                               const Box&       a_box) = 0;


  virtual GodunovPhysics* new_godunovPhysics() const = 0;


  virtual int numConserved() = 0;


  virtual Vector<string> stateNames() = 0;


  virtual int numFluxes() = 0;


  virtual void computeUpdate(FArrayBox&       a_dU,
                             FluxBox&         a_F,
                             const FArrayBox& a_U,
                             const FluxBox&   a_WHalf,
                             const bool&      a_useArtificialViscosity,
                             const Real&      a_artificialViscosity,
                             const Real&      a_currentTime,
                             const Real&      a_dx,
                             const Real&      a_dt,
                             const Box&       a_box);


  virtual void getFlux(FArrayBox&       a_flux,
                       const FArrayBox& a_WHalf,
                       const int&       a_dir,
                       const Box&       a_box);


  virtual bool isDefined() const;


  virtual int numPrimitives() = 0;


  virtual void charAnalysis(FArrayBox&       a_dW,
                            const FArrayBox& a_W,
                            const int&       a_dir,
                            const Box&       a_box) = 0;


  virtual void charSynthesis(FArrayBox&       a_dW,
                             const FArrayBox& a_W,
                             const int&       a_dir,
                             const Box&       a_box) = 0;


  virtual void charValues(FArrayBox&       a_lambda,
                          const FArrayBox& a_W,
                          const int&       a_dir,
                          const Box&       a_box) = 0;


  virtual void incrementSource(FArrayBox&       a_S,
                               const FArrayBox& a_W,
                               const Box&       a_box) = 0;


  virtual void riemann(
                       FArrayBox&       a_WStar,
                       const FArrayBox& a_WLeft,
                       const FArrayBox& a_WRight,
                       const FArrayBox& a_W,
                       const Real&      a_time,
                       const int&       a_dir,
                       const Box&       a_box) = 0;


  virtual void postNormalPred(FArrayBox&       a_dWMinus,
                              FArrayBox&       a_dWPlus,
                              const FArrayBox& a_W,
                              const Real&      a_dt,
                              const Real&      a_dx,
                              const int&       a_dir,
                              const Box&       a_box) = 0;


  virtual void quasilinearUpdate(FArrayBox&       a_AdWdx,
                                 const FArrayBox& a_wHalf,
                                 const FArrayBox& a_W,
                                 const Real&      a_scale,
                                 const int&       a_dir,
                                 const Box&       a_box) = 0;


  virtual void consToPrim(FArrayBox&       a_W,
                          const FArrayBox& a_U,
                          const Box&       a_box) = 0;


  virtual Interval velocityInterval() = 0;


  virtual int pressureIndex() = 0;


  virtual Real smallPressure() = 0;


  virtual int bulkModulusIndex() = 0;


  virtual void artVisc(FArrayBox&       a_F,
                       const FArrayBox& a_U,
                       const Real&      a_artificialViscosity,
                       const Real&      a_currentTime,
                       const int&       a_dir,
                       const Box&       a_box);

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


protected:
  // Has this object been defined
  bool m_isDefined;

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

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

  // Initial and boundary condition object and has it been set
  PhysIBC* m_bc;
  bool     m_isBCSet;


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

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

#include "NamespaceFooter.H"
#endif

---