gparticle

Single-particle (and multi-particle) generator configuration and shooting utilities. More...

Collaboration diagram for gparticle:

Files
file	gparticle.h
	Definition of the Gparticle class used by the gparticle module.
file	gparticleConventions.h
	Conventions and error codes for the gparticle module.
file	gparticleDoxy.h
	Doxygen entry point for the gparticle module documentation.

Data Structures
class	Gparticle
	Lightweight particle specification and primary vertex shooter. More...

Macros
#define	GPARTICLENOTDEFINED   (-999)
	Sentinel value used to mark an unset/undefined numeric parameter.

Typedefs
using	GparticlePtr = std::shared_ptr<Gparticle>
	Shared pointer type used for Gparticle instances.

Detailed Description

The gparticle module provides:

• A lightweight particle specification container: Gparticle
• Option parsing utilities to build one or more Gparticle objects from structured CLI options
• File-reader utilities for event-indexed -gparticlefile input
• Generated-particle records used by event output banks

Macro Definition Documentation

GPARTICLENOTDEFINED

#define GPARTICLENOTDEFINED   (-999)

Definition at line 27 of file gparticleConventions.h.

Typedef Documentation

GparticlePtr

using GparticlePtr = std::shared_ptr<Gparticle>

Definition at line 453 of file gparticle.h.