#include <HeedMatterDef.h>

Inheritance diagram for Heed::HeedMatterDef:

Public Member Functions
	HeedMatterDef ()
	Default constructor.

	HeedMatterDef (EnergyMesh fenergy_mesh, MatterDef amatter, AtomPhotoAbsCS *faapacs[], double fW=0.0, double fF=standard_factor_Fano)

	HeedMatterDef (EnergyMesh fenergy_mesh, GasDef agas, MolecPhotoAbsCS *fampacs[], double fW=0.0, double fF=standard_factor_Fano)

	HeedMatterDef (EnergyMesh fenergy_mesh, const std::string &gas_notation, MolecPhotoAbsCS fampacs[], double fW=0.0, double fF=standard_factor_Fano)

void	replace_epsi12 (const std::string &file_name)

virtual void	print (std::ostream &file, int l) const

virtual HeedMatterDef *	copy () const

Public Member Functions inherited from Heed::RegPassivePtr
	RegPassivePtr (void)

	RegPassivePtr (char fs_ban_del, char fs_ban_sub, char fs_ban_cop=0)

	RegPassivePtr (const RegPassivePtr &f)

RegPassivePtr &	operator= (const RegPassivePtr &f)

CountPP_ns::CountPassivePtr *	book (void) const

void	clear_pointers (void) const

virtual RegPassivePtr *	copy () const

virtual	~RegPassivePtr ()

virtual void	print (std::ostream &file, int l=1) const

void	set_s_ban_del (char fs_ban_del)

char	get_s_ban_del (void) const

void	set_s_ban_sub (char fs_ban_sub)

char	get_s_ban_sub (void) const

void	set_s_ban_cop (char fs_ban_cop)

char	get_s_ban_cop (void) const

void	set_s_allow_del_at_zero_count (char fs_allow_del_at_zero_count)

char	get_s_allow_del_at_zero_count (void) const

long	get_total_number_of_references (void) const

Public Attributes
PassivePtr< MatterDef >	matter

std::vector< PassivePtr< const AtomPhotoAbsCS > >	apacs

double	eldens_cm_3
	Electron density cm**-3.

double	eldens
	Electron density MeV**3.

double	xeldens
	Long. electron density MeV**2/cm (for x=1 cm).

double	wpla
	Squared plasma energy;.

double	radiation_length
	Radiation Length.

double	Rutherford_const
	Const for Rutherford cross section (1/cm3).

double	W
	Mean work per pair production, MeV.

double	F
	Fano factor.

PassivePtr< EnergyMesh >	energy_mesh

std::vector< double >	ACS
	Photoabsorbtion cross section per one atom(Mb).

std::vector< double >	ICS

std::vector< double >	epsip
	Some plasma dielectric constant (not used, but just initialized for print)

std::vector< double >	epsi1
	Real part of dielectric constant (e_1 - 1).

std::vector< double >	epsi2
	Imaginary part of dielectric constant.

double	min_ioniz_pot

Static Public Attributes
static const int	s_use_mixture_thresholds = 0

Additional Inherited Members
Static Public Member Functions inherited from Heed::RegPassivePtr
static void	set_s_ban_del_ignore (char fs_ban_del_ignore)

static char	get_s_ban_del_ignore (void)

static void	set_s_print_adr_cpp (char fs_print_adr_cpp)

static char	get_s_print_adr_cpp (void)

Detailed Description

Definition of matter parameters necessary for HEED. This is photoabsorption cross section, dielectric constant and other parameters related to these. All the parameters depending on energy are kept in arrays associated with specific energy mesh, which should be defined.

The principle is ordinary: definition of just a class. To the contrary with wcpplib/matter, there is no any global "database" and no formal ban to duplicate these definitions (although there would not be sense in duplication).

Definition at line 27 of file HeedMatterDef.h.

Constructor & Destructor Documentation

◆ HeedMatterDef() [1/4]

Heed::HeedMatterDef::HeedMatterDef ( )

Default constructor.

Definition at line 19 of file HeedMatterDef.cpp.

    : eldens_cm_3(0.0),
      eldens(0.0),
      xeldens(0.0),
      wpla(0.0),
      radiation_length(0.0),
      Rutherford_const(0.0),
      W(0.0),
      F(0.0) {}

Referenced by copy().

◆ HeedMatterDef() [2/4]

