G4IonStoppingData Class Reference

#include <G4IonStoppingData.hh>

Inheritance diagram for G4IonStoppingData:

Public Member Functions
	G4IonStoppingData (const G4String &dir, G4bool icru)
	~G4IonStoppingData () override
	G4IonStoppingData (G4IonStoppingData &)=delete
const G4IonStoppingData &	operator= (const G4IonStoppingData &)=delete
G4bool	IsApplicable (G4int atomicNumberIon, G4int atomicNumberElem) override
G4bool	IsApplicable (G4int atomicNumberIon, const G4String &matIdentifier) override
G4bool	BuildPhysicsVector (G4int ionZ, const G4String &matName) override
G4bool	BuildPhysicsVector (G4int ionZ, G4int matZ) override
G4PhysicsVector *	GetPhysicsVector (G4int atomicNumberIon, G4int atomicNumberElem) override
G4PhysicsVector *	GetPhysicsVector (G4int atomicNumberIon, const G4String &matIdenfier) override
G4double	GetDEDX (G4double kinEnergyPerNucleon, G4int atomicNumberIon, G4int atomicNumberElem)
G4double	GetDEDX (G4double kinEnergyPerNucleon, G4int atomicNumberIon, const G4String &matIdentifier)
G4bool	AddPhysicsVector (G4PhysicsVector *physicsVector, G4int atomicNumberIon, const G4String &matIdentifier)
G4bool	AddPhysicsVector (G4PhysicsVector *physicsVector, G4int atomicNumberIon, G4int atomicNumberElem)
G4bool	RemovePhysicsVector (G4int atomicNumberIon, const G4String &matIdentifier)
G4bool	RemovePhysicsVector (G4int atomicNumberIon, G4int atomicNumberElem)
void	ClearTable ()
void	DumpMap ()
Public Member Functions inherited from G4VIonDEDXTable
	G4VIonDEDXTable ()=default
virtual	~G4VIonDEDXTable ()=default
	G4VIonDEDXTable (G4VIonDEDXTable &)=delete
const G4VIonDEDXTable &	operator= (const G4VIonDEDXTable &)=delete

Detailed Description

Definition at line 57 of file G4IonStoppingData.hh.

Constructor & Destructor Documentation

G4IonStoppingData() [1/2]

G4IonStoppingData::G4IonStoppingData	(	const G4String &	dir,
		G4bool	icru )

Definition at line 63 of file G4IonStoppingData.cc.

: subDir(dir), fICRU90(val) {}

Referenced by G4IonStoppingData(), and operator=().

~G4IonStoppingData()

G4IonStoppingData::~G4IonStoppingData ( )

override

Definition at line 67 of file G4IonStoppingData.cc.

{ ClearTable(); }

G4IonStoppingData() [2/2]

G4IonStoppingData::G4IonStoppingData ( G4IonStoppingData & )

delete

Member Function Documentation

AddPhysicsVector() [1/2]

G4bool G4IonStoppingData::AddPhysicsVector	(	G4PhysicsVector *	physicsVector,
		G4int	atomicNumberIon,
		const G4String &	matIdentifier )

Definition at line 151 of file G4IonStoppingData.cc.

{
  if (physicsVector == nullptr) {
    G4Exception("G4IonStoppingData::AddPhysicsVector() for material", "mat037", FatalException,
      "Pointer to vector is null-pointer.");
    return false;
  }
 
  if (matIdentifier.empty()) {
    G4Exception("G4IonStoppingData::AddPhysicsVector() for material", "mat038", FatalException,
      "Invalid name of the material.");
    return false;
  }
 
  if (atomicNumberIon <= 0) {
    G4Exception("G4IonStoppingData::AddPhysicsVector() for material", "mat039", FatalException,
      "Illegal atomic number.");
    return false;
  }
 
  G4IonDEDXKeyMat mkey = std::make_pair(atomicNumberIon, matIdentifier);
 
  if (dedxMapMaterials.count(mkey) == 1) {
    G4ExceptionDescription ed;
    ed << "Vector with Z1 = " << atomicNumberIon << ", mat = " << matIdentifier
       << "already exists. Remove first before replacing.";
    G4Exception("G4IonStoppingData::AddPhysicsVector() for material", "mat040", FatalException, ed);
    return false;
  }
 
  dedxMapMaterials[mkey] = physicsVector;
 
  return true;
}

