SelfGravityPhysics.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 _SELFGRAVITY_PHYSICS_H_
#define _SELFGRAVITY_PHYSICS_H_

#include <string>
using std::string;

#include "GodunovPhysics.H"
#include "FluxBox.H"
#include "LGintegrator.H"
#include "CodeUnits.H"

class SelfGravityPhysics : public GodunovPhysics
{
public:
  SelfGravityPhysics();

  virtual ~SelfGravityPhysics();

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

  virtual Real getMaxWaveSpeedWithSource(const FArrayBox& a_U,
                                         const FArrayBox& a_S,
                                         const Real&      a_dx,
                                         const Box&       a_box);

  virtual GodunovPhysics* new_godunovPhysics() const;

  virtual Vector<string> stateNames();

  virtual Vector<string> plotNames();

  virtual int numConserved();


  virtual int numFluxes();

  virtual bool isDefined();

  virtual int numPrimitives();

  virtual int numSlopes();

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

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


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

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

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

  virtual void incrementSource(FArrayBox&       a_localS,
                               const FArrayBox& a_S,
                               const FArrayBox& a_W,
                               const Real&      a_time,
                               const Real&      a_dt,
                               const Box&       a_box);
  virtual void incrementSource(FArrayBox&       a_S,
                               const FArrayBox& a_W,
                               const Box&       a_box){;};

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

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

  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 synchronize(FArrayBox&       a_U,
                           const FArrayBox& a_UOld,
                           const Box&       a_box);

  virtual void setupSourceTerm(FArrayBox&       a_S,
                               const ForceBox&  a_force,
                               const FArrayBox& a_U,
                               const Real&      a_time,
                               const Real&      a_dt,
                               const Box&       a_box);

  virtual Real applySource(FArrayBox&       a_U,
                           const FArrayBox& a_force,
                           const Real&      a_time,
                           const Real&      a_dt,
                           const Box&       a_box);

  virtual void forceCorrection(FArrayBox&       a_U,
                               const ForceBox&  a_force,
                               const Real&      a_time,
                               const Real&      a_dt,
                               const Box&       a_box);

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

  virtual Interval velocityInterval();

  virtual int pressureIndex();

  virtual int densityIndex();

  virtual int bulkModulusIndex();

  virtual int entropyIndex();

  virtual Real smallPressure();

  virtual void setSmallPressure(const Real& a_smallPressure);

  virtual void setUnits(const CodeUnits& a_units);

protected:
  // Used to limit the absolute value of a "pressure" difference 
  Real m_smallPressure;

  // 
  CodeUnits m_units;

  // FAB pointing to a source term
  FArrayBox* m_source;

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

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


#endif

---