Celeritas  0.5.0-56+6b053cd
Public Member Functions | List of all members
celeritas::FastSimulationOffload Class Referencefinal

Offload tracks to Celeritas via G4VFastSimulationModel interface. More...

#include <FastSimulationOffload.hh>

Inheritance diagram for celeritas::FastSimulationOffload:
Inheritance graph
[legend]

Public Member Functions

 FastSimulationOffload (G4String const &name, SharedParams const *params, LocalTransporter *local)
 Construct a model to be used in all volumes of the problem.
 
 FastSimulationOffload (G4String const &name, G4Envelope *region, SharedParams const *params, LocalTransporter *local)
 Construct a model for a specific volume of space (an "envelope"). More...
 
G4bool IsApplicable (G4ParticleDefinition const &particle) final
 Return true if this model can be applied to the input G4ParticleDefinition . More...
 
G4bool ModelTrigger (G4FastTrack const &track) final
 Return true if model can be applied given dynamic particle state in G4FastTrack . More...
 
void DoIt (G4FastTrack const &track, G4FastStep &step) final
 Offload the incoming track to Celeritas.
 

Detailed Description

Offload tracks to Celeritas via G4VFastSimulationModel interface.

This class must be constructed locally on each worker thread/task, typically within the application's concrete implementation of G4VUserDetectorConstruction::ConstructSDandField().

Constructor & Destructor Documentation

◆ FastSimulationOffload()

celeritas::FastSimulationOffload::FastSimulationOffload ( G4String const &  name,
G4Envelope *  region,
SharedParams const *  params,
LocalTransporter local 
)

Construct a model for a specific volume of space (an "envelope").

The envelope cannot be nullptr as this will cause a segmentation fault in the G4VFastSimulation base class constructor.

Member Function Documentation

◆ IsApplicable()

G4bool celeritas::FastSimulationOffload::IsApplicable ( G4ParticleDefinition const &  particle)
final

Return true if this model can be applied to the input G4ParticleDefinition .

Purely checks if the particle is one that Celeritas has been setup to handle.

◆ ModelTrigger()

G4bool celeritas::FastSimulationOffload::ModelTrigger ( G4FastTrack const &  track)
final

Return true if model can be applied given dynamic particle state in G4FastTrack .

Always returns true because we only make the decision to offload to Celeritas based on geometric region and particle type.


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