Heed::HeedMatterDef::HeedMatterDef	(	EnergyMesh *	fenergy_mesh,
		MatterDef *	amatter,
		AtomPhotoAbsCS *	faapacs[],
		double	fW = `0.0`,
		double	fF = `standard_factor_Fano`
	)

Constructor. If fW == 0.0, the program takes mean W from molecules for gas or from atoms for matters. If fF is input as 0.0, it is assigned to be mean for gas. For matters this is the terminating error.

Definition at line 29 of file HeedMatterDef.cpp.

    : W(fW), F(fF), energy_mesh(fenergy_mesh) {
  mfunname("HeedMatterDef::HeedMatterDef(...)");
  matter.put(amatter);
  check_econd11(matter->qatom(), <= 0, mcerr);
  const long q = matter->qatom();
  apacs.resize(q);
  for (long n = 0; n < q; ++n) {
    apacs[n].put(faapacs[n]);
    check_econd12(matter->atom(n)->Z(), !=, apacs[n]->get_Z(), mcerr);
  }
  check_econd11(F, == 0.0, mcerr);
  if (W == 0.0) {
#ifdef CALC_W_USING_CHARGES
    double mean_I = 0.0;
    double d = 0.0;
    for (long n = 0; n < q; ++n) {
      const double w = matter->weight_quan(n) * apacs[n]->get_Z();
      mean_I += w * apacs[n]->get_I_min();
      d += w;
    }
    W = coef_I_to_W * mean_I / d;
#else
    double mean_I = 0.0;
    for (long n = 0; n < q; ++n) {
      mean_I += matter->weight_quan(n) * apacs[n]->get_I_min();
    }
    W = coef_I_to_W * mean_I;
#endif
  }
  inite_HeedMatterDef();
}

◆ HeedMatterDef() [3/4]

Heed::HeedMatterDef::HeedMatterDef	(	EnergyMesh *	fenergy_mesh,
		GasDef *	agas,
		MolecPhotoAbsCS *	fampacs[],
		double	fW = `0.0`,
		double	fF = `standard_factor_Fano`
	)

Definition at line 63 of file HeedMatterDef.cpp.

    : W(fW), F(fF), energy_mesh(fenergy_mesh) {
  mfunname("HeedMatterDef::HeedMatterDef(...)");
  matter.put(agas);
  check_econd11(agas->qmolec(), <= 0, mcerr);
  const long qat = agas->qatom();
  apacs.resize(qat);
  const long qmol = agas->qmolec();
  long nat = 0;
  for (long nmol = 0; nmol < qmol; ++nmol) {
    check_econd12(agas->molec(nmol)->tqatom(), !=, fampacs[nmol]->get_qatom(),
                  mcerr);
    // number of different atoms in mol
    const long qa = agas->molec(nmol)->qatom();
    for (long na = 0; na < qa; ++na) {
      apacs[nat].put(fampacs[nmol]->get_atom(na).getver());
      check_econd12(apacs[nat]->get_Z(), !=, agas->molec(nmol)->atom(na)->Z(),
                    mcerr);
      nat++;
    }
  }
  if (F == 0.0) {
#ifdef CALC_W_USING_CHARGES
    double u = 0.0;
    double d = 0.0;
    for (long n = 0; n < qmol; ++n) {
      const double w = agas->weight_quan_molec(n) * fampacs[n]->get_total_Z();
      u += w * fampacs[n]->get_F();
      d += w;
    }
    F = u / d;
#else
    for (long n = 0; n < qmol; ++n) {
      F += agas->weight_quan_molec(n) * fampacs[n]->get_F();
    }
#endif
  }
 
  if (W == 0.0) {
#ifdef CALC_W_USING_CHARGES
    double u = 0.0;
    double d = 0.0;
    for (long n = 0; n < qmol; ++n) {
      const double w = agas->weight_quan_molec(n) * fampacs[n]->get_total_Z();
      u += w * fampacs[n]->get_W();
      d += w;
    }
    W = u / d;
#else
    for (long n = 0; n < qmol; ++n) {
      W += agas->weight_quan_molec(n) * fampacs[n]->get_W();
    }
#endif
  }
  inite_HeedMatterDef();
}

◆ HeedMatterDef() [4/4]

