Detailed Description

C++ implementation of VEDALOSS stopping power calculation.

Description

Based on the original Fortran code VEDALOSS written by Roland Dayras (CEA/SPhN Saclay) and Enrico de Filippo (INFN LNS Catania), KVedaLoss provides range tables for the stopping of charged ions in a large variety of pre-defined solid and gaseous media. It can be used to calculated energy losses, residual energies, ranges, and the corresponding inverse calculations.

The code interpolates the range tables of Northcliffe and Schilling (NCS) with those of Hubert, Bimbot and Gauvin (HBG) in order to calculate ranges based on data valid in the energy range $0.1\leq E/A\leq 250$ MeV/nucleon. For $E/A<2.5$ MeV/nucleon ranges are taken from NCS (which include the contribution from nuclear stopping), while at higher energies ranges are taken from HBG. It should be noted that the ranges of HBG were calculated from 2.5 MeV/nucleon upwards taking the NCS range at 2.5 MeV/nucleon as starting point.

Method

For each material, the interpolated range for each ion from $Z=1$ to $Z=100$ is parametrised as

\[ \log R = \sum_{i=0}^{5}a_{i}\left(\log\epsilon\right)^{i} \]

where $R$ is the range [ $g/cm^{2}$] of the ion and $\epsilon$ its incident energy [MeV/nucleon]. The six parameters $a_{i}$ for each atomic number $Z$ (for a reference isotope mass number $A$) were found by fitting the range data taken from NS and HBG. Such fits can be realized using the KVedaLossRangeFitter class.

See here for comparisons of the fitted ranges with the original values from NCS and HBG.

Adding new absorber definitions

KVedaLoss provides methods to add new absorber definitions using interpolations of the NCS and HBG range tables provided by KVRangeYanez. See below for methods to add new absorbers composed of single elements, compounds, or mixtures.

For full explanations and examples of how to use this facility, see Energy Loss & Range Calculations

Energy limits

Normally all range, $dE$, $E_{res}$ functions are limited to range $0\leq E\leq E_{max}$, where $E_{max}$ is nominal maximum energy for which range tables are valid (usually 400MeV/u for $Z<3$, 250MeV/u for $Z>3$).

If higher energies are required, call static method KVedaLoss::SetIgnoreEnergyLimits() BEFORE ANY MATERIALS ARE CREATED in order to recalculate the $E_{max}$ limits in such a way that:

range function is always monotonically increasing function of $E_{inc}$;
stopping power is concave (i.e. no minimum of stopping power followed by an increase)

Then, at the most, the new limit will be 1 GeV/nucleon, or at the least, it will remain at the nominal (400 or 250 MeV/nucleon) level.

Definition at line 63 of file KVedaLoss.h.

#include <KVedaLoss.h>

Inheritance diagram for KVedaLoss:

[legend]

Public Member Functions
	KVedaLoss ()
	Default constructor. More...

virtual	~KVedaLoss ()
	Destructor. More...

KVIonRangeTableMaterial *	AddCompoundMaterial (const Char_t , const Char_t , Int_t, Int_t , Int_t , Int_t *, Double_t=-1.0) const

KVIonRangeTableMaterial *	AddElementalMaterial (Int_t Z, Int_t A=0) const

KVIonRangeTableMaterial *	AddMixedMaterial (const Char_t , const Char_t , Int_t, Int_t , Int_t , Int_t , Double_t , Double_t=-1.0) const

Bool_t	AddRANGEMaterial (const Char_t *name) const
	If the given material is defined in the RANGE tables, import it into VEDALOSS. More...

Bool_t	CheckIon (Int_t Z, Int_t A) const

TObjArray *	GetListOfMaterials ()

void	Print (Option_t *="") const

Bool_t	ReadMaterials (const Char_t *path) const
	Read and add range tables for materials in file. More...

Public Member Functions inherited from KVIonRangeTable
	KVIonRangeTable (const Char_t name="", const Char_t title="")
	Default constructor. More...

