G4Molecule Class Reference

#include <G4Molecule.hh>

Inheritance diagram for G4Molecule:

Collaboration diagram for G4Molecule:

Public Member Functions
void	Print () const
void *	operator new (size_t)
void	operator delete (void *)
	G4Molecule (const G4Molecule &)
G4Molecule &	operator= (const G4Molecule &right)
G4bool	operator== (const G4Molecule &right) const
G4bool	operator!= (const G4Molecule &right) const
G4bool	operator< (const G4Molecule &right) const
	operator int () const
virtual G4ITType	GetITSubType () const
	G4Molecule (G4MoleculeDefinition *molecule)
	G4Molecule (G4MoleculeDefinition *molDef, int charge)
	G4Molecule (G4MoleculeDefinition *molecule, G4int, G4int)
	G4Molecule (G4MoleculeDefinition *molecule, G4int, G4bool)
	G4Molecule (G4MolecularConfiguration *)
virtual	~G4Molecule ()
const G4String &	GetName () const
const G4String &	GetFormatedName () const
G4int	GetAtomsNumber () const
void	SetElectronOccupancy (const G4ElectronOccupancy *)
void	ExciteMolecule (G4int)
void	IonizeMolecule (G4int)
void	AddElectron (G4int orbit, G4int n=1)
void	RemoveElectron (G4int, G4int number=1)
void	MoveOneElectron (G4int, G4int)
G4double	GetNbElectrons () const
void	PrintState () const
G4Track *	BuildTrack (G4double globalTime, const G4ThreeVector &Position)
G4double	GetKineticEnergy () const
G4double	GetDiffusionVelocity () const
const std::vector< const G4MolecularDissociationChannel * > *	GetDecayChannel () const
G4int	GetFakeParticleID () const
G4int	GetMoleculeID () const
const G4MoleculeDefinition *	GetDefinition () const
void	SetDiffusionCoefficient (G4double)
G4double	GetDiffusionCoefficient () const
G4double	GetDiffusionCoefficient (const G4Material *, double temperature) const
void	SetDecayTime (G4double)
G4double	GetDecayTime () const
void	SetVanDerVaalsRadius (G4double)
G4double	GetVanDerVaalsRadius () const
const G4ElectronOccupancy *	GetElectronOccupancy () const
G4int	GetCharge () const
void	SetMass (G4double)
G4double	GetMass () const
const G4String &	GetLabel () const
void	SetLabel (const G4String &label)
void	ChangeConfigurationToLabel (const G4String &label)
G4MolecularConfiguration *	GetMolecularConfiguration () const
Public Member Functions inherited from G4IT
	G4IT ()
	G4IT (G4Track *)
virtual	~G4IT ()
virtual G4bool	diff (const G4IT &right) const =0
virtual G4bool	equal (const G4IT &right) const =0
G4bool	operator< (const G4IT &right) const
G4bool	operator== (const G4IT &right) const
G4bool	operator!= (const G4IT &right) const
void	SetTrack (G4Track *)
G4Track *	GetTrack ()
const G4Track *	GetTrack () const
void	RecordCurrentPositionNTime ()
const G4ThreeVector &	GetPosition () const
double	operator[] (int i) const
const G4ThreeVector &	GetPreStepPosition () const
G4double	GetPreStepLocalTime () const
G4double	GetPreStepGlobalTime () const
void	SetPrevious (G4IT *)
void	SetNext (G4IT *)
G4IT *	GetPrevious ()
G4IT *	GetNext ()
const G4IT *	GetPrevious () const
const G4IT *	GetNext () const
void	SetITBox (G4ITBox *)
const G4ITBox *	GetITBox () const
void	TakeOutBox ()
void	SetNode (G4KDNode_Base *)
G4KDNode_Base *	GetNode () const
void	SetParentID (int, int)
void	GetParentID (int &, int &)
G4TrackingInformation *	GetTrackingInfo ()
G4TrackListNode *	GetListNode ()
void	SetListNode (G4TrackListNode *node)
virtual const G4ITType	GetITType () const =0
Public Member Functions inherited from G4VUserTrackInformation
	G4VUserTrackInformation ()
	G4VUserTrackInformation (const G4String &infoType)
	G4VUserTrackInformation (const G4VUserTrackInformation &)