Heed::HeedMatterDef::HeedMatterDef	(	EnergyMesh *	fenergy_mesh,
		const std::string &	gas_notation,
		MolecPhotoAbsCS *	fampacs[],
		double	fW = `0.0`,
		double	fF = `standard_factor_Fano`
	)

Definition at line 121 of file HeedMatterDef.cpp.

    : W(fW), F(fF), energy_mesh(fenergy_mesh) {
  mfunnamep("HeedMatterDef::HeedMatterDef(...)");
  MatterDef* amat = MatterDef::get_MatterDef(gas_notation);
  GasDef* agas = dynamic_cast<GasDef*>(amat);
  if (!agas) {
    funnw.ehdr(mcerr);
    mcerr << "notation supplied as the gas notation is not appear "
          << "to be related to gas \n";
    mcerr << "gas_notation=" << gas_notation << '\n';
    spexit(mcerr);
  }
 
  matter.put(agas);
  check_econd11(agas->qmolec(), <= 0, mcerr);
  const long qat = agas->qatom();
  apacs.resize(qat);
  const long qmol = agas->qmolec();
  long nat = 0;
  for (long nmol = 0; nmol < qmol; ++nmol) {
    check_econd12(agas->molec(nmol)->tqatom(), !=, fampacs[nmol]->get_qatom(),
                  mcerr);
    // quantity of different atoms in molecule.
    const long qa = agas->molec(nmol)->qatom();
    for (long na = 0; na < qa; ++na) {
      apacs[nat].put(fampacs[nmol]->get_atom(na).getver());
      check_econd12(apacs[nat]->get_Z(), !=, agas->molec(nmol)->atom(na)->Z(),
                    mcerr);
      nat++;
    }
  }
  if (F == 0.0) {
#ifdef CALC_W_USING_CHARGES
    double u = 0.0;
    double d = 0.0;
    for (long n = 0; n < qmol; ++n) {
      const double w = agas->weight_quan_molec(n) * fampacs[n]->get_total_Z();
      u += w * fampacs[n]->get_F();
      d += w;
    }
    F = u / d;
#else
    for (long n = 0; n < qmol; ++n) {
      F += agas->weight_quan_molec(n) * fampacs[n]->get_F();
    }
#endif
  }
 
  if (W == 0.0) {
#ifdef CALC_W_USING_CHARGES
    double u = 0.0;
    double d = 0.0;
    for (long n = 0; n < qmol; ++n) {
      const double w = agas->weight_quan_molec(n) * fampacs[n]->get_total_Z();
      u += w * fampacs[n]->get_W();
      d += w;
    }
    W = u / d;
#else
    for (long n = 0; n < qmol; ++n) {
      W += agas->weight_quan_molec(n) * fampacs[n]->get_W();
    }
#endif
  }
  inite_HeedMatterDef();
}

Member Function Documentation

◆ copy()

virtual HeedMatterDef * Heed::HeedMatterDef::copy ( ) const

inlinevirtual

Reimplemented from Heed::RegPassivePtr.

Definition at line 84 of file HeedMatterDef.h.

84{ return new HeedMatterDef(*this); }

Heed::HeedMatterDef::HeedMatterDef

HeedMatterDef()

Default constructor.

Definition: HeedMatterDef.cpp:19

◆ print()

void Heed::HeedMatterDef::print	(	std::ostream &	file,
		int	l
	)		const

virtual

Reimplemented from Heed::RegPassivePtr.

