G4TransportationParameters Class Reference

#include <G4TransportationParameters.hh>

Public Member Functions
	~G4TransportationParameters ()=default
G4bool	SetNumberOfTrials (G4int val)
G4bool	SetWarningEnergy (G4double val)
G4bool	SetImportantEnergy (G4double val)
G4int	GetNumberOfTrials () const
G4double	GetWarningEnergy () const
G4double	GetImportantEnergy () const
G4bool	IsMagneticMomentEnabled () const
G4bool	EnableUseOfMagneticMoment (G4bool useMoment=true)
G4bool	SetHighLooperThresholds ()
G4bool	SetIntermediateLooperThresholds ()
G4bool	SetLowLooperThresholds ()
G4bool	SetSilenceAllLooperWarnings (G4bool val=true)
G4bool	GetSilenceAllLooperWarnings ()
void	StreamInfo (std::ostream &os) const
void	Dump () const

Static Public Member Functions
static G4TransportationParameters *	Instance ()
static G4bool	Exists ()

Friends
std::ostream &	operator<< (std::ostream &os, const G4TransportationParameters &)

Detailed Description

Definition at line 48 of file G4TransportationParameters.hh.

Constructor & Destructor Documentation

~G4TransportationParameters()

G4TransportationParameters::~G4TransportationParameters ( )

default

Member Function Documentation

Dump()

void G4TransportationParameters::Dump

(

)

const

Definition at line 133 of file G4TransportationParameters.cc.

{
  G4MUTEXLOCK(&transportParamsMutex);
  StreamInfo(G4cout);
  G4MUTEXUNLOCK(&transportParamsMutex);
}

EnableUseOfMagneticMoment()

G4bool G4TransportationParameters::EnableUseOfMagneticMoment

(

G4bool

useMoment = true

)

Definition at line 189 of file G4TransportationParameters.cc.

{
  if(IsLocked()) { return false; }   
  fUseMagneticMoment= useMoment;
  return true;
}

Exists()

static G4bool G4TransportationParameters::Exists ( )

inlinestatic

Definition at line 76 of file G4TransportationParameters.hh.

{ return theInstance != nullptr; } 

Referenced by G4Transportation::G4Transportation().

GetImportantEnergy()

G4double G4TransportationParameters::GetImportantEnergy ( ) const

inline

Definition at line 61 of file G4TransportationParameters.hh.

{ return fImportantEnergy; }

Referenced by StreamInfo().

GetNumberOfTrials()

G4int G4TransportationParameters::GetNumberOfTrials ( ) const

inline

Definition at line 59 of file G4TransportationParameters.hh.

{ return fNumberOfTrials; }

Referenced by StreamInfo().

GetSilenceAllLooperWarnings()

G4bool G4TransportationParameters::GetSilenceAllLooperWarnings ( )

inline

Definition at line 73 of file G4TransportationParameters.hh.

{ return fSilenceLooperWarnings; }

GetWarningEnergy()

G4double G4TransportationParameters::GetWarningEnergy ( ) const

inline

Definition at line 60 of file G4TransportationParameters.hh.

{ return fWarningEnergy; }

Referenced by StreamInfo().

Instance()

G4TransportationParameters * G4TransportationParameters::Instance ( )

static

Definition at line 55 of file G4TransportationParameters.cc.

{
  if(theInstance == nullptr) {      
    G4MUTEXLOCK(&transportParamsMutex);
    if(theInstance == nullptr) {        
      static G4TransportationParameters manager;
      theInstance = &manager;
    }
    G4MUTEXUNLOCK(&transportParamsMutex);
  }
  return theInstance;
}

Referenced by G4Transportation::G4Transportation().

IsMagneticMomentEnabled()

G4bool G4TransportationParameters::IsMagneticMomentEnabled ( ) const

inline

Definition at line 62 of file G4TransportationParameters.hh.

{ return fUseMagneticMoment; }

SetHighLooperThresholds()

G4bool G4TransportationParameters::SetHighLooperThresholds

(

)

Definition at line 142 of file G4TransportationParameters.cc.

