#include <PhotoAbsCS.h>

Inheritance diagram for Heed::PhotoAbsCS:

Public Member Functions
	PhotoAbsCS ()
	Default constructor.

	PhotoAbsCS (const std::string &fname, int fZ, double fthreshold)
	Constructor.

virtual	~PhotoAbsCS ()
	Destructor.

const std::string &	get_name () const
	Name of this shell or atom.

int	get_number () const
	Number of this shell.

int	get_Z () const

double	get_threshold () const
	Return the threshold energy.

virtual double	get_CS (double energy) const =0
	Retrieve cross-section [Mb] at a given energy [MeV].

virtual double	get_integral_CS (double energy1, double energy2) const =0
	Retrieve integral cross-section [Mb * MeV] in a given interval [MeV].

virtual void	scale (double fact)=0
	Multiply by some factor. Can be useful for debugging and other purposes.

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

virtual PhotoAbsCS *	copy () const =0

Protected Attributes
std::string	name

int	number

int	Z

double	threshold

Detailed Description

Photoabsorption cross-section base class.

The literature data on photoabsorption cross section are fragmentar and not always consistent. This class hierarchy is designed to gather them in a consistent library. The principle is ordinary: definition of an abstract class which defines the interface available for the rest of program, and definition of derived classes with this or that realization. To the contrary with wcpplib/matter, there is no any global "database" and no formal ban to duplicate these definitions. So these are simple classes determining photoabsorption cross sections for atomic shells, for atoms, and for molecules. Also the atomic relaxation cascades are defined. The system requires some memory for keeping data, and some disk files with input information. It takes some time for initializations, so it is not intended to be used in a loop. In the fortran version of HEED, the equivalent data structure kept in a common block was depending on energy mesh. But in this C++ version it was found possible to avoid this dependence. The data are kept and handled as is, without unnecessary conversions. This improves precision of handling energies near ionization thresholds.

2004, I. Smirnov

Definition at line 46 of file PhotoAbsCS.h.

Constructor & Destructor Documentation

◆ PhotoAbsCS() [1/2]

Heed::PhotoAbsCS::PhotoAbsCS ( )

Default constructor.

Definition at line 79 of file PhotoAbsCS.cpp.

79: name(""), number(-1), Z(0), threshold(0.0) {}

Heed::PhotoAbsCS::Z

int Z

Definition: PhotoAbsCS.h:78

Heed::PhotoAbsCS::threshold

double threshold

Definition: PhotoAbsCS.h:79

Heed::PhotoAbsCS::name

std::string name

Definition: PhotoAbsCS.h:76

Heed::PhotoAbsCS::number

int number

Definition: PhotoAbsCS.h:77

◆ PhotoAbsCS() [2/2]

Heed::PhotoAbsCS::PhotoAbsCS	(	const std::string &	fname,
		int	fZ,
		double	fthreshold
	)

Constructor.

Definition at line 81 of file PhotoAbsCS.cpp.

    : name(fname), number(-1), Z(fZ), threshold(fthreshold) {
 
  // Try to get the (shell) number from the name.
  std::istringstream ss(name);
  int i = -100;
  ss >> i;
  if (i >= 1 && i <= 50) number = i;
}

◆ ~PhotoAbsCS()

virtual Heed::PhotoAbsCS::~PhotoAbsCS ( )

inlinevirtual

Destructor.

Definition at line 53 of file PhotoAbsCS.h.

53{}

Member Function Documentation

◆ copy()

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

pure virtual

Implemented in Heed::AveragePhotoAbsCS, Heed::HydrogenPhotoAbsCS, Heed::SimpleTablePhotoAbsCS, and Heed::PhenoPhotoAbsCS.

◆ get_CS()

virtual double Heed::PhotoAbsCS::get_CS ( double energy ) const

pure virtual

Retrieve cross-section [Mb] at a given energy [MeV].

Implemented in Heed::AveragePhotoAbsCS, Heed::HydrogenPhotoAbsCS, Heed::SimpleTablePhotoAbsCS, and Heed::PhenoPhotoAbsCS.

◆ get_integral_CS()

virtual double Heed::PhotoAbsCS::get_integral_CS	(	double	energy1,
		double	energy2
	)		const

pure virtual

Retrieve integral cross-section [Mb * MeV] in a given interval [MeV].

Implemented in Heed::AveragePhotoAbsCS, Heed::HydrogenPhotoAbsCS, Heed::SimpleTablePhotoAbsCS, and Heed::PhenoPhotoAbsCS.

◆ get_name()

const std::string & Heed::PhotoAbsCS::get_name ( ) const

inline

Name of this shell or atom.