virtual	~KVIonRangeTable ()
	Destructor. More...

virtual Double_t	GetAtomicMass (const Char_t *)
	Returns atomic mass of a material in the range tables. More...

virtual Double_t	GetDeltaEFromEResOfIon (const Char_t *mat, Int_t Z, Int_t A, Double_t ERes, Double_t e, Double_t isoAmat=0., Double_t T=-1., Double_t P=-1.)

virtual Double_t	GetDeltaEOfIon (const Char_t *mat, Int_t Z, Int_t A, Double_t E, Double_t r, Double_t Amat=0., Double_t T=-1., Double_t P=-1.)

virtual Double_t	GetDensity (const Char_t *)
	Returns density (g/cm**3) of a material in the range tables. More...

virtual Double_t	GetEIncFromDeltaEOfIon (const Char_t *mat, Int_t Z, Int_t A, Double_t DeltaE, Double_t e, enum SolType type=kEmax, Double_t isoAmat=0., Double_t T=-1., Double_t P=-1.)

virtual Double_t	GetEIncFromEResOfIon (const Char_t *mat, Int_t Z, Int_t A, Double_t Eres, Double_t e, Double_t isoAmat=0., Double_t T=-1., Double_t P=-1.)

virtual Double_t	GetEIncOfMaxDeltaEOfIon (const Char_t *mat, Int_t Z, Int_t A, Double_t e, Double_t isoAmat=0., Double_t T=-1., Double_t P=-1.)

virtual Double_t	GetEmaxValid (const Char_t *material, Int_t Z, Int_t A)

virtual Double_t	GetEResOfIon (const Char_t *mat, Int_t Z, Int_t A, Double_t E, Double_t r, Double_t Amat=0., Double_t T=-1., Double_t P=-1.)

virtual Double_t	GetLinearDeltaEFromEResOfIon (const Char_t *mat, Int_t Z, Int_t A, Double_t ERes, Double_t e, Double_t isoAmat=0., Double_t T=-1., Double_t P=-1.)

virtual Double_t	GetLinearDeltaEOfIon (const Char_t *mat, Int_t Z, Int_t A, Double_t E, Double_t d, Double_t Amat=0., Double_t T=-1., Double_t P=-1.)

virtual Double_t	GetLinearEIncFromDeltaEOfIon (const Char_t *mat, Int_t Z, Int_t A, Double_t DeltaE, Double_t e, enum SolType type=kEmax, Double_t isoAmat=0., Double_t T=-1., Double_t P=-1.)

virtual Double_t	GetLinearEIncFromEResOfIon (const Char_t *mat, Int_t Z, Int_t A, Double_t Eres, Double_t e, Double_t isoAmat=0., Double_t T=-1., Double_t P=-1.)

virtual Double_t	GetLinearEIncOfMaxDeltaEOfIon (const Char_t *mat, Int_t Z, Int_t A, Double_t e, Double_t isoAmat=0., Double_t T=-1., Double_t P=-1.)

virtual Double_t	GetLinearEResOfIon (const Char_t *mat, Int_t Z, Int_t A, Double_t E, Double_t d, Double_t Amat=0., Double_t T=-1., Double_t P=-1.)

virtual Double_t	GetLinearMaxDeltaEOfIon (const Char_t *mat, Int_t Z, Int_t A, Double_t e, Double_t isoAmat=0., Double_t T=-1., Double_t P=-1.)

virtual Double_t	GetLinearPunchThroughEnergy (const Char_t *mat, Int_t Z, Int_t A, Double_t e, Double_t isoAmat=0., Double_t T=-1., Double_t P=-1.)

virtual Double_t	GetLinearRangeOfIon (const Char_t *mat, Int_t Z, Int_t A, Double_t E, Double_t Amat=0., Double_t T=-1., Double_t P=-1.)

KVIonRangeTableMaterial *	GetMaterial (const Char_t *material) const
	Returns pointer to material of given name or type. More...

