Basic options class independent of Geant4. More...

#include <optionsBase.h>

Inheritance diagram for GMAD::OptionsBase:

Collaboration diagram for GMAD::OptionsBase:

Public Member Functions
	OptionsBase ()

void	print () const
	print some properties

Data Fields
std::string	inputFileName
	Input filename.

std::string	visMacroFileName
	Visualisation filename.

std::string	geant4MacroFileName
	Geant4 macro to run.

std::string	geant4PhysicsMacroFileName
	Geant4 physics macro.

bool	geant4PhysicsMacroFileNameFromExecOptions

bool	visDebug
	Flag for visualisation debug.

bool	batch
	Flag for batch / interactive mode.

bool	verbose
	General verbosity.

int	verboseRunLevel
	Run level verbosity.

int	verboseTrackingLevel
	Tracking verbosity.

int	verboseImportanceSampling

bool	verboseSensitivity

bool	circular
	Flag for circular machine.

int	seed
	The seed value for the random number generator.

std::string	randomEngine
	Name of random engine to use.

int	nGenerate
	The number of primary events to simulate.

bool	recreate
	Whether to recreate from a file or not.

std::string	recreateFileName
	The file path to recreate a run from.

int	startFromEvent
	Event to start from when recreating.

bool	writeSeedState
	Write the seed state each event to a text file.

bool	useASCIISeedState
	Whether to use the seed state from an ASCII file.

std::string	seedStateFileName
	Seed state file path.

bool	generatePrimariesOnly
	Whether to only generate primary coordinates and quit, or not.

std::string	bdsimPath

std::string	physicsList
	list of physics processes

bool	physicsVerbose

int	physicsVerbosity

double	physicsEnergyLimitLow

double	physicsEnergyLimitHigh

bool	g4PhysicsUseBDSIMRangeCuts

bool	g4PhysicsUseBDSIMCutsAndLimits

int	eventOffset
	Event number to start from when recreating from a root file.

bool	recreateSeedState
	Load seed state when recreating events.

double	elossHistoBinWidth

double	ffact
	magnetic field flip (+1 default, -1: flip sign)

int	eventNumberOffset

bool	checkOverlaps
	bdsim options

double	xsize
	for element specification

double	ysize

std::string	magnetGeometryType
	default magnet geometry parameters

std::string	outerMaterialName

double	horizontalWidth

double	thinElementLength

bool	hStyle
	H Style dipoles (if not, C Style).

double	vhRatio

double	coilWidthFraction

double	coilHeightFraction

bool	ignoreLocalMagnetGeometry

bool	buildPoleFaceGeometry

bool	preprocessGDML
	geometry control

bool	preprocessGDMLSchema

bool	dontSplitSBends
	geometry debug, don't split bends into multiple segments

bool	yokeFields

bool	yokeFieldsMatchLHCGeometry

bool	useOldMultipoleOuterFields

double	scalingFieldOuter

bool	includeFringeFields

bool	includeFringeFieldsCavities

std::string	vacMaterial
	vacuum material

std::string	emptyMaterial
	material in container volumes

std::string	worldMaterial

std::string	worldGeometryFile

bool	autoColourWorldGeometryFile

std::string	importanceWorldGeometryFile

std::string	importanceVolumeMap

double	worldVolumeMargin
	Padding margin for world volume size.

double	vacuumPressure

bool	removeTemporaryFiles

std::string	temporaryDirectory

double	samplerDiameter

std::string	defaultBiasVacuum

std::string	defaultBiasMaterial

std::string	biasForWorldVolume

std::string	biasForWorldContents

std::string	biasForWorldVacuum

std::string	worldVacuumVolumeNames

std::string	integratorSet

std::string	fieldModulator

double	lengthSafety

double	lengthSafetyLarge

double	maximumTrackingTime
	Maximum tracking time per track [s].

double	maximumStepLength
	Maximum permitted step length in any volume.

double	maximumTrackLength
	Maximum permitted track length [m].

