G4DeexPrecoParameters.hh

Go to the documentation of this file.

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
//
// 15.03.2016 V.Ivanchenko 
//
// List of parameters of the pre-compound model
// and the deexcitation module
//
// Verbosity level depends on the local verbosity level and the verbosity
// level of hadronics defined in G4HadronicParameters
//
// OPTxs is a type of model for inverse cross section. It is different
// for pre-compound and de-excitation (fPrecoType and fDeexType).
// Possible types:
//    0 - Dostrovski's parameterization
//    1 - G4NeutronInelasticXS or G4ParticleInelasticXS
//    2 - Chatterjee's paramaterization
//    3 - Kalbach's parameterization
//
 
#ifndef G4DeexPrecoParameters_h
#define G4DeexPrecoParameters_h 1
 
#include "globals.hh"
 
enum G4DeexChannelType
{
  fEvaporation = 0,
  fGEM,
  fCombined,
  fGEMVI,
  fDummy
};
 
enum G4PreCompoundType
{
  eDefault = 0,
  eDeexcitation,
  ePrecoInterface
};
 
enum G4FermiBreakUpType
{
  bModelVI = 0,
  bModelAN,
  bDummy
};
 
class G4StateManager;
class G4DeexParametersMessenger;
 
class G4DeexPrecoParameters
{
public:
 
  G4DeexPrecoParameters();
 
  ~G4DeexPrecoParameters();
 
  void SetDefaults();
 
  // printing
  std::ostream& StreamInfo(std::ostream& os) const;
  void Dump();
  friend std::ostream& operator<< (std::ostream& os, 
                   const G4DeexPrecoParameters&);
 
  G4int GetVerbose() const;
 
  // inline access methods 
  inline G4double GetLevelDensity() const;
 
  inline G4double GetR0() const;
 
  inline G4double GetTransitionsR0() const;
 
  inline G4double GetFBUEnergyLimit() const;
 
  inline G4double GetFermiEnergy() const;
 
  inline G4double GetPrecoLowEnergy() const;
 
  inline G4double GetPrecoHighEnergy() const;
 
  inline G4double GetPhenoFactor() const;
 
  inline G4double GetMinExcitation() const;
 
  inline G4double GetNuclearLevelWidth() const;
 
  inline G4double GetMaxLifeTime() const;
 
  inline G4double GetMinExPerNucleounForMF() const;
 
  inline G4int GetMinZForPreco() const;
 
  inline G4int GetMinAForPreco() const;
 
  // should be renamed 
  inline G4int GetPrecoModelType() const;
 
  // should be renamed 
  inline G4int GetDeexModelType() const;
 
  inline G4int GetTwoJMAX() const;
 
  inline G4int GetUploadZ() const;
 
  inline G4bool NeverGoBack() const;
 
  inline G4bool UseSoftCutoff() const;
 
  inline G4bool UseCEM() const;
 
  inline G4bool UseGNASH() const;
 
  inline G4bool UseHETC() const;
 
  inline G4bool UseAngularGen() const;
 
  inline G4bool PrecoDummy() const;
 
  inline G4bool CorrelatedGamma() const;
 
  inline G4bool GetInternalConversionFlag() const;
 
  inline G4bool GetLevelDensityFlag() const;
 
  inline G4bool GetDiscreteExcitationFlag() const;
 
  inline G4bool StoreICLevelData() const;
 
  inline G4bool IsomerProduction() const;
 
  inline G4DeexChannelType GetDeexChannelsType() const;
 
  inline G4PreCompoundType GetPreCompoundType() const;
 
  inline G4FermiBreakUpType GetFermiBreakUpType() const;
 
  // Set methods 
  void SetLevelDensity(G4double);
 
  void SetR0(G4double);
 
  void SetTransitionsR0(G4double);
 
  void SetFBUEnergyLimit(G4double);
 
  void SetFermiEnergy(G4double);
 
  void SetPrecoLowEnergy(G4double);
 
  void SetPrecoHighEnergy(G4double);
 
  void SetPhenoFactor(G4double);
 