Definition at line 361 of file HeedMatterDef.cpp.

                                                       {
  if (l <= 0) return;
  Ifile << "HeedMatterDef:\n";
  indn.n += 2;
  matter->print(file, 1);
  if (l >= 2) {
    long q = matter->qatom();
    Ifile << "Printing " << q << " photoabsorption cross sections:\n";
    indn.n += 2;
    for (long n = 0; n < q; ++n) {
      apacs[n]->print(file, l - 1);
    }
    indn.n -= 2;
  }
  Iprintan(file, eldens_cm_3, "1/cm^3");
  Iprintan(file, eldens, "MeV^3");
  Iprintan(file, xeldens, "MeV^2/cm");
  Iprintn(file, wpla);
  Iprintn(file, radiation_length);
  Iprintan(file, Rutherford_const, "1/cm^3");
  Iprintn(file, W);
  Iprintn(file, F);
  Iprintn(file, min_ioniz_pot);
  Iprintn(file, energy_mesh->get_q());
  if (l >= 2) {
    long qe = energy_mesh->get_q();
    long ne;
    indn.n += 2;
    Ifile << " ne       energy      ACS(Mb)      ICS(Mb) ACS(1/MeV^2) "
             "ICS(1/MeV^2)       epsip       epsi1       epsi2   "
             "(1+epsi1)^2+epsi2^2\n";
    for (ne = 0; ne < qe; ne++) {
      Ifile << std::setw(3) << ne << ' ' << std::setw(12)
            << energy_mesh->get_e(ne) << ' ' << std::setw(12) << ACS[ne] << ' '
            << std::setw(12) << ICS[ne] << ' ' << std::setw(12)
            << ACS[ne] * C1_MEV2_MBN << ' ' << std::setw(12)
            << ICS[ne] * C1_MEV2_MBN << ' ' << std::setw(12) << epsip[ne] << ' '
            << std::setw(12) << epsi1[ne] << ' ' << std::setw(12) << epsi2[ne]
            << ' ' << std::setw(12)
            << pow((1 + epsi1[ne]), 2) + pow(epsi2[ne], 2) << " \n";
    }
    indn.n -= 2;
  }
  indn.n -= 2;
}

◆ replace_epsi12()

void Heed::HeedMatterDef::replace_epsi12 ( const std::string & file_name )

Definition at line 311 of file HeedMatterDef.cpp.

                                                             {
  mfunnamep("void HeedMatterDef::replace_epsi12(const std::string& file_name)");
 
  std::ifstream file(file_name.c_str());
  if (!file) {
    funnw.ehdr(mcerr);
    mcerr << "cannot open file " << file_name << std::endl;
    spexit(mcerr);
  } else {
    mcout << "file " << file_name << " is opened" << std::endl;
  }
  long qe = 0;  // number of points in input mesh
  file >> qe;
  check_econd11(qe, <= 2, mcerr);
 
  std::vector<double> ener(qe);
  std::vector<double> eps1(qe);
  std::vector<double> eps2(qe);
 
  for (long ne = 0; ne < qe; ++ne) {
    file >> ener[ne] >> eps1[ne] >> eps2[ne];
    check_econd11(eps2[ne], < 0.0, mcerr);
    if (ne > 0) {
      check_econd12(ener[ne], <, ener[ne - 1], mcerr);
    }
  }
 
  PointCoorMesh<double, std::vector<double> > pcmd(qe, &(ener));
  double emin = ener[0] - 0.5 * (ener[1] - ener[0]);
  double emax = ener[qe - 1] + 0.5 * (ener[qe - 1] - ener[qe - 2]);
 
  qe = energy_mesh->get_q();
  for (long ne = 0; ne < qe; ++ne) {
    double ec = energy_mesh->get_ec(ne);
    epsi1[ne] =
        t_value_straight_point_ar<double, std::vector<double>,
                                  PointCoorMesh<double, std::vector<double> > >(
            pcmd,  // dimension q
            eps1,  // dimension q-1
            ec, 0, 1, emin, 1, emax);
    epsi2[ne] =
        t_value_straight_point_ar<double, std::vector<double>,
                                  PointCoorMesh<double, std::vector<double> > >(
            pcmd,  // dimension q
            eps2,  // dimension q-1
            ec, 1, 1, emin, 1, emax);
    // Iprint3n(mcout, ec, epsi1[ne], epsi2[ne]);
  }
}

Member Data Documentation

◆ ACS

std::vector<double> Heed::HeedMatterDef::ACS

Photoabsorbtion cross section per one atom(Mb).

Definition at line 44 of file HeedMatterDef.h.

Referenced by print().

◆ apacs

std::vector<PassivePtr<const AtomPhotoAbsCS> > Heed::HeedMatterDef::apacs

Definition at line 30 of file HeedMatterDef.h.

Referenced by HeedMatterDef(), Heed::HeedParticle::physics(), Heed::HeedParticle_BGM::physics(), Heed::HeedPhoton::physics(), Heed::HeedPhoton::physics_after_new_speed(), and print().

◆ eldens

double Heed::HeedMatterDef::eldens

Electron density MeV**3.

Definition at line 33 of file HeedMatterDef.h.

Referenced by print().

◆ eldens_cm_3