double	chordStepMinimum

double	chordStepMinimumYoke

double	deltaIntersection

double	minimumEpsilonStep

double	maximumEpsilonStep

double	deltaOneStep

bool	stopSecondaries

bool	killNeutrinos

bool	killedParticlesMassAddedToEloss

double	minimumRadiusOfCurvature
	Minimum allowed radius of curvature.

bool	sampleElementsWithPoleface

double	nominalMatrixRelativeMomCut
	Momentum threshold for nominal dipole matrix tracking.

bool	teleporterFullTransform
	Whether to use the new Transform3D method for the teleporter.

double	dEThresholdForScattering

double	backupStepperMomLimit
	Fractional momentum limit for reverting to backup steppers.

bool	sensitiveOuter

bool	sensitiveBeamPipe

int	numberOfEventsPerNtuple

bool	storeMinimalData

bool	storeApertureImpacts

bool	storeApertureImpactsIons

bool	storeApertureImpactsAll

bool	storeApertureImpactsHistograms

double	apertureImpactsMinimumKE

bool	storeCavityInfo

bool	storeCollimatorInfo

bool	storeCollimatorHits

bool	storeCollimatorHitsLinks

bool	storeCollimatorHitsIons

bool	storeCollimatorHitsAll

double	collimatorHitsMinimumKE

bool	storeEloss

bool	storeElossHistograms

bool	storeElossVacuum

bool	storeElossVacuumHistograms

bool	storeElossTunnel

bool	storeElossTunnelHistograms

bool	storeElossWorld

bool	storeElossWorldIntegral

bool	storeElossWorldContents

bool	storeElossWorldContentsIntegral

bool	storeElossTurn

bool	storeElossLinks

bool	storeElossLocal

bool	storeElossGlobal

bool	storeElossTime

bool	storeElossStepLength

bool	storeElossPreStepKineticEnergy

bool	storeElossModelID

bool	storeElossPhysicsProcesses

bool	storeParticleData

bool	storePrimaries

bool	storePrimaryHistograms

bool	storeTrajectory

int	storeTrajectoryDepth

int	storeTrajectoryStepPoints

bool	storeTrajectoryStepPointLast

std::string	storeTrajectoryParticle

std::string	storeTrajectoryParticleID

bool	storeTrajectorySecondaryParticles

double	storeTrajectoryEnergyThreshold

std::string	storeTrajectorySamplerID

std::string	storeTrajectoryELossSRange

bool	storeTrajectoryTransportationSteps

bool	trajNoTransportation
	kept only for backwards compatibility.

bool	storeTrajectoryKineticEnergy

bool	storeTrajectoryMomentumVector

bool	storeTrajectoryProcesses

bool	storeTrajectoryTime

bool	storeTrajectoryLocal

bool	storeTrajectoryLinks

bool	storeTrajectoryIon

bool	storeTrajectoryMaterial

bool	storeTrajectoryAllVariables

bool	trajectoryFilterLogicAND

bool	storeSamplerAll

bool	storeSamplerPolarCoords

bool	storeSamplerCharge

bool	storeSamplerKineticEnergy

bool	storeSamplerMass

bool	storeSamplerRigidity

bool	storeSamplerIon

double	trajCutGTZ

double	trajCutLTR

bool	trajConnect

bool	storeModel

int	samplersSplitLevel

int	modelSplitLevel

int	uprootCompatible

int	nturns

std::string	ptcOneTurnMapFileName

double	printFractionEvents

double	printFractionTurns

bool	printPhysicsProcesses

int	nSegmentsPerCircle
	Number of facets per 2pi in visualisation.

int	nbinsx

int	nbinsy

int	nbinsz

int	nbinse

double	xmin

double	xmax

double	ymin

double	ymax

double	zmin

double	zmax

double	emin

double	emax

bool	useScoringMap

std::vector< std::string >	setKeys
	A list of all the keys that have been set in this instance.


