Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/processes/hadronic/cross_sections/include/G4CrossSectionFactory.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 #ifndef G4CrossSectionFactory_h
 27 #define G4CrossSectionFactory_h 1
 28 
 29 
 30 #include "globals.hh"
 31 #include "G4VCrossSectionDataSet.hh"
 32 #include "G4CrossSectionFactoryRegistry.hh"
 33 #include "G4Threading.hh"
 34 
 35 class G4VBaseXSFactory
 36 {
 37 
 38 public:
 39 
 40   virtual G4VCrossSectionDataSet* Instantiate() = 0;
 41 
 42 };
 43 
 44 
 45 //Generic template XS-factory
 46 template <typename T, int mode> class G4CrossSectionFactory : public G4VBaseXSFactory
 47 {
 48 public:
 49   G4CrossSectionFactory(const G4String& name)
 50   {
 51       G4CrossSectionFactoryRegistry::Instance()->Register(name,this);
 52   }
 53   
 54   virtual G4VCrossSectionDataSet* Instantiate() 
 55   {
 56       G4ExceptionDescription msg;
 57       msg<<"Factory mode: "<<mode<<" not supported!";
 58       G4Exception("G4CrossSectionFactory::Instantiate","CrossSectionFactory001",FatalException,msg);
 59     return static_cast<T*>(0);
 60   }
 61 };
 62 
 63 //Partial specialized template for non-singleton non-shared factory
 64 // each call to Instantiate creates a new XS
 65 template <typename T> class G4CrossSectionFactory<T,0> : public G4VBaseXSFactory
 66 {
 67 public:
 68     
 69     G4CrossSectionFactory(const G4String& name)
 70     {
 71         G4CrossSectionFactoryRegistry::Instance()->Register(name,this);
 72     }
 73     
 74     virtual G4VCrossSectionDataSet* Instantiate()
 75     {
 76         return new T();
 77     }
 78 };
 79 
 80 //Partial specialized template for singleton, shared factory
 81 // each call to Instantiate returns pointer to static object
 82 template <typename T> class G4CrossSectionFactory<T,1> : public G4VBaseXSFactory
 83 {
 84 public:
 85     G4CrossSectionFactory(const G4String& name)
 86     {
 87         G4CrossSectionFactoryRegistry::Instance()->Register(name,this);
 88     }
 89     
 90     virtual G4VCrossSectionDataSet* Instantiate()
 91     {
 92         static T* shared = new T();
 93         return shared;
 94     }
 95 };
 96 
 97 //Partial specialized template for singleton, shared factory
 98 // each call to Instantiate returns pointer to static thread-local object
 99 template <typename T> class G4CrossSectionFactory<T,2> : public G4VBaseXSFactory
100 {
101     G4CrossSectionFactory(const G4String& name)
102     {
103         G4CrossSectionFactoryRegistry::Instance()->Register(name,this);
104     }
105     
106     virtual G4VCrossSectionDataSet* Instantiate()
107     {
108         static G4ThreadLocal T* shared = new T();
109         return shared;
110     }
111 };
112 
113 
114 #define G4_BASE_DECLARE_XS_FACTORY(cross_section, flag) \
115   const G4CrossSectionFactory<cross_section,flag>& cross_section##Factory = G4CrossSectionFactory<cross_section,flag>(cross_section::Default_Name())
116 
117 #define G4_BASE_REFERENCE_XS_FACTORY(cross_section,flag) \
118   class cross_section; \
119   extern const G4CrossSectionFactory<cross_section,flag>& cross_section##Factory; \
120   const G4CrossSectionFactory<cross_section,flag>& cross_section##FactoryRef = cross_section##Factory
121 
122 //Macros to help define and reference factories
123 #define G4_DECLARE_XS_FACTORY(cross_section) G4_BASE_DECLARE_XS_FACTORY(cross_section,0)
124 #define G4_DECLARE_SHAREDXS_FACTORY(cross_section) G4_BASE_DECLARE_XS_FACTORY(cross_section,1)
125 #define G4_DECLARE_SHAREDTLSXS_FACTORY(cross_section) G4_BASE_DECLARE_XS_FACTORY(cross_section,2)
126 
127 
128 #define G4_REFERENCE_XS_FACTORY(cross_section) G4_BASE_REFERENCE_XS_FACTORY(cross_section,0)
129 #define G4_REFERENCE_SHAREDXS_FACTORY(cross_section) G4_BASE_REFERENCE_XS_FACTORY(cross_section,1)
130 #define G4_REFERENCE_SHAREDTLSXS_FACTORY(cross_section) G4_BASE_REFERENCE_XS_FACTORY(cross_section,2)
131 
132 #endif
133