BDSModulator Class Reference

Base class for a modulator. More...

#include <BDSModulator.hh>

Inheritance diagram for BDSModulator:

Collaboration diagram for BDSModulator:

Public Member Functions
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.

Static Public Member Functions
static void	SetEventIndex (G4int eventIndexIn)
	Setter for the static counter so we can trace where it's used.

Static Protected Attributes
static G4int	eventIndex = 0

Detailed Description

Base class for a modulator.

A modulator returns a numerical factor based on x,y,z,t,eventNumber.

Turn number can also be used and should be accessed through BDSGlobalConstants in the derived class that would wish to use this (static) variable.

Author

Fabian Metzger

Definition at line 36 of file BDSModulator.hh.

Member Function Documentation

Factor()

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

pure virtual

Derived class must implement this. T is global, others are presumed to be local coordinates.

Implemented in BDSModulatorSinT, and BDSModulatorTopHatT.

Referenced by BDSFieldE::GetFieldTransformed(), BDSFieldEM::GetFieldTransformed(), and BDSFieldMag::GetFieldTransformed().

Here is the caller graph for this function:

RecommendedMaxStepLength()

virtual G4double BDSModulator::RecommendedMaxStepLength ( ) const

pure virtual

Must return the smallest spatial.

Implemented in BDSModulatorSinT, and BDSModulatorTopHatT.

Referenced by BDSFieldFactory::CreateFieldEM(), BDSFieldFactory::CreateFieldERaw(), and BDSFieldFactory::CreateFieldMagRaw().

Here is the caller graph for this function:

SetEventIndex()

void BDSModulator::SetEventIndex ( G4int  eventIndexIn )

static

Setter for the static counter so we can trace where it's used.

Definition at line 23 of file BDSModulator.cc.

VariesWithTime()

virtual G4bool BDSModulator::VariesWithTime ( ) const

pure virtual

Each derived class should override this.

Implemented in BDSModulatorSinT, and BDSModulatorTopHatT.

Referenced by BDSFieldFactory::CreateFieldEM(), BDSFieldFactory::CreateFieldERaw(), and BDSFieldFactory::CreateFieldMagRaw().

Here is the caller graph for this function:

Field Documentation

eventIndex

G4int BDSModulator::eventIndex = 0

staticprotected

Definition at line 57 of file BDSModulator.hh.

---

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

• /Users/lnevay/physics/reps/bdsim/include/BDSModulator.hh
• /Users/lnevay/physics/reps/bdsim/src/BDSModulator.cc