G4VUserTrackInformation &	operator= (const G4VUserTrackInformation &)
virtual	~G4VUserTrackInformation ()
const G4String &	GetType () const

Static Public Member Functions
static G4Molecule *	GetMolecule (const G4Track *)

Additional Inherited Members
Public Types inherited from G4IT
enum	ELimited {   kDoNot, kUnique, kSharedTransport, kSharedOther,   kUndefLimited }
Protected Member Functions inherited from G4IT
	G4IT (const G4IT &)
G4IT &	operator= (const G4IT &)
Protected Attributes inherited from G4IT
G4Track *	fpTrack
Protected Attributes inherited from G4VUserTrackInformation
G4String *	pType

Detailed Description

Class Description The dynamic molecule holds all the data that change for a molecule It has a pointer to G4MoleculeDefinition object, which holds all the "ground level" information.

Definition at line 98 of file G4Molecule.hh.

Constructor & Destructor Documentation

G4Molecule::G4Molecule

(

const G4Molecule &

right

)

Definition at line 104 of file G4Molecule.cc.

                                              :
    G4VUserTrackInformation("G4Molecule"), G4IT(right)
{
  fpMolecularConfiguration = right.fpMolecularConfiguration;
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4Molecule::G4Molecule

(

G4MoleculeDefinition *

moleculeDefinition

)

To build a molecule at ground state according to a given G4MoleculeDefinition that can be obtained from G4GenericMoleculeManager

Build a molecule at ground state according to a given G4MoleculeDefinition that can be obtained from G4GenericMoleculeManager

Definition at line 181 of file G4Molecule.cc.

                                                                :
    G4VUserTrackInformation("G4Molecule"), G4IT()
{
  fpMolecularConfiguration =
      G4MolecularConfiguration::
        GetOrCreateMolecularConfiguration(moleculeDefinition);
}

G4Molecule::G4Molecule	(	G4MoleculeDefinition *	molDef,
		int	charge
	)

Definition at line 192 of file G4Molecule.cc.

{
  fpMolecularConfiguration =
      G4MolecularConfiguration::
        GetOrCreateMolecularConfiguration(moleculeDefinition,
                                          charge);
}

Here is the call graph for this function:

G4Molecule::G4Molecule	(	G4MoleculeDefinition *	moleculeDefinition,
		G4int	OrbitalToFree,
		G4int	OrbitalToFill
	)

To build a molecule at a specific excitation/ionisation state according to a ground state that can be obtained from G4GenericMoleculeManager

Build a molecule at a specific excitation/ionisation state according to a ground state that can be obtained from G4GenericMoleculeManager. Put 0 in the second option if this is a ionisation.

Definition at line 206 of file G4Molecule.cc.

                                            :
    G4VUserTrackInformation("G4Molecule"), G4IT()
{
  if (moleculeDefinition->GetGroundStateElectronOccupancy())
  {
    G4ElectronOccupancy dynElectronOccupancy(
        *moleculeDefinition->GetGroundStateElectronOccupancy());

    if (OrbitalToFill != 0)
    {
      dynElectronOccupancy.RemoveElectron(OrbitalToFree - 1, 1);
      dynElectronOccupancy.AddElectron(OrbitalToFill - 1, 1);
      // dynElectronOccupancy.DumpInfo(); // DEBUG
    }

    if (OrbitalToFill == 0)
    {
      dynElectronOccupancy.RemoveElectron(OrbitalToFree - 1, 1);
      // dynElectronOccupancy.DumpInfo(); // DEBUG
    }

    fpMolecularConfiguration =
        G4MolecularConfiguration::GetOrCreateMolecularConfiguration(
            moleculeDefinition, dynElectronOccupancy);
  }
  else
  {
    fpMolecularConfiguration = 0;
    G4Exception(
        "G4Molecule::G4Molecule(G4MoleculeDefinition * moleculeDefinition, "
        "G4int OrbitalToFree, G4int OrbitalToFill)",
        "G4Molecule_wrong_usage_of_constructor",
        FatalErrorInArgument,
        "If you want to use this constructor, the molecule definition has to be "
        "first defined with electron occupancies");
  }
}

G4Molecule::G4Molecule	(	G4MoleculeDefinition *	moleculeDefinition,
		G4int	Level,
		G4bool	Excitation
	)

Specific builder for water molecules to be used in Geant4-DNA, the last option Excitation is true if the molecule is excited, is false is the molecule is ionized.

Definition at line 253 of file G4Molecule.cc.

                                          :
    G4VUserTrackInformation("G4Molecule"), G4IT()
{
  if (moleculeDefinition->GetGroundStateElectronOccupancy())
  {
    G4ElectronOccupancy dynElectronOccupancy(
        *moleculeDefinition->GetGroundStateElectronOccupancy());

    if (Excitation == true)
    {
      dynElectronOccupancy.RemoveElectron(Level, 1);
      dynElectronOccupancy.AddElectron(5, 1);
      // dynElectronOccupancy.DumpInfo(); // DEBUG
    }

    if (Excitation == false)
    {
      dynElectronOccupancy.RemoveElectron(Level, 1);
      // dynElectronOccupancy.DumpInfo(); // DEBUG
    }

    fpMolecularConfiguration =
        G4MolecularConfiguration::GetOrCreateMolecularConfiguration(
            moleculeDefinition, dynElectronOccupancy);
  }
  else
  {
    fpMolecularConfiguration = 0;
    G4Exception(
        "G4Molecule::G4Molecule(G4MoleculeDefinition * moleculeDefinition, "
        "G4int OrbitalToFree, G4int OrbitalToFill)",
        "G4Molecule_wrong_usage_of_constructor",
        FatalErrorInArgument,
        "If you want to use this constructor, the molecule definition has to be "
        "first defined with electron occupancies");

  }
}

Here is the call graph for this function:

G4Molecule::G4Molecule

(

G4MolecularConfiguration *

molConf

)

Definition at line 296 of file G4Molecule.cc.

{
  fpMolecularConfiguration = molConf;
}

Here is the call graph for this function:

G4Molecule::~G4Molecule ( )

virtual

Definition at line 160 of file G4Molecule.cc.

{
  if (fpTrack != nullptr)
  {
    if (G4VMoleculeCounter::Instance()->InUse())
    {
      G4VMoleculeCounter::Instance()->
        RemoveAMoleculeAtTime(fpMolecularConfiguration,
                              fpTrack->GetGlobalTime(),
                              &(fpTrack->GetPosition()));
    }
    fpTrack = nullptr;
  }
  fpMolecularConfiguration = nullptr;
}

Here is the call graph for this function:

Member Function Documentation

void G4Molecule::AddElectron	(	G4int	orbit,
		G4int	n = 1
	)

Add n electrons to a given orbit. Note : You can add as many electrons to a given orbit, the result may be unrealist.

Definition at line 332 of file G4Molecule.cc.

{
  fpMolecularConfiguration = fpMolecularConfiguration->AddElectron(orbit,
                                                                   number);
}

Here is the call graph for this function:

G4Track * G4Molecule::BuildTrack	(	G4double	globalTime,
		const G4ThreeVector &	Position
	)

Definition at line 391 of file G4Molecule.cc.

{
  if (fpTrack != 0){
    G4Exception("G4Molecule::BuildTrack", "Molecule001", FatalErrorInArgument,
                "A track was already assigned to this molecule");
  }

  // Kinetic Values
  // Set a random direction to the molecule
  G4double costheta = (2 * G4UniformRand()-1);
  G4double theta = acos(costheta);
  G4double phi = 2 * pi * G4UniformRand();

  G4double xMomentum = cos(phi) * sin(theta);
  G4double yMomentum = sin(theta) * sin(phi);
  G4double zMomentum = costheta;

  G4ThreeVector MomentumDirection(xMomentum, yMomentum, zMomentum);
  G4double KineticEnergy = GetKineticEnergy();

  G4DynamicParticle* dynamicParticle = new G4DynamicParticle(
      fpMolecularConfiguration->GetDefinition(), MomentumDirection,
      KineticEnergy);

  if (G4VMoleculeCounter::InUse()){
    G4VMoleculeCounter::Instance()->
      AddAMoleculeAtTime(fpMolecularConfiguration,
                         globalTime,
                         &(fpTrack->GetPosition()));
  }

  //Set the Track
  fpTrack = new G4Track(dynamicParticle, globalTime, position);
  fpTrack->SetUserInformation(this);

  return fpTrack;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4Molecule::ChangeConfigurationToLabel

(

const G4String &

label

)

Definition at line 611 of file G4Molecule.cc.

{
  // TODO check fpMolecularConfiguration already exists
  // and new one as well
  // TODO notify for stack change
  fpMolecularConfiguration =
      G4MolecularConfiguration::GetMolecularConfiguration(
          fpMolecularConfiguration->GetDefinition(), label);

  assert(fpMolecularConfiguration!=0);
}

Here is the call graph for this function:

void G4Molecule::ExciteMolecule

(

G4int

ExcitedLevel

)

Method used in Geant4-DNA to excite water molecules

Definition at line 314 of file G4Molecule.cc.

{
  fpMolecularConfiguration = fpMolecularConfiguration->ExciteMolecule(
      ExcitedLevel);
}

Here is the call graph for this function:

G4int G4Molecule::GetAtomsNumber

(

)

const

Returns the nomber of atoms compouning the molecule

Definition at line 370 of file G4Molecule.cc.

{
  return fpMolecularConfiguration->GetAtomsNumber();
}

Here is the call graph for this function:

G4int G4Molecule::GetCharge

(

)

const

Returns the charge of molecule.

Definition at line 518 of file G4Molecule.cc.

{
  return fpMolecularConfiguration->GetCharge();
}

Here is the call graph for this function:

const vector< const G4MolecularDissociationChannel * > * G4Molecule::GetDecayChannel

(

)

const

Definition at line 469 of file G4Molecule.cc.

{
  return fpMolecularConfiguration->GetDecayChannel();
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4Molecule::GetDecayTime

(

)

const

Returns the decay time of the molecule.

Definition at line 497 of file G4Molecule.cc.

{
  return fpMolecularConfiguration->GetDecayTime();
}

Here is the call graph for this function:

Here is the caller graph for this function:

const G4MoleculeDefinition * G4Molecule::GetDefinition

(

)

const

Get molecule definition. This G4MoleculeDefinition has the ground electronic state of the molecule.

Definition at line 546 of file G4Molecule.cc.

{
  return fpMolecularConfiguration->GetDefinition();
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4Molecule::GetDiffusionCoefficient

(

)

const

Returns the diffusion coefficient D.

Definition at line 560 of file G4Molecule.cc.

{
  return fpMolecularConfiguration->GetDiffusionCoefficient();
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4Molecule::GetDiffusionCoefficient	(	const G4Material *	mat,
		double	temperature
	)		const

Returns the diffusion coefficient D.

Definition at line 567 of file G4Molecule.cc.

{
  return fpMolecularConfiguration->GetDiffusionCoefficient(mat,
                                                           temperature);
}

Here is the call graph for this function:

G4double G4Molecule::GetDiffusionVelocity

(

)

const

Definition at line 444 of file G4Molecule.cc.

{
  double moleculeMass = fpMolecularConfiguration->GetMass() / (c_squared);

  // Different possibilities
  // Ideal Gaz case : Maxwell Boltzmann Distribution
  //    double sigma = k_Boltzmann * fgTemperature / mass;
  //    return G4RandGauss::shoot( 0, sigma );
  // Ideal Gaz case : mean velocity from equipartition theorem
  return sqrt(3 * k_Boltzmann *
              G4MolecularConfiguration::GetGlobalTemperature()/ moleculeMass);
  // Using this approximation for liquid is wrong
  // However the brownian process avoid taking
  // care of energy consideration and plays only
  // with positions
}

Here is the call graph for this function:

Here is the caller graph for this function:

const G4ElectronOccupancy * G4Molecule::GetElectronOccupancy

(

)

const

Returns the object ElectronOccupancy describing the electronic configuration of the molecule.

Definition at line 539 of file G4Molecule.cc.

{
  return fpMolecularConfiguration->GetElectronOccupancy();
}

Here is the call graph for this function:

G4int G4Molecule::GetFakeParticleID

(

)

const

Definition at line 476 of file G4Molecule.cc.

{
  return fpMolecularConfiguration->GetFakeParticleID();
}

Here is the call graph for this function:

const G4String & G4Molecule::GetFormatedName

(

)

const

Returns the formated name of the molecule

Definition at line 363 of file G4Molecule.cc.

{
  return fpMolecularConfiguration->GetFormatedName();
}

Here is the call graph for this function:

virtual G4ITType G4Molecule::GetITSubType ( ) const

inlinevirtual

Reimplemented from G4IT.

Definition at line 128 of file G4Molecule.hh.

  {
    return GetMoleculeID();
  }

Here is the call graph for this function:

G4double G4Molecule::GetKineticEnergy

(

)

const

Definition at line 432 of file G4Molecule.cc.

{
  // Ideal Gaz case
  double v = GetDiffusionVelocity();
  double E = (fpMolecularConfiguration->GetMass() / (c_squared)) * (v * v) / 2.;
  return E;
}

Here is the call graph for this function:

Here is the caller graph for this function:

const G4String & G4Molecule::GetLabel

(

)

const

Returns the label of the molecule configuration

Definition at line 597 of file G4Molecule.cc.

{
  return fpMolecularConfiguration->GetLabel();
}

Here is the call graph for this function:

G4double G4Molecule::GetMass

(

)

const

Returns the total mass of the molecule.

Definition at line 532 of file G4Molecule.cc.

{
  return fpMolecularConfiguration->GetMass();
}

Here is the call graph for this function:

G4MolecularConfiguration * G4Molecule::GetMolecularConfiguration

(

)

const

Definition at line 576 of file G4Molecule.cc.

{
  return fpMolecularConfiguration;
}

Here is the caller graph for this function:

G4Molecule * G4Molecule::GetMolecule ( const G4Track *  track )

static

Definition at line 90 of file G4Molecule.cc.

{
  return (G4Molecule*) (GetIT(track));
}

Here is the call graph for this function:

G4int G4Molecule::GetMoleculeID

(

)

const

Definition at line 483 of file G4Molecule.cc.

{
  return fpMolecularConfiguration->GetMoleculeID();
}

Here is the call graph for this function:

Here is the caller graph for this function:

const G4String & G4Molecule::GetName ( ) const

virtual

Returns the name of the molecule

Implements G4IT.

Definition at line 356 of file G4Molecule.cc.

{
  return fpMolecularConfiguration->GetName();
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4Molecule::GetNbElectrons

(

)

const

Returns the number of electron.

Definition at line 377 of file G4Molecule.cc.

{
  return fpMolecularConfiguration->GetNbElectrons();
}

Here is the call graph for this function:

G4double G4Molecule::GetVanDerVaalsRadius

(

)

const

Definition at line 511 of file G4Molecule.cc.

{
  return fpMolecularConfiguration->GetVanDerVaalsRadius();
}

Here is the call graph for this function:

void G4Molecule::IonizeMolecule

(

G4int

IonizedLevel

)

Method used in Geant4-DNA to ionize water molecules

Definition at line 324 of file G4Molecule.cc.

{
  fpMolecularConfiguration = fpMolecularConfiguration->IonizeMolecule(
      IonizedLevel);
}

Here is the call graph for this function:

void G4Molecule::MoveOneElectron	(	G4int	orbitToFree,
		G4int	orbitToFill
	)

Move one electron from an orbit to another.

Definition at line 348 of file G4Molecule.cc.

{
  fpMolecularConfiguration = fpMolecularConfiguration->MoveOneElectron(
      orbitToFree, orbitToFill);
}

Here is the call graph for this function:

void G4Molecule::operator delete ( void *  aMolecule )

inline

Definition at line 316 of file G4Molecule.hh.

{
  aMoleculeAllocator->FreeSingle((G4Molecule *) aMolecule);
}

G4Molecule::operator int ( ) const

inline

Definition at line 123 of file G4Molecule.hh.

  {
    return GetMoleculeID();
  }

Here is the call graph for this function:

void * G4Molecule::operator new ( size_t  )

inline

Definition at line 308 of file G4Molecule.hh.

{
  if (!aMoleculeAllocator) aMoleculeAllocator = new G4Allocator<G4Molecule>;
  return (void *) aMoleculeAllocator->MallocSingle();
}

G4bool G4Molecule::operator!=

(

const G4Molecule &

right

)

const

Definition at line 132 of file G4Molecule.cc.

{
  return !(*this == right);
}

G4bool G4Molecule::operator<

(

const G4Molecule &

right

)

const

The two methods below are the most called of the simulation : compare molecules in the MoleculeStackManager or in the InteractionTable

Definition at line 143 of file G4Molecule.cc.

{
  return fpMolecularConfiguration < right.fpMolecularConfiguration;
}

G4Molecule & G4Molecule::operator=

(

const G4Molecule &

right

)

Definition at line 112 of file G4Molecule.cc.

{
  if (&right == this) return *this;
  fpMolecularConfiguration = right.fpMolecularConfiguration;
  return *this;
}

G4bool G4Molecule::operator==

(

const G4Molecule &

right

)

const

Definition at line 121 of file G4Molecule.cc.

{
  if (fpMolecularConfiguration == right.fpMolecularConfiguration)
  {
    return true;
  }
  return false;
}

void G4Molecule::Print ( ) const

virtual

Reimplemented from G4IT.

Definition at line 97 of file G4Molecule.cc.

{
  G4cout << "The user track information is a molecule" << G4endl;
}

void G4Molecule::PrintState

(

)

const

Show the electronic state of the molecule.

Definition at line 384 of file G4Molecule.cc.

{
  fpMolecularConfiguration->PrintState();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4Molecule::RemoveElectron	(	G4int	orbit,
		G4int	number = 1
	)

Remove n electrons to a given orbit.

Definition at line 340 of file G4Molecule.cc.

{
  fpMolecularConfiguration = fpMolecularConfiguration->RemoveElectron(orbit,
                                                                      number);
}

Here is the call graph for this function:

void G4Molecule::SetDecayTime

(

G4double

dynDecayTime

)

Set the decay time of the molecule.

Definition at line 490 of file G4Molecule.cc.

{
  fpMolecularConfiguration->SetDecayTime(dynDecayTime);
}

Here is the call graph for this function:

void G4Molecule::SetDiffusionCoefficient

(

G4double

dynDiffusionCoefficient

)

Sets the diffusion coefficient D of the molecule used in diffusion processes to calculate the mean square jump distance between two changes of direction. In three dimension : <x^2> = 6 D t where t is the mean jump time between two changes of direction.

Definition at line 553 of file G4Molecule.cc.

{
  fpMolecularConfiguration->SetDiffusionCoefficient(dynDiffusionCoefficient);
}

Here is the call graph for this function:

void G4Molecule::SetElectronOccupancy

(

const G4ElectronOccupancy *

occ

)

Will set up the correct molecularConfiguration given an electron configuration

Definition at line 303 of file G4Molecule.cc.

{
  fpMolecularConfiguration =
      G4MolecularConfiguration::GetOrCreateMolecularConfiguration(
          fpMolecularConfiguration->GetDefinition(), *occ);
}

Here is the call graph for this function:

void G4Molecule::SetLabel

(

const G4String &

label

)

Definition at line 604 of file G4Molecule.cc.

{
  fpMolecularConfiguration->SetLabel(label);
}

Here is the call graph for this function:

void G4Molecule::SetMass

(

G4double

aMass

)

Set the total mass of the molecule.

Definition at line 525 of file G4Molecule.cc.

{
  fpMolecularConfiguration->SetMass(aMass);
}

Here is the call graph for this function:

void G4Molecule::SetVanDerVaalsRadius

(

G4double

dynVanDerVaalsRadius

)

The Van Der Valls Radius of the molecule

Definition at line 504 of file G4Molecule.cc.

{
  fpMolecularConfiguration->SetVanDerVaalsRadius(dynVanDerVaalsRadius);
}

Here is the call graph for this function:

---

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

• geant4.10.03.p01/source/processes/electromagnetic/dna/molecules/management/include/G4Molecule.hh
• geant4.10.03.p01/source/processes/electromagnetic/dna/molecules/management/src/G4Molecule.cc