physics.hpp

Go to the documentation of this file.

#ifndef PHYSICS_HPP
#define PHYSICS_HPP
 
// C/C++ headers
#include <string>
#include <vector>
 
// Athena++ headers
#include "../athena.hpp"
 
// Forward declarations
class MeshBlock;
class ParameterInput;
enum class TaskStatus;
struct PhysicsPackage;
 
template <typename T>
class TaskManager;
 
class Physics {
 public:
  // data
  MeshBlock *pmy_block;
  TaskManager<Physics> *ptm;
 
  // functions
  Physics(MeshBlock *pmb, ParameterInput *pin);
  ~Physics();
  void Initialize(AthenaArray<Real> const &w);
  size_t RestartDataSizeInBytes();
  size_t DumpRestartData(char *pdst);
  size_t LoadRestartData(char *psrc);
 
  void ApplyPhysicsPackages(AthenaArray<Real> &du, AthenaArray<Real> const &w,
                            Real time, Real dt);
 
  // package functions
  TaskStatus RelaxBotTemperature(AthenaArray<Real> &du,
                                 AthenaArray<Real> const &w, Real time,
                                 Real dt);
  TaskStatus RelaxBotVelocity(AthenaArray<Real> &du, AthenaArray<Real> const &w,
                              Real time, Real dt);
  TaskStatus RelaxBotComposition(AthenaArray<Real> &du,
                                 AthenaArray<Real> const &w, Real time,
                                 Real dt);
 
  TaskStatus TopSpongeLayer(AthenaArray<Real> &du, AthenaArray<Real> const &w,
                            Real time, Real dt);
  TaskStatus BotSpongeLayer(AthenaArray<Real> &du, AthenaArray<Real> const &w,
                            Real time, Real dt);
  TaskStatus LeftSpongeLayer(AthenaArray<Real> &du, AthenaArray<Real> const &w,
                             Real time, Real dt);
  TaskStatus RightSpongeLayer(AthenaArray<Real> &du, AthenaArray<Real> const &w,
                              Real time, Real dt);
 
  TaskStatus TopCooling(AthenaArray<Real> &du, AthenaArray<Real> const &w,
                        Real time, Real dt);
  TaskStatus BotHeating(AthenaArray<Real> &du, AthenaArray<Real> const &w,
                        Real time, Real dt);
 
 protected:
  // package list
  std::vector<PhysicsPackage> packages_;
 
  // bottom boundary condition
  AthenaArray<Real> hydro_bot_;
  AthenaArray<Real> tem_bot_, vel_bot_, com_bot_;
 
  // parameters for relax bottom temperature
  Real Tbot_, tau_Tbot_, tau_Ubot_, tau_Qbot_;
 
  // parameters for sponge layer
  Real tau_top_;   
  Real width_top_; 
  Real tau_bot_;   
  Real width_bot_; 
  Real tau_left_;   
  Real width_left_; 
  Real tau_right_;   
  Real width_right_; 
  // parameters for heating/cooling
  Real dTdt_;     
  Real flux_top_; 
  Real flux_bot_; 
  // parameters for friction
  Real friction_bot_tau_;
};
 
struct PhysicsPackage {
  uint64_t id;        
  uint64_t dep;       
  uint64_t conflict;  
  int cost;           
  bool load_balance;  
 
  // ptr to member function
  TaskStatus (Physics::*Function)(AthenaArray<Real> &,
                                  AthenaArray<Real> const &, Real, Real);
};
 
namespace PhysicsPackageNames {
const uint64_t NONE = 0LL;
const uint64_t FIX_BOT_TEMPERATURE = 1LL << 0;
const uint64_t FIX_BOT_VELOCITY = 1LL << 1;
const uint64_t FIX_BOT_COMPOSITION = 1LL << 2;
const uint64_t TOP_SPONGE_LAYER = 1LL << 3;
const uint64_t BOT_SPONGE_LAYER = 1LL << 4;
const uint64_t LFT_SPONGE_LAYER = 1LL << 5;
const uint64_t RHT_SPONGE_LAYER = 1LL << 6;
const uint64_t TOP_COOLING = 1LL << 7;
const uint64_t BOT_HEATING = 1LL << 8;
}  // namespace PhysicsPackageNames
 
#endif