G4AdjointPrimaryGeneratorAction Class Reference

#include <G4AdjointPrimaryGeneratorAction.hh>

Inheritance diagram for G4AdjointPrimaryGeneratorAction:

Public Member Functions
	G4AdjointPrimaryGeneratorAction ()
	~G4AdjointPrimaryGeneratorAction () override
	G4AdjointPrimaryGeneratorAction (const G4AdjointPrimaryGeneratorAction &)=delete
G4AdjointPrimaryGeneratorAction &	operator= (const G4AdjointPrimaryGeneratorAction &)=delete
void	GeneratePrimaries (G4Event *) override
void	SetEmin (G4double val)
void	SetEmax (G4double val)
void	SetEminIon (G4double val)
void	SetEmaxIon (G4double val)
void	SetSphericalAdjointPrimarySource (G4double radius, G4ThreeVector pos)
void	SetAdjointPrimarySourceOnAnExtSurfaceOfAVolume (const G4String &volume_name)
void	ConsiderParticleAsPrimary (const G4String &particle_name)
void	NeglectParticleAsPrimary (const G4String &particle_name)
void	SetPrimaryIon (G4ParticleDefinition *adjointIon, G4ParticleDefinition *fwdIon)
void	UpdateListOfPrimaryParticles ()
void	SetRndmFlag (const G4String &val)
size_t	GetNbOfAdjointPrimaryTypes ()
std::vector< G4ParticleDefinition * > *	GetListOfPrimaryFwdParticles ()
const G4String &	GetPrimaryIonName ()
void	SetNbPrimaryFwdGammasPerEvent (G4int nb)
void	SetNbAdjointPrimaryGammasPerEvent (G4int nb)
void	SetNbAdjointPrimaryElectronsPerEvent (G4int nb)
G4ParticleDefinition *	GetLastGeneratedFwdPrimaryParticle ()
Public Member Functions inherited from G4VUserPrimaryGeneratorAction
	G4VUserPrimaryGeneratorAction ()
virtual	~G4VUserPrimaryGeneratorAction ()=default

Detailed Description

Definition at line 80 of file G4AdjointPrimaryGeneratorAction.hh.

Constructor & Destructor Documentation

G4AdjointPrimaryGeneratorAction() [1/2]

G4AdjointPrimaryGeneratorAction::G4AdjointPrimaryGeneratorAction

(

)

Definition at line 48 of file G4AdjointPrimaryGeneratorAction.cc.

{
  theAdjointPrimaryGenerator = new G4AdjointPrimaryGenerator();
 
  PrimariesConsideredInAdjointSim[G4String("e-")] = false;
  PrimariesConsideredInAdjointSim[G4String("gamma")] = false;
  PrimariesConsideredInAdjointSim[G4String("proton")] = false;
  PrimariesConsideredInAdjointSim[G4String("ion")] = false;
 
  ListOfPrimaryFwdParticles.clear();
  ListOfPrimaryAdjParticles.clear();
}

~G4AdjointPrimaryGeneratorAction()

G4AdjointPrimaryGeneratorAction::~G4AdjointPrimaryGeneratorAction ( )

override

Definition at line 63 of file G4AdjointPrimaryGeneratorAction.cc.

{
  delete theAdjointPrimaryGenerator;
}

G4AdjointPrimaryGeneratorAction() [2/2]

G4AdjointPrimaryGeneratorAction::G4AdjointPrimaryGeneratorAction ( const G4AdjointPrimaryGeneratorAction & )

delete

Member Function Documentation

ConsiderParticleAsPrimary()

void G4AdjointPrimaryGeneratorAction::ConsiderParticleAsPrimary

(

const G4String &

particle_name

)

Definition at line 248 of file G4AdjointPrimaryGeneratorAction.cc.

{
  if (PrimariesConsideredInAdjointSim.find(particle_name) != PrimariesConsideredInAdjointSim.end())
  {
    PrimariesConsideredInAdjointSim[particle_name] = true;
  }
  UpdateListOfPrimaryParticles();
}

Referenced by G4AdjointSimManager::ConsiderParticleAsPrimary().

GeneratePrimaries()

void G4AdjointPrimaryGeneratorAction::GeneratePrimaries ( G4Event * anEvent )

overridevirtual

Implements G4VUserPrimaryGeneratorAction.

Definition at line 70 of file G4AdjointPrimaryGeneratorAction.cc.