KVIonRangeTableMaterial *	GetMaterial (TGeoMaterial *) const

virtual const Char_t *	GetMaterialName (const Char_t *)
	Return name of material of given type or name if it is in range tables. More...

virtual Double_t	GetMaxDeltaEOfIon (const Char_t *mat, Int_t Z, Int_t A, Double_t e, Double_t isoAmat=0., Double_t T=-1., Double_t P=-1.)

virtual Double_t	GetPunchThroughEnergy (const Char_t *mat, Int_t Z, Int_t A, Double_t e, Double_t isoAmat=0., Double_t T=-1., Double_t P=-1.)

virtual Double_t	GetRangeOfIon (const Char_t *mat, Int_t Z, Int_t A, Double_t E, Double_t Amat=0., Double_t T=-1., Double_t P=-1.)

virtual TGeoMaterial *	GetTGeoMaterial (const Char_t *material)
	Create and return pointer to TGeoMaterial/Mixture corresponding to material. More...

virtual Double_t	GetZ (const Char_t *)
	Returns atomic number of a material in the range tables. More...

virtual Bool_t	IsMaterialGas (const Char_t *)
	Return kTRUE if material is gaseous. More...

virtual Bool_t	IsMaterialKnown (const Char_t *)
	Return kTRUE if material is in range tables. More...

virtual Bool_t	IsMaterialKnown (TGeoMaterial *)
	Returns kTRUE if material corresponding to TGeoMaterial name or type is in range table. More...

virtual void	SetTemperatureAndPressure (const Char_t *, Double_t temperature, Double_t pressure)

Public Member Functions inherited from KVBase
	KVBase ()
	Default constructor. More...

	KVBase (const Char_t name, const Char_t title="")
	Ctor for object with given name and type. More...

	KVBase (const KVBase &)
	copy ctor More...

virtual	~ KVBase ()

virtual void	Clear (Option_t *opt="")
	Clear object properties : name, type/title, number, label. More...

virtual void	Copy (TObject &) const
	Make a copy of this object. More...

const Char_t *	GetLabel () const

UInt_t	GetNumber () const

UInt_t	GetNumberOfObjects () const

virtual TObject *	GetObject () const

virtual const Char_t *	GetType () const

Bool_t	HasLabel () const

virtual Bool_t	IsCalled (const Char_t *name) const

Bool_t	IsLabelled (const Char_t *l) const

virtual Bool_t	IsType (const Char_t *typ) const

virtual void	List ()

KVBase &	operator= (const KVBase &)
	copy assignment operator More...

Double_t	ProtectedGetX (const TF1 *func, Double_t val, int &status, Double_t xmin=0.0, Double_t xmax=0.0) const

void	SetLabel (const Char_t *lab)

virtual void	SetNumber (UInt_t num)

virtual void	SetType (const Char_t *str)

Static Public Member Functions
static Bool_t	IsUseNewRangeInversion ()

static void	SetIgnoreEnergyLimits (Bool_t yes=kTRUE)

static void	SetUseNewRangeInversion (Bool_t yes=kTRUE)

Static Public Member Functions inherited from KVIonRangeTable
static KVIonRangeTable *	GetRangeTable (const Char_t *name)
	Generates an instance of the KVIonRangeTable plugin class corresponding to given name. More...

Static Public Member Functions inherited from KVBase
static Bool_t	AreEqual (Double_t x, Double_t y, Long64_t maxdif=1)
	Comparison between two 64-bit floating-point values. More...

static void	BackupFileWithDate (const Char_t *path)

static void	CombineFiles (const Char_t file1, const Char_t file2, const Char_t *newfilename, Bool_t keep=kTRUE)

static void	Deprecated (const char method, const char advice)

static Bool_t	FindClassSourceFiles (const Char_t class_name, KVString &imp_file, KVString &dec_file, const Char_t dir_name=".")

static Bool_t	FindExecutable (TString &exec, const Char_t *path="$(PATH)")

