celeritas::StepDiagnosticBase Class Reference

Tally number of steps taken by each particle type. More...

#include <StepDiagnosticBase.hh>

Inheritance diagram for celeritas::StepDiagnosticBase:

Public Types
Type aliases
using	StoreT = StreamStore< ParticleTallyParamsData, ParticleTallyStateData >
using	VecVecCount = std::vector< std::vector< size_type > >
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
	StepDiagnosticBase (size_type num_particles, size_type max_bins, size_type num_streams)
	Construct with counts.
	~StepDiagnosticBase ()
	Default destructor.
VecVecCount	calc_steps () const
	Get the diagnostic results accumulated over all streams.
size_type	state_size () const
	Size of diagnostic state data (number of bins times number of particles)
StoreT &	store () const
void	clear ()
	Reset diagnostic results.
Output interface
Category	category () const final
	Category of data to write.
void	output (JsonPimpl *) const final
	Write output to the given JSON object.
Public Member Functions inherited from celeritas::OutputInterface
virtual std::string_view	label () const =0
	Key for the entry inside the category.

Detailed Description

Tally number of steps taken by each particle type.

This adds an step-diagnostic entry to the result category of the main Celeritas output that bins the total number of steps taken by a track, grouped by particle type. The result is an integral over all events.

Member Function Documentation

category()

Category celeritas::StepDiagnosticBase::category ( ) const

inlinefinalvirtual

Category of data to write.

Implements celeritas::OutputInterface.

output()

void celeritas::StepDiagnosticBase::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:

• StepDiagnosticBase.hh
• StepDiagnosticBase.cc