Celeritas 0.6.0-dev.115+3b60a5fd
Loading...
Searching...
No Matches
Public Member Functions | List of all members
celeritas::GeantSimpleCalo Class Referencefinal

Manage a simple calorimeter sensitive detector across threads. More...

#include <GeantSimpleCalo.hh>

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

Public Types

Type aliases
using SPConstParams = std::shared_ptr< SharedParams const >
 
using UPSensitiveDetector = std::unique_ptr< G4VSensitiveDetector >
 
using VecLV = std::vector< G4LogicalVolume * >
 
using VecReal = std::vector< double >
 
using EnergyUnits = units::Mev
 
- Public Types inherited from celeritas::OutputInterface
enum class  Category {
  input , result , system , internal ,
  size_
}
 Output category (TODO: could replace with string/cstring?)
 

Public Member Functions

 GeantSimpleCalo (std::string name, SPConstParams params, VecLV volumes)
 Construct with name and logical volume pointers.
 
UPSensitiveDetector MakeSensitiveDetector ()
 Emit a new detector for the local thread and attach to the stored LVs.
 
VecLV constVolumes () const
 Get the list of volumes with this SD attached.
 
VecReal CalcTotalEnergyDeposition () const
 Calculate thread-integrated energy deposition.
 
Output interface
Category category () const final
 Category of data to write.
 
std::string_view label () const final
 Return the key in the JSON output.
 
void output (JsonPimpl *) const final
 Write output to the given JSON object.
 

Detailed Description

Manage a simple calorimeter sensitive detector across threads.

The factory should be created in DetectorConstruction or DetectorConstruction::Construct and added to the output parameters. Calling MakeSensitiveDetector will emit a sensitive detector for the local thread and attach it to the logical volumes on the local thread.

Member Function Documentation

◆ CalcTotalEnergyDeposition()

auto celeritas::GeantSimpleCalo::CalcTotalEnergyDeposition ( ) const

Calculate thread-integrated energy deposition.

This function should only be called after all detector data has been collected.

◆ category()

Category celeritas::GeantSimpleCalo::category ( ) const
inlinefinalvirtual

Category of data to write.

Implements celeritas::OutputInterface.

◆ label()

std::string_view celeritas::GeantSimpleCalo::label ( ) const
finalvirtual

Return the key in the JSON output.

Implements celeritas::OutputInterface.

◆ output()

void celeritas::GeantSimpleCalo::output ( JsonPimpl j) const
finalvirtual

Write output to the given JSON object.

Implements celeritas::OutputInterface.


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