double Heed::HeedMatterDef::eldens_cm_3

Electron density cm**-3.

Definition at line 32 of file HeedMatterDef.h.

Referenced by print().

◆ energy_mesh

PassivePtr<EnergyMesh> Heed::HeedMatterDef::energy_mesh

Definition at line 40 of file HeedMatterDef.h.

Referenced by Heed::HeedParticle::physics(), Heed::HeedParticle_BGM::physics(), print(), and replace_epsi12().

◆ epsi1

std::vector<double> Heed::HeedMatterDef::epsi1

Real part of dielectric constant (e_1 - 1).

Definition at line 51 of file HeedMatterDef.h.

Referenced by print(), and replace_epsi12().

◆ epsi2

std::vector<double> Heed::HeedMatterDef::epsi2

Imaginary part of dielectric constant.

Definition at line 53 of file HeedMatterDef.h.

Referenced by print(), and replace_epsi12().

◆ epsip

std::vector<double> Heed::HeedMatterDef::epsip

Some plasma dielectric constant (not used, but just initialized for print)

Definition at line 49 of file HeedMatterDef.h.

Referenced by print().

◆ F

double Heed::HeedMatterDef::F

Fano factor.

Definition at line 39 of file HeedMatterDef.h.

Referenced by Garfield::TrackHeed::GetFanoFactor(), HeedMatterDef(), and print().

◆ ICS

std::vector<double> Heed::HeedMatterDef::ICS

Photoionization cross section per one atom(Mb).

Definition at line 45 of file HeedMatterDef.h.

Referenced by print().

◆ matter

PassivePtr<MatterDef> Heed::HeedMatterDef::matter

Definition at line 29 of file HeedMatterDef.h.

Referenced by HeedMatterDef(), Heed::HeedParticle::physics(), Heed::HeedParticle_BGM::physics(), Heed::HeedPhoton::physics(), and print().

◆ min_ioniz_pot

double Heed::HeedMatterDef::min_ioniz_pot

Minimum ionization potential. It is used only for switching off the Cherenkov radiation below it.

Definition at line 56 of file HeedMatterDef.h.

Referenced by print().

◆ radiation_length

double Heed::HeedMatterDef::radiation_length

Radiation Length.

Definition at line 36 of file HeedMatterDef.h.

Referenced by print().

◆ Rutherford_const

double Heed::HeedMatterDef::Rutherford_const

Const for Rutherford cross section (1/cm3).

Definition at line 37 of file HeedMatterDef.h.

Referenced by print().

◆ s_use_mixture_thresholds

const int Heed::HeedMatterDef::s_use_mixture_thresholds = 0

static

Flag affecting mixtures of atoms with different ionization potentials. If 1, all energy transfers what is absorbed even with the energy less than the potential of ionization of single atom, but more than the minimal potential of ionization of the mixture, should ionize. This is emulation of Jesse effect in extreme case. It is likely not realistic. So the recommended value is 0.

Definition at line 92 of file HeedMatterDef.h.

◆ W

double Heed::HeedMatterDef::W

Mean work per pair production, MeV.

Definition at line 38 of file HeedMatterDef.h.

Referenced by Garfield::TrackHeed::GetW(), HeedMatterDef(), and print().

◆ wpla

double Heed::HeedMatterDef::wpla

Squared plasma energy;.

Definition at line 35 of file HeedMatterDef.h.

Referenced by print().

◆ xeldens

double Heed::HeedMatterDef::xeldens

Long. electron density MeV**2/cm (for x=1 cm).

Definition at line 34 of file HeedMatterDef.h.

Referenced by print().

The documentation for this class was generated from the following files:

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HeedMatterDef() [1/4]

◆ HeedMatterDef() [2/4]

◆ HeedMatterDef() [3/4]

◆ HeedMatterDef() [4/4]

Member Function Documentation

◆ copy()

◆ print()

◆ replace_epsi12()

Member Data Documentation

◆ ACS

◆ apacs

◆ eldens

◆ eldens_cm_3

◆ energy_mesh

◆ epsi1

◆ epsi2

◆ epsip

◆ F

◆ ICS

◆ matter

◆ min_ioniz_pot

◆ radiation_length

◆ Rutherford_const

◆ s_use_mixture_thresholds

◆ W

◆ wpla

◆ xeldens