AdvectPhysics.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 _ADVECTPHYSICS_H_
#define _ADVECTPHYSICS_H_

#include "GodunovPhysics.H"
#include "FluxBox.H"

#include "NamespaceHeader.H"


class AdvectPhysics : public GodunovPhysics
{
public:

  AdvectPhysics();


  ~AdvectPhysics();


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


  virtual GodunovPhysics* new_godunovPhysics() const;


  virtual int numConserved()
  {
    return 1;
  }


  virtual Vector<string> stateNames()
  {
    Vector<string> retval(1, string("scalar"));

    return retval;
  }


  virtual int numFluxes()
  {
    return 1;
  }


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


  virtual bool isDefined() const
  {
    return m_isDefined;
  }


  virtual int numPrimitives()
  {
    return 1;
  }


  virtual void charAnalysis(FArrayBox&       a_dW,
                            const FArrayBox& a_W,
                            const int&       a_dir,
                            const Box&       a_box)
  {

    // This is the identity mapping for advection - do nothing
  }


  virtual void charSynthesis(FArrayBox&       a_dW,
                             const FArrayBox& a_W,
                             const int&       a_dir,
                             const Box&       a_box)
  {

    // This is the identity mapping for advection - do nothing
  }


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


  virtual void incrementSource(FArrayBox&       a_S,
                               const FArrayBox& a_W,
                               const Box&       a_box)
  {

    // The source term does not explicitly depend on the current primitive state
  }


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


  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)
  {
    // Nothing needs to be done here
  }


  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);


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


  virtual Interval velocityInterval()
  {
    MayDay::Error("AdvectPhysics::velocityInterval - not defined");

    Interval retval(-1,-1);
    return retval;
  }


  virtual int pressureIndex()
  {
    MayDay::Error("AdvectPhysics::pressureIndex - not defined");

    return -1;
  }


  virtual Real smallPressure()
  {
    MayDay::Error("AdvectPhysics::smallPressure - not defined");

    return -1.0;
  }


  virtual int bulkModulusIndex()
  {
    MayDay::Error("AdvectPhysics::bulkModulusIndex - not defined");

    return -1;
  }


  void setVelocities(FArrayBox* a_celVelPtr,
                     FluxBox*   a_advVelPtr)
  {
    m_isVelSet = true;
    m_advVelPtr  = a_advVelPtr;
    m_cellVelPtr = a_celVelPtr;
  }

protected:
  bool m_isVelSet;
  FluxBox* m_advVelPtr;

  FArrayBox* m_cellVelPtr;

};

#include "NamespaceFooter.H"
#endif

---