Geant4  10.02.p02
G4CascadeParameters.hh
Go to the documentation of this file.
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 // $Id: G4CascadeParameters.hh 72016 2013-07-03 16:24:15Z mkelsey $
27 // Encapsulate all user-configurable parameters with associated envvars
28 //
29 // 20120912 M. Kelsey -- Add interface to support UI commands
30 // 20130304 M. Kelsey -- Add flag to collect and display cascade structure
31 // 20130308 M. Kelsey -- Add flag to use separate 3-body momentum generators
32 // 20130421 M. Kelsey -- Add flag for CHECK_ECONS, replacing #ifdef's
33 // 20130702 M. Kelsey -- Add flag to use N-body phase-space generator
34 // 20140311 G. Cosmo -- Implement standard (non-const) singleton pattern
35 // 20141030 M. Kelsey -- Add flag to enable direct pi-N absorption
36 // 20141211 M. Kelsey -- Change PIN_ABSORPTION flag to double, for energy cut
37 
38 #ifndef G4CascadeParameters_hh
39 #define G4CascadeParameters_hh 1
40 
41 #include "globals.hh"
42 #include <iosfwd>
43 
45 
46 
48 public:
49  static const G4CascadeParameters* Instance(); // Singleton
51 
52  // Top-level configuration flags
53  static G4int verbose() { return Instance()->VERBOSE_LEVEL; }
54  static G4bool checkConservation() { return Instance()->CHECK_ECONS; }
56  static G4bool doCoalescence() { return Instance()->DO_COALESCENCE; }
57  static G4bool showHistory() { return Instance()->SHOW_HISTORY; }
58  static G4bool use3BodyMom() { return Instance()->USE_3BODYMOM; }
59  static G4bool usePhaseSpace() { return Instance()->USE_PHASESPACE; }
61  static const G4String& randomFile() { return Instance()->RANDOM_FILE; }
62 
63  // Nuclear structure parameters
64  static G4bool useTwoParam() { return Instance()->TWOPARAM_RADIUS; }
65  static G4double radiusScale() { return Instance()->RADIUS_SCALE; }
66  static G4double radiusSmall() { return Instance()->RADIUS_SMALL; }
67  static G4double radiusAlpha() { return Instance()->RADIUS_ALPHA; }
69  static G4double fermiScale() { return Instance()->FERMI_SCALE; }
70  static G4double xsecScale() { return Instance()->XSEC_SCALE; }
71  static G4double gammaQDScale() { return Instance()->GAMMAQD_SCALE; }
72 
73  // Final-state clustering cuts
74  static G4double dpMaxDoublet() { return Instance()->DPMAX_DOUBLET; }
75  static G4double dpMaxTriplet() { return Instance()->DPMAX_TRIPLET; }
76  static G4double dpMaxAlpha() { return Instance()->DPMAX_ALPHA; }
77 
78  static void DumpConfiguration(std::ostream& os) { Instance()->DumpConfig(os); }
79 
80 private: // Environment variable values, null pointers mean not set
81  const char* G4CASCADE_VERBOSE;
82  const char* G4CASCADE_CHECK_ECONS;
89  const char* G4CASCADE_RANDOM_FILE;
90  const char* G4NUCMODEL_USE_BEST;
91  const char* G4NUCMODEL_RAD_2PAR;
92  const char* G4NUCMODEL_RAD_SCALE;
93  const char* G4NUCMODEL_RAD_SMALL;
94  const char* G4NUCMODEL_RAD_ALPHA;
97  const char* G4NUCMODEL_XSEC_SCALE;
98  const char* G4NUCMODEL_GAMMAQD;
99  const char* DPMAX_2CLUSTER;
100  const char* DPMAX_3CLUSTER;
101  const char* DPMAX_4CLUSTER;
102 
103  void Initialize(); // Fill parameter values from envvar strings
104 
105  G4int VERBOSE_LEVEL; // Top-level configuration flags
114 
115  G4bool BEST_PAR; // Nuclear structure parameters
124 
125  G4double DPMAX_DOUBLET; // Final-state clustering cuts
128 
129 private: // Singleton -- no public constructor
131  void DumpConfig(std::ostream& os) const;
132 
133  G4CascadeParamMessenger* messenger; // For access via UI commands
135 
137 };
138 
139 #endif /* G4CascadeParameters_hh */
const char * G4NUCMODEL_USE_BEST
void DumpConfig(std::ostream &os) const
static G4double xsecScale()
static G4bool showHistory()
static G4double dpMaxAlpha()
const char * G4NUCMODEL_RAD_SMALL
static G4double radiusTrailing()
static G4double piNAbsorption()
const char * G4CASCADE_VERBOSE
const char * G4CASCADE_SHOW_HISTORY
static G4double radiusScale()
static G4bool doCoalescence()
static G4bool checkConservation()
int G4int
Definition: G4Types.hh:78
static G4CascadeParameters * fpInstance
const char * G4NUCMODEL_XSEC_SCALE
static const G4String & randomFile()
const char * G4CASCADE_DO_COALESCENCE
const char * G4NUCMODEL_RAD_TRAILING
const char * G4NUCMODEL_RAD_2PAR
const char * G4NUCMODEL_RAD_SCALE
const char * G4NUCMODEL_FERMI_SCALE
bool G4bool
Definition: G4Types.hh:79
const char * G4CASCADE_PIN_ABSORPTION
static G4bool usePhaseSpace()
static G4double fermiScale()
const char * G4CASCADE_CHECK_ECONS
static G4double radiusAlpha()
static const G4CascadeParameters * Instance()
const char * G4CASCADE_USE_3BODYMOM
static G4double dpMaxTriplet()
const char * G4CASCADE_USE_PRECOMPOUND
const char * G4CASCADE_USE_PHASESPACE
static G4double dpMaxDoublet()
static G4bool useTwoParam()
const char * G4CASCADE_RANDOM_FILE
static G4bool use3BodyMom()
double G4double
Definition: G4Types.hh:76
static G4double radiusSmall()
G4CascadeParamMessenger * messenger
static void DumpConfiguration(std::ostream &os)
const char * G4NUCMODEL_GAMMAQD
const char * G4NUCMODEL_RAD_ALPHA
static G4double gammaQDScale()
static G4bool usePreCompound()