{
  G4int evt_id = anEvent->GetEventID();
  std::size_t n = ListOfPrimaryAdjParticles.size();
  index_particle = std::size_t(evt_id) - n * (std::size_t(evt_id) / n);
 
  G4double E1 = Emin;
  G4double E2 = Emax;
  if (ListOfPrimaryAdjParticles[index_particle] == nullptr)
    UpdateListOfPrimaryParticles();  // ion has not been created yet
 
  if (ListOfPrimaryAdjParticles[index_particle]->GetParticleName() == "adj_proton") {
    E1 = EminIon;
    E2 = EmaxIon;
  }
  if (ListOfPrimaryAdjParticles[index_particle]->GetParticleType() == "adjoint_nucleus") {
    G4int A = ListOfPrimaryAdjParticles[index_particle]->GetAtomicMass();
    E1 = EminIon * A;
    E2 = EmaxIon * A;
  }
  // Generate first the forwrad primaries
  theAdjointPrimaryGenerator->GenerateFwdPrimaryVertex(
    anEvent, ListOfPrimaryFwdParticles[index_particle], E1, E2);
  G4PrimaryVertex* fwdPrimVertex = anEvent->GetPrimaryVertex();
 
  p = fwdPrimVertex->GetPrimary()->GetMomentum();
  pos = fwdPrimVertex->GetPosition();
  G4double pmag = p.mag();
  G4double m0 = ListOfPrimaryFwdParticles[index_particle]->GetPDGMass();
  G4double ekin = std::sqrt(m0 * m0 + pmag * pmag) - m0;
 
  G4double weight_correction = 1.;
  // For gamma generate the particle along the backward ray
  G4ThreeVector dir = -p / p.mag();
 
  weight_correction = 1.;
 
  if (ListOfPrimaryFwdParticles[index_particle] == G4Gamma::Gamma() && nb_fwd_gammas_per_event > 1)
  {
    G4double weight = (1. / nb_fwd_gammas_per_event);
    fwdPrimVertex->SetWeight(weight);
    for (G4int i = 0; i < nb_fwd_gammas_per_event - 1; ++i) {
      auto newFwdPrimVertex = new G4PrimaryVertex();
      newFwdPrimVertex->SetPosition(pos.x(), pos.y(), pos.z());
      newFwdPrimVertex->SetT0(0.);
      auto aPrimParticle =
        new G4PrimaryParticle(ListOfPrimaryFwdParticles[index_particle], p.x(), p.y(), p.z());
      newFwdPrimVertex->SetPrimary(aPrimParticle);
      newFwdPrimVertex->SetWeight(weight);
      anEvent->AddPrimaryVertex(newFwdPrimVertex);
    }
  }
 
  // Now generate the adjoint primaries
  auto adjPrimVertex = new G4PrimaryVertex();
  adjPrimVertex->SetPosition(pos.x(), pos.y(), pos.z());
  adjPrimVertex->SetT0(0.);
  auto aPrimParticle =
    new G4PrimaryParticle(ListOfPrimaryAdjParticles[index_particle], -p.x(), -p.y(), -p.z());
 
  adjPrimVertex->SetPrimary(aPrimParticle);
  anEvent->AddPrimaryVertex(adjPrimVertex);
 
  // The factor pi is to normalise the weight to the directional flux
  G4double adjoint_source_area = G4AdjointSimManager::GetInstance()->GetAdjointSourceArea();
  G4double adjoint_weight =
    weight_correction * ComputeEnergyDistWeight(ekin, E1, E2) * adjoint_source_area * pi;
  if (ListOfPrimaryAdjParticles[index_particle]->GetParticleName() == "adj_gamma") {
    // The weight will be corrected at the end of the track if splitted tracks
    // are used
    adjoint_weight = adjoint_weight / nb_adj_primary_gammas_per_event;
    for (G4int i = 0; i < nb_adj_primary_gammas_per_event - 1; ++i) {
      auto newAdjPrimVertex = new G4PrimaryVertex();
      newAdjPrimVertex->SetPosition(pos.x(), pos.y(), pos.z());
      newAdjPrimVertex->SetT0(0.);
      aPrimParticle =
        new G4PrimaryParticle(ListOfPrimaryAdjParticles[index_particle], -p.x(), -p.y(), -p.z());
      newAdjPrimVertex->SetPrimary(aPrimParticle);
      newAdjPrimVertex->SetWeight(adjoint_weight);
      anEvent->AddPrimaryVertex(newAdjPrimVertex);
    }
  }
  else if (ListOfPrimaryAdjParticles[index_particle]->GetParticleName() == "adj_electron") {
    // The weight will be corrected at the end of the track if splitted tracks
    // are used
    adjoint_weight = adjoint_weight / nb_adj_primary_electrons_per_event;
    for (G4int i = 0; i < nb_adj_primary_electrons_per_event - 1; ++i) {
      auto newAdjPrimVertex = new G4PrimaryVertex();
      newAdjPrimVertex->SetPosition(pos.x(), pos.y(), pos.z());
      newAdjPrimVertex->SetT0(0.);
      aPrimParticle =
        new G4PrimaryParticle(ListOfPrimaryAdjParticles[index_particle], -p.x(), -p.y(), -p.z());
      newAdjPrimVertex->SetPrimary(aPrimParticle);
      newAdjPrimVertex->SetWeight(adjoint_weight);
      anEvent->AddPrimaryVertex(newAdjPrimVertex);
    }
  }
  adjPrimVertex->SetWeight(adjoint_weight);
 
  // Call some methods of G4AdjointSimManager
  G4AdjointSimManager::GetInstance()->SetAdjointTrackingMode(true);
  G4AdjointSimManager::GetInstance()->ClearEndOfAdjointTrackInfoVectors();
  G4AdjointSimManager::GetInstance()->ResetDidOneAdjPartReachExtSourceDuringEvent();
}

