| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 // INCL++ intra-nuclear cascade model
27 // Alain Boudard, CEA-Saclay, France
28 // Joseph Cugnon, University of Liege, Belgium
29 // Jean-Christophe David, CEA-Saclay, France
30 // Pekka Kaitaniemi, CEA-Saclay, France, and Helsinki Institute of Physics, Finland
31 // Sylvie Leray, CEA-Saclay, France
32 // Davide Mancusi, CEA-Saclay, France
33 //
34 #define INCLXX_IN_GEANT4_MODE 1
35
36 #include "globals.hh"
37
38 /** \file G4INCLXXInterfaceMessenger.cc
39 * \brief Messenger class for the Geant4 INCL++ interface.
40 *
41 * \date 26th April 2012
42 * \author Davide Mancusi
43 */
44
45 #include "G4INCLXXInterfaceMessenger.hh"
46 #include "G4SystemOfUnits.hh"
47 #include <sstream>
48
49 const G4String G4INCLXXInterfaceMessenger::theUIDirectory = "/process/had/inclxx/";
50
51 G4INCLXXInterfaceMessenger::G4INCLXXInterfaceMessenger(G4INCLXXInterfaceStore *anInterfaceStore) :
52 theINCLXXInterfaceStore(anInterfaceStore)
53 {
54 // Create a directory for the INCL++ commands
55 theINCLXXDirectory = new G4UIdirectory(theUIDirectory);
56 theINCLXXDirectory->SetGuidance("Parameters for the INCL++ model");
57
58 // This command controls whether nucleus-nucleus reactions should accurately
59 // describe the projectile or the target nucleus (default: projectile)
60 accurateNucleusCmd = new G4UIcmdWithAString((theUIDirectory + "accurateNucleus").data(),this);
61 accurateNucleusCmd->SetGuidance("Set which nucleus will be accurately described in nucleus-nucleus reactions.");
62 accurateNucleusCmd->SetGuidance(" projectile: accurate description of projectile-related quantities");
63 accurateNucleusCmd->SetGuidance(" target: accurate description of target-related quantities");
64 accurateNucleusCmd->SetGuidance(" Default: projectile");
65 accurateNucleusCmd->SetParameterName("AccurateNucleus",true);
66 accurateNucleusCmd->SetDefaultValue("projectile");
67 accurateNucleusCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
68
69 // This command selects the maximum mass number of clusters to be produced in
70 // the INCL++ cascade
71 maxClusterMassCmd = new G4UIcmdWithAnInteger((theUIDirectory + "maxClusterMass").data(),this);
72 maxClusterMassCmd->SetGuidance("Set the maximum cluster mass.");
73 maxClusterMassCmd->SetGuidance(" The INCL++ cascade stage will produce clusters with mass up to the value of this parameter (included)");
74 maxClusterMassCmd->SetGuidance(" Allowed range: [2,12]");
75 maxClusterMassCmd->SetParameterName("MaxClusterMass",true);
76 maxClusterMassCmd->SetDefaultValue(8);
77 maxClusterMassCmd->SetRange("MaxClusterMass>=2 && MaxClusterMass<=12");
78 maxClusterMassCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
79
80 // This command sets the energy below which PreCoumpound will be used
81 cascadeMinEnergyPerNucleonCmd = new G4UIcmdWithADoubleAndUnit((theUIDirectory + "cascadeMinEnergyPerNucleon").data(),this);
82 cascadeMinEnergyPerNucleonCmd->SetGuidance("Set the minimum energy per nucleon at which cascade will be used.");
83 cascadeMinEnergyPerNucleonCmd->SetGuidance(" INCL++ will rely on PreCompound for reactions induced by projectiles slower than the given energy (per nucleon, where applicable)");
84 cascadeMinEnergyPerNucleonCmd->SetParameterName("cascadeMinEnergyPerNucleon",true);
85 cascadeMinEnergyPerNucleonCmd->SetDefaultValue(1.*MeV);
86 cascadeMinEnergyPerNucleonCmd->SetRange("cascadeMinEnergyPerNucleon>=0");
87 cascadeMinEnergyPerNucleonCmd->SetUnitCategory("Energy");
88 cascadeMinEnergyPerNucleonCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
89
90 // This command allows the user to set several INCL++ internals in one shot
91 inclPhysicsCmd = new G4UIcmdWithAString((theUIDirectory + "setPhysics").data(),this);
92 inclPhysicsCmd->SetGuidance("Set a global configuration for INCL++.");
93 inclPhysicsCmd->SetGuidance(" default: default configuration, most recent options");
94 inclPhysicsCmd->SetGuidance(" incl42: try to mimic the behaviour from INCL4.2");
95 inclPhysicsCmd->SetParameterName("type", false);
96 inclPhysicsCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
97
98 // This command allows the user to change the de-excitation model to be used
99 // with INCL++
100 useAblaCmd = new G4UIcommand((theUIDirectory + "useAbla").data(),this);
101 useAblaCmd->SetGuidance("Use ABLA++ as de-excitation model after INCL++.");
102 useAblaCmd->AvailableForStates(G4State_Idle);
103 }
104
105 G4INCLXXInterfaceMessenger::~G4INCLXXInterfaceMessenger() {
106 delete theINCLXXDirectory;
107 delete accurateNucleusCmd;
108 delete maxClusterMassCmd;
109 delete cascadeMinEnergyPerNucleonCmd;
110 delete inclPhysicsCmd;
111 delete useAblaCmd;
112 }
113
114 void G4INCLXXInterfaceMessenger::SetNewValue(G4UIcommand *command, G4String newValues) {
115 if(command==accurateNucleusCmd) {
116 G4StrUtil::to_lower(newValues);
117 if(newValues=="projectile") {
118 theINCLXXInterfaceStore->SetAccurateProjectile(true);
119 } else if(newValues=="target") {
120 theINCLXXInterfaceStore->SetAccurateProjectile(false);
121 }
122 } else if(command==maxClusterMassCmd) {
123 const G4int parameter = maxClusterMassCmd->GetNewIntValue(newValues);
124 theINCLXXInterfaceStore->SetMaxClusterMass(parameter);
125 } else if(command==cascadeMinEnergyPerNucleonCmd) {
126 const G4double parameter = cascadeMinEnergyPerNucleonCmd->GetNewDoubleValue(newValues);
127 theINCLXXInterfaceStore->SetCascadeMinEnergyPerNucleon(parameter);
128 } else if(command==inclPhysicsCmd) {
129 theINCLXXInterfaceStore->SetINCLPhysics(newValues);
130 } else if(command==useAblaCmd) {
131 theINCLXXInterfaceStore->UseAblaDeExcitation();
132 }
133 }
134