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

102 lines
3.8 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. *
// ********************************************************************
//
// G4Mag_SpinEqRhs
//
// Class description:
//
// This is the equation of motion for a particle with spin in a pure
// magnetic field. The three components of the particle's spin are
// treated utilising BMT equation.
// Authors: John Apostolakis (CERN) & Peter Gumplinger (TRIUMF), 08.02.1999
// --------------------------------------------------------------------
#ifndef G4MAG_SPIN_EQRHS_HH
#define G4MAG_SPIN_EQRHS_HH
#include "G4Types.hh"
#include "G4Mag_EqRhs.hh"
#include "G4ChargeState.hh"
class G4MagneticField;
/**
* @brief G4Mag_SpinEqRhs defines the equation of motion for a particle with
* spin in a pure magnetic field. The three components of the particle's spin
* are treated utilising BMT equation.
*/
class G4Mag_SpinEqRhs : public G4Mag_EqRhs
{
public:
/**
* Constructor for G4Mag_SpinEqRhs.
* @param[in] MagField Pointer to the associated magnetic field.
*/
G4Mag_SpinEqRhs( G4MagneticField* MagField );
/**
* Default Destructor.
*/
~G4Mag_SpinEqRhs() override = default;
/**
* Sets the charge momentum mass value.
*/
void SetChargeMomentumMass(G4ChargeState particleCharge,
G4double MomentumXc,
G4double mass) override;
/**
* Calculates the value of the derivative, given the value of the field.
* @param[in] y Coefficients array.
* @param[in] B Field value.
* @param[out] dydx Derivatives array.
*/
void EvaluateRhsGivenB( const G4double y[],
const G4double B[3],
G4double dydx[] ) const override;
/**
* Setter and getter for the magnetic anomaly.
*/
inline void SetAnomaly(G4double a) { anomaly = a; }
inline G4double GetAnomaly() const { return anomaly; }
/**
* Returns the equation of motion type ID, i.e. "kEqMagneticWithSpin".
*/
inline G4EquationType GetEquationType() const override { return kEqMagneticWithSpin; }
private:
G4double charge=0.0, mass=0.0, magMoment=0.0, spin=0.0;
G4double omegac=0.0, anomaly=0.0011659208;
G4double beta=0.0, gamma=0.0;
};
#endif