{
  if(IsLocked()) { return false; }
  
  // Restores the old high values -- potentially appropriate for energy-frontier
  //   HEP experiments.
  // Caution:  All tracks with E < 100 MeV that are found to loop are 
  SetWarningEnergy(    100.0 * CLHEP::MeV ); // Warn above this energy
  SetImportantEnergy(  250.0 * CLHEP::MeV ); // Extra trial above this En
 
  G4int maxTrials = 10;
  SetNumberOfTrials( maxTrials );
  
  return true;
}

SetImportantEnergy()

G4bool G4TransportationParameters::SetImportantEnergy

(

G4double

val

)

Definition at line 106 of file G4TransportationParameters.cc.

{
   if(IsLocked()) { return false; }
   fImportantEnergy = val;
 
   // Consistency check -- and trial fix   
   if( fImportantEnergy < fWarningEnergy )
      fWarningEnergy = fImportantEnergy;
   
   return true;
}

Referenced by SetHighLooperThresholds(), and SetLowLooperThresholds().

SetIntermediateLooperThresholds()

G4bool G4TransportationParameters::SetIntermediateLooperThresholds

(

)

Definition at line 160 of file G4TransportationParameters.cc.

{
  if(IsLocked()) { return false; } // Currently must not change during loop - may relax
 
  // Medium values -- reasonable default for an unknown application
  fWarningEnergy=     1.0 * CLHEP::MeV; // Warn above this energy
  fImportantEnergy=  10.0 * CLHEP::MeV; // Extra trial above this En
  fNumberOfTrials= 10;
  return true;
}

SetLowLooperThresholds()

G4bool G4TransportationParameters::SetLowLooperThresholds

(

)

Definition at line 173 of file G4TransportationParameters.cc.

{
  if(IsLocked()) { return false; }
  
  // These values were the default in Geant4 10.5 - beta
  SetWarningEnergy(     1.0 * CLHEP::keV ); // Warn above this En
  SetImportantEnergy(   1.0 * CLHEP::MeV ); // Extra trials above it
 
  G4int maxTrials = 30;
  SetNumberOfTrials( maxTrials );
 
  return true;  
}

SetNumberOfTrials()

G4bool G4TransportationParameters::SetNumberOfTrials

(

G4int

val

)

Definition at line 83 of file G4TransportationParameters.cc.

{
   if(IsLocked()) { return false; }
   fNumberOfTrials = val;
   return true;
}

Referenced by SetHighLooperThresholds(), and SetLowLooperThresholds().

SetSilenceAllLooperWarnings()

G4bool G4TransportationParameters::SetSilenceAllLooperWarnings

(

G4bool

val = true

)

Definition at line 199 of file G4TransportationParameters.cc.

{
  if(IsLocked()) { return false; }
  fSilenceLooperWarnings= val;
  return true;
}   

SetWarningEnergy()

G4bool G4TransportationParameters::SetWarningEnergy

(

G4double

val

)

Definition at line 92 of file G4TransportationParameters.cc.

{
   if(IsLocked()) { return false; }
   fWarningEnergy = val;
 
   // Consistency check -- and trial fix
   if( fWarningEnergy > fImportantEnergy   )
      fImportantEnergy = fWarningEnergy;
   
   return true;      
}

Referenced by SetHighLooperThresholds(), and SetLowLooperThresholds().

StreamInfo()

void G4TransportationParameters::StreamInfo

(

std::ostream &

os

)

const

Definition at line 120 of file G4TransportationParameters.cc.

{
  auto prec = os.precision(5);
 
  os << "Transport Parameters:  " << G4endl;
  os << "   Warning   energy = " << GetWarningEnergy()   / CLHEP::MeV << " MeV " << G4endl;
  os << "   Important energy = " << GetImportantEnergy() / CLHEP::MeV << " MeV " << G4endl;
  os << "   Number of trials = " << GetNumberOfTrials() << G4endl;
  os.precision(prec);
}

Referenced by Dump().

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, const G4TransportationParameters &    )

friend

---

The documentation for this class was generated from the following files:

• G4TransportationParameters.hh
• G4TransportationParameters.cc