static const Char_t *	FindFile (const Char_t *search, TString &wfil)

static const Char_t *	GetBINDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetDATABASEFilePath ()

static const Char_t *	GetDATADIRFilePath (const Char_t *namefile="")

static Bool_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Bool_t defval)

static const Char_t *	GetDataSetEnv (const Char_t dataset, const Char_t type, const Char_t *defval)

static Double_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Double_t defval)

static const Char_t *	GetETCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetExampleFilePath (const Char_t library, const Char_t namefile)
	Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.) More...

static const Char_t *	GetINCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetKVBuildDate ()
	Returns KaliVeda build date. More...

static const Char_t *	GetKVBuildDir ()
	Returns top-level directory used for build. More...

static const Char_t *	GetKVBuildTime ()
	Returns KaliVeda build time. More...

static const Char_t *	GetKVBuildType ()
	Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...) More...

static const Char_t *	GetKVBuildUser ()
	Returns username of person who performed build. More...

static const Char_t *	GetKVSourceDir ()
	Returns top-level directory of source tree used for build. More...

static const Char_t *	GetKVVersion ()
	Returns KaliVeda version string. More...

static const Char_t *	GetLIBDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetListOfPlugins (const Char_t *base)

static const Char_t *	GetListOfPluginURIs (const Char_t *base)

static const Char_t *	GetPluginURI (const Char_t base, const Char_t plugin)

static void	GetTempFileName (TString &base)

static const Char_t *	GetTEMPLATEDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetWORKDIRFilePath (const Char_t *namefile="")

static const Char_t *	gitBranch ()
	Returns git branch of sources. More...

static const Char_t *	gitCommit ()
	Returns last git commit of sources. More...

static void	InitEnvironment ()

static bool	is_gnuinstall ()

static Bool_t	IsThisAPlugin (const TString &uri, TString &base)

static TPluginHandler *	LoadPlugin (const Char_t base, const Char_t uri="0")

static Bool_t	OpenContextMenu (const char method, TObject obj, const char *alt_method_name="")

static void	OpenTempFile (TString &base, std::ofstream &fp)

static void	PrintSplashScreen ()
	Prints welcome message and infos on version etc. More...

static Bool_t	SearchAndOpenKVFile (const Char_t name, KVSQLite::database &dbfile, const Char_t kvsubdir="")

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ifstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ofstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchKVFile (const Char_t name, TString &fullpath, const Char_t kvsubdir="")

static const Char_t *	WorkingDirectory ()

Private Member Functions
void	AddMaterial (KVIonRangeTableMaterial *) const

Bool_t	CheckMaterialsList () const

KVIonRangeTableMaterial *	GetMaterialWithNameOrType (const Char_t *material) const
	Returns pointer to material of given name or type. More...

Bool_t	init_materials () const

Private Attributes
TString	fLocalMaterialsDirectory

Static Private Attributes
static Bool_t	fgNewRangeInversion = kTRUE
	static flag for using new KVedaLossInverseRangeFunction More...

static KVHashList *	fMaterials = 0x0
	static list of all known materials More...

Additional Inherited Members
Public Types inherited from KVIonRangeTable
enum	SolType { kEmax , kEmin }

Public Types inherited from KVBase
enum	EKaliVedaBits { kIsKaliVedaObject = BIT(23) }

Constructor & Destructor Documentation

◆ KVedaLoss()

KVedaLoss::KVedaLoss ( )

Default constructor.

Definition at line 69 of file KVedaLoss.cpp.

◆ ~KVedaLoss()

KVedaLoss::~KVedaLoss ( )

virtual

Destructor.

Definition at line 86 of file KVedaLoss.cpp.

Member Function Documentation

◆ AddCompoundMaterial()

KVIonRangeTableMaterial * KVedaLoss::AddCompoundMaterial	(	const Char_t *	name,
		const Char_t *	symbol,
		Int_t	nel,
		Int_t *	Z,
		Int_t *	A,
		Int_t *	nat,
		Double_t	dens = `-1.0`
	)		const

