G4IonStoppingData Class Reference

#include <G4IonStoppingData.hh>

Inheritance diagram for G4IonStoppingData:

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

Private Types
typedef std::pair< G4int, G4int >	G4IonDEDXKeyElem
typedef std::pair< G4int, G4String >	G4IonDEDXKeyMat
typedef std::map< G4IonDEDXKeyElem, G4PhysicsVector * >	G4IonDEDXMapElem
typedef std::map< G4IonDEDXKeyMat, G4PhysicsVector * >	G4IonDEDXMapMat

Private Member Functions
	G4IonStoppingData (G4IonStoppingData &)=delete
const G4IonStoppingData &	operator= (const G4IonStoppingData &)=delete

Private Attributes
G4IonDEDXMapElem	dedxMapElements
G4IonDEDXMapMat	dedxMapMaterials
G4bool	fICRU90
G4String	subDir

Detailed Description

Definition at line 59 of file G4IonStoppingData.hh.

Member Typedef Documentation

G4IonDEDXKeyElem

typedef std::pair<G4int, G4int> G4IonStoppingData::G4IonDEDXKeyElem

private

Definition at line 161 of file G4IonStoppingData.hh.

G4IonDEDXKeyMat

typedef std::pair<G4int, G4String> G4IonStoppingData::G4IonDEDXKeyMat

private

Definition at line 162 of file G4IonStoppingData.hh.

G4IonDEDXMapElem

typedef std::map<G4IonDEDXKeyElem, G4PhysicsVector*> G4IonStoppingData::G4IonDEDXMapElem

private

Definition at line 164 of file G4IonStoppingData.hh.

G4IonDEDXMapMat

typedef std::map<G4IonDEDXKeyMat, G4PhysicsVector*> G4IonStoppingData::G4IonDEDXMapMat

private

Definition at line 165 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) {
}

~G4IonStoppingData()

G4IonStoppingData::~G4IonStoppingData ( )

virtual

Definition at line 69 of file G4IonStoppingData.cc.

                                      {
  ClearTable();
}

References ClearTable().

G4IonStoppingData() [2/2]

G4IonStoppingData::G4IonStoppingData ( G4IonStoppingData &  )

privatedelete

Member Function Documentation

AddPhysicsVector() [1/2]

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

Definition at line 163 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;
}

References dedxMapMaterials, FatalException, and G4Exception().

Referenced by BuildPhysicsVector().

AddPhysicsVector() [2/2]

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

Definition at line 207 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;
}

References dedxMapElements, FatalException, and G4Exception().

BuildPhysicsVector() [1/2]

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

virtual

Implements G4VIonDEDXTable.

Definition at line 305 of file G4IonStoppingData.cc.

                                   {
 
  if( IsApplicable(atomicNumberIon, matname) ) return true;
 
  const char* path = std::getenv("G4LEDATA");
  if ( !path ) {
    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;
  
  G4PhysicsFreeVector* 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;
}

References AddPhysicsVector(), cm2, FatalException, fICRU90, geant4_check_module_cycles::file, g, G4Exception(), IsApplicable(), MeV, and subDir.

BuildPhysicsVector() [2/2]

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

virtual

Implements G4VIonDEDXTable.

Definition at line 356 of file G4IonStoppingData.cc.

{
  if( IsApplicable(ZIon, ZElem) ) return true;
 
  char* path = std::getenv("G4LEDATA");
  if ( !path ) {
    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;  
  G4PhysicsFreeVector* 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;
}

References AddPhysicsVector(), cm2, FatalException, fICRU90, geant4_check_module_cycles::file, g, G4Exception(), IsApplicable(), MeV, and subDir.

ClearTable()

void G4IonStoppingData::ClearTable

(

)

Definition at line 404 of file G4IonStoppingData.cc.

                                   {
 
  G4IonDEDXMapMat::iterator iterMat = dedxMapMaterials.begin();
  G4IonDEDXMapMat::iterator iterMat_end = dedxMapMaterials.end();
 
  for(;iterMat != iterMat_end; iterMat++) { 
 
    G4PhysicsVector* vec = iterMat -> second;
 
    if(vec != 0) delete vec;
  }
 
  dedxMapMaterials.clear();
 
  G4IonDEDXMapElem::iterator iterElem = dedxMapElements.begin();
  G4IonDEDXMapElem::iterator iterElem_end = dedxMapElements.end();
 
  for(;iterElem != iterElem_end; iterElem++) { 
 
    G4PhysicsVector* vec = iterElem -> second;
 
    if(vec != 0) delete vec;
  }
 
  dedxMapElements.clear();
}

References dedxMapElements, dedxMapMaterials, and second.

Referenced by ~G4IonStoppingData().

DumpMap()

void G4IonStoppingData::DumpMap

(

)

Definition at line 433 of file G4IonStoppingData.cc.

                                {
 
  G4IonDEDXMapMat::iterator iterMat = dedxMapMaterials.begin();
  G4IonDEDXMapMat::iterator 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 != 0) {
         G4cout << std::setw(15) << std::right
                << atomicNumberIon
                << std::setw(25) << std::right
                << matIdentifier
                << G4endl;
      }
  }
 
  G4IonDEDXMapElem::iterator iterElem = dedxMapElements.begin();
  G4IonDEDXMapElem::iterator 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 != 0) {
         G4cout << std::setw(15) << std::right
                << atomicNumberIon
                << std::setw(25) << std::right
                << atomicNumberElem
                << G4endl;
      }
  }
 
}