Referenced by BuildPhysicsVector(), and BuildPhysicsVector().

AddPhysicsVector() [2/2]

G4bool G4IonStoppingData::AddPhysicsVector	(	G4PhysicsVector *	physicsVector,
		G4int	atomicNumberIon,
		G4int	atomicNumberElem )

Definition at line 191 of file G4IonStoppingData.cc.

{
  if (physicsVector == nullptr) {
    G4Exception("G4IonStoppingData::AddPhysicsVector() for element", "mat037", FatalException,
      "Pointer to vector is null-pointer.");
    return false;
  }
 
  if (atomicNumberIon <= 0) {
    G4Exception("G4IonStoppingData::AddPhysicsVector() for element", "mat038", FatalException,
      "Invalid ion number.");
    return false;
  }
 
  if (atomicNumberElem <= 0) {
    G4Exception("G4IonStoppingData::AddPhysicsVector() for element", "mat039", FatalException,
      "Illegal atomic number.");
    return false;
  }
 
  G4IonDEDXKeyElem key = std::make_pair(atomicNumberIon, atomicNumberElem);
 
  if (dedxMapElements.count(key) == 1) {
    G4ExceptionDescription ed;
    ed << "Vector with Z1 = " << atomicNumberIon << ", Z= " << atomicNumberElem
       << "already exists. Remove first before replacing.";
    G4Exception("G4IonStoppingData::AddPhysicsVector() for element", "mat040", FatalException, ed);
    return false;
  }
 
  dedxMapElements[key] = physicsVector;
 
  return true;
}

BuildPhysicsVector() [1/2]

G4bool G4IonStoppingData::BuildPhysicsVector ( G4int ionZ, const G4String & matName )

overridevirtual

Implements G4VIonDEDXTable.

Definition at line 285 of file G4IonStoppingData.cc.

{
  if (IsApplicable(atomicNumberIon, matname)) {
    return true;
  }
 
  const char* path = G4FindDataDir("G4LEDATA");
  if (path == nullptr) {
    G4Exception("G4IonStoppingData::BuildPhysicsVector()", "mat521", FatalException,
      "G4LEDATA environment variable not set");
    return false;
  }
 
  std::ostringstream file;
  G4String ww =
    (fICRU90 && (matname == "G4_WATER" || matname == "G4_AIR" || matname == "G4_GRAPHITE")) ? "90"
                                                                                            : "73";
 
  file << path << "/" << subDir << ww << "/z" << atomicNumberIon << "_" << matname << ".dat";
  G4String fileName = G4String(file.str().c_str());
 
  std::ifstream ifilestream(fileName);
 
  if (! ifilestream.is_open()) {
    return false;
  }
 
  auto* physicsVector = new G4PhysicsFreeVector(true);
 
  if (! physicsVector->Retrieve(ifilestream, true)) {
    ifilestream.close();
    return false;
  }
 
  physicsVector->ScaleVector(MeV, MeV * cm2 / (0.001 * g));
  physicsVector->FillSecondDerivatives();
 
  // Retrieved vector is added to material store
  if (! AddPhysicsVector(physicsVector, atomicNumberIon, matname)) {
    delete physicsVector;
    ifilestream.close();
    return false;
  }
 
  ifilestream.close();
  return true;
}

BuildPhysicsVector() [2/2]

G4bool G4IonStoppingData::BuildPhysicsVector ( G4int ionZ, G4int matZ )

overridevirtual

Implements G4VIonDEDXTable.

Definition at line 337 of file G4IonStoppingData.cc.