Definition at line 56 of file PhotoAbsCS.h.

56{ return name; }

Referenced by Heed::SimpleAtomPhotoAbsCS::SimpleAtomPhotoAbsCS().

◆ get_number()

int Heed::PhotoAbsCS::get_number ( ) const

inline

Number of this shell.

Definition at line 58 of file PhotoAbsCS.h.

58{ return number; }

◆ get_threshold()

double Heed::PhotoAbsCS::get_threshold ( ) const

inline

Return the threshold energy.

Definition at line 64 of file PhotoAbsCS.h.

64{ return threshold; }

Referenced by Heed::SimpleTablePhotoAbsCS::SimpleTablePhotoAbsCS().

◆ get_Z()

int Heed::PhotoAbsCS::get_Z ( ) const

inline

Charge or number of electrons at this shell or in this atom (in principle the integral of CS should satisfy the Thomas-Reiche-Kuhn sum rule).

Definition at line 62 of file PhotoAbsCS.h.

62{ return Z; }

Referenced by Heed::SimpleAtomPhotoAbsCS::SimpleAtomPhotoAbsCS().

◆ print()

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

virtual

Reimplemented in Heed::AveragePhotoAbsCS, Heed::HydrogenPhotoAbsCS, Heed::SimpleTablePhotoAbsCS, and Heed::PhenoPhotoAbsCS.

Definition at line 91 of file PhotoAbsCS.cpp.

                                                    {
  if (l <= 0) return;
  Ifile << "PhotoAbsCS: name=" << name << " Z = " << Z
        << " threshold = " << threshold << std::endl;
}

◆ scale()

virtual void Heed::PhotoAbsCS::scale ( double fact )

pure virtual

Multiply by some factor. Can be useful for debugging and other purposes.

Implemented in Heed::AveragePhotoAbsCS, Heed::HydrogenPhotoAbsCS, Heed::SimpleTablePhotoAbsCS, and Heed::PhenoPhotoAbsCS.

Member Data Documentation

◆ name

std::string Heed::PhotoAbsCS::name

protected

Definition at line 76 of file PhotoAbsCS.h.

Referenced by Heed::AveragePhotoAbsCS::AveragePhotoAbsCS(), get_name(), PhotoAbsCS(), print(), Heed::HydrogenPhotoAbsCS::print(), Heed::SimpleTablePhotoAbsCS::print(), and Heed::PhenoPhotoAbsCS::print().

◆ number

int Heed::PhotoAbsCS::number

protected

Definition at line 77 of file PhotoAbsCS.h.

Referenced by Heed::AveragePhotoAbsCS::AveragePhotoAbsCS(), get_number(), Heed::HydrogenPhotoAbsCS::HydrogenPhotoAbsCS(), and PhotoAbsCS().

◆ threshold

double Heed::PhotoAbsCS::threshold

protected

Definition at line 79 of file PhotoAbsCS.h.

Referenced by Heed::AveragePhotoAbsCS::AveragePhotoAbsCS(), Heed::HydrogenPhotoAbsCS::get_CS(), Heed::SimpleTablePhotoAbsCS::get_CS(), Heed::PhenoPhotoAbsCS::get_CS(), Heed::HydrogenPhotoAbsCS::get_integral_CS(), Heed::SimpleTablePhotoAbsCS::get_integral_CS(), Heed::PhenoPhotoAbsCS::get_integral_CS(), get_threshold(), Heed::PhenoPhotoAbsCS::PhenoPhotoAbsCS(), print(), Heed::HydrogenPhotoAbsCS::print(), Heed::SimpleTablePhotoAbsCS::print(), Heed::PhenoPhotoAbsCS::print(), and Heed::SimpleTablePhotoAbsCS::SimpleTablePhotoAbsCS().

◆ Z

int Heed::PhotoAbsCS::Z

protected

Definition at line 78 of file PhotoAbsCS.h.

Referenced by Heed::AveragePhotoAbsCS::AveragePhotoAbsCS(), get_Z(), Heed::PhenoPhotoAbsCS::PhenoPhotoAbsCS(), print(), Heed::HydrogenPhotoAbsCS::print(), Heed::SimpleTablePhotoAbsCS::print(), and Heed::PhenoPhotoAbsCS::print().

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PhotoAbsCS() [1/2]

◆ PhotoAbsCS() [2/2]

◆ ~PhotoAbsCS()

Member Function Documentation

◆ copy()

◆ get_CS()

◆ get_integral_CS()

◆ get_name()

◆ get_number()

◆ get_threshold()

◆ get_Z()

◆ print()

◆ scale()

Member Data Documentation

◆ name

◆ number

◆ threshold

◆ Z