Files
geant4/source/geometry/magneticfield/include/G4RepleteEofM.hh
2025-12-05 08:54:02 +01:00

117 lines
4.1 KiB
C++

//
// ********************************************************************
// * License and Disclaimer *
// * *
// * The Geant4 software is copyright of the Copyright Holders of *
// * the Geant4 Collaboration. It is provided under the terms and *
// * conditions of the Geant4 Software License, included in the file *
// * LICENSE and available at http://cern.ch/geant4/license . These *
// * include a list of copyright holders. *
// * *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work make any representation or warranty, express or implied, *
// * regarding this software system or assume any liability for its *
// * use. Please see the license in the file LICENSE and URL above *
// * for the full disclaimer and the limitation of liability. *
// * *
// * This code implementation is the result of the scientific and *
// * technical work of the GEANT4 collaboration. *
// * By using, copying, modifying or distributing the software (or *
// * any work based on the software) you agree to acknowledge its *
// * use in resulting scientific publications, and indicate your *
// * acceptance of all terms of the Geant4 Software license. *
// ********************************************************************
//
// G4RepleteEofM
//
// Class description:
//
// This is the right-hand side of equation of motion in a combined
// field, including: magnetic, electric, gravity, and gradient B field,
// as well as spin tracking.
// Author: Peter Gumplinger (TRIUMF), 08.04.2013
// -------------------------------------------------------------------
#ifndef G4EOFM_HH
#define G4EOFM_HH
#include "G4ChargeState.hh"
#include "G4EquationOfMotion.hh"
class G4Field;
/**
* @brief G4RepleteEofM is the right-hand side of equation of motion in a
* combined field, including: magnetic, electric, gravity, and gradient
* B field, as well as spin tracking.
*/
class G4RepleteEofM : public G4EquationOfMotion
{
public:
/**
* Constructor for G4EquationOfMotion.
* @param[in] field Pointer to the field.
* @param[in] nvar The number of integration variables.
*/
G4RepleteEofM(G4Field* field, G4int nvar = 8);
/**
* Default Destructor.
*/
~G4RepleteEofM() override = default;
/**
* Sets the charge, momentum and mass of the current particle.
* Used to set the equation's coefficients.
* @param[in] particleCharge Magnetic charge and moments in e+ units.
* @param[in] MomentumXc Particle momentum.
* @param[in] mass Particle mass.
*/
void SetChargeMomentumMass(G4ChargeState particleCharge, // in e+ units
G4double MomentumXc,
G4double mass) override;
/**
* Calculates the value of the derivative, given the value of the field.
* @param[in] y Coefficients array.
* @param[in] Field Field value.
* @param[out] dydx Derivatives array.
*/
void EvaluateRhsGivenB(const G4double y[],
const G4double Field[],
G4double dydx[] ) const override;
/**
* Setter and getter for the magnetic anomaly.
*/
inline void SetAnomaly(G4double a) { anomaly = a; }
inline G4double GetAnomaly() const { return anomaly; }
/**
* Modifiers.
*/
inline void SetBField() { fBfield = true; }
inline void SetEField() { fEfield = true; }
inline void SetgradB() { fgradB = true; }
inline void SetSpin() { fSpin = true; }
private:
G4int fNvar = 0;
G4bool fBfield=false, fEfield=false,
fGfield=false, fgradB=false, fSpin=false;
G4double charge=0.0, mass=0.0, magMoment=0.0, spin=0.0;
G4double ElectroMagCof=0.0;
G4double omegac=0.0, anomaly=0.0;
G4double beta=0.0, gamma=0.0;
};
#endif