include/Geant4/G4FieldParameters.icc

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // G4FieldParameters inline methods implementation
0027 //
0028 // Author: Ivana Hrivnacova (IJCLab, Orsay), 2024.
0029 // -------------------------------------------------------------------
0030
0031 // Set type of field
0032 inline void G4FieldParameters::SetFieldType(G4FieldType field)
0033 {
0034   fField = field;
0035 }
0036
0037 // Set the type of equation of motion of a particle in a field
0038 inline void G4FieldParameters::SetEquationType(G4EquationType equation)
0039 {
0040   fEquation = equation;
0041 }
0042
0043 // Set the type of integrator of particle's equation of motion
0044 inline void G4FieldParameters::SetStepperType(G4StepperType stepper)
0045 {
0046   fStepper = stepper;
0047 }
0048
0049 // Set minimum step in G4ChordFinder
0050 inline void G4FieldParameters::SetMinimumStep(G4double value)
0051 {
0052   fMinimumStep = value;
0053 }
0054
0055 // Set delta chord in G4ChordFinder
0056 inline void G4FieldParameters::SetDeltaChord(G4double value)
0057 {
0058   fDeltaChord = value;
0059 }
0060
0061 // Set delta one step in global field manager
0062 inline void G4FieldParameters::SetDeltaOneStep(G4double value)
0063 {
0064   fDeltaOneStep = value;
0065 }
0066
0067 // Set delta intersection in global field manager
0068 inline void G4FieldParameters::SetDeltaIntersection(G4double value)
0069 {
0070   fDeltaIntersection = value;
0071 }
0072
0073 // Set minimum epsilon step in global field manager
0074 inline void G4FieldParameters::SetMinimumEpsilonStep(G4double value)
0075 {
0076   fMinimumEpsilonStep = value;
0077 }
0078
0079 // Set maximum epsilon step in global field manager
0080 inline void G4FieldParameters::SetMaximumEpsilonStep(G4double value)
0081 {
0082   fMaximumEpsilonStep = value;
0083 }
0084
0085 // Set the distance within which the field is considered constant
0086 inline void G4FieldParameters::SetConstDistance(G4double value)
0087 {
0088   fConstDistance = value;
0089 }
0090
0091 // Return the name of associated volume, if local field
0092 inline const G4String& G4FieldParameters::GetVolumeName() const
0093 {
0094   return fVolumeName;
0095 }
0096
0097 // Return the type of field
0098 inline const G4FieldType& G4FieldParameters::GetFieldType() const
0099 {
0100   return fField;
0101 }
0102
0103 // Return the type of equation of motion of a particle in a field
0104 inline const G4EquationType& G4FieldParameters::GetEquationType() const
0105 {
0106   return fEquation;
0107 }
0108
0109 // Return the type of integrator of particle's equation of motion
0110 inline const G4StepperType& G4FieldParameters::GetStepperType() const
0111 {
0112   return fStepper;
0113 }
0114
0115 // Return the user defined equation of motion
0116 inline G4EquationOfMotion* G4FieldParameters::GetUserEquationOfMotion() const
0117 {
0118   return fUserEquation;
0119 }
0120
0121 // Return the user defined integrator of particle's equation of motion
0122 inline G4MagIntegratorStepper* G4FieldParameters::GetUserStepper() const
0123 {
0124   return fUserStepper;
0125 }
0126
0127 // Return minimum step in G4ChordFinder
0128 inline G4double G4FieldParameters::GetMinimumStep() const
0129 {
0130   return fMinimumStep;
0131 }
0132
0133 // Return delta chord in G4ChordFinder
0134 inline G4double G4FieldParameters::GetDeltaChord() const
0135 {
0136   return fDeltaChord;
0137 }
0138
0139 // Return delta one step in global field manager
0140 inline G4double G4FieldParameters::GetDeltaOneStep() const
0141 {
0142   return fDeltaOneStep;
0143 }
0144
0145 // Return delta intersection in global field manager
0146 inline G4double G4FieldParameters::GetDeltaIntersection() const
0147 {
0148   return fDeltaIntersection;
0149 }
0150
0151 // Return minimum epsilon step in global field manager
0152 inline G4double G4FieldParameters::GetMinimumEpsilonStep() const
0153 {
0154   return fMinimumEpsilonStep;
0155 }
0156
0157 // Return maximum epsilon step in global field manager
0158 inline G4double G4FieldParameters::GetMaximumEpsilonStep() const
0159 {
0160   return fMaximumEpsilonStep;
0161 }
0162
0163 // Return the distance within which the field is considered constant
0164 inline G4double G4FieldParameters::GetConstDistance() const
0165 {
0166   return fConstDistance;
0167 }