  void SetMinExcitation(G4double);
 
  void SetNuclearLevelWidth(G4double);
 
  void SetMaxLifeTime(G4double);
 
  void SetMinExPerNucleounForMF(G4double);
 
  void SetMinEForMultiFrag(G4double);
 
  void SetMinZForPreco(G4int);
 
  void SetMinAForPreco(G4int);
 
  // should be renamed
  void SetPrecoModelType(G4int);
 
  // should be renamed
  void SetDeexModelType(G4int);
 
  void SetTwoJMAX(G4int);
 
  void SetVerbose(G4int);
 
  void SetNeverGoBack(G4bool);
 
  void SetUseSoftCutoff(G4bool);
 
  void SetUseCEM(G4bool);
 
  void SetUseGNASH(G4bool);
 
  void SetUseHETC(G4bool);
 
  void SetUseAngularGen(G4bool);
 
  void SetPrecoDummy(G4bool);
 
  void SetCorrelatedGamma(G4bool);
 
  void SetStoreICLevelData(G4bool);
 
  // obsolete method (use SetStoreICLevelData)
  void SetStoreAllLevels(G4bool);
 
  void SetInternalConversionFlag(G4bool);
 
  void SetLevelDensityFlag(G4bool);
 
  void SetDiscreteExcitationFlag(G4bool);
 
  void SetIsomerProduction(G4bool);
 
  void SetDeexChannelsType(G4DeexChannelType);
 
  void SetPreCompoundType(G4PreCompoundType);
 
  void SetFermiBreakUpType(G4FermiBreakUpType);
 
  G4DeexPrecoParameters(const G4DeexPrecoParameters & right) = delete;  
  const G4DeexPrecoParameters& operator=
  (const G4DeexPrecoParameters &right) = delete;
  G4bool operator==(const G4DeexPrecoParameters &right) const = delete;
  G4bool operator!=(const G4DeexPrecoParameters &right) const = delete;
 
private:
 
  void Initialise();
 
  G4bool IsLocked() const;
 
  G4DeexParametersMessenger* theMessenger;
  G4StateManager* fStateManager;
 
  // Level density parameter
  G4double fLevelDensity;
 
  // Nuclear radius r0 
  G4double fR0;
 
  // Nuclear radius r0 for transitions
  G4double fTransitionsR0;
 
  // upper limit of level energy for Fermi Break-up model
  G4double fFBUEnergyLimit;
 
  // Fermi energy level
  G4double fFermiEnergy;
 
  // Excitation per nucleon limits 
  G4double fPrecoLowEnergy;
  G4double fPrecoHighEnergy;
 
  // Preco phenomenological factor
  G4double fPhenoFactor;
 
  // Excitation handler
  G4double fMinExcitation;
  G4double fNuclearLevelWidth;
  G4double fMaxLifeTime;
 
  // Multi-fragmentation model
  G4double fMinExPerNucleounForMF;
 
  // Cross section type
  G4int fPrecoType;
  G4int fDeexType;
 
  G4int fTwoJMAX;
 
  // Preco model
  G4int fMinZForPreco;
  G4int fMinAForPreco;
 
  G4int fVerbose;
 
  // Preco flags
  G4bool fNeverGoBack;
  G4bool fUseSoftCutoff;
  G4bool fUseCEM;
  G4bool fUseGNASH;
  G4bool fUseHETC;
  G4bool fUseAngularGen;
  G4bool fPrecoDummy;
 
  // Deex flags
  G4bool fCorrelatedGamma;
  G4bool fStoreAllLevels;
  G4bool fInternalConversion;
  G4bool fLD; 
  G4bool fFD; 
  G4bool fIsomerFlag;
  G4bool fIsPrinted{false};
 
  // type of a set of de-exitation channels
  G4DeexChannelType fDeexChannelType;
  G4PreCompoundType fPreCompoundType;
  G4FermiBreakUpType fFermiBreakUpType;
};
 
inline G4double G4DeexPrecoParameters::GetLevelDensity() const
{ 
  return fLevelDensity; 
}
 
