MagboltzInterface.hh

Go to the documentation of this file.

// Interface to Magboltz (version 11.19)
 
#ifndef G_MAGBOLTZ_INTERFACE
#define G_MAGBOLTZ_INTERFACE
 
#include <cstdint>
 
#ifndef __CINT__
 
namespace Garfield {
 
namespace Magboltz {
 
constexpr unsigned int nEnergySteps = 4000;
constexpr unsigned int nMaxIonisationTerms = 30;
constexpr unsigned int nMaxInelasticTerms = 250;
constexpr unsigned int nMaxAttachmentTerms = 8;
constexpr unsigned int nMaxNullTerms = 10;
constexpr unsigned int nMaxLevelsPerComponent = 300;
constexpr unsigned int nCharName = 25;
constexpr unsigned int nCharDescr = 50;
constexpr unsigned int nMaxLevels = 960;
constexpr unsigned int nMaxComponents = 6;
 
extern "C" {
 
// Magboltz COMMON blocks
 
// Magnetic field
extern struct {
  double eovb;
  double wb;
  double btheta, bmag;
} bfld_;
 
extern struct {
  std::int64_t nGas;
  std::int64_t nStep;
  std::int64_t nAniso;
  double efinal;
  double estep;
  double akt;
  double ary;
  double tempc;
  double torr;
  std::int64_t ipen;
} inpt_;
 
extern struct {
  double tmax;
  double small;
  double api;
  double estart;
  double theta, phi;
  double rstart;
  double efield;
  std::int64_t nmax;
} setp_;
 
extern struct {
  double amgas[6];
  double vtmb[6];
  double tcfmx;
  double tcfmxg[6];
  std::int64_t ithrm;
} thrm_;
 
// Physical constants
extern struct {
  double echarg;
  double emass;
  double amu;
  double pir2;
} cnsts_;
 
extern struct {
  double eg[nEnergySteps];
  double eroot[nEnergySteps];
  double qt1[nEnergySteps];
  double qt2[nEnergySteps];
  double qt3[nEnergySteps];
  double qt4[nEnergySteps];
} mix2_;
 
extern struct {
  double den[nEnergySteps];
} dens_;
 
extern struct {
  double time[300];
  std::int64_t icoll[30];
  double spec[nEnergySteps];
  double tmax1;
  double ave;
  double den;
  double xid;
  double x;
  double y;
  double z;
  double st;
  std::int64_t nnull;
  std::int64_t icoln[nMaxLevels];
  std::int64_t icolnn[60];
} outpt_;
 
extern struct {
  double time[300];
  std::int64_t icoll[5][nMaxComponents];
  double spec[nEnergySteps];
  double tmax1;
  double ave;
  double den;
  double xid;
  double x;
  double y;
  double z;
  double st;
  std::int64_t nnull;
  std::int64_t icoln[290][nMaxComponents];
  std::int64_t icolnn[10][nMaxComponents];
} outptt_;
 
extern struct {
  char dscrpt[nMaxLevels][nCharDescr];
  char dscrptn[60][nCharDescr];
} scrip_;
 
extern struct {
  char dscrpt[nMaxLevelsPerComponent][nMaxComponents][nCharDescr];
  char dscrptn[10][nMaxComponents][nCharDescr];
} script_;
 
extern struct {
  double cf[nMaxLevels][nEnergySteps];
  double ein[nMaxLevels];
  double tcf[nEnergySteps];
  std::int64_t iarry[nMaxLevels];
  double rgas[nMaxLevels];
  double ipn[nMaxLevels];
  double wpl[nMaxLevels];
  std::int64_t last;
  std::int64_t isize;
  double penfra[nMaxLevels][3];
  double tcfmax[8];
} large_;
 
extern struct {
  double cf[290][nEnergySteps][nMaxComponents];
  double ein[290][nMaxComponents];
  double tcf[nEnergySteps][nMaxComponents];
  std::int64_t iarry[290][nMaxComponents];
  double rgas[290][nMaxComponents];
  double ipn[290][nMaxComponents];
  double wpl[290][nMaxComponents];
  std::int64_t last[nMaxComponents];
  std::int64_t isize[nMaxComponents];
  double penfra[290][3][nMaxComponents];
  double tcfmax[nMaxComponents];
} larget_;
 
// Definition of the gas mixture
extern struct {
  std::int64_t ngasn[6];
} gasn_;
 
extern struct {
  double an1, an2, an3, an4, an5, an6, an;
  double frac[6];
} ratio_;
 
// Calculation results
// Drift velocity
extern struct {
  double wx, wy, wz;
} vel_;
extern struct {
  double dwx, dwy, dwz;
} velerr_;
 
// Diffusion
extern struct {
  double difxx, difyy, difzz;
  double difyz, difxy, difxz;
} diflab_;
extern struct {
  double dxxer, dyyer, dzzer;
  double dyzer, dxyer, dxzer;
} diferb_;
extern struct {
  double difln, diftr;
} difvel_;
extern struct {
  double dfler, dfter;
} diferl_;
 
// Townsend and attachment coefficient
extern struct {
  double alpha, att;
} ctowns_;
extern struct {
  double alper, atter;
} ctwner_;
 
// Time of flight swarm parameters
extern struct {
  double ralpha, ralper;
  double tofene, tofener, tofwv, tofwver;
  double tofdl, tofdler, tofdt, tofdter;
  double tofwr, tofwrer;
  double rattof, ratofer;
} tofout_;
 
// Steady state townsend swarm parameters
extern struct {
  double vdout, vderr;                //< diffusion modified drift
  double wsout, wserr, dlout, dlerr;  //< seems to be WS SST velocities i.e.
                                      // mean arrival time drift velocity?
  double dtout, dterr, alphasst, alphaerr;
  double attsst, atterr;
} sstout_;
 
void gasmix_(std::int64_t* ngs, double* q, double* qin, std::int64_t* nin,
             double* e, double* ei, char* name, double* virl, double* eb,
             double* peqel, double* peqin, double* penfra, std::int64_t* kel,
             std::int64_t* kin, double* qion, double* peqion, double* eion,
             std::int64_t* nion, double* qatt, std::int64_t* natt,
             double* qnull, std::int64_t* nnull, double* scln,
             std::int64_t* nc0, double* ec0, double* wk, double* efl,
             std::int64_t* ng1, double* eg1, std::int64_t* ng2, double* eg2,
             char scrpt[nMaxLevelsPerComponent][nCharDescr],
             char scrptn[nMaxNullTerms][nCharDescr], short namelen,
             short scrpt_len, short scrptn_len);
 
void colf_(double* freq, double* freel, double* freion, double* freatt,
           double* frein, std::int64_t* ntotal);
 
void colft_(double* freq, double* freel, double* freion, double* freatt,
            double* frein, std::int64_t* ntotal);
 
void magboltz_();
}
}  // namespace Magboltz
}  // namespace Garfield
#endif
#endif