{
  if (IsApplicable(ZIon, ZElem)) {
    return true;
  }
 
  const char* path = G4FindDataDir("G4LEDATA");
  if (path == nullptr) {
    G4Exception("G4IonStoppingData::BuildPhysicsVector()", "mat522", FatalException,
      "G4LEDATA environment variable not set");
    return false;
  }
  std::ostringstream file;
  G4String ww =
    (fICRU90 && ZIon <= 18 && (ZElem == 1 || ZElem == 6 || ZElem == 7 || ZElem == 8)) ? "90" : "73";
 
  file << path << "/" << subDir << ww << "/z" << ZIon << "_" << ZElem << ".dat";
 
  G4String fileName = G4String(file.str().c_str());
  std::ifstream ifilestream(fileName);
 
  if (! ifilestream.is_open()) {
    return false;
  }
  auto* physicsVector = new G4PhysicsFreeVector(true);
 
  if (! physicsVector->Retrieve(ifilestream, true)) {
    ifilestream.close();
    return false;
  }
 
  physicsVector->ScaleVector(MeV, MeV * cm2 / (0.001 * g));
  physicsVector->FillSecondDerivatives();
 
  // Retrieved vector is added to material store
  if (! AddPhysicsVector(physicsVector, ZIon, ZElem)) {
    delete physicsVector;
    ifilestream.close();
    return false;
  }
 
  ifilestream.close();
  return true;
}

ClearTable()

void G4IonStoppingData::ClearTable

(

)

Definition at line 386 of file G4IonStoppingData.cc.

{
  auto iterMat = dedxMapMaterials.begin();
  auto iterMat_end = dedxMapMaterials.end();
 
  for (; iterMat != iterMat_end; iterMat++) {
    G4PhysicsVector* vec = iterMat->second;
 
    delete vec;
  }
 
  dedxMapMaterials.clear();
 
  auto iterElem = dedxMapElements.begin();
  auto iterElem_end = dedxMapElements.end();
 
  for (; iterElem != iterElem_end; iterElem++) {
    G4PhysicsVector* vec = iterElem->second;
 
    delete vec;
  }
 
  dedxMapElements.clear();
}

Referenced by ~G4IonStoppingData().

DumpMap()

void G4IonStoppingData::DumpMap

(

)

Definition at line 413 of file G4IonStoppingData.cc.

{
  auto iterMat = dedxMapMaterials.begin();
  auto iterMat_end = dedxMapMaterials.end();
 
  G4cout << std::setw(15) << std::right << "Atomic nmb ion" << std::setw(25) << std::right
         << "Material name" << G4endl;
 
  for (; iterMat != iterMat_end; iterMat++) {
    G4IonDEDXKeyMat key = iterMat->first;
    G4PhysicsVector* physicsVector = iterMat->second;
 
    G4int atomicNumberIon = key.first;
    G4String matIdentifier = key.second;
 
    if (physicsVector != nullptr) {
      G4cout << std::setw(15) << std::right << atomicNumberIon << std::setw(25) << std::right
             << matIdentifier << G4endl;
    }
  }
 
  auto iterElem = dedxMapElements.begin();
  auto iterElem_end = dedxMapElements.end();
 
  G4cout << std::setw(15) << std::right << "Atomic nmb ion" << std::setw(25) << std::right
         << "Atomic nmb material" << G4endl;
 
  for (; iterElem != iterElem_end; iterElem++) {
    G4IonDEDXKeyElem key = iterElem->first;
    G4PhysicsVector* physicsVector = iterElem->second;
 
    G4int atomicNumberIon = key.first;
    G4int atomicNumberElem = key.second;
 
    if (physicsVector != nullptr) {
      G4cout << std::setw(15) << std::right << atomicNumberIon << std::setw(25) << std::right
             << atomicNumberElem << G4endl;
    }
  }
}

GetDEDX() [1/2]

G4double G4IonStoppingData::GetDEDX	(	G4double	kinEnergyPerNucleon,
		G4int	atomicNumberIon,
		const G4String &	matIdentifier )

Definition at line 137 of file G4IonStoppingData.cc.

{
  G4IonDEDXKeyMat key = std::make_pair(atomicNumberIon, matIdentifier);
 
  auto iter = dedxMapMaterials.find(key);
 
  return (iter != dedxMapMaterials.end()) ? (iter->second)->Value(kinEnergyPerNucleon) : 0.0;
}

GetDEDX() [2/2]

G4double G4IonStoppingData::GetDEDX	(	G4double	kinEnergyPerNucleon,
		G4int	atomicNumberIon,
		G4int	atomicNumberElem )

Definition at line 123 of file G4IonStoppingData.cc.

