celeritas::GeneratorInterface Class Reference

Interface class for generating new tracks. More...

#include <GeneratorInterface.hh>

Inheritance diagram for celeritas::GeneratorInterface:

Public Member Functions
virtual	~GeneratorInterface ()
	Default destructor.
virtual GeneratorId	generator_id () const =0
	Index of this class instance in its registry.
virtual std::string_view	label () const =0
	Short unique label of the generator.
virtual GeneratorStateBase &	counters (AuxStateVec &) const =0
	Get generator counters (mutable)
virtual GeneratorStateBase const &	counters (AuxStateVec const &) const =0
	Get generator counters.

Protected Member Functions
	CELER_DEFAULT_COPY_MOVE (GeneratorInterface)

Detailed Description

Interface class for generating new tracks.

Generators store information about pending primary or secondary particles as auxiliary data and initialize the new tracks directly in the vacant slots.

Constructor & Destructor Documentation

GeneratorInterface()

celeritas::GeneratorInterface::GeneratorInterface ( )

protecteddefault

Allow construction and assignment only through daughter classes

Member Function Documentation

CELER_DEFAULT_COPY_MOVE()

celeritas::GeneratorInterface::CELER_DEFAULT_COPY_MOVE ( GeneratorInterface  )

protected

Allow construction and assignment only through daughter classes

counters() [1/2]

virtual GeneratorStateBase & celeritas::GeneratorInterface::counters ( AuxStateVec &  ) const

pure virtual

Get generator counters (mutable)

Implemented in celeritas::optical::GeneratorBase.

counters() [2/2]

virtual GeneratorStateBase const & celeritas::GeneratorInterface::counters ( AuxStateVec const &  ) const

pure virtual

Get generator counters.

Implemented in celeritas::optical::GeneratorBase.

generator_id()

virtual GeneratorId celeritas::GeneratorInterface::generator_id ( ) const

pure virtual

Index of this class instance in its registry.

Implemented in celeritas::optical::GeneratorBase.

label()

virtual std::string_view celeritas::GeneratorInterface::label ( ) const

pure virtual

Short unique label of the generator.

Implemented in celeritas::optical::GeneratorBase.

---

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

• GeneratorInterface.hh
• GeneratorInterface.cc