GetLastGeneratedFwdPrimaryParticle()

G4ParticleDefinition * G4AdjointPrimaryGeneratorAction::GetLastGeneratedFwdPrimaryParticle ( )

inline

Definition at line 117 of file G4AdjointPrimaryGeneratorAction.hh.

    {
      return ListOfPrimaryFwdParticles[index_particle];
    }

Referenced by G4AdjointSimManager::GetLastGeneratedFwdPrimaryParticle().

GetListOfPrimaryFwdParticles()

std::vector< G4ParticleDefinition * > * G4AdjointPrimaryGeneratorAction::GetListOfPrimaryFwdParticles ( )

inline

Definition at line 103 of file G4AdjointPrimaryGeneratorAction.hh.

    {
      return &ListOfPrimaryFwdParticles;
    }

Referenced by G4AdjointSimManager::GetListOfPrimaryFwdParticles(), G4AdjointSimManager::GetNbOfPrimaryFwdParticles(), and G4AdjointSimManager::RegisterAtEndOfAdjointTrack().

GetNbOfAdjointPrimaryTypes()

size_t G4AdjointPrimaryGeneratorAction::GetNbOfAdjointPrimaryTypes ( )

inline

Definition at line 102 of file G4AdjointPrimaryGeneratorAction.hh.

{ return ListOfPrimaryAdjParticles.size(); }

Referenced by G4AdjointSimManager::RunAdjointSimulation().

GetPrimaryIonName()

const G4String & G4AdjointPrimaryGeneratorAction::GetPrimaryIonName ( )

inline

Definition at line 107 of file G4AdjointPrimaryGeneratorAction.hh.

{ return ion_name; }

Referenced by G4AdjointSimManager::GetPrimaryIonName().

NeglectParticleAsPrimary()

void G4AdjointPrimaryGeneratorAction::NeglectParticleAsPrimary

(

const G4String &

particle_name

)

Definition at line 259 of file G4AdjointPrimaryGeneratorAction.cc.

{
  if (PrimariesConsideredInAdjointSim.find(particle_name) != PrimariesConsideredInAdjointSim.end())
  {
    PrimariesConsideredInAdjointSim[particle_name] = false;
  }
  UpdateListOfPrimaryParticles();
}

Referenced by G4AdjointSimManager::NeglectParticleAsPrimary().

operator=()

G4AdjointPrimaryGeneratorAction & G4AdjointPrimaryGeneratorAction::operator= ( const G4AdjointPrimaryGeneratorAction & )

delete

SetAdjointPrimarySourceOnAnExtSurfaceOfAVolume()

void G4AdjointPrimaryGeneratorAction::SetAdjointPrimarySourceOnAnExtSurfaceOfAVolume

(

const G4String &

volume_name

)

Definition at line 239 of file G4AdjointPrimaryGeneratorAction.cc.

{
  type_of_adjoint_source = "ExternalSurfaceOfAVolume";
  theAdjointPrimaryGenerator->SetAdjointPrimarySourceOnAnExtSurfaceOfAVolume(volume_name);
}

Referenced by G4AdjointSimManager::DefineAdjointSourceOnTheExtSurfaceOfAVolume().

SetEmax()

void G4AdjointPrimaryGeneratorAction::SetEmax

(

G4double

val

)

Definition at line 185 of file G4AdjointPrimaryGeneratorAction.cc.

{
  Emax = val;
  EmaxIon = val;
}

Referenced by G4AdjointSimManager::SetAdjointSourceEmax().

SetEmaxIon()

void G4AdjointPrimaryGeneratorAction::SetEmaxIon

(

G4double

val

)

Definition at line 200 of file G4AdjointPrimaryGeneratorAction.cc.

{
  EmaxIon = val;
}

SetEmin()

void G4AdjointPrimaryGeneratorAction::SetEmin

(

G4double

val

)

Definition at line 177 of file G4AdjointPrimaryGeneratorAction.cc.

{
  Emin = val;
  EminIon = val;
}

Referenced by G4AdjointSimManager::SetAdjointSourceEmin().

SetEminIon()

void G4AdjointPrimaryGeneratorAction::SetEminIon

(

G4double

val

)

Definition at line 193 of file G4AdjointPrimaryGeneratorAction.cc.

{
  EminIon = val;
}

SetNbAdjointPrimaryElectronsPerEvent()

void G4AdjointPrimaryGeneratorAction::SetNbAdjointPrimaryElectronsPerEvent ( G4int nb )

inline

Definition at line 113 of file G4AdjointPrimaryGeneratorAction.hh.

    {
      nb_adj_primary_electrons_per_event = nb;
    }

Referenced by G4AdjointSimManager::SetNbAdjointPrimaryElectronsPerEvent().

SetNbAdjointPrimaryGammasPerEvent()

void G4AdjointPrimaryGeneratorAction::SetNbAdjointPrimaryGammasPerEvent ( G4int nb )

inline

Definition at line 109 of file G4AdjointPrimaryGeneratorAction.hh.

    {
      nb_adj_primary_gammas_per_event = nb;
    }

Referenced by G4AdjointSimManager::SetNbAdjointPrimaryGammasPerEvent().

SetNbPrimaryFwdGammasPerEvent()

void G4AdjointPrimaryGeneratorAction::SetNbPrimaryFwdGammasPerEvent ( G4int nb )

inline

Definition at line 108 of file G4AdjointPrimaryGeneratorAction.hh.

{ nb_fwd_gammas_per_event = nb; }

Referenced by G4AdjointSimManager::SetNbOfPrimaryFwdGammasPerEvent().

SetPrimaryIon()

void G4AdjointPrimaryGeneratorAction::SetPrimaryIon	(	G4ParticleDefinition *	adjointIon,
		G4ParticleDefinition *	fwdIon )

Definition at line 301 of file G4AdjointPrimaryGeneratorAction.cc.

{
  fwd_ion = fwdIon;
  adj_ion = adjointIon;
  UpdateListOfPrimaryParticles();
}

Referenced by G4AdjointSimManager::SetPrimaryIon().

SetRndmFlag()

void G4AdjointPrimaryGeneratorAction::SetRndmFlag ( const G4String & val )

inline

Definition at line 101 of file G4AdjointPrimaryGeneratorAction.hh.

{ rndmFlag = val; }

SetSphericalAdjointPrimarySource()

void G4AdjointPrimaryGeneratorAction::SetSphericalAdjointPrimarySource	(	G4double	radius,
		G4ThreeVector	pos )

Definition at line 228 of file G4AdjointPrimaryGeneratorAction.cc.

{
  radius_spherical_source = radius;
  center_spherical_source = center_pos;
  type_of_adjoint_source = "Spherical";
  theAdjointPrimaryGenerator->SetSphericalAdjointPrimarySource(radius, center_pos);
}

Referenced by G4AdjointSimManager::DefineSphericalAdjointSource(), and G4AdjointSimManager::DefineSphericalAdjointSourceWithCentreAtTheCentreOfAVolume().

UpdateListOfPrimaryParticles()

void G4AdjointPrimaryGeneratorAction::UpdateListOfPrimaryParticles

(

)

Definition at line 270 of file G4AdjointPrimaryGeneratorAction.cc.

{
  G4ParticleTable* theParticleTable = G4ParticleTable::GetParticleTable();
  ListOfPrimaryFwdParticles.clear();
  ListOfPrimaryAdjParticles.clear();
  for (const auto& iter : PrimariesConsideredInAdjointSim) {
    if (iter.second) {
      G4String fwd_particle_name = iter.first;
      if (fwd_particle_name != "ion") {
        G4String adj_particle_name = G4String("adj_") + fwd_particle_name;
        ListOfPrimaryFwdParticles.push_back(theParticleTable->FindParticle(fwd_particle_name));
        ListOfPrimaryAdjParticles.push_back(theParticleTable->FindParticle(adj_particle_name));
      }
      else {
        if (fwd_ion != nullptr) {
          ion_name = fwd_ion->GetParticleName();
          G4String adj_ion_name = G4String("adj_") + ion_name;
          ListOfPrimaryFwdParticles.push_back(fwd_ion);
          ListOfPrimaryAdjParticles.push_back(adj_ion);
        }
        else {
          ListOfPrimaryFwdParticles.push_back(nullptr);
          ListOfPrimaryAdjParticles.push_back(nullptr);
        }
      }
    }
  }
}

Referenced by ConsiderParticleAsPrimary(), GeneratePrimaries(), NeglectParticleAsPrimary(), SetPrimaryIon(), and G4AdjointSimManager::SwitchToAdjointSimulationMode().

---

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

• G4AdjointPrimaryGeneratorAction.hh
• G4AdjointPrimaryGeneratorAction.cc