AMRLevelPolytropicGasFactory.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 _AMRLEVELPOLYTROPICGASFACTORY_H_
#define _AMRLEVELPOLYTROPICGASFACTORY_H_

#include "AMRLevelFactory.H"

#include "AMRLevelPolytropicGas.H"


class AMRLevelPolytropicGasFactory: public AMRLevelFactory
{
public:

  AMRLevelPolytropicGasFactory();


  virtual ~AMRLevelPolytropicGasFactory();


  virtual void define(const Real&                 a_cfl,
                      const Real&                 a_domainLength,
                      const int&                  a_verbosity,
                      const Real&                 a_refineThresh,
                      const int&                  a_tagBufferSize,
                      const Real&                 a_initialDtMultiplier,
                      const GodunovPhysics* const a_godunovPhysics,
                      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,
                      const bool&                 a_useSourceTerm,
                      const Real&                 a_sourceTermScaling,
                      const bool&                 a_highOrderLimiter);


  virtual AMRLevel* new_amrlevel() const;


  bool isDefined() const;


protected:
  // CFL number
  Real m_cfl;

  // Physical dimension of the longest side of the domain
  Real m_domainLength;

  // Verbosity of the object
  int m_verbosity;

  // Refinement threshold for gradient
  Real m_refineThresh;

  // Tag buffer size
  int m_tagBufferSize;

  // Initial dt multiplier
  Real m_initialDtMultiplier;

  // Pointer to the object that supplies the physics needed by the integrator
  // (used as a factory here)
  const GodunovPhysics* m_godunovPhysics;

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

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

  // Do slope limiting in the primitive 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;

  // Supply a source term to the computation
  bool m_useSourceTerm;
  Real m_sourceTermScaling;

  // Use a high-order limiter?
  bool m_highOrderLimiter;
  
  // Has this object been defined
  bool m_isDefined;


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

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

#endif

---