inline G4double G4DeexPrecoParameters::GetR0() const
{ 
  return fR0; 
}
 
inline G4double G4DeexPrecoParameters::GetTransitionsR0() const
{ 
  return fTransitionsR0; 
}
 
inline G4double G4DeexPrecoParameters::GetFBUEnergyLimit() const
{
  return fFBUEnergyLimit;
}
 
inline G4double G4DeexPrecoParameters::GetFermiEnergy() const
{ 
  return fFermiEnergy; 
}
 
inline G4double G4DeexPrecoParameters::GetPrecoLowEnergy() const
{ 
  return fPrecoLowEnergy; 
}
 
inline G4double G4DeexPrecoParameters::GetPrecoHighEnergy() const
{ 
  return fPrecoHighEnergy; 
}
 
inline G4double G4DeexPrecoParameters::GetPhenoFactor() const
{ 
  return fPhenoFactor; 
}
 
inline G4double G4DeexPrecoParameters::GetMinExcitation() const
{
  return fMinExcitation;
}
 
inline G4double G4DeexPrecoParameters::GetNuclearLevelWidth() const
{
  return fNuclearLevelWidth;
}
 
inline G4double G4DeexPrecoParameters::GetMaxLifeTime() const
{
  return fMaxLifeTime;
}
 
inline G4double G4DeexPrecoParameters::GetMinExPerNucleounForMF() const
{
  return fMinExPerNucleounForMF;
}
 
inline G4int G4DeexPrecoParameters::GetMinZForPreco() const
{
  return fMinZForPreco;
}
 
inline G4int G4DeexPrecoParameters::GetMinAForPreco() const
{
  return fMinAForPreco;
}
 
inline G4int G4DeexPrecoParameters::GetPrecoModelType() const
{
  return fPrecoType;
}
 
inline G4int G4DeexPrecoParameters::GetDeexModelType() const
{
  return fDeexType;
}
 
inline G4int G4DeexPrecoParameters::GetTwoJMAX() const
{
  return fTwoJMAX;
}
 
inline G4bool G4DeexPrecoParameters::NeverGoBack() const
{
  return fNeverGoBack;
}
 
inline G4bool G4DeexPrecoParameters::UseSoftCutoff() const
{
  return fUseSoftCutoff;
}
 
inline G4bool G4DeexPrecoParameters::UseCEM() const
{
  return fUseCEM;
}
 
inline G4bool G4DeexPrecoParameters::UseGNASH() const
{
  return fUseGNASH;
}
 
inline G4bool G4DeexPrecoParameters::UseHETC() const
{
  return fUseHETC;
}
 
inline G4bool G4DeexPrecoParameters::UseAngularGen() const
{
  return fUseAngularGen;
}
 
inline G4bool G4DeexPrecoParameters::PrecoDummy() const
{
  return fPrecoDummy;
}
 
inline G4bool G4DeexPrecoParameters::CorrelatedGamma() const
{
  return fCorrelatedGamma;
}
 
inline G4bool G4DeexPrecoParameters::StoreICLevelData() const
{
  return fStoreAllLevels;
}
 
inline G4bool G4DeexPrecoParameters::GetInternalConversionFlag() const
{
  return fInternalConversion;
}
 
inline G4bool G4DeexPrecoParameters::GetLevelDensityFlag() const
{
  return fLD;
}
 
inline G4bool G4DeexPrecoParameters::GetDiscreteExcitationFlag() const
{
  return fFD;
}
 
inline G4bool G4DeexPrecoParameters::IsomerProduction() const
{
  return fIsomerFlag;
}
 
inline G4DeexChannelType G4DeexPrecoParameters::GetDeexChannelsType() const
{
  return fDeexChannelType;
}
 
inline G4PreCompoundType G4DeexPrecoParameters::GetPreCompoundType() const
{
  return fPreCompoundType;
}
 
inline G4FermiBreakUpType G4DeexPrecoParameters::GetFermiBreakUpType() const
{
  return fFermiBreakUpType;
}
  
#endif