BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes
BDSModulatorTopHatT Class Reference

Top-hat modulator as a function of T. More...

#include <BDSModulatorTopHatT.hh>

Inheritance diagram for BDSModulatorTopHatT:
Inheritance graph
Collaboration diagram for BDSModulatorTopHatT:
Collaboration graph

Public Member Functions

 BDSModulatorTopHatT (G4double T0, G4double T1, G4double amplitudeScaleIn=1.0)
 
virtual G4double Factor (const G4ThreeVector &xyz, G4double T) const
 Returns value of equation in brief at the top of this file.
 
virtual G4bool VariesWithTime () const
 Each derived class should override this.
 
virtual G4double RecommendedMaxStepLength () const
 Return difference in T0, T1 / 20.
 
virtual G4double Factor (const G4ThreeVector &xyz, G4double T) const =0
 
virtual G4bool VariesWithTime () const =0
 Each derived class should override this.
 
virtual G4double RecommendedMaxStepLength () const =0
 Must return the smallest spatial.
 

Private Attributes

G4double T0
 
G4double T1
 
G4double scale
 

Additional Inherited Members

- Static Public Member Functions inherited from BDSModulator
static void SetEventIndex (G4int eventIndexIn)
 Setter for the static counter so we can trace where it's used.
 
- Static Protected Attributes inherited from BDSModulator
static G4int eventIndex = 0
 

Detailed Description

Top-hat modulator as a function of T.

factor = amplitudeScale, T0 <= T <= T1 ; else 0

Author
Laurie Nevay

Definition at line 34 of file BDSModulatorTopHatT.hh.

Constructor & Destructor Documentation

◆ BDSModulatorTopHatT()

BDSModulatorTopHatT::BDSModulatorTopHatT ( G4double  T0,
G4double  T1,
G4double  amplitudeScaleIn = 1.0 
)
explicit

Definition at line 27 of file BDSModulatorTopHatT.cc.

Member Function Documentation

◆ Factor()

G4double BDSModulatorTopHatT::Factor ( const G4ThreeVector &  xyz,
G4double  T 
) const
virtual

Returns value of equation in brief at the top of this file.

Implements BDSModulator.

Definition at line 42 of file BDSModulatorTopHatT.cc.

◆ RecommendedMaxStepLength()

G4double BDSModulatorTopHatT::RecommendedMaxStepLength ( ) const
virtual

Return difference in T0, T1 / 20.

Implements BDSModulator.

Definition at line 48 of file BDSModulatorTopHatT.cc.

◆ VariesWithTime()

virtual G4bool BDSModulatorTopHatT::VariesWithTime ( ) const
inlinevirtual

Each derived class should override this.

Implements BDSModulator.

Definition at line 47 of file BDSModulatorTopHatT.hh.

Field Documentation

◆ scale

G4double BDSModulatorTopHatT::scale
private

Definition at line 55 of file BDSModulatorTopHatT.hh.

◆ T0

G4double BDSModulatorTopHatT::T0
private

Definition at line 53 of file BDSModulatorTopHatT.hh.

◆ T1

G4double BDSModulatorTopHatT::T1
private

Definition at line 54 of file BDSModulatorTopHatT.hh.


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