std::string	outputFileName
	Parameter for output format.

std::string	outputFormat
	Parameter for output format.

bool	outputDoublePrecision
	Parameter for output format.

int	outputCompressionLevel
	Parameter for output format.


bool	survey
	Parameter for survey.

std::string	surveyFileName
	Parameter for survey.


bool	verboseEventBDSIM
	Event level verbosity.

int	verboseEventLevel
	Event level verbosity.

int	verboseEventStart
	Event level verbosity.

int	verboseEventContinueFor
	Event level verbosity.


bool	verboseSteppingBDSIM
	Stepping level verbosity.

int	verboseSteppingLevel
	Stepping level verbosity.

int	verboseSteppingEventStart
	Stepping level verbosity.

int	verboseSteppingEventContinueFor
	Stepping level verbosity.

bool	verboseSteppingPrimaryOnly
	Stepping level verbosity.


bool	exportGeometry
	Parameter for controlling geometry export.

std::string	exportType
	Parameter for controlling geometry export.

std::string	exportFileName
	Parameter for controlling geometry export.


double	beamlineX
	Initial beam line transform w.r.t. the world coordinate frame.

double	beamlineY
	Initial beam line transform w.r.t. the world coordinate frame.

double	beamlineZ
	Initial beam line transform w.r.t. the world coordinate frame.

double	beamlinePhi
	Initial beam line transform w.r.t. the world coordinate frame.

double	beamlineTheta
	Initial beam line transform w.r.t. the world coordinate frame.

double	beamlinePsi
	Initial beam line transform w.r.t. the world coordinate frame.

double	beamlineAxisX
	Initial beam line transform w.r.t. the world coordinate frame.

double	beamlineAxisY
	Initial beam line transform w.r.t. the world coordinate frame.

double	beamlineAxisZ
	Initial beam line transform w.r.t. the world coordinate frame.

double	beamlineAngle
	Initial beam line transform w.r.t. the world coordinate frame.

bool	beamlineAxisAngle
	Initial beam line transform w.r.t. the world coordinate frame.

double	beamlineS
	Initial beam line transform w.r.t. the world coordinate frame.


double	beampipeThickness
	default beampipe parameters

std::string	apertureType
	default beampipe parameters

double	aper1
	default beampipe parameters

double	aper2
	default beampipe parameters

double	aper3
	default beampipe parameters

double	aper4
	default beampipe parameters

std::string	beampipeMaterial
	default beampipe parameters

bool	ignoreLocalAperture
	default beampipe parameters


bool	buildTunnel
	tunnel geometry parameters

bool	buildTunnelStraight
	tunnel geometry parameters

std::string	tunnelType
	tunnel geometry parameters

double	tunnelThickness
	tunnel geometry parameters

double	tunnelSoilThickness
	tunnel geometry parameters

std::string	tunnelMaterial
	tunnel geometry parameters

std::string	soilMaterial
	tunnel geometry parameters

bool	buildTunnelFloor
	tunnel geometry parameters

double	tunnelFloorOffset
	tunnel geometry parameters

double	tunnelAper1
	tunnel geometry parameters

double	tunnelAper2
	tunnel geometry parameters

bool	tunnelVisible
	tunnel geometry parameters

double	tunnelOffsetX
	tunnel geometry parameters

double	tunnelOffsetY
	tunnel geometry parameters

double	tunnelMaxSegmentLength
	tunnel geometry parameters


bool	turnOnOpticalAbsorption
	Physics processes.

bool	turnOnMieScattering
	Physics processes.

bool	turnOnRayleighScattering
	Physics processes.

bool	turnOnOpticalSurface
	Physics processes.


double	scintYieldFactor
	physics parameters

int	maximumPhotonsPerStep
	physics parameters

int	maximumBetaChangePerStep
	physics parameters

long	maximumTracksPerEvent
	physics parameters

double	minimumKineticEnergy
	physics parameters

double	minimumKineticEnergyTunnel
	physics parameters