References dedxMapElements, dedxMapMaterials, G4cout, G4endl, and second.

GetDEDX() [1/2]

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

Definition at line 147 of file G4IonStoppingData.cc.

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

References dedxMapMaterials.

GetDEDX() [2/2]

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

Definition at line 131 of file G4IonStoppingData.cc.

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

References dedxMapElements.

GetPhysicsVector() [1/2]

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

virtual

Implements G4VIonDEDXTable.

Definition at line 117 of file G4IonStoppingData.cc.

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

References dedxMapMaterials.

GetPhysicsVector() [2/2]

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

virtual

Implements G4VIonDEDXTable.

Definition at line 103 of file G4IonStoppingData.cc.

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

References dedxMapElements.

IsApplicable() [1/2]

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

virtual

Implements G4VIonDEDXTable.

Definition at line 89 of file G4IonStoppingData.cc.

{
  G4IonDEDXKeyMat key = std::make_pair(atomicNumberIon, matIdentifier);
 
  G4IonDEDXMapMat::iterator iter = dedxMapMaterials.find(key);
 
  return (iter == dedxMapMaterials.end()) ? false : true; 
}

References dedxMapMaterials.

IsApplicable() [2/2]

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

virtual

Implements G4VIonDEDXTable.

Definition at line 75 of file G4IonStoppingData.cc.

{
  G4IonDEDXKeyElem key = std::make_pair(atomicNumberIon, atomicNumberElem);
 
  G4IonDEDXMapElem::iterator iter = dedxMapElements.find(key);
 
  return (iter == dedxMapElements.end()) ? false : true; 
}

References dedxMapElements.

Referenced by BuildPhysicsVector().

operator=()

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

privatedelete

RemovePhysicsVector() [1/2]

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

Definition at line 250 of file G4IonStoppingData.cc.

                        {
 
  G4IonDEDXKeyMat key = std::make_pair(atomicNumberIon, matIdentifier);
 
  G4IonDEDXMapMat::iterator 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;
}

References dedxMapMaterials, FatalException, and G4Exception().

RemovePhysicsVector() [2/2]

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

Definition at line 278 of file G4IonStoppingData.cc.

                        {
  G4IonDEDXKeyElem key = std::make_pair(atomicNumberIon, atomicNumberElem);
 
  G4IonDEDXMapElem::iterator 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;
}

References dedxMapElements, FatalException, and G4Exception().

Field Documentation

dedxMapElements

G4IonDEDXMapElem G4IonStoppingData::dedxMapElements

private

Definition at line 167 of file G4IonStoppingData.hh.

Referenced by AddPhysicsVector(), ClearTable(), DumpMap(), GetDEDX(), GetPhysicsVector(), IsApplicable(), and RemovePhysicsVector().

dedxMapMaterials

G4IonDEDXMapMat G4IonStoppingData::dedxMapMaterials

private

Definition at line 168 of file G4IonStoppingData.hh.

Referenced by AddPhysicsVector(), ClearTable(), DumpMap(), GetDEDX(), GetPhysicsVector(), IsApplicable(), and RemovePhysicsVector().

fICRU90

G4bool G4IonStoppingData::fICRU90

private

Definition at line 170 of file G4IonStoppingData.hh.

Referenced by BuildPhysicsVector().

subDir

G4String G4IonStoppingData::subDir

private

Definition at line 159 of file G4IonStoppingData.hh.

Referenced by BuildPhysicsVector().

---

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

• source/materials/include/G4IonStoppingData.hh
• source/materials/src/G4IonStoppingData.cc