simcore::APrimePhysics Class Reference

Defines basic APrime physics. More...

#include <APrimePhysics.h>

Public Member Functions
	APrimePhysics (const framework::config::Parameters &params)
	Class constructor.
virtual	~APrimePhysics ()
	Class destructor.
void	ConstructParticle ()
	Construct particle.
void	ConstructProcess ()
	Construct the process.

Static Public Attributes
static const std::string	NAME = "APrime"
	The name of this physics constructor.

Private Attributes
G4double	ap_mass_
	the mass of the A' for this run
bool	enable_
	is dark brem enabled for this run?
framework::config::Parameters	parameters_
	Dark brem parameters to pass to the process (if enabled)
std::unique_ptr< G4DarkBremsstrahlung >	process_

Detailed Description

Defines basic APrime physics.

It constructs the APrime particle and links the dark brem process to the electron.

See also

G4APrime

G4DarkBremsstrahlung in G4DarkBreM

Note

This class basically does not do anything except register the custom particle (G4APrime) and custom process (G4DarkBremsstrahlung).

Definition at line 35 of file APrimePhysics.h.

Constructor & Destructor Documentation

APrimePhysics()

simcore::APrimePhysics::APrimePhysics

(

const framework::config::Parameters &

params

)

Class constructor.

Parameters

params

Parameters to configure the dark brem process

Definition at line 39 of file APrimePhysics.cxx.

    : G4VPhysicsConstructor(APrimePhysics::NAME),
      parameters_{params},
      process_{nullptr} {
  ap_mass_ = parameters_.getParameter<double>("ap_mass", 0.) * MeV;
  enable_ = parameters_.getParameter<bool>("enable", false);
}

References ap_mass_, enable_, framework::config::Parameters::getParameter(), and parameters_.

~APrimePhysics()

virtual simcore::APrimePhysics::~APrimePhysics ( )

inlinevirtual

Class destructor.

Nothing right now.

Definition at line 58 of file APrimePhysics.h.

{}

Member Function Documentation

ConstructParticle()

void simcore::APrimePhysics::ConstructParticle

(

)

Construct particle.

Insert A' into the Geant4 particle table. Geant4 registers all instances derived from G4ParticleDefinition and deletes them at the end of processing.

Uses the A' mass given by the parameter APrimeMass to inform the G4APrime instance what mass to use.

See also

G4APrime

Insert A-prime into the Geant4 particle table.

Geant4 registers all instances derived from G4ParticleDefinition and deletes them at the end of the run. We configure the A' to have the input mass and the PDG ID number of 622.

Definition at line 47 of file APrimePhysics.cxx.

                                      {
  auto model{parameters_.getParameter<framework::config::Parameters>("model")};
  static const std::map<std::string, G4APrime::DecayMode> decay_lut = {
      {"no_decay", G4APrime::DecayMode::NoDecay},
      {"flat_decay", G4APrime::DecayMode::FlatDecay},
      {"geant_decay", G4APrime::DecayMode::GeantDecay}};
  auto decay_it{decay_lut.find(
      model.getParameter<std::string>("decay_mode", "no_decay"))};
  if (decay_it == decay_lut.end()) {
    EXCEPTION_RAISE(
        "BadConf",
        "Unrecognized decay mode '" +
            model.getParameter<std::string>("decay_mode") +
            "',"
            " options are 'no_decay', 'flat_decay', or 'geant_decay'.");
  }
 
  double ap_tau = model.getParameter<double>("ap_tau", -1.0);
 
  G4APrime::Initialize(ap_mass_, 622, ap_tau, decay_it->second);
}

References ap_mass_, framework::config::Parameters::getParameter(), and parameters_.

ConstructProcess()

void simcore::APrimePhysics::ConstructProcess

(

)

Construct the process.

Links the dark brem processs to the electron through the process manager only if the dark brem process is enabled ('enable' is True).

G4ProcessManager registers and cleans up any created processes, so we can forget about it after creating it.

See also

G4DarkBremsstrahlung in G4DarkBreM

