GasData.H

Go to the documentation of this file.

 
#ifndef _GASDATA_H_
#define _GASDATA_H_
 
#include <cmath>
#include <vector>
#include "../Utils/Constants.H"
#include "../Utils/Types.H"
#include "../Utils/RealTensor2.H"
#include "../Utils/Vec3.H"
 
namespace criptic {
 
  namespace gas {
 
    class GasData {
 
    public:
      
      Real dx;             
      // Quantities
      Real den;            
      Real ionDen;         
      RealVec v;           
      RealVec B;           
      // Gradients of quantities
      RealVec denGrad;     
      RealVec ionDenGrad;  
      RealTensor2 vGrad;   
      RealTensor2 BGrad;   
      // Composition information -- needed for loss calculations
      Real xH0;            
      Real xHp;            
      Real xHe0;           
      Real xHep;           
      Real xHep2;          
      Real xe;             
      Real Z;              
      // Radiation field information -- needed for inverse Compton losses
      std::vector<Real> TBB; 
      std::vector<Real> WBB; 
      // Trivial convenience methods
      Real UB() const {
#ifdef CRIPTIC_UNITS_CGS
    return B.mag2() / (8 * M_PI);
#else
    return B.mag2() / (2 * constants::mu0);
#endif
      }
 
      constexpr Real xH2() const {
    return 0.5 * (1 - xH0 - xHp);
      }
 
      constexpr Real xHe() const {
    return xHe0 + xHep + xHep2;
      }
      
      constexpr Real X() const {
    return (1.0 - Z) / (1.0 + 4.0 * (xHe0 + xHep + xHep2));
      }
 
      constexpr Real Y() const {
    return (1.0 - Z) * 4.0 * xHe() / (1.0 + 4.0 * xHe());
      }
 
      constexpr Real AxZ() const {
    return (1.0 + 4.0 * xHe()) * Z / (1.0 - Z);
      }
 
      constexpr Real muH() const {
    return 1.0 / X();
      }
 
      constexpr Real mue() const {
    return (1.0 + 4.0 * xHe() + AxZ()) /
      (1.0 + 2.0 * xHe() + 0.5 * AxZ());
      }
 
      constexpr Real nH() const {
    return den / (muH() * constants::mH);
      }
 
      constexpr Real neTot() const {
    return den / (mue() * constants::mH);
      }
      
      constexpr Real neFree() const {
    return xe * nH();
      }
      
      void setAtomicComposition() {
    xH0 = 1.0 - 1.0e-2;
    xHp = xe = 1.0e-2;
    xHe0 = 0.0955;
    xHep = xHep2 = 0.0;
    Z = 0.0199;
      }
      
      void setMolecularComposition() {
    xH0 = xHp = 0.0;
    xe = 1.0e-6;
    xHe0 = 0.0955;
    xHep = xHep2 = 0.0;
    Z = 0.0199;
      }
 
      void setIonizedComposition() {
    xH0 = xHe0 = 0.0;    // No neutral species
    xHp = 1.0;           // H is fully ionized
    xHep = 0.0;          // Treat He as fully ionized
    xHep2 = 0.0955;
    xe = 1 + 2 * 0.0955; // Asplund+ (2009) He abundance, fully ionized
    Z = 0.0199;
      }
 
      // Define the the operations of multiplication by a scalar and
      // addition of two GasData object. These are intended to make it
      // possible to take weighted averages of GasData objects.
 
      GasData operator*(const Real& w) const {
    GasData r;
    r.dx = w * dx;
    r.den = w * den;
    r.ionDen = w * ionDen;
    r.v = w * v;
    r.B = w * B;
    r.denGrad = w * denGrad;
    r.ionDenGrad = w * ionDenGrad;
    r.vGrad = w * vGrad;
    r.BGrad = w * BGrad;
    r.xH0 = w * xH0;
    r.xHp = w * xHp;
    r.xHe0 = w * xHe0;
    r.xHep = w * xHep;
    r.xHep2 = w * xHep2;
    r.xe = w * xe;
    r.Z = w * Z;
    r.WBB = WBB;
    for (IdxType i=0; i<WBB.size(); i++) r.WBB[i] *= w;
    r.TBB = TBB;
    return r;
      }
 
      GasData operator+(const GasData& gd) const {
    GasData r;
    r.dx = gd.dx + dx;
    r.den = gd.den + den;
    r.ionDen = gd.ionDen + ionDen;
    r.v = gd.v + v;
    r.B = gd.B + B;
    r.denGrad = gd.denGrad + denGrad;
    r.ionDenGrad = gd.ionDenGrad + ionDenGrad;
    r.vGrad = gd.vGrad + vGrad;
    r.BGrad = gd.BGrad + BGrad;
    r.xH0 = gd.xH0 + xH0;
    r.xHp = gd.xHp + xHp;
    r.xHe0 = gd.xHe0 + xHe0;
    r.xHep = gd.xHep + xHep;
    r.xHep2 = gd.xHep2 + xHep2;
    r.xe = gd.xe + xe;
    r.Z = gd.Z + Z;
    r.WBB = gd.WBB;
    for (IdxType i=0; i<WBB.size(); i++) r.WBB[i] += WBB[i];
    r.TBB = TBB;
    return r;
      }      
    };
 
    // Scalar multiplication and addition operators
    inline GasData operator*(const Real& w,
                 const GasData& gd) {
      return gd * w;
    }
  }
}
 
#endif
// _GASDATA_H_