---

PatchGodunov.H

Go to the documentation of this file.

/* _______              __
  / ___/ /  ___  __ _  / /  ___
 / /__/ _ \/ _ \/  ' \/ _ \/ _ \
 \___/_//_/\___/_/_/_/_.__/\___/
*/
//
// This software is copyright (C) by the Lawrence Berkeley
// National Laboratory.  Permission is granted to reproduce
// this software for non-commercial purposes provided that
// this notice is left intact.
//
// It is acknowledged that the U.S. Government has rights to
// this software under Contract DE-AC03-765F00098 between
// the U.S.  Department of Energy and the University of
// California.
//
// This software is provided as a professional and academic
// contribution for joint exchange. Thus it is experimental,
// is provided ``as is'', with no warranties of any kind
// whatsoever, no support, no promise of updates, or printed
// documentation. By using this software, you acknowledge
// that the Lawrence Berkeley National Laboratory and
// Regents of the University of California shall have no
// liability with respect to the infringement of other
// copyrights by any part of this software.
//

#ifndef _PATCH_GODUNOV_H_
#define _PATCH_GODUNOV_H_

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

#include <string>
using std::string;


class PatchGodunov
{
public:

  PatchGodunov();


  virtual ~PatchGodunov();


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


  virtual void setPhysIBC(PhysIBC* a_bc);


  virtual PhysIBC* getPhysIBC() const;


  virtual void setSlopeParameters(bool a_fourthOrderSlopes,
                                  bool a_flattening,
                                  bool a_limitSlopes = true);


  virtual bool useFourthOrderSlopes();


  virtual bool useFlattening();


  virtual bool limitSlopes();


  virtual void setArtificialViscosity(bool a_useArtificialViscosity,
                                      Real a_artificialViscosity);


  virtual bool useArtificialViscosity();


  virtual Real artificialViscosityCoefficient();


  virtual PatchGodunov* new_patchGodunov() const = 0;


  virtual void setCurrentTime(const Real& a_currentTime);


  virtual void setCurrentBox(const Box& a_currentBox);


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


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


  virtual int numConserved() = 0;


  virtual Vector<string> stateNames();


  virtual int numFluxes() = 0;

protected:

  virtual bool isDefined() const;


  virtual int numPrimitives() = 0;


  virtual int numSlopes() = 0;


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


  virtual void computeFlattening(FArrayBox&       a_flattening,
                                 const FArrayBox& a_W,
                                 const Box&       a_box);


  virtual void slope(FArrayBox&       a_dW,
                     const FArrayBox& a_W,
                     const FArrayBox& a_flattening,
                     const int&       a_dir,
                     const Box&       a_box);


  virtual void normalPred(FArrayBox&       a_WMinus,
                          FArrayBox&       a_WPlus,
                          const FArrayBox& a_W,
                          const FArrayBox& a_dW,
                          const Real&      a_scale,
                          const int&       a_dir,
                          const Box&       a_box) = 0;


  virtual void incrementWithSource(FArrayBox&       a_W,
                                   const FArrayBox& a_S,
                                   const Real&      a_scale,
                                   const Box&       a_box);


  virtual void riemann(FArrayBox&       a_F,
                       const FArrayBox& a_WLeft,
                       const FArrayBox& a_WRight,
                       const int&       a_dir,
                       const Box&       a_box) = 0;


  virtual void updatePrim(FArrayBox&       a_WMinus,
                          FArrayBox&       a_WPlus,
                          const FArrayBox& a_F,
                          const Real&      a_scale,
                          const int&       a_dir,
                          const Box&       a_box) = 0;


  virtual void artificialViscosity(FArrayBox&       a_F,
                                   const FArrayBox& a_U,
                                   const FArrayBox& a_divVel,
                                   const int&       a_dir,
                                   const Box&       a_box);
  

  virtual void updateCons(FArrayBox&       a_U,
                          const FArrayBox& a_F,
                          const Real&      a_scale,
                          const int&       a_dir,
                          const Box&       a_box) = 0;


  virtual void postUpdateCons(FArrayBox&       a_U,
                          const FArrayBox& a_Uold,
                          const Real&      a_dt,
                          const Real&      a_dx,
                          const Box&       a_box);


  virtual Interval velocityInterval() = 0;


  virtual int pressureIndex() = 0;


  virtual int bulkModulusIndex() = 0;


  virtual void applyLimiter(FArrayBox&       a_dW,
                            const FArrayBox& a_dWLeft,
                            const FArrayBox& a_dWRight,
                            const int&       a_dir,
                            const Box&       a_box);


  virtual void divVel(FArrayBox&       a_divVel,
                      const FArrayBox& a_W,
                      const int        a_dir,
                      const Box&       a_box);

  // Has define() been called
  bool m_isDefined;

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

  // Slope computation flags and have they been set
  bool m_useFourthOrderSlopes;
  bool m_useFlattening;
  bool m_limitSlopes;

  // Have they been set
  bool m_isSlopeSet;

  // Artificial viscosity flag, coefficient, and have they been set
  bool m_useArtificialViscosity;
  Real m_artificialViscosity;
  bool m_isArtViscSet;

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

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

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

#endif

---