include/Geant4/G4VPositronAtRestModel.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 // GEANT4 Class header file
0027 //
0028 // File name:     G4VPositronAtRestModel
0029 //
0030 // Author:        V. Ivanchenko
0031 //
0032 // Creation date: 13 May 2024
0033 //
0034 // Class Description:
0035 // Abstract base class for sampling of positron annihilation at rest
0036 // There is a requirement to implementation of the virtual method
0037 // SampleSecondaries(...):
0038 //   in the list of dynamic particles two first should be the most
0039 //   energetic gamma from the annihilation. The number of produced
0040 //   particles is not limited.
0041 //
0042 // -------------------------------------------------------------------
0043 //
0044
0045 #ifndef G4VPositronAtRestModel_h
0046 #define G4VPositronAtRestModel_h 1
0047
0048 #include "globals.hh"
0049 #include <vector>
0050
0051 class G4Material;
0052 class G4DynamicParticle;
0053
0054 class G4VPositronAtRestModel
0055 {
0056 public:
0057
0058   explicit G4VPositronAtRestModel(const G4String& name) : fName(name) {};
0059
0060   virtual ~G4VPositronAtRestModel() = default;
0061
0062   virtual void SampleSecondaries(std::vector<G4DynamicParticle*>& secParticles,
0063                  G4double& localEnergyDeposit,
0064                  const G4Material*) const = 0;
0065
0066   virtual void PrintGeneratorInformation() const = 0;
0067
0068   const G4String& GetName() const { return fName; };
0069
0070   G4VPositronAtRestModel& operator=
0071   (const  G4VPositronAtRestModel& right) = delete;
0072   G4VPositronAtRestModel(const G4VPositronAtRestModel&) = delete;
0073
0074 private:
0075
0076   G4String fName;
0077 };
0078
0079 #endif
0080