common/include/GunPrimaryGeneratorAction.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 //
0027 /// \file common/include/GunPrimaryGeneratorAction.hh
0028 /// \brief Definition of the Common::GunPrimaryGeneratorAction class
0029
0030 #ifndef GunPrimaryGeneratorAction_h
0031 #define GunPrimaryGeneratorAction_h 1
0032
0033 #include "CLHEP/Units/SystemOfUnits.h"
0034
0035 #include "G4ThreeVector.hh"
0036 #include "G4VUserPrimaryGeneratorAction.hh"
0037 #include "globals.hh"
0038
0039 class G4ParticleGun;
0040 class G4Event;
0041
0042 /// \ingroup primary_generator
0043 /// \brief The primary generator class with particle gun
0044 ///
0045 /// \author I. Hrivnacova; IPN Orsay
0046
0047 namespace Common
0048 {
0049
0050 /// \brief The primary generator class with particle gun
0051 ///
0052 /// \author I. Hrivnacova; IPN Orsay
0053
0054 class GunPrimaryGeneratorAction : public G4VUserPrimaryGeneratorAction
0055 {
0056   public:
0057     GunPrimaryGeneratorAction(const G4String& particleName = "geantino",
0058                               G4double energy = 1. * CLHEP::MeV,
0059                               G4ThreeVector position = G4ThreeVector(0, 0, 0),
0060                               G4ThreeVector momentumDirection = G4ThreeVector(0, 0, 1));
0061     ~GunPrimaryGeneratorAction() override;
0062
0063     // methods
0064     void GeneratePrimaries(G4Event*) override;
0065
0066   private:
0067     // data members
0068     G4ParticleGun* fParticleGun = nullptr;
0069 };
0070
0071 }  // namespace Common
0072
0073 #endif