Gabriele Cosmo
465 lines
16 KiB
C++
465 lines
16 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. *
|
|
// ********************************************************************
|
|
//
|
|
//
|
|
// $Id: G4VProcess.hh,v 1.23 2006/06/29 21:07:50 gunter Exp $
|
|
// GEANT4 tag $Name: geant4-09-00 $
|
|
//
|
|
//
|
|
// ------------------------------------------------------------
|
|
// GEANT 4 class header file
|
|
//
|
|
// History: first implementation, based on object model of
|
|
// 2nd December 1995, G.Cosmo
|
|
//
|
|
// Class Description
|
|
// This class is the virtual class for physics process objects.
|
|
// It defines public methods which describe the behavior of
|
|
// a physics process.
|
|
//
|
|
// ------------------------------------------------------------
|
|
// New Physics scheme 18 Dec. 1996 H.Kurahige
|
|
// ------------------------------------------------------------
|
|
// change DoIt/GetPIL arguments type 20 Mar. 1997 H.Kurashige
|
|
// modified AlongStepGPIL 17 Dec. 1997 H.Kurashige
|
|
// modified for new ParticleChange 12 Mar. 1998 H.Kurashige
|
|
// Add process trype 27 Mar. 1998 H.Kurashige
|
|
// Remove thePhysicsTable 2 Aug. 1998 H.Kurashige
|
|
// Add PILfactor and GPIL 3 Nov. 2000 H.Kurashige
|
|
// Add Store/RetrievePhysicsTable 8 Nov. 2000 H.Kurashige
|
|
// Modify Store/RetrievePhysicsTable methods 9 Mar. 2001 H.Kurashige
|
|
// Added PreparePhysicsTable 20 Aug. 2004 H.Kurashige
|
|
|
|
#ifndef G4VProcess_h
|
|
#define G4VProcess_h 1
|
|
|
|
#include "globals.hh"
|
|
#include <cmath>
|
|
#include "G4ios.hh"
|
|
|
|
class G4ParticleDefinition;
|
|
class G4DynamicParticle;
|
|
class G4Track;
|
|
class G4Step;
|
|
|
|
#include "G4PhysicsTable.hh"
|
|
#include "G4VParticleChange.hh"
|
|
#include "G4ForceCondition.hh"
|
|
#include "G4GPILSelection.hh"
|
|
#include "G4ParticleChange.hh"
|
|
#include "G4ProcessType.hh"
|
|
|
|
class G4VProcess
|
|
{
|
|
// A virtual class for physics process objects. It defines
|
|
// public methods which describe the behavior of a
|
|
// physics process.
|
|
|
|
private:
|
|
// hide default constructor and assignment operator as private
|
|
// do not hide default constructor for alpha version
|
|
// G4VProcess G4VProcess();
|
|
G4VProcess & operator=(const G4VProcess &right);
|
|
|
|
public: // with description
|
|
// constructor requires the process name and type
|
|
G4VProcess(const G4String& aName = "NoName",
|
|
G4ProcessType aType = fNotDefined );
|
|
|
|
// copy constructor copys the name but does not copy the
|
|
// physics table (0 pointer is assigned)
|
|
G4VProcess(const G4VProcess &right);
|
|
|
|
public:
|
|
// destructor
|
|
virtual ~G4VProcess();
|
|
|
|
// equal opperators
|
|
G4int operator==(const G4VProcess &right) const;
|
|
G4int operator!=(const G4VProcess &right) const;
|
|
|
|
public: // with description
|
|
////////////////////////////
|
|
// DoIt /////////////////
|
|
///////////////////////////
|
|
virtual G4VParticleChange* PostStepDoIt(
|
|
const G4Track& track,
|
|
const G4Step& stepData
|
|
) = 0;
|
|
|
|
virtual G4VParticleChange* AlongStepDoIt(
|
|
const G4Track& track,
|
|
const G4Step& stepData
|
|
) = 0;
|
|
virtual G4VParticleChange* AtRestDoIt(
|
|
const G4Track& track,
|
|
const G4Step& stepData
|
|
) = 0;
|
|
// A virtual base class function that has to be overridden
|
|
// by any subclass. The DoIt method actually performs the
|
|
// physics process and determines either momentum change
|
|
// of the production of secondaries etc.
|
|
// arguments
|
|
// const G4Track& track:
|
|
// reference to the current G4Track information
|
|
// const G4Step& stepData:
|
|
// reference to the current G4Step information
|
|
|
|
//////////////////////////
|
|
// GPIL //////////////
|
|
/////////////////////////
|
|
virtual G4double AlongStepGetPhysicalInteractionLength(
|
|
const G4Track& track,
|
|
G4double previousStepSize,
|
|
G4double currentMinimumStep,
|
|
G4double& proposedSafety,
|
|
G4GPILSelection* selection) = 0;
|
|
|
|
virtual G4double AtRestGetPhysicalInteractionLength(
|
|
const G4Track& track,
|
|
G4ForceCondition* condition
|
|
) = 0;
|
|
|
|
virtual G4double PostStepGetPhysicalInteractionLength(
|
|
const G4Track& track,
|
|
G4double previousStepSize,
|
|
G4ForceCondition* condition
|
|
) = 0;
|
|
|
|
// Returns the Step-size (actual length) which is allowed
|
|
// by "this" process. (for AtRestGetPhysicalInteractionLength,
|
|
// return value is Step-time) The NumberOfInteractionLengthLeft is
|
|
// recalculated by using previousStepSize and the Step-size is
|
|
// calucalted accoding to the resultant NumberOfInteractionLengthLeft.
|
|
// using NumberOfInteractionLengthLeft, which is recalculated at
|
|
// arguments
|
|
// const G4Track& track:
|
|
// reference to the current G4Track information
|
|
// G4double* previousStepSize:
|
|
// the Step-size (actual length) of the previous Step
|
|
// of this track. Negative calue indicates that
|
|
// NumberOfInteractionLengthLeft must be reset.
|
|
// the current physical interaction legth of this process
|
|
// G4ForceCondition* condition:
|
|
// the flag indicates DoIt of this process is forced
|
|
// to be called
|
|
// Forced: Corresponding DoIt is forced
|
|
// NotForced: Corresponding DoIt is called
|
|
// if the Step size of this Step is determined
|
|
// by this process
|
|
// !! AlongStepDoIt is always called !!
|
|
// G4double& currentMinimumStep:
|
|
// this value is used for transformation of
|
|
// true path length to geometrical path length
|
|
|
|
G4double GetCurrentInteractionLength() const;
|
|
// Returns currentInteractionLength
|
|
|
|
////////// PIL factor ////////
|
|
void SetPILfactor(G4double value);
|
|
G4double GetPILfactor() const;
|
|
// Set/Get factor for PhysicsInteractionLength
|
|
// which is passed to G4SteppingManager for both AtRest and PostStep
|
|
|
|
// These three GPIL methods are used by Stepping Manager.
|
|
// They invoke virtual GPIL methods listed above.
|
|
// As for AtRest and PostStep the returned value is multipled by thePILfactor
|
|
//
|
|
G4double AlongStepGPIL( const G4Track& track,
|
|
G4double previousStepSize,
|
|
G4double currentMinimumStep,
|
|
G4double& proposedSafety,
|
|
G4GPILSelection* selection );
|
|
|
|
G4double AtRestGPIL( const G4Track& track,
|
|
G4ForceCondition* condition );
|
|
|
|
G4double PostStepGPIL( const G4Track& track,
|
|
G4double previousStepSize,
|
|
G4ForceCondition* condition );
|
|
|
|
//////////////////////
|
|
virtual G4bool IsApplicable(const G4ParticleDefinition&){return true;};
|
|
// Returns true if this process object is applicable to
|
|
// the particle type
|
|
// Process will not be registered to a particle if IsApplicable is false
|
|
|
|
virtual void BuildPhysicsTable(const G4ParticleDefinition&){};
|
|
// Messaged by the Particle definition (via the Process manager)
|
|
// whenever cross section tables have to be rebuilt (i.e. if new
|
|
// materials have been defined).
|
|
// It is overloaded by individual processes when they need physics
|
|
// tables.
|
|
|
|
virtual void PreparePhysicsTable(const G4ParticleDefinition&){};
|
|
// Messaged by the Particle definition (via the Process manager)
|
|
// whenever cross section tables have to be prepare for rebuilt
|
|
// (i.e. if new materials have been defined).
|
|
// It is overloaded by individual processes when they need physics
|
|
// tables.
|
|
|
|
// Processes which Build physics tables independent of cuts
|
|
// (for example in their constructors)
|
|
// should preferably use private
|
|
// void BuildThePhysicsTable() and void PreparePhysicsTable().
|
|
// Not another BuildPhysicsTable, please.
|
|
|
|
|
|
virtual G4bool StorePhysicsTable(const G4ParticleDefinition* ,
|
|
const G4String&,
|
|
G4bool ascii = false)
|
|
{ascii=false; return true;}
|
|
// Store PhysicsTable in a file.
|
|
// (return false in case of failure at I/O )
|
|
|
|
virtual G4bool RetrievePhysicsTable( const G4ParticleDefinition* ,
|
|
const G4String&,
|
|
G4bool ascii = false)
|
|
{ascii=false; return false;}
|
|
// Retrieve Physics from a file.
|
|
// (return true if the Physics Table can be build by using file)
|
|
// (return false if the process has no functionality or in case of failure)
|
|
// File name should be defined by each process
|
|
// and the file should be placed under the directory specifed by the argument.
|
|
const G4String& GetPhysicsTableFileName(const G4ParticleDefinition* ,
|
|
const G4String& directory,
|
|
const G4String& tableName,
|
|
G4bool ascii =false);
|
|
// this method is utility for Store/RetreivePhysicsTable
|
|
|
|
////////////////////////////
|
|
const G4String& GetProcessName() const;
|
|
// Returns the name of the process.
|
|
|
|
G4ProcessType GetProcessType() const;
|
|
// Returns the process type.
|
|
|
|
void SetProcessType(G4ProcessType );
|
|
// Set the process type.
|
|
|
|
static const G4String& GetProcessTypeName(G4ProcessType );
|
|
// Returns the process type name
|
|
|
|
virtual void StartTracking(G4Track*);
|
|
virtual void EndTracking();
|
|
// inform Start/End of tracking for each track to the physics process
|
|
|
|
public:
|
|
virtual void SetProcessManager(const G4ProcessManager*);
|
|
// A process manager set its own pointer when the process is registered
|
|
// the process Manager
|
|
virtual const G4ProcessManager* GetProcessManager();
|
|
// Get the process manager which the process belongs to
|
|
|
|
protected:
|
|
const G4ProcessManager* aProcessManager;
|
|
|
|
protected:
|
|
G4VParticleChange* pParticleChange;
|
|
// The pointer to G4VParticleChange object
|
|
// which is modified and returned by address by the DoIt() method.
|
|
// This pointer should be set in each physics process
|
|
// after construction of derived class object.
|
|
|
|
G4ParticleChange aParticleChange;
|
|
// This object is kept for compatibility with old scheme
|
|
// This will be removed in future
|
|
|
|
G4double theNumberOfInteractionLengthLeft;
|
|
// The flight length left for the current tracking particle
|
|
// in unit of "Interaction length".
|
|
|
|
G4double currentInteractionLength;
|
|
// The InteractionLength in the current material
|
|
|
|
public: // with description
|
|
virtual void ResetNumberOfInteractionLengthLeft();
|
|
// reset (determine the value of)NumberOfInteractionLengthLeft
|
|
|
|
protected: // with description
|
|
virtual void SubtractNumberOfInteractionLengthLeft(
|
|
G4double previousStepSize
|
|
);
|
|
// subtract NumberOfInteractionLengthLeft by the value corresponding to
|
|
// previousStepSize
|
|
|
|
virtual void ClearNumberOfInteractionLengthLeft();
|
|
// clear NumberOfInteractionLengthLeft
|
|
// !!! This method should be at the end of PostStepDoIt()
|
|
// !!! and AtRestDoIt
|
|
|
|
protected:
|
|
G4String theProcessName;
|
|
// The name of the process
|
|
|
|
G4String thePhysicsTableFileName;
|
|
|
|
G4ProcessType theProcessType;
|
|
// The type of the process
|
|
|
|
G4double thePILfactor;
|
|
// factor for PhysicsInteractionLength
|
|
// which is passed to G4SteppingManager
|
|
|
|
public: // with description
|
|
virtual void DumpInfo() const;
|
|
// dump out process information
|
|
|
|
public: // with description
|
|
void SetVerboseLevel(G4int value);
|
|
G4int GetVerboseLevel() const;
|
|
// set/get controle flag for output message
|
|
// 0: Silent
|
|
// 1: Warning message
|
|
// 2: More
|
|
|
|
|
|
protected:
|
|
G4int verboseLevel;
|
|
// controle flag for output message
|
|
|
|
};
|
|
|
|
// -----------------------------------------
|
|
// inlined function members implementation
|
|
// -----------------------------------------
|
|
#include "Randomize.hh"
|
|
|
|
inline
|
|
const G4String& G4VProcess::GetProcessName() const
|
|
{
|
|
return theProcessName;
|
|
}
|
|
|
|
inline
|
|
G4ProcessType G4VProcess::GetProcessType() const
|
|
{
|
|
return theProcessType;
|
|
}
|
|
|
|
inline
|
|
void G4VProcess::SetProcessType(G4ProcessType aType)
|
|
{
|
|
theProcessType = aType;
|
|
}
|
|
|
|
inline void G4VProcess::SetVerboseLevel(G4int value)
|
|
{
|
|
verboseLevel = value;
|
|
}
|
|
|
|
inline G4int G4VProcess::GetVerboseLevel() const
|
|
{
|
|
return verboseLevel;
|
|
}
|
|
|
|
inline void G4VProcess::ResetNumberOfInteractionLengthLeft()
|
|
{
|
|
theNumberOfInteractionLengthLeft = -std::log( G4UniformRand() );
|
|
}
|
|
|
|
inline void G4VProcess::ClearNumberOfInteractionLengthLeft()
|
|
{
|
|
theNumberOfInteractionLengthLeft = -1.0;
|
|
}
|
|
|
|
inline G4double G4VProcess::GetCurrentInteractionLength() const
|
|
{
|
|
return currentInteractionLength;
|
|
}
|
|
|
|
inline void G4VProcess::SetPILfactor(G4double value)
|
|
{
|
|
if (value>0.) {
|
|
thePILfactor = value;
|
|
}
|
|
}
|
|
|
|
inline G4double G4VProcess::GetPILfactor() const
|
|
{
|
|
return thePILfactor;
|
|
}
|
|
|
|
inline G4double G4VProcess::AlongStepGPIL( const G4Track& track,
|
|
G4double previousStepSize,
|
|
G4double currentMinimumStep,
|
|
G4double& proposedSafety,
|
|
G4GPILSelection* selection )
|
|
{
|
|
G4double value
|
|
=AlongStepGetPhysicalInteractionLength(track, previousStepSize, currentMinimumStep, proposedSafety, selection);
|
|
return value;
|
|
}
|
|
|
|
inline G4double G4VProcess::AtRestGPIL( const G4Track& track,
|
|
G4ForceCondition* condition )
|
|
{
|
|
G4double value
|
|
=AtRestGetPhysicalInteractionLength(track, condition);
|
|
return thePILfactor*value;
|
|
}
|
|
|
|
inline G4double G4VProcess::PostStepGPIL( const G4Track& track,
|
|
G4double previousStepSize,
|
|
G4ForceCondition* condition )
|
|
{
|
|
G4double value
|
|
=PostStepGetPhysicalInteractionLength(track, previousStepSize, condition);
|
|
return thePILfactor*value;
|
|
}
|
|
|
|
inline
|
|
void G4VProcess::SetProcessManager(const G4ProcessManager* procMan)
|
|
{
|
|
aProcessManager = procMan;
|
|
}
|
|
|
|
inline
|
|
const G4ProcessManager* G4VProcess::GetProcessManager()
|
|
{
|
|
return aProcessManager;
|
|
}
|
|
#endif
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|