Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/particles/adjoint/include/G4AdjointIons.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ] 

  1 //
  2 // ********************************************************************
  3 // * License and Disclaimer                                           *
  4 // *                                                                  *
  5 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
  6 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
  7 // * conditions of the Geant4 Software License,  included in the file *
  8 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
  9 // * include a list of copyright holders.                             *
 10 // *                                                                  *
 11 // * Neither the authors of this software system, nor their employing *
 12 // * institutes,nor the agencies providing financial support for this *
 13 // * work  make  any representation or  warranty, express or implied, *
 14 // * regarding  this  software system or assume any liability for its *
 15 // * use.  Please see the license in the file  LICENSE  and URL above *
 16 // * for the full disclaimer and the limitation of liability.         *
 17 // *                                                                  *
 18 // * This  code  implementation is the result of  the  scientific and *
 19 // * technical work of the GEANT4 collaboration.                      *
 20 // * By using,  copying,  modifying or  distributing the software (or *
 21 // * any work based  on the software)  you  agree  to acknowledge its *
 22 // * use  in  resulting  scientific  publications,  and indicate your *
 23 // * acceptance of all terms of the Geant4 Software license.          *
 24 // ********************************************************************
 25 //
 26 // ------------------------------------------------------------
 27 //      GEANT 4 class header file
 28 //
 29 //      History:
 30 //    1 July 2009 creation by L. Desorgher based on a modification of G4Ions
 31 //
 32 //-------------------------------------------------------------
 33 //  Documentation:
 34 //    Adjoint particles are used in Reverse/Adjoint Monte Carlo simulations. New adjoint
 35 //    processes act on adjoint particles when they are  tracked backward in the geometry.
 36 //    The use of adjoint particles instead of "normal" particles during a reverse simulation
 37 //    is based on an idea of M. Asai.
 38 //
 39 
 40 #ifndef G4AdjointIons_h
 41 #define G4AdjointIons_h 1
 42 
 43 #include "G4ParticleDefinition.hh"
 44 #include "G4String.hh"
 45 #include "G4Types.hh"
 46 
 47 class G4AdjointIons : public G4ParticleDefinition
 48 {
 49     // Class Description
 50     //  This is the base class for all nuclei including pre-defined
 51     //  light nuclei such as deuteron, alpha, and proton (Hydrogen)
 52     //  All nuclei/ions created on the fly are objects of this class
 53     //  Atomic number and atomic mass are vaild only for particles derived
 54     //  from this class.  This class has Excitation Energy in addition to
 55     //  the normal particle properties.
 56 
 57   public:
 58     // clang-format off
 59    G4AdjointIons(
 60        const G4String&     aName,        G4double            mass,
 61        G4double            width,        G4double            charge,   
 62        G4int               iSpin,        G4int               iParity,    
 63        G4int               iConjugation, G4int               iIsospin,   
 64        G4int               iIsospin3,    G4int               gParity,
 65        const G4String&     pType,        G4int               lepton,      
 66        G4int               baryon,       G4int               encoding,
 67        G4bool              stable,       G4double            lifetime,
 68        G4DecayTable        *decaytable,  G4bool              shortlived,
 69        const G4String&     subType ="",
 70        G4int               anti_encoding =0,
 71        G4double            excitation = 0.0
 72    );
 73     // clang-format on
 74 
 75     ~G4AdjointIons() override = default;
 76 
 77     G4AdjointIons* IonsDefinition();
 78     G4AdjointIons* Ions();
 79 
 80     // Get excitation energy of nucleus
 81     G4double GetExcitationEnergy() const;
 82 
 83   protected:
 84     G4AdjointIons() = default;
 85 
 86   private:
 87     G4double theExcitationEnergy;
 88 };
 89 
 90 inline G4AdjointIons* G4AdjointIons::Ions()
 91 {
 92   return this;
 93 }
 94 
 95 inline G4double G4AdjointIons::GetExcitationEnergy() const
 96 {
 97   return theExcitationEnergy;
 98 }
 99 
100 #endif
101