Definition at line 76 of file APrimePhysics.cxx.

                                     {
  // add process to electron if we are enabled
  if (enable_) {
    auto model{
        parameters_.getParameter<framework::config::Parameters>("model")};
    auto model_name{model.getParameter<std::string>("name")};
    if (model_name == "vertex_library" or model_name == "g4db") {
      static const std::map<std::string, g4db::G4DarkBreMModel::ScalingMethod>
          method_lut = {
              {"forward_only",
               g4db::G4DarkBreMModel::ScalingMethod::ForwardOnly},
              {"cm_scaling", g4db::G4DarkBreMModel::ScalingMethod::CMScaling},
              {"undefined", g4db::G4DarkBreMModel::ScalingMethod::Undefined}};
      auto scaling_method_it{
          method_lut.find(model.getParameter<std::string>("method"))};
      if (scaling_method_it == method_lut.end()) {
        EXCEPTION_RAISE(
            "BadConf",
            "Unrecognized scaling method '" +
                model.getParameter<std::string>("method") +
                "',"
                " options are 'forward_only', 'cm_scaling', or 'undefined'.");
      }
      // Note: The process variable isn't used here, but creating the
      // G4DarkBremsstahlung object has side-effects
      process_ = std::make_unique<G4DarkBremsstrahlung>(
          std::make_shared<g4db::G4DarkBreMModel>(
              model.getParameter<std::string>("library_path"),
              false /* dark brem off muons instead of electrons - we
                       always DB off electrons here */
              ,
              model.getParameter<double>("threshold"),
              model.getParameter<double>("epsilon"), scaling_method_it->second,
              g4db::G4DarkBreMModel::XsecMethod::Auto,
              model.getParameter<double>("max_R_for_full", 50.0),
              model.getParameter<int>("aprime_lhe_id", 622),
              true,  // always load the library
              model.getParameter<bool>("scale_APrime", false),
              model.getParameter<double>("dist_decay_min", 0.0),
              model.getParameter<double>("dist_decay_max", 1.0)),
          parameters_.getParameter<bool>("only_one_per_event"),
          1., /* global bias - should use bias operator instead */
          parameters_.getParameter<bool>("cache_xsec"));
      process_->RegisterStorageMechanism(store_element_z);
    } else {
      EXCEPTION_RAISE("BadConf",
                      "Unrecognized model name '" + model_name + "'.");
    }
    G4cout << "[ APrimePhysics ] : Initialization of dark brem complete"
           << G4endl;
  }
}

References enable_, framework::config::Parameters::getParameter(), parameters_, and simcore::store_element_z().

Member Data Documentation

ap_mass_

G4double simcore::APrimePhysics::ap_mass_

private

the mass of the A' for this run

Definition at line 89 of file APrimePhysics.h.

Referenced by APrimePhysics(), and ConstructParticle().

enable_

bool simcore::APrimePhysics::enable_

private

is dark brem enabled for this run?

Definition at line 92 of file APrimePhysics.h.

Referenced by APrimePhysics(), and ConstructProcess().

NAME

const std::string simcore::APrimePhysics::NAME = "APrime"

static

The name of this physics constructor.

Passed into Geant4 to register this physics, should not conflict with any other Geant4 physics.

Definition at line 44 of file APrimePhysics.h.

parameters_

framework::config::Parameters simcore::APrimePhysics::parameters_

private

Dark brem parameters to pass to the process (if enabled)

Note

This can't be a reference because we pass it to the process after the configuration step from our POV is done. Thus we need our own copy that won't be destroyed.

Definition at line 101 of file APrimePhysics.h.

Referenced by APrimePhysics(), ConstructParticle(), and ConstructProcess().

process_

std::unique_ptr<G4DarkBremsstrahlung> simcore::APrimePhysics::process_

private

Definition at line 103 of file APrimePhysics.h.

---

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

• SimCore/include/SimCore/APrimePhysics.h
• SimCore/src/SimCore/APrimePhysics.cxx