double	minimumRange
	physics parameters

std::string	particlesToExcludeFromCuts
	physics parameters

double	defaultRangeCut
	physics parameters

double	prodCutPhotons
	physics parameters

double	prodCutElectrons
	physics parameters

double	prodCutPositrons
	physics parameters

double	prodCutProtons
	physics parameters

double	neutronTimeLimit
	physics parameters

double	neutronKineticEnergyLimit
	physics parameters

bool	useLENDGammaNuclear
	physics parameters

bool	useElectroNuclear
	physics parameters

bool	useMuonNuclear
	physics parameters

bool	useGammaToMuMu
	physics parameters

bool	usePositronToMuMu
	physics parameters

bool	usePositronToHadrons
	physics parameters

bool	restoreFTPFDiffractionForAGreater10
	physics parameters

bool	beamPipeIsInfiniteAbsorber
	physics parameters

bool	collimatorsAreInfiniteAbsorbers
	physics parameters

bool	tunnelIsInfiniteAbsorber
	physics parameters

int	muonSplittingFactor
	physics parameters

double	muonSplittingThresholdParentEk
	physics parameters

int	muonSplittingFactor2
	physics parameters

double	muonSplittingThresholdParentEk2
	physics parameters

bool	muonSplittingExcludeWeight1Particles
	physics parameters

double	muonSplittingExclusionWeight
	physics parameters

Detailed Description

Basic options class independent of Geant4.

This is the basic options structure that can be saved to output and should only contain basic built in C++ types. No Geant4 types are to be used. See also the Options class which inherits this one.

Definition at line 35 of file optionsBase.h.

Constructor & Destructor Documentation

◆ OptionsBase()

OptionsBase::OptionsBase ( )

< -1 -> no action taken (could want 0)

< 0 -> no action taken

< kept only for backwards compatibility.

Definition at line 25 of file optionsBase.cc.

References aper1, aper2, aper3, aper4, apertureType, backupStepperMomLimit, batch, bdsimPath, beamlineAngle, beamlineAxisAngle, beamlineAxisX, beamlineAxisY, beamlineAxisZ, beamlinePhi, beamlinePsi, beamlineS, beamlineTheta, beamlineX, beamlineY, beamlineZ, beamPipeIsInfiniteAbsorber, beampipeMaterial, beampipeThickness, buildTunnel, buildTunnelFloor, buildTunnelStraight, checkOverlaps, circular, collimatorsAreInfiniteAbsorbers, defaultRangeCut, dontSplitSBends, emptyMaterial, eventOffset, exportFileName, exportGeometry, exportType, ffact, geant4MacroFileName, geant4PhysicsMacroFileName, generatePrimariesOnly, hStyle, ignoreLocalAperture, inputFileName, magnetGeometryType, maximumBetaChangePerStep, maximumPhotonsPerStep, maximumStepLength, maximumTrackingTime, maximumTrackLength, maximumTracksPerEvent, minimumKineticEnergy, minimumKineticEnergyTunnel, minimumRadiusOfCurvature, minimumRange, muonSplittingExcludeWeight1Particles, muonSplittingExclusionWeight, muonSplittingFactor, muonSplittingFactor2, muonSplittingThresholdParentEk, muonSplittingThresholdParentEk2, neutronKineticEnergyLimit, neutronTimeLimit, nGenerate, nominalMatrixRelativeMomCut, nSegmentsPerCircle, outputCompressionLevel, outputDoublePrecision, outputFileName, outputFormat, particlesToExcludeFromCuts, physicsList, preprocessGDML, prodCutElectrons, prodCutPhotons, prodCutPositrons, prodCutProtons, randomEngine, recreate, recreateFileName, recreateSeedState, restoreFTPFDiffractionForAGreater10, scintYieldFactor, seed, seedStateFileName, soilMaterial, startFromEvent, survey, surveyFileName, teleporterFullTransform, trajNoTransportation, tunnelAper1, tunnelAper2, tunnelFloorOffset, tunnelIsInfiniteAbsorber, tunnelMaterial, tunnelMaxSegmentLength, tunnelOffsetX, tunnelOffsetY, tunnelSoilThickness, tunnelThickness, tunnelType, tunnelVisible, turnOnMieScattering, turnOnOpticalAbsorption, turnOnOpticalSurface, turnOnRayleighScattering, useASCIISeedState, useElectroNuclear, useGammaToMuMu, useLENDGammaNuclear, useMuonNuclear, usePositronToHadrons, usePositronToMuMu, vacMaterial, verbose, verboseEventBDSIM, verboseEventContinueFor, verboseEventLevel, verboseEventStart, verboseRunLevel, verboseSteppingBDSIM, verboseSteppingEventContinueFor, verboseSteppingEventStart, verboseSteppingLevel, verboseSteppingPrimaryOnly, verboseTrackingLevel, visDebug, visMacroFileName, worldVolumeMargin, writeSeedState, and xsize.