virtual

Use the RANGE tables (see KVRangeYanez) to add a compound material with a simple formula composed of different elements

Parameters

[in]	name	name for the new compound (no spaces)
[in]	symbol	chemical symbol for compound
[in]	nelem	number of elements in compound
[in]	z[nelem]	atomic numbers of elements
[in]	a[nelem]	mass numbers of elements
[in]	natoms[nelem]	number of atoms of each element
[in]	density	in $g/cm^{3}$, only required if compound is a solid

Reimplemented from KVIonRangeTable.

Definition at line 252 of file KVedaLoss.cpp.

◆ AddElementalMaterial()

KVIonRangeTableMaterial * KVedaLoss::AddElementalMaterial	(	Int_t	Z,
		Int_t	A = `0`
	)		const

virtual

Use the RANGE tables (see KVRangeYanez) to generate a new material composed of a single chemical element.

Parameters

[in]	Z	atomic number of element $Z$
[in]	A	[optional] mass number of isotope $A$

If the isotope A is not specified, we create a material containing the naturally occuring isotopes of the given element, weighted according to their natural abundances.

If the element name is "X", this material will be called "natX", for "naturally-occuring X".

Reimplemented from KVIonRangeTable.

Definition at line 204 of file KVedaLoss.cpp.

◆ AddMaterial()

void KVedaLoss::AddMaterial ( KVIonRangeTableMaterial * mat ) const

private

Add a material (taken from a different range table) to VEDALOSS This means fitting the ranges for Z=1-100 and writing the parameters in a file which will be stored in

/VEDALOSS/[name].dat

which will be read at each initialisation to include the new material

Definition at line 330 of file KVedaLoss.cpp.

◆ AddMixedMaterial()

KVIonRangeTableMaterial * KVedaLoss::AddMixedMaterial	(	const Char_t *	name,
		const Char_t *	symbol,
		Int_t	nel,
		Int_t *	Z,
		Int_t *	A,
		Int_t *	nat,
		Double_t *	prop,
		Double_t	dens = `-1.0`
	)		const

virtual

Use the RANGE tables (see KVRangeYanez) to add a material which is a mixture of either elements or compounds:

Parameters

[in]	name	name for the new mixture (no spaces)
[in]	symbol	chemical symbol for mixture
[in]	nel	number of elements in mixture
[in]	z[nel]	atomic numbers of elements
[in]	a[nel]	mass numbers of elements
[in]	nat[nel]	number of atoms of each element
[in]	prop[nel]	proportion by mass in mixture of element
[in]	density	in $g/cm^{3}$, if mixture is a solid

Reimplemented from KVIonRangeTable.

Definition at line 284 of file KVedaLoss.cpp.

◆ AddRANGEMaterial()

Bool_t KVedaLoss::AddRANGEMaterial ( const Char_t * name ) const

If the given material is defined in the RANGE tables, import it into VEDALOSS.

Definition at line 227 of file KVedaLoss.cpp.

◆ CheckIon()

Bool_t KVedaLoss::CheckIon	(	Int_t	Z,
		Int_t	A
	)		const

virtual

Reimplemented from KVIonRangeTable.

Definition at line 59 of file KVedaLoss.cpp.

◆ CheckMaterialsList()

Bool_t KVedaLoss::CheckMaterialsList ( ) const

inlineprivate

Definition at line 68 of file KVedaLoss.h.

◆ GetListOfMaterials()

TObjArray * KVedaLoss::GetListOfMaterials ( )

virtual

Create and fill a list of all materials for which range tables exist. Each entry is a TNamed with the name and type (title) of the material. User's responsibility to delete list after use (it owns its objects).

Implements KVIonRangeTable.

Definition at line 372 of file KVedaLoss.cpp.

◆ GetMaterialWithNameOrType()