{
  G4IonDEDXKeyElem key = std::make_pair(atomicNumberIon, atomicNumberElem);
 
  auto iter = dedxMapElements.find(key);
 
  return (iter != dedxMapElements.end()) ? (iter->second)->Value(kinEnergyPerNucleon) : 0.0;
}

GetPhysicsVector() [1/2]

G4PhysicsVector * G4IonStoppingData::GetPhysicsVector ( G4int atomicNumberIon, const G4String & matIdenfier )

overridevirtual

Implements G4VIonDEDXTable.

Definition at line 110 of file G4IonStoppingData.cc.

{
  G4IonDEDXKeyMat key = std::make_pair(atomicNumberIon, matIdentifier);
 
  auto iter = dedxMapMaterials.find(key);
 
  return (iter != dedxMapMaterials.end()) ? iter->second : nullptr;
}

GetPhysicsVector() [2/2]

G4PhysicsVector * G4IonStoppingData::GetPhysicsVector ( G4int atomicNumberIon, G4int atomicNumberElem )

overridevirtual

Implements G4VIonDEDXTable.

Definition at line 97 of file G4IonStoppingData.cc.

{
  G4IonDEDXKeyElem key = std::make_pair(atomicNumberIon, atomicNumberElem);
 
  auto iter = dedxMapElements.find(key);
 
  return (iter != dedxMapElements.end()) ? iter->second : nullptr;
}

IsApplicable() [1/2]

G4bool G4IonStoppingData::IsApplicable ( G4int atomicNumberIon, const G4String & matIdentifier )

overridevirtual

Implements G4VIonDEDXTable.

Definition at line 84 of file G4IonStoppingData.cc.

{
  G4IonDEDXKeyMat key = std::make_pair(atomicNumberIon, matIdentifier);
 
  auto iter = dedxMapMaterials.find(key);
 
  return iter != dedxMapMaterials.end();
}

IsApplicable() [2/2]

G4bool G4IonStoppingData::IsApplicable ( G4int atomicNumberIon, G4int atomicNumberElem )

overridevirtual

Implements G4VIonDEDXTable.

Definition at line 71 of file G4IonStoppingData.cc.

{
  G4IonDEDXKeyElem key = std::make_pair(atomicNumberIon, atomicNumberElem);
 
  auto iter = dedxMapElements.find(key);
 
  return iter != dedxMapElements.end();
}

Referenced by BuildPhysicsVector(), and BuildPhysicsVector().

operator=()

const G4IonStoppingData & G4IonStoppingData::operator= ( const G4IonStoppingData & )

delete

RemovePhysicsVector() [1/2]

G4bool G4IonStoppingData::RemovePhysicsVector	(	G4int	atomicNumberIon,
		const G4String &	matIdentifier )

Definition at line 231 of file G4IonStoppingData.cc.

{
  G4IonDEDXKeyMat key = std::make_pair(atomicNumberIon, matIdentifier);
 
  auto iter = dedxMapMaterials.find(key);
 
  if (iter == dedxMapMaterials.end()) {
    G4Exception("G4IonStoppingData::RemovePhysicsVector() for material", "mat038", FatalException,
      "Invalid name of the material.");
    return false;
  }
 
  G4PhysicsVector* physicsVector = (*iter).second;
 
  // Deleting key of physics vector from material map
  dedxMapMaterials.erase(key);
 
  // Deleting physics vector
  delete physicsVector;
 
  return true;
}

RemovePhysicsVector() [2/2]

G4bool G4IonStoppingData::RemovePhysicsVector	(	G4int	atomicNumberIon,
		G4int	atomicNumberElem )

Definition at line 258 of file G4IonStoppingData.cc.

{
  G4IonDEDXKeyElem key = std::make_pair(atomicNumberIon, atomicNumberElem);
 
  auto iter = dedxMapElements.find(key);
 
  if (iter == dedxMapElements.end()) {
    G4Exception("G4IonStoppingData::RemovePhysicsVector() for element", "mat038", FatalException,
      "Invalid element.");
    return false;
  }
 
  G4PhysicsVector* physicsVector = (*iter).second;
 
  // Deleting key of physics vector from material map
  dedxMapElements.erase(key);
 
  // Deleting physics vector
  delete physicsVector;
 
  return true;
}

---

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

• G4IonStoppingData.hh
• G4IonStoppingData.cc