Member Function Documentation

◆ print()

void OptionsBase::print ( ) const

print some properties

Definition at line 379 of file optionsBase.cc.

References ffact, nGenerate, turnOnMieScattering, turnOnOpticalAbsorption, turnOnOpticalSurface, and turnOnRayleighScattering.

Referenced by GMAD::Parser::PrintOptions().

Here is the caller graph for this function:

Field Documentation

◆ aper1

double GMAD::OptionsBase::aper1

default beampipe parameters

Definition at line 183 of file optionsBase.h.

Referenced by BDSGlobalConstants::BDSGlobalConstants(), OptionsBase(), and GMAD::Options::PublishMembers().

◆ aper2

double GMAD::OptionsBase::aper2

default beampipe parameters

Definition at line 184 of file optionsBase.h.

Referenced by BDSGlobalConstants::BDSGlobalConstants(), OptionsBase(), and GMAD::Options::PublishMembers().

◆ aper3

double GMAD::OptionsBase::aper3

default beampipe parameters

Definition at line 185 of file optionsBase.h.

Referenced by BDSGlobalConstants::BDSGlobalConstants(), OptionsBase(), and GMAD::Options::PublishMembers().

◆ aper4

double GMAD::OptionsBase::aper4

default beampipe parameters

Definition at line 186 of file optionsBase.h.

Referenced by BDSGlobalConstants::BDSGlobalConstants(), OptionsBase(), and GMAD::Options::PublishMembers().

◆ apertureImpactsMinimumKE

double GMAD::OptionsBase::apertureImpactsMinimumKE

Definition at line 315 of file optionsBase.h.

◆ apertureType

std::string GMAD::OptionsBase::apertureType

default beampipe parameters

Definition at line 182 of file optionsBase.h.

Referenced by BDSGlobalConstants::BDSGlobalConstants(), OptionsBase(), and GMAD::Options::PublishMembers().

◆ autoColourWorldGeometryFile

bool GMAD::OptionsBase::autoColourWorldGeometryFile

Definition at line 195 of file optionsBase.h.

◆ backupStepperMomLimit

double GMAD::OptionsBase::backupStepperMomLimit

Fractional momentum limit for reverting to backup steppers.

Definition at line 300 of file optionsBase.h.

Referenced by OptionsBase(), and GMAD::Options::PublishMembers().

◆ batch

bool GMAD::OptionsBase::batch

Flag for batch / interactive mode.

Definition at line 59 of file optionsBase.h.

Referenced by BDSExecOptions::BDSExecOptions(), OptionsBase(), and GMAD::Options::PublishMembers().

◆ bdsimPath

std::string GMAD::OptionsBase::bdsimPath

String that points to path where files are searched; based on environment variable or else input filename

Definition at line 112 of file optionsBase.h.

Referenced by BDSExecOptions::BDSExecOptions(), OptionsBase(), and GMAD::Options::PublishMembers().