KVIonRangeTableMaterial * KVedaLoss::GetMaterialWithNameOrType ( const Char_t * material ) const

privatevirtual

Returns pointer to material of given name or type.

Implements KVIonRangeTable.

Definition at line 309 of file KVedaLoss.cpp.

◆ init_materials()

Bool_t KVedaLoss::init_materials ( ) const

private

PRIVATE method - called to initialize fMaterials list of all known materials properties

Any files in /vedaloss.dat will also be read, these contain materials added by the user(s)

Definition at line 99 of file KVedaLoss.cpp.

◆ IsUseNewRangeInversion()

static Bool_t KVedaLoss::IsUseNewRangeInversion ( )

inlinestatic

Definition at line 92 of file KVedaLoss.h.

◆ Print()

void KVedaLoss::Print ( Option_t * = "" ) const

virtual

Reimplemented from KVIonRangeTable.

Definition at line 358 of file KVedaLoss.cpp.

◆ ReadMaterials()

Bool_t KVedaLoss::ReadMaterials ( const Char_t * path ) const

virtual

Read and add range tables for materials in file.

Implements KVIonRangeTable.

Definition at line 136 of file KVedaLoss.cpp.

◆ SetIgnoreEnergyLimits()

void KVedaLoss::SetIgnoreEnergyLimits ( Bool_t yes = kTRUE )

static

Call this static method with yes=kTRUE in order to recalculate the nominal limits on incident ion energies for which the range tables are valid.

Normally all range, $dE$, $E_{res}$ functions are limited to range $0\leq E\leq E_{max}$, where $E_{max}$ is nominal maximum energy for which range tables are valid (usually 400MeV/u for $Z<3$, 250MeV/u for $Z>3$).

If higher energies are required, call static method KVedaLoss::SetIgnoreEnergyLimits() BEFORE ANY MATERIALS ARE CREATED in order to recalculate the $E_{max}$ limits in such a way that:

range function is always monotonically increasing function of $E_{inc}$;
stopping power is concave (i.e. no minimum of stopping power followed by an increase)

Then, at the most, the new limit will be 1 GeV/nucleon, or at the least, it will remain at the nominal (400 or 250 MeV/nucleon) level.

Definition at line 36 of file KVedaLoss.cpp.

◆ SetUseNewRangeInversion()

static void KVedaLoss::SetUseNewRangeInversion ( Bool_t yes = kTRUE )

inlinestatic

Definition at line 88 of file KVedaLoss.h.

Member Data Documentation

◆ fgNewRangeInversion

Bool_t KVedaLoss::fgNewRangeInversion = kTRUE

staticprivate

static flag for using new KVedaLossInverseRangeFunction

Definition at line 74 of file KVedaLoss.h.

◆ fLocalMaterialsDirectory

TString KVedaLoss::fLocalMaterialsDirectory

private

Definition at line 65 of file KVedaLoss.h.

◆ fMaterials

KVHashList * KVedaLoss::fMaterials = 0x0

staticprivate

static list of all known materials

Definition at line 64 of file KVedaLoss.h.

[in]	Z	atomic number of element \(Z\)
[in]	A	[optional] mass number of isotope \(A\)

Detailed Description

Description

Method

Adding new absorber definitions

Energy limits

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVedaLoss()

◆ ~KVedaLoss()

Member Function Documentation

◆ AddCompoundMaterial()

◆ AddElementalMaterial()

◆ AddMaterial()

◆ AddMixedMaterial()

◆ AddRANGEMaterial()

◆ CheckIon()

◆ CheckMaterialsList()

◆ GetListOfMaterials()

◆ GetMaterialWithNameOrType()

◆ init_materials()

◆ IsUseNewRangeInversion()

◆ Print()

◆ ReadMaterials()

◆ SetIgnoreEnergyLimits()

◆ SetUseNewRangeInversion()

Member Data Documentation

◆ fgNewRangeInversion

◆ fLocalMaterialsDirectory

◆ fMaterials