vecGeomNavigation/include/VG01PrimaryGeneratorAction.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 VG01PrimaryGeneratorAction.hh
0028 /// \brief Definition of the VG01PrimaryGeneratorAction class
0029
0030 //  Generator with multiple modes: uniform, free, axis, fixed)
0031 //
0032 //  Primary generator that can be configured using modes to either:
0033 //    - 'uniform' direction secondaries       (default)
0034 //    - 'free'    which is configured by UI - initialised in con/tor
0035 //    - 'axis'    directing secondaries by rotation to x, y & z axis
0036 //    - 'fixed'   along x axis, and near it ( y = 0.1 or z = 0.1)
0037 //
0038 //  Authors: J. Apostolakis & S. Wenzel (CERN)  2018-2021
0039 //
0040 //  Started from FullCMS code by Mihaly Novak (CERN) 2017
0041
0042 #ifndef _G01PRIMARYGENERATORACTION_H_
0043 #define _G01PRIMARYGENERATORACTION_H_
0044
0045 #include "G4VUserPrimaryGeneratorAction.hh"
0046 #include "globals.hh"
0047
0048 class G4Event;
0049 class G4ParticleGun;
0050
0051 /// Configurable primary generator action to demonstrate use of
0052 ///   VecGeom Navigation
0053
0054 class VG01PrimaryGeneratorAction : public G4VUserPrimaryGeneratorAction
0055 {
0056   public:
0057     enum EGeneratorMode
0058     {
0059       kFixedMode,
0060       kUniformMode,
0061       kAxisMode,
0062       kFreeMode
0063     };
0064     //                     x Axis       random dir    x, y, z     UI directed
0065
0066     VG01PrimaryGeneratorAction(EGeneratorMode mode = kUniformMode);
0067     ~VG01PrimaryGeneratorAction();
0068
0069     void GeneratePrimaries(G4Event* anEvent) override;
0070
0071     void SetGeneratorMode(EGeneratorMode val) { fMode = val; }
0072     EGeneratorMode GetGeneratorMode() { return fMode; }
0073
0074   private:
0075     G4ParticleGun* fParticleGun;
0076     EGeneratorMode fMode;
0077 };
0078
0079 #endif