Newer
Older
// $Id: Geant4Setup.cpp 578 2013-05-17 22:33:09Z markus.frank $
//====================================================================
// AIDA Detector description implementation for LCD
//--------------------------------------------------------------------
//
// Author : M.Frank
//
//====================================================================
// Framework include files
#include "DD4hep/Printout.h"
#include "DD4hep/DetFactoryHelper.h"
/// Namespace for the AIDA detector description toolkit
namespace DD4hep {
// Forward declarations
class ActionSequence;
using namespace std;
using namespace DD4hep::Simulation;
using namespace DD4hep::Simulation::Setup;
typedef DD4hep::Geometry::LCDD lcdd_t;
typedef DD4hep::Geometry::DetElement DetElement;
/// Namespace for the Geant4 based simulation part of the AIDA detector description toolkit
namespace Simulation {
// Forward declarations
class XMLSetup;
/// Action cast
template <typename TYPE, typename PTR> TYPE* _action(PTR* in) {
return dynamic_cast<TYPE*>(in);
/// Install Geant4 mesenger to action objects
template <typename T> static void installMessenger(const T& handle) {
handle->installMessengers();
/// Set the properties of a Geant4 Action object from XML object attributes
template <typename T> static void _setAttributes(const T& handle, xml_h& e) {
XML::Handle_t props(e);
// Now we set the object properties
vector<XML::Attribute> attrs = props.attributes();
for(vector<XML::Attribute>::iterator i=attrs.begin(); i!=attrs.end(); ++i) {
XML::Attribute a = *i;
handle[XML::_toString(props.attr_name(a))].str(props.attr<string>(a));
}
/// Set the properties of a Geant4 Action object from <properties/> XML subsection
template <typename T> static void _setProperties(const T& handle, xml_h& e) {
xml_comp_t action(e);
// Now we set the object properties
XML::Handle_t props = action.child(_Unicode(properties),false);
if ( props ) {
_setAttributes(handle, props);
}
if ( action.hasAttr(_Unicode(Control)) ) {
handle["Control"].str(props.attr<string>(_Unicode(Control)));
}
/// Create/Configure Geant4 sensitive action object from XML
static Action _convertSensitive(lcdd_t& lcdd, xml_h e, const string& detector) {
xml_comp_t action(e);
Kernel& kernel = Kernel::access(lcdd);
TypeName tn = TypeName::split(action.attr<string>(_U(name)));
// Create the object using the factory method
Sensitive handle(kernel,action.attr<string>(_U(name)),detector);
_setProperties(Action(handle.get()),e);
for(xml_coll_t f(e,_Unicode(filter)); f; ++f) {
string nam = f.attr<string>(_U(name));
Filter filter(kernel.globalFilter(nam,false));
handle->adopt(filter);
}
installMessenger(handle);
printout(INFO,"Geant4Setup","+++ Added sensitive element %s of type %s",
tn.second.c_str(),tn.first.c_str());
return Action(handle);
}
/// Create/Configure Action object from XML
static Action _convertAction(lcdd_t& lcdd, xml_h e) {
xml_comp_t action(e);
Kernel& kernel = Kernel::access(lcdd);
TypeName tn = TypeName::split(action.attr<string>(_U(name)));
// Create the object using the factory method
Action handle(kernel,action.attr<string>(_U(name)));
_setProperties(handle,e);
printout(INFO,"Geant4Setup","+++ Added action %s of type %s",tn.second.c_str(),tn.first.c_str());
installMessenger(handle);
if ( action.hasChild(_Unicode(adopt)) ) {
xml_comp_t child = action.child(_Unicode(adopt));
Geant4Action* user = kernel.globalAction(child.nameStr());
Geant4ParticleHandler* ph = dynamic_cast<Geant4ParticleHandler*>(handle.get());
if ( ph ) {
ph->adopt(user);
}
enum { SENSITIVE, ACTION, FILTER };
/// Create/Configure Action object from XML
Action _createAction(lcdd_t& lcdd, xml_h a, const string& seqType, int what) {
string nam = a.attr<string>(_U(name));
TypeName typ = TypeName::split(nam);
Kernel& kernel = Kernel::access(lcdd);
Action action((what==FILTER) ? (Geant4Action*)kernel.globalFilter(typ.second,false)
: (what==ACTION) ? kernel.globalAction(typ.second,false)
/// : (what==FILTER) ? kernel.globalAction(typ.second,false)
: 0);
// Create the object using the factory method
action = (what == SENSITIVE) ? Action(_convertSensitive(lcdd, a, seqType))
: (what==ACTION) ? _convertAction(lcdd, a)
: (what==FILTER) ? _convertAction(lcdd, a)
: Action();
if ( !action ) {
throw runtime_error(format("Geant4ActionSequence","DDG4: The action '%s'"
" cannot be created. [Action-Missing]",nam.c_str()));
}
* <actions>
* <action name="Geant4PostTrackingAction/PostTrackAction"
* <properties
* NAME1="Value1"
* NAME2="Value2" />
* </action>
* </actions>
*/
template <> void Converter<Action>::operator()(xml_h e) const {
Action a = _convertAction(lcdd, e);
Kernel::access(lcdd).registerGlobalAction(a);
}
/// Convert Sensitive detector filters
/**
* Note: Filters are Geant4Actions and - if global - may also receive properties!
*
* <filters>
* <filter name="GeantinoRejector"/>
* <filter name="EnergyDepositMinimumCut">
* <properties cut="10*MeV"/>
* </filter>
* </filters>
*/
template <> void Converter<Filter>::operator()(xml_h e) const {
Action a = _convertAction(lcdd, e);
Kernel::access(lcdd).registerGlobalFilter(a);
}
* <phases>
* <phase name="Geant4PostTrackingPhase/PostTrackPhase"
* <properties
* NAME1="Value1"
* NAME2="Value2" />
* </phase>
* </phases>
*/
template <> void Converter<Phase>::operator()(xml_h e) const {
xml_comp_t x_phase(e);
Kernel& kernel = Kernel::access(lcdd);
string nam = x_phase.attr<string>(_U(type));
typedef Geant4ActionPhase PH;
Phase p;
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
if ( nam == "RunAction/begin" ) {
void (Geant4ActionPhase::*func)(const G4Run*) = &Geant4ActionPhase::call;
kernel.runAction().callAtBegin((p=kernel.addPhase<const G4Run*>(nam)).get(),func);
//&Geant4ActionPhase::call<const G4Run*>);
}
else if ( nam == "RunAction/end" ) {
void (Geant4ActionPhase::*func)(const G4Run*) = &Geant4ActionPhase::call;
kernel.runAction().callAtEnd((p=kernel.addPhase<const G4Run*>(nam)).get(),func);
//&PH::call<const G4Run*>);
}
else if ( nam == "EventAction/begin" ) {
void (Geant4ActionPhase::*func)(const G4Event*) = &Geant4ActionPhase::call;
kernel.eventAction().callAtBegin((p=kernel.addPhase<const G4Event*>(nam)).get(),func);
//&PH::call<const G4Event*>);
}
else if ( nam == "EventAction/end" ) {
void (Geant4ActionPhase::*func)(const G4Event*) = &Geant4ActionPhase::call;
kernel.eventAction().callAtEnd((p=kernel.addPhase<const G4Event*>(nam)).get(),func);
//&PH::call<const G4Event*>);
}
else if ( nam == "TrackingAction/begin" ) {
void (Geant4ActionPhase::*func)(const G4Track*) = &Geant4ActionPhase::call;
kernel.trackingAction().callAtBegin((p=kernel.addPhase<const G4Track*>(nam)).get(),func);
//&PH::call<const G4Track*>);
}
else if ( nam == "TrackingAction/end" ) {
void (Geant4ActionPhase::*func)(const G4Track*) = &Geant4ActionPhase::call;
kernel.trackingAction().callAtEnd((p=kernel.addPhase<const G4Track*>(nam,false)).get(),func);
//&PH::call<const G4Track*>);
}
else if ( nam == "StackingAction/newStage" ) {
kernel.stackingAction().callAtNewStage((p=kernel.addPhase<void>(nam,false)).get(),&PH::call);
}
else if ( nam == "StackingAction/prepare" ) {
kernel.stackingAction().callAtPrepare((p=kernel.addPhase<void>(nam,false)).get(),&PH::call);
}
else if ( nam == "SteppingAction" ) {
void (Geant4ActionPhase::*func)(const G4Step*,G4SteppingManager*) = &Geant4ActionPhase::call;
kernel.steppingAction().call((p=kernel.addPhase<const G4Step*>(nam)).get(),func);
//&PH::call<const G4Step*,G4SteppingManager*>);
}
else if ( nam == "GeneratorAction/primaries" ) {
void (Geant4ActionPhase::*func)(G4Event*) = &Geant4ActionPhase::call;
kernel.generatorAction().call((p=kernel.addPhase<G4Event*>(nam)).get(),func);
//&PH::call<G4Event*>);
}
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
else {
TypeName tn = TypeName::split(nam);
DetElement det = lcdd.detector(tn.first);
if ( !det.isValid() ) {
throw runtime_error(format("Phase","DDG4: The phase '%s' of type SensitiveSeq"
" cannot be attached to a non-existing detector"
" [Detector-Missing]",nam.c_str()));
}
Geometry::SensitiveDetector sd = lcdd.sensitiveDetector(tn.first);
if ( !sd.isValid() ) {
throw runtime_error(format("Phase","DDG4: The phase '%s' of type SensitiveSeq"
" cannot be attached to a non-existing sensitive detector"
" [Sensitive-Missing]",nam.c_str()));
}
SensitiveSeq sdSeq = SensitiveSeq(kernel,tn.first);
if ( tn.second == "begin" )
sdSeq->callAtBegin((p=kernel.addPhase<G4HCofThisEvent*>(tn.second)).get(),
&PH::call<G4HCofThisEvent*>);
else if ( tn.second == "end" )
sdSeq->callAtEnd((p=kernel.addPhase<G4HCofThisEvent*>(tn.second)).get(),
&PH::call<G4HCofThisEvent*>);
else if ( tn.second == "clear" )
sdSeq->callAtClear((p=kernel.addPhase<G4HCofThisEvent*>(tn.second)).get(),
&PH::call<G4HCofThisEvent*>);
else if ( tn.second == "process" )
sdSeq->callAtProcess((p=kernel.addPhase<G4Step*>(tn.second)).get(),
&PH::call<G4Step*,G4TouchableHistory*>);
else
throw runtime_error(format("Phase","DDG4: The phase '%s' of type SensitiveSeq"
" cannot be attached to the call '%s'."
" [Callback-Missing]",tn.first.c_str(), tn.second.c_str()));
}
}
/// Convert Action sequences into objects
/**
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
* <sequences>
* <sequence name="Geant4EventActionSequence/EventAction"
* <member name="" type="Geant4TrackerEventMonitor/TrackerEvtAction"/>
* </sequence>
* <sequence name="Geant4SensdetActionSequence/SiVertexBarrel"
* <member type="Geant4TrackerSensitiveMonitor/TrackerHitMonitor">
* <properties
* NAME1="Value1"
* NAME2="Value2" />
* </member>
* </sequence>
* </sequences>
*/
template <> void Converter<ActionSequence>::operator()(xml_h e) const {
xml_comp_t seq(e);
SensitiveSeq sdSeq;
string seqNam;
TypeName seqType;
int what = ACTION;
Kernel& kernel = Kernel::access(lcdd);
if ( seq.hasAttr(_U(sd)) ) {
seqNam = seq.attr<string>(_U(type))+"/"+seq.attr<string>(_U(sd));
seqType = TypeName::split(seqNam);
sdSeq = SensitiveSeq(kernel,seqNam);
what = SENSITIVE;
}
else {
seqNam = seq.attr<string>(_U(name));
seqType = TypeName::split(seqNam);
}
printout(INFO,"Geant4Setup","+++ ActionSequence %s of type %s added.",
seqType.second.c_str(),seqType.first.c_str());
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
if ( seqType.second == "PhysicsList" ) {
PhysicsActionSeq pl(&kernel.physicsList());
PropertyManager& m = kernel.physicsList().properties();
m.dump();
_setAttributes(pl,e);
m.dump();
}
for(xml_coll_t a(seq,_Unicode(action)); a; ++a) {
string nam = a.attr<string>(_U(name));
Action action(_createAction(lcdd,a,seqType.second,what));
if ( seqType.second == "RunAction" )
kernel.runAction().adopt(_action<RunAction::handled_type>(action.get()));
else if ( seqType.second == "EventAction" )
kernel.eventAction().adopt(_action<EventAction::handled_type>(action.get()));
else if ( seqType.second == "GeneratorAction" )
kernel.generatorAction().adopt(_action<GenAction::handled_type>(action.get()));
else if ( seqType.second == "TrackingAction" )
kernel.trackingAction().adopt(_action<TrackAction::handled_type>(action.get()));
else if ( seqType.second == "StackingAction" )
kernel.stackingAction().adopt(_action<StackAction::handled_type>(action.get()));
else if ( seqType.second == "SteppingAction" )
kernel.steppingAction().adopt(_action<StepAction::handled_type>(action.get()));
else if ( seqType.second == "PhysicsList" )
kernel.physicsList().adopt(_action<PhysicsList::handled_type>(action.get()));
else if ( sdSeq.get() )
sdSeq->adopt(_action<Sensitive::handled_type>(action.get()));
else {
throw runtime_error(format("ActionSequence","DDG4: The action '%s'"
" cannot be attached to any sequence '%s'."
" [Sequence-Missing]",nam.c_str(), seqNam.c_str()));
}
printout(INFO,"Geant4Setup","+++ ActionSequence %s added filter object:%s",
seqType.second.c_str(),action->name().c_str());
}
if ( what == SENSITIVE ) {
for(xml_coll_t a(seq,_Unicode(filter)); a; ++a) {
string nam = a.attr<string>(_U(name));
Action action(_createAction(lcdd,a,"",FILTER));
printout(INFO,"Geant4Setup","+++ ActionSequence %s added filter object:%s",
seqType.second.c_str(),action->name().c_str());
if ( sdSeq.get() )
sdSeq->adopt(_action<Filter::handled_type>(action.get()));
else {
throw runtime_error(format("ActionSequence","DDG4: The action '%s'"
" cannot be attached to any sequence '%s'."
" [Sequence-Missing]",nam.c_str(), seqNam.c_str()));
}
}
}
}
/// Create/Configure PhysicsList objects
/**
* <physicslist>
* <processes>
* <particle name="'e-'">
* <process name="G4eMultipleScattering" ordAtRestDoIt="-1" ordAlongSteptDoIt="1" ordPostStepDoIt="1"/>
* <process name="G4eIonisation" ordAtRestDoIt="-1" ordAlongSteptDoIt="2" ordPostStepDoIt="2"/>
* </particle>
* </processes>
* </physicslist>
*/
template <> void Converter<Geant4PhysicsList::ParticleProcesses>::operator()(xml_h e) const {
xml_comp_t part(e);
string part_name = part.nameStr();
Geant4PhysicsList::ParticleProcesses& procs =
_object<Geant4PhysicsList>().processes(part_name);
for(xml_coll_t q(part,_Unicode(process)); q; ++q) {
xml_comp_t proc(q);
Geant4PhysicsList::Process p;
p.name = proc.nameStr();
p.ordAtRestDoIt = proc.attr<int>(_Unicode(ordAtRestDoIt));
p.ordAlongSteptDoIt = proc.attr<int>(_Unicode(ordAlongSteptDoIt));
p.ordPostStepDoIt = proc.attr<int>(_Unicode(ordPostStepDoIt));
procs.push_back(p);
printout(INFO,"Geant4Setup","+++ Converter<ParticleProcesses: Particle:%s add process %s %d %d %d",
part_name.c_str(),p.name.c_str(),p.ordAtRestDoIt,p.ordAlongSteptDoIt,p.ordPostStepDoIt);
}
}
/// Create/Configure PhysicsList objects: Particle constructors
/**
* <physicslist>
* <particles>
* <construct name="G4Electron"/>
* <construct name="G4Gamma"/>
* <construct name="G4BosonConstructor"/>
* <construct name="G4LeptonConstructor"/>
* <construct name="G4BaryonConstructor"/>
* </particles>
* </physicslist>
*/
template <> void Converter<Geant4PhysicsList::ParticleConstructor>::operator()(xml_h e) const {
Geant4PhysicsList::ParticleConstructors& parts = _object<Geant4PhysicsList>().particles();
xml_comp_t part(e);
string n = part.nameStr();
parts.push_back(n);
printout(INFO,"Geant4Setup","+++ ParticleConstructor: Add Geant4 particle constructor '%s'",n.c_str());
/// Create/Configure PhysicsList objects: Physics constructors
/**
* <physicslist>
* <physics>
* <construct name="G4EmStandardPhysics"/>
* <construct name="HadronPhysicsQGSP"/>
* </physics>
* </physicslist>
*/
template <> void Converter<Geant4PhysicsList::PhysicsConstructor>::operator()(xml_h e) const {
Geant4PhysicsList::PhysicsConstructors& parts = _object<Geant4PhysicsList>().physics();
xml_comp_t part(e);
string n = part.nameStr();
parts.push_back(n);
printout(INFO,"Geant4Setup","+++ PhysicsConstructor: Add Geant4 physics constructor '%s'",n.c_str());
}
/// Create/Configure PhysicsList extension objects: Predefined Geant4 Physics lists
/**
* <physicslist>
* <list name="TQGSP_FTFP_BERT_95"/>
* </physicslist>
* Note: list items are Geant4Actions and - if global - may receive properties!
*/
struct PhysicsListExtension;
template <> void Converter<PhysicsListExtension>::operator()(xml_h e) const {
Kernel& kernel = Kernel::access(lcdd);
string ext = xml_comp_t(e).nameStr();
kernel.physicsList().properties()["extends"].str(ext);
printout(INFO,"Geant4Setup","+++ PhysicsListExtension: Set predefined Geant4 physics list to '%s'",ext.c_str());
/// Create/Configure PhysicsList objects: Predefined Geant4 Physics lists
template <> void Converter<PhysicsList>::operator()(xml_h e) const {
string name = e.attr<string>(_U(name));
Kernel& kernel = Kernel::access(lcdd);
PhysicsList handle(kernel,name);
_setAttributes(handle,e);
xml_coll_t(e,_Unicode(particles)).for_each(_Unicode(construct),Converter<Geant4PhysicsList::ParticleConstructor>(lcdd,handle.get()));
xml_coll_t(e,_Unicode(processes)).for_each(_Unicode(particle),Converter<Geant4PhysicsList::ParticleProcesses>(lcdd,handle.get()));
xml_coll_t(e,_Unicode(physics)).for_each(_Unicode(construct),Converter<Geant4PhysicsList::PhysicsConstructor>(lcdd,handle.get()));
xml_coll_t(e,_Unicode(extends)).for_each(Converter<PhysicsListExtension>(lcdd,handle.get()));
kernel.physicsList().adopt(handle);
}
template <> void Converter<Kernel>::operator()(xml_h e) const {
Kernel& kernel = Kernel::access(lcdd);
xml_comp_t k(e);
if ( k.hasAttr(_Unicode(NumEvents)) )
kernel.property("NumEvents").str(k.attr<string>(_Unicode(NumEvents)));
if ( k.hasAttr(_Unicode(UI)) )
kernel.property("UI").str(k.attr<string>(_Unicode(UI)));
}
/// Main entry point to configure Geant4 with XML
template <> void Converter<XMLSetup>::operator()(xml_h seq) const {
xml_elt_t compact(seq);
// First execute the basic setup from the plugins module
long result = ROOT::Reflex::PluginService::Create<long>("geant4_XML_reader",&lcdd,&seq);
if ( 0 == result ) {
throw runtime_error("DD4hep: Failed to locate plugin to interprete files of type"
" \"" + seq.tag() + "\" - no factory of type geant4_XML_reader.");
}
result = *(long*) result;
if (result != 1) {
throw runtime_error("DD4hep: Failed to parse the XML tag " + seq.tag() + " with the plugin geant4_XML_reader");
}
xml_coll_t(compact,_Unicode(kernel)).for_each(Converter<Kernel>(lcdd,param));
// Now deal with the new stuff.....
xml_coll_t(compact,_Unicode(actions) ).for_each(_Unicode(action),Converter<Action>(lcdd,param));
xml_coll_t(compact,_Unicode(filters) ).for_each(_Unicode(filter),Converter<Filter>(lcdd,param));
xml_coll_t(compact,_Unicode(sequences) ).for_each(_Unicode(sequence),Converter<ActionSequence>(lcdd,param));
xml_coll_t(compact,_Unicode(phases) ).for_each(_Unicode(phase),Converter<Phase>(lcdd,param));
xml_coll_t(compact,_Unicode(physicslist)).for_each(Converter<PhysicsList>(lcdd,param));
}
}
static long setup_Geant4(lcdd_t& lcdd, const xml_h& element) {
(DD4hep::Converter<DD4hep::Simulation::XMLSetup>(lcdd))(element);
DECLARE_XML_DOC_READER(geant4_setup,setup_Geant4)