G4TransportationLogger Class Reference

#include <G4TransportationLogger.hh>

Public Member Functions
	G4TransportationLogger (const G4String &className, G4int verbosity)
	G4TransportationLogger (const char *className, G4int verbosity)
	~G4TransportationLogger ()
void	ReportLoopingTrack (const G4Track &track, const G4Step &stepInfo, G4int numTrials, G4long noCalls, const char *methodName) const
void	ReportLooperThresholds (const char *className)
void	SetThresholds (G4double newEnWarn, G4double importantEnergy, G4int newMaxTrials)
G4int	GetVerboseLevel () const
void	SetVerboseLevel (G4int level)
G4double	GetThresholdWarningEnergy () const
G4double	GetThresholdImportantEnergy () const
G4double	GetThresholdTrials () const
void	SetThresholdWarningEnergy (G4double val)
void	SetThresholdImportantEnergy (G4double val)
void	SetThresholdTrials (G4int maxNoTrials)

Detailed Description

Definition at line 47 of file G4TransportationLogger.hh.

Constructor & Destructor Documentation

G4TransportationLogger() [1/2]

G4TransportationLogger::G4TransportationLogger	(	const G4String &	className,
		G4int	verbosity
	)

Definition at line 42 of file G4TransportationLogger.cc.

   : fClassName(className), fVerbose(verbosity),
     fThldWarningEnergy(0.), fThldImportantEnergy(0.), fThldTrials(0)
{
}

G4TransportationLogger() [2/2]

G4TransportationLogger::G4TransportationLogger	(	const char *	className,
		G4int	verbosity
	)

Definition at line 49 of file G4TransportationLogger.cc.

   : fClassName(className), fVerbose(verbosity),
     fThldWarningEnergy(0.), fThldImportantEnergy(0.), fThldTrials(0)
{
}

~G4TransportationLogger()

G4TransportationLogger::~G4TransportationLogger

(

)

Definition at line 56 of file G4TransportationLogger.cc.

{
}

Member Function Documentation

GetThresholdImportantEnergy()

G4double G4TransportationLogger::GetThresholdImportantEnergy ( ) const

inline

Definition at line 77 of file G4TransportationLogger.hh.

{ return fThldImportantEnergy; }

Referenced by ReportLooperThresholds().

GetThresholdTrials()

G4double G4TransportationLogger::GetThresholdTrials ( ) const

inline

Definition at line 78 of file G4TransportationLogger.hh.

{ return fThldTrials; }

Referenced by ReportLooperThresholds(), and ReportLoopingTrack().

GetThresholdWarningEnergy()

G4double G4TransportationLogger::GetThresholdWarningEnergy ( ) const

inline

Definition at line 76 of file G4TransportationLogger.hh.

{ return fThldWarningEnergy; }

Referenced by ReportLooperThresholds(), and ReportLoopingTrack().

GetVerboseLevel()

G4int G4TransportationLogger::GetVerboseLevel ( ) const

inline

Definition at line 71 of file G4TransportationLogger.hh.

{ return fVerbose; }

ReportLooperThresholds()

void G4TransportationLogger::ReportLooperThresholds

(

const char *

className

)

Definition at line 75 of file G4TransportationLogger.cc.

{
   G4cout << className << ":  Current values for thresholds related to "
          << " the killing of looping tracks: " << G4endl
          <<  "    Warning Energy   = " << GetThresholdWarningEnergy() / CLHEP::MeV << " MeV "
          <<  "  ( below this tracks are killed without warning ) " << G4endl
          <<  "    Important Energy = " << GetThresholdImportantEnergy() / CLHEP::MeV
          <<  "  ( above this tracks are given multiple chances ) " << G4endl
          <<  "    Extra Trials     = " << GetThresholdTrials()
          << " 'important' tracks, i.e. those above 'important' energy "
          << G4endl;
}

Referenced by G4CoupledTransportation::ReportLooperThresholds(), and G4Transportation::ReportLooperThresholds().

ReportLoopingTrack()

void G4TransportationLogger::ReportLoopingTrack	(	const G4Track &	track,
		const G4Step &	stepInfo,
		G4int	numTrials,
		G4long	noCalls,
		const char *	methodName
	)		const

Definition at line 92 of file G4TransportationLogger.cc.

{
  static std::atomic<unsigned int> numAdviceExcessSteps(0);
  constexpr double gramPerCm3 = gram / ( centimeter * centimeter * centimeter ) ;
  std::ostringstream msg;
  auto preStepPt= stepData.GetPreStepPoint();
  auto preStepEn= preStepPt ? preStepPt->GetKineticEnergy() / MeV : -1.0 ;
  msg << " Transportation is killing track that is looping or stuck. " << G4endl
      << "   Track is "
      << track.GetParticleDefinition()->GetParticleName()
      << " and has " << track.GetKineticEnergy() / MeV
      << " MeV energy  ( pre-Step = " << preStepEn << " ) " << G4endl;
  msg << "   momentum = " << track.GetMomentum() << " mag= " << track.GetMomentum().mag()
      << G4endl
      << "   position = " << track.GetPosition();
  auto physVolume= track.GetVolume();
  auto material= physVolume->GetLogicalVolume()->GetMaterial();
  msg << " is in volume '" << physVolume->GetName() << "', ";
  if( material )
  {
     msg << " its material is '" << material->GetName() << "'";
     msg << " with density = " << material->GetDensity() / gramPerCm3
         << " g/cm^3 ";
  }
  else
  {
     msg << " unable to obtain material information (including density.) ";
  }
  msg << G4endl;
  msg << " Total number of Steps by this track: " << track.GetCurrentStepNumber()
      << G4endl
      << " Length of this step = " << stepData.GetStepLength() / mm << " mm "
      << G4endl     
      << " Number of propagation trials = " << numTrials
      << " ( vs maximum = " << GetThresholdTrials() << " for 'important' particles ) " 
      << G4endl
      << "   ( Number of *calls* of Transport/AlongStepDoIt = " << noCalls << " )"
      << G4endl;
 
  const G4int numPrints= 5;
  if( numAdviceExcessSteps++ < numPrints )
  { 
     msg << " =============== Recommendations / advice ====================" << G4endl;             
     msg << " Recommendations to address this issue (Transport-001-ExcessSteps)" << G4endl;
     msg << " This warning is controlled by the SetThresholdWarningEnergy "
         << " method of G4Transportation.  " << G4endl
         << " Current value of 'warning' threshold= "
         << GetThresholdWarningEnergy() / MeV << " MeV " << G4endl;
     msg << " - If 'unimportant' particles (with energy low enough not to matter in your "
         << "  application, then increase its value. "   << G4endl;
     msg << " - If particles of high-enough energy to be important are being "
         << " killed, you can " << G4endl
         << "   a) Increase the trial steps using the method  SetThresholdTrials().  "
         << "  Particles above the 'important' threshold " << G4endl
         << "  will be given this many 'chances'."
         << "  The default value was 10, and the current value is " << GetThresholdTrials()
         << G4endl
         << "   b) Increase the energy which you consider 'important' (above this they are"
         << " killed only after extra trials), using the method SetThresholdImportantEnergy() " << G4endl
         << "      Note: this can incur a potentially high cost in extra simulation time " 
         << " if more tracks require very large number of integration steps . " << G4endl
         << "   c) investigate alternative integration methods " << G4endl
         << "    e.g.  Helical methods for uniform or almost uniform fields"
         << " or else higher order RK methods such as DormandPrince78 "
         << G4endl;
     msg << " This information is provided " << numPrints << " times. Current count: "
         << numAdviceExcessSteps << " / " << numPrints << G4endl;
     msg << " =============================================================" << G4endl;
  }
  const G4String fullMethodName= fClassName + "::" + methodName;
  G4Exception( fullMethodName, "Transport-001-ExcessSteps", JustWarning, msg);
}

Referenced by G4CoupledTransportation::AlongStepDoIt(), and G4Transportation::AlongStepDoIt().

SetThresholdImportantEnergy()

void G4TransportationLogger::SetThresholdImportantEnergy ( G4double  val )

inline

Definition at line 81 of file G4TransportationLogger.hh.

{ fThldImportantEnergy= val; }

Referenced by SetThresholds().

SetThresholds()

void G4TransportationLogger::SetThresholds	(	G4double	newEnWarn,
		G4double	importantEnergy,
		G4int	newMaxTrials
	)

Definition at line 63 of file G4TransportationLogger.cc.

{
   SetThresholdWarningEnergy( newEnWarn );
   SetThresholdImportantEnergy( importantEnergy );
   SetThresholdTrials(newMaxTrials );
}

SetThresholdTrials()

void G4TransportationLogger::SetThresholdTrials ( G4int  maxNoTrials )

inline

Definition at line 82 of file G4TransportationLogger.hh.

{ fThldTrials = std::max( maxNoTrials, 1); }

Referenced by SetThresholds().

SetThresholdWarningEnergy()

void G4TransportationLogger::SetThresholdWarningEnergy ( G4double  val )

inline

Definition at line 80 of file G4TransportationLogger.hh.

{ fThldWarningEnergy= val; }

Referenced by SetThresholds().

SetVerboseLevel()

void G4TransportationLogger::SetVerboseLevel ( G4int  level )

inline

Definition at line 72 of file G4TransportationLogger.hh.

{ fVerbose = level; }

---

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

• G4TransportationLogger.hh
• G4TransportationLogger.cc