Gabriele Cosmo
279 lines
12 KiB
C++
279 lines
12 KiB
C++
//
|
|
// ********************************************************************
|
|
// * 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. *
|
|
// ********************************************************************
|
|
//
|
|
// G4MagInt_Driver
|
|
//
|
|
// Class description:
|
|
//
|
|
// Provides a driver that talks to the Integrator Stepper, and insures that
|
|
// the error is within acceptable bounds.
|
|
|
|
// V.Grichine, 07.10.1996 - Created
|
|
// W.Wander, 28.01.1998 - Added ability for low order integrators
|
|
// J.Apostolakis, 08.11.2001 - Respect minimum step in AccurateAdvance
|
|
// --------------------------------------------------------------------
|
|
#ifndef G4MAGINT_DRIVER_HH
|
|
#define G4MAGINT_DRIVER_HH
|
|
|
|
#include "G4VIntegrationDriver.hh"
|
|
#include "G4MagIntegratorStepper.hh"
|
|
#include "G4ChordFinderDelegate.hh"
|
|
|
|
class G4MagInt_Driver : public G4VIntegrationDriver,
|
|
public G4ChordFinderDelegate<G4MagInt_Driver>
|
|
{
|
|
public: // with description
|
|
|
|
G4MagInt_Driver(G4double hminimum,
|
|
G4MagIntegratorStepper* pItsStepper,
|
|
G4int numberOfComponents = 6,
|
|
G4int statisticsVerbosity = 0);
|
|
virtual ~G4MagInt_Driver() override;
|
|
// Constructor, destructor.
|
|
|
|
G4MagInt_Driver(const G4MagInt_Driver&) = delete;
|
|
G4MagInt_Driver& operator=(const G4MagInt_Driver&) = delete;
|
|
|
|
inline virtual G4double AdvanceChordLimited(G4FieldTrack& track,
|
|
G4double stepMax,
|
|
G4double epsStep,
|
|
G4double chordDistance) override;
|
|
|
|
inline virtual void OnStartTracking() override;
|
|
inline virtual void OnComputeStep() override {};
|
|
virtual G4bool DoesReIntegrate() const override { return true; }
|
|
|
|
virtual G4bool AccurateAdvance(G4FieldTrack& y_current,
|
|
G4double hstep,
|
|
G4double eps, // Requested y_err/hstep
|
|
G4double hinitial = 0.0) override;
|
|
// Above drivers for integrator (Runge-Kutta) with stepsize control.
|
|
// Integrates ODE starting values y_current
|
|
// from current s (s=s0) to s=s0+h with accuracy eps.
|
|
// On output ystart is replaced by value at end of interval.
|
|
// The concept is similar to the odeint routine from NRC p.721-722.
|
|
|
|
virtual G4bool QuickAdvance(G4FieldTrack& y_val, // INOUT
|
|
const G4double dydx[],
|
|
G4double hstep,
|
|
G4double& dchord_step,
|
|
G4double& dyerr) override;
|
|
// QuickAdvance just tries one Step - it does not ensure accuracy.
|
|
|
|
void StreamInfo( std::ostream& os ) const override;
|
|
// Write out the parameters / state of the driver
|
|
|
|
G4bool QuickAdvance(G4FieldTrack& y_posvel, // INOUT
|
|
const G4double dydx[],
|
|
G4double hstep, // IN
|
|
G4double& dchord_step,
|
|
G4double& dyerr_pos_sq,
|
|
G4double& dyerr_mom_rel_sq );
|
|
// New QuickAdvance that also just tries one Step
|
|
// (so also does not ensure accuracy)
|
|
// but does return the errors in position and
|
|
// momentum (normalised: Delta_Integration(p^2)/(p^2) )
|
|
|
|
inline G4double GetHmin() const;
|
|
inline G4double Hmin() const; // Obsolete
|
|
inline G4double GetSafety() const;
|
|
inline G4double GetPshrnk() const;
|
|
inline G4double GetPgrow() const;
|
|
inline G4double GetErrcon() const;
|
|
virtual void GetDerivatives(const G4FieldTrack& y_curr, // INput
|
|
G4double dydx[]) const override; // OUTput
|
|
|
|
virtual void GetDerivatives(const G4FieldTrack& track,
|
|
G4double dydx[],
|
|
G4double field[]) const override;
|
|
// Accessors
|
|
|
|
virtual G4EquationOfMotion* GetEquationOfMotion() override;
|
|
virtual void SetEquationOfMotion(G4EquationOfMotion* equation) override;
|
|
|
|
virtual void RenewStepperAndAdjust(G4MagIntegratorStepper* pItsStepper) override;
|
|
// Sets a new stepper pItsStepper for this driver. Then it calls
|
|
// ReSetParameters to reset its parameters accordingly.
|
|
|
|
inline void ReSetParameters(G4double new_safety = 0.9);
|
|
// i) sets the exponents (pgrow & pshrnk),
|
|
// using the current Stepper's order,
|
|
// ii) sets the safety
|
|
// ii) calculates "errcon" according to the above values.
|
|
|
|
inline void SetSafety(G4double valS);
|
|
inline void SetPshrnk(G4double valPs);
|
|
inline void SetPgrow (G4double valPg);
|
|
inline void SetErrcon(G4double valEc);
|
|
// When setting safety or pgrow, errcon will be set to a compatible value.
|
|
|
|
inline G4double ComputeAndSetErrcon();
|
|
|
|
virtual const G4MagIntegratorStepper* GetStepper() const override;
|
|
virtual G4MagIntegratorStepper* GetStepper() override;
|
|
|
|
void OneGoodStep(G4double ystart[], // Like old RKF45step()
|
|
const G4double dydx[],
|
|
G4double& x,
|
|
G4double htry,
|
|
G4double eps, // memb variables ?
|
|
G4double& hdid,
|
|
G4double& hnext ) ;
|
|
// This takes one Step that is as large as possible while
|
|
// satisfying the accuracy criterion of:
|
|
// yerr < eps * |y_end-y_start|
|
|
|
|
virtual G4double ComputeNewStepSize(G4double errMaxNorm, // normalised
|
|
G4double hstepCurrent) override;
|
|
// Taking the last step's normalised error, calculate
|
|
// a step size for the next step.
|
|
// Does it limit the next step's size within a factor of the current?
|
|
// -- DOES NOT limit for very bad steps
|
|
// -- DOES limit for very good (x5)
|
|
|
|
G4double
|
|
ComputeNewStepSize_WithoutReductionLimit(G4double errMaxNorm,
|
|
G4double hstepCurrent);
|
|
// Taking the last step's normalised error, calculate
|
|
// a step size for the next step.
|
|
// Do not limit the next step's size within a factor of the
|
|
// current one when *reducing* the size, i.e. for badly failing steps.
|
|
|
|
G4double ComputeNewStepSize_WithinLimits(G4double errMaxNorm, // normalised
|
|
G4double hstepCurrent);
|
|
// Taking the last step's normalised error, calculate
|
|
// a step size for the next step.
|
|
// Limit the next step's size within a range around the current one.
|
|
|
|
inline G4int GetMaxNoSteps() const;
|
|
inline void SetMaxNoSteps(G4int val);
|
|
// Modify and Get the Maximum number of Steps that can be
|
|
// taken for the integration of a single segment -
|
|
// (i.e. a single call to AccurateAdvance).
|
|
|
|
public: // without description
|
|
|
|
inline void SetHmin(G4double newval);
|
|
virtual void SetVerboseLevel(G4int newLevel) override;
|
|
virtual G4int GetVerboseLevel() const override;
|
|
|
|
inline G4double GetSmallestFraction() const;
|
|
void SetSmallestFraction( G4double val );
|
|
|
|
protected: // without description
|
|
|
|
void WarnSmallStepSize(G4double hnext, G4double hstep,
|
|
G4double h, G4double xDone,
|
|
G4int noSteps);
|
|
|
|
void WarnTooManyStep(G4double x1start, G4double x2end, G4double xCurrent);
|
|
void WarnEndPointTooFar(G4double endPointDist,
|
|
G4double hStepSize ,
|
|
G4double epsilonRelative,
|
|
G4int debugFlag);
|
|
// Issue warnings for undesirable situations
|
|
|
|
void PrintStatus(const G4double* StartArr,
|
|
G4double xstart,
|
|
const G4double* CurrentArr,
|
|
G4double xcurrent,
|
|
G4double requestStep,
|
|
G4int subStepNo);
|
|
void PrintStatus(const G4FieldTrack& StartFT,
|
|
const G4FieldTrack& CurrentFT,
|
|
G4double requestStep,
|
|
G4int subStepNo);
|
|
void PrintStat_Aux(const G4FieldTrack& aFieldTrack,
|
|
G4double requestStep,
|
|
G4double actualStep,
|
|
G4int subStepNo,
|
|
G4double subStepSize,
|
|
G4double dotVelocities);
|
|
// Verbose output for debugging
|
|
|
|
void PrintStatisticsReport();
|
|
// Report on the number of steps, maximum errors etc.
|
|
|
|
#ifdef QUICK_ADV_TWO
|
|
G4bool QuickAdvance( G4double yarrin[], // In
|
|
const G4double dydx[],
|
|
G4double hstep,
|
|
G4double yarrout[], // Out
|
|
G4double& dchord_step, // Out
|
|
G4double& dyerr ); // in length
|
|
#endif
|
|
|
|
private:
|
|
|
|
// ---------------------------------------------------------------
|
|
// INVARIANTS
|
|
|
|
G4double fMinimumStep = 0.0;
|
|
// Minimum Step allowed in a Step (in absolute units)
|
|
G4double fSmallestFraction = 1.0e-12; // Expected range 1e-12 to 5e-15
|
|
// Smallest fraction of (existing) curve length - in relative units
|
|
// below this fraction the current step will be the last
|
|
|
|
const G4int fNoIntegrationVariables = 0; // Variables in integration
|
|
const G4int fMinNoVars = 12; // Minimum number for FieldTrack
|
|
const G4int fNoVars = 0; // Full number of variable
|
|
|
|
G4int fMaxNoSteps;
|
|
G4int fMaxStepBase = 250; // was 5000
|
|
// Default maximum number of steps is Base divided by the order of Stepper
|
|
|
|
G4double safety;
|
|
G4double pshrnk; // exponent for shrinking
|
|
G4double pgrow; // exponent for growth
|
|
G4double errcon;
|
|
// Parameters used to grow and shrink trial stepsize.
|
|
|
|
G4int fStatisticsVerboseLevel = 0;
|
|
|
|
// ---------------------------------------------------------------
|
|
// DEPENDENT Objects
|
|
|
|
G4MagIntegratorStepper* pIntStepper = nullptr;
|
|
|
|
// ---------------------------------------------------------------
|
|
// STATE
|
|
|
|
unsigned long fNoTotalSteps=0, fNoBadSteps=0;
|
|
unsigned long fNoSmallSteps=0, fNoInitialSmallSteps=0, fNoCalls=0;
|
|
G4double fDyerr_max=0.0, fDyerr_mx2=0.0;
|
|
G4double fDyerrPos_smTot=0.0, fDyerrPos_lgTot=0.0, fDyerrVel_lgTot=0.0;
|
|
G4double fSumH_sm=0.0, fSumH_lg=0.0;
|
|
// Step Statistics
|
|
|
|
G4int fVerboseLevel = 0; // Verbosity level for printing (debug, ..)
|
|
// Could be varied during tracking - to help identify issues
|
|
|
|
using ChordFinderDelegate = G4ChordFinderDelegate<G4MagInt_Driver>;
|
|
};
|
|
|
|
#include "G4MagIntegratorDriver.icc"
|
|
|
|
#endif
|