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

Sinusoidal modulator as a function of global time. More...

#include <BDSModulatorSinT.hh>

Inheritance diagram for BDSModulatorSinT:
Inheritance graph
Collaboration diagram for BDSModulatorSinT:
Collaboration graph

Public Member Functions

 BDSModulatorSinT (G4double frequencyIn, G4double phaseIn=0, G4double amplitudeOffsetIn=0, 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 the wavlength / 20 of the oscillator.
 
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 angularFrequency
 
G4double phase
 
G4double offset
 
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

Sinusoidal modulator as a function of global time.

factor = offset + scale * sin(2pi*frequency*T + phase)

Author
Fabian Metzger

Definition at line 33 of file BDSModulatorSinT.hh.

Constructor & Destructor Documentation

◆ BDSModulatorSinT()

BDSModulatorSinT::BDSModulatorSinT ( G4double  frequencyIn,
G4double  phaseIn = 0,
G4double  amplitudeOffsetIn = 0,
G4double  amplitudeScaleIn = 1.0 
)
explicit

Definition at line 29 of file BDSModulatorSinT.cc.

Member Function Documentation

◆ Factor()

G4double BDSModulatorSinT::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 BDSModulatorSinT.cc.

◆ RecommendedMaxStepLength()

G4double BDSModulatorSinT::RecommendedMaxStepLength ( ) const
virtual

Return the wavlength / 20 of the oscillator.

Implements BDSModulator.

Definition at line 49 of file BDSModulatorSinT.cc.

◆ VariesWithTime()

virtual G4bool BDSModulatorSinT::VariesWithTime ( ) const
inlinevirtual

Each derived class should override this.

Implements BDSModulator.

Definition at line 47 of file BDSModulatorSinT.hh.

Field Documentation

◆ angularFrequency

G4double BDSModulatorSinT::angularFrequency
private

Definition at line 53 of file BDSModulatorSinT.hh.

◆ offset

G4double BDSModulatorSinT::offset
private

Definition at line 55 of file BDSModulatorSinT.hh.

◆ phase

G4double BDSModulatorSinT::phase
private

Definition at line 54 of file BDSModulatorSinT.hh.

◆ scale

G4double BDSModulatorSinT::scale
private

Definition at line 56 of file BDSModulatorSinT.hh.


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