#include <G4Mag_SpinEqRhs.hh>

Inheritance diagram for G4Mag_SpinEqRhs:

Public Member Functions
void	EvaluateRhsGivenB (const G4double y[], const G4double B[3], G4double dydx[]) const

void	EvaluateRhsReturnB (const G4double y[], G4double dydx[], G4double Field[]) const

G4double	FCof () const

	G4Mag_SpinEqRhs (G4MagneticField *MagField)

G4double	GetAnomaly () const

G4Field *	GetFieldObj ()

const G4Field *	GetFieldObj () const

void	GetFieldValue (const G4double Point[4], G4double Field[]) const

void	RightHandSide (const G4double y[], G4double dydx[]) const

void	SetAnomaly (G4double a)

void	SetChargeMomentumMass (G4ChargeState particleCharge, G4double MomentumXc, G4double mass)

void	SetFieldObj (G4Field *pField)

	~G4Mag_SpinEqRhs ()

Private Attributes
G4double	anomaly =0.0011659208

G4double	beta =0.0

G4double	charge =0.0

G4double	fCof_val = 0.0

G4double	gamma =0.0

G4Field *	itsField = nullptr

G4double	magMoment =0.0

G4double	mass =0.0

G4double	omegac =0.0

G4double	spin =0.0

Static Private Attributes
static const G4double	fUnitConstant = 0.299792458 * (GeV/(tesla*m))

Detailed Description

Definition at line 45 of file G4Mag_SpinEqRhs.hh.

Constructor & Destructor Documentation

◆ G4Mag_SpinEqRhs()

G4Mag_SpinEqRhs::G4Mag_SpinEqRhs ( G4MagneticField * MagField )

Definition at line 37 of file G4Mag_SpinEqRhs.cc.

  : G4Mag_EqRhs( MagField )
{
}

◆ ~G4Mag_SpinEqRhs()

G4Mag_SpinEqRhs::~G4Mag_SpinEqRhs ( )

Definition at line 42 of file G4Mag_SpinEqRhs.cc.

43{

44}

Member Function Documentation

◆ EvaluateRhsGivenB()

void G4Mag_SpinEqRhs::EvaluateRhsGivenB	(	const G4double	y[],
		const G4double	B[3],
		G4double	dydx[]
	)		const

virtual

Implements G4Mag_EqRhs.

Definition at line 74 of file G4Mag_SpinEqRhs.cc.

{
   G4double momentum_mag_square = sqr(y[3]) + sqr(y[4]) + sqr(y[5]);
   G4double inv_momentum_magnitude = 1.0 / std::sqrt( momentum_mag_square );
   G4double cof = FCof()*inv_momentum_magnitude;
 
   dydx[0] = y[3] * inv_momentum_magnitude;       //  (d/ds)x = Vx/V
   dydx[1] = y[4] * inv_momentum_magnitude;       //  (d/ds)y = Vy/V
   dydx[2] = y[5] * inv_momentum_magnitude;       //  (d/ds)z = Vz/V
 
   if (charge == 0.)
   {
      dydx[3] = 0.;
      dydx[4] = 0.;
      dydx[5] = 0.;
   }
   else
   {
      dydx[3] = cof*(y[4]*B[2] - y[5]*B[1]) ;   // Ax = a*(Vy*Bz - Vz*By)
      dydx[4] = cof*(y[5]*B[0] - y[3]*B[2]) ;   // Ay = a*(Vz*Bx - Vx*Bz)
      dydx[5] = cof*(y[3]*B[1] - y[4]*B[0]) ;   // Az = a*(Vx*By - Vy*Bx)
   }
 
   G4ThreeVector u(y[3], y[4], y[5]);
   u *= inv_momentum_magnitude; 
 
   G4ThreeVector BField(B[0],B[1],B[2]);
 
   G4double udb = anomaly*beta*gamma/(1.+gamma) * (BField * u); 
   G4double ucb = (anomaly+1./gamma)/beta;
 
   // Initialise the values of dydx that we do not update.
   dydx[6] = dydx[7] = dydx[8] = 0.0;
 
   G4ThreeVector Spin(y[9],y[10],y[11]);
 
   G4double pcharge;
   if (charge == 0.)
   {
     pcharge = 1.;
   }
   else
   {
     pcharge = charge;
   }
 
   G4ThreeVector dSpin(0.,0.,0.);
   if (Spin.mag2() != 0.)
   {
     dSpin = pcharge*omegac*(ucb*(Spin.cross(BField))-udb*(Spin.cross(u)));
   }
 
   dydx[9] = dSpin.x();
   dydx[10] = dSpin.y();
   dydx[11] = dSpin.z();
 
   return;
}

References anomaly, B(), beta, charge, G4Mag_EqRhs::FCof(), gamma, omegac, sqr(), CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

◆ EvaluateRhsReturnB()

void G4EquationOfMotion::EvaluateRhsReturnB	(	const G4double	y[],
		G4double	dydx[],
		G4double	Field[]
	)		const

inlineinherited

Referenced by G4RKG3_Stepper::StepNoErr().

◆ FCof()

G4double G4Mag_EqRhs::FCof ( ) const

inlineinherited

Definition at line 62 of file G4Mag_EqRhs.hh.

62{ return fCof_val; }

G4Mag_EqRhs::fCof_val

G4double fCof_val

Definition: G4Mag_EqRhs.hh:69

References G4Mag_EqRhs::fCof_val.

Referenced by G4MagHelicalStepper::AdvanceHelix(), G4BFieldIntegrationDriver::CurvatureRadius(), G4ErrorMag_UsualEqRhs::EvaluateRhsGivenB(), EvaluateRhsGivenB(), G4Mag_UsualEqRhs::EvaluateRhsGivenB(), G4ConstRK4::RightHandSideConst(), and G4TMagFieldEquation< T_Field >::TEvaluateRhsGivenB().

◆ GetAnomaly()

G4double G4Mag_SpinEqRhs::GetAnomaly ( ) const

inline

Definition at line 64 of file G4Mag_SpinEqRhs.hh.

64{ return anomaly; }

References anomaly.

◆ GetFieldObj() [1/2]

G4Field * G4EquationOfMotion::GetFieldObj ( )

inlineinherited

◆ GetFieldObj() [2/2]

const G4Field * G4EquationOfMotion::GetFieldObj ( ) const

inlineinherited

Referenced by G4NystromRK4::GetField().

◆ GetFieldValue()

void G4EquationOfMotion::GetFieldValue	(	const G4double	Point[4],
		G4double	Field[]
	)		const

inlineinherited

Referenced by G4BFieldIntegrationDriver::GetFieldValue(), and G4MultiLevelLocator::ReportFieldValue().

◆ RightHandSide()

void G4EquationOfMotion::RightHandSide	(	const G4double	y[],
		G4double	dydx[]
	)		const

inlineinherited

Referenced by G4ModifiedMidpoint::DoStep(), and G4VFSALIntegrationStepper::RightHandSide().

◆ SetAnomaly()

void G4Mag_SpinEqRhs::SetAnomaly ( G4double a )

inline

Definition at line 63 of file G4Mag_SpinEqRhs.hh.

63{ anomaly = a; }

References anomaly.

◆ SetChargeMomentumMass()

void G4Mag_SpinEqRhs::SetChargeMomentumMass	(	G4ChargeState	particleCharge,
		G4double	MomentumXc,
		G4double	mass
	)

virtual

Reimplemented from G4Mag_EqRhs.

Definition at line 47 of file G4Mag_SpinEqRhs.cc.

{
   G4Mag_EqRhs::SetChargeMomentumMass( particleCharge, MomentumXc, mass);
 
   charge = particleCharge.GetCharge();
   mass      = particleMass;
   magMoment = particleCharge.GetMagneticDipoleMoment();
   spin      = particleCharge.GetSpin();
 
   omegac = (eplus/mass)*c_light;
 
   G4double muB = 0.5*eplus*hbar_Planck/(mass/c_squared);
 
   G4double g_BMT;
   if ( spin != 0. ) g_BMT = (std::abs(magMoment)/muB)/spin;
   else g_BMT = 2.;
 
   anomaly = (g_BMT - 2.)/2.;
 
   G4double E = std::sqrt(sqr(MomentumXc)+sqr(mass));
   beta  = MomentumXc/E;
   gamma = E/mass;
}

References anomaly, beta, source.hepunit::c_light, source.hepunit::c_squared, charge, eplus, gamma, G4ChargeState::GetCharge(), G4ChargeState::GetMagneticDipoleMoment(), G4ChargeState::GetSpin(), source.hepunit::hbar_Planck, magMoment, mass, omegac, G4Mag_EqRhs::SetChargeMomentumMass(), spin, and sqr().

◆ SetFieldObj()

void G4EquationOfMotion::SetFieldObj ( G4Field * pField )

inlineinherited

Referenced by G4FieldManager::SetDetectorField(), and G4NystromRK4::SetDistanceForConstantField().

Field Documentation

◆ anomaly

G4double G4Mag_SpinEqRhs::anomaly =0.0011659208

private

Definition at line 70 of file G4Mag_SpinEqRhs.hh.

Referenced by EvaluateRhsGivenB(), GetAnomaly(), SetAnomaly(), and SetChargeMomentumMass().

◆ beta

G4double G4Mag_SpinEqRhs::beta =0.0

private

Definition at line 71 of file G4Mag_SpinEqRhs.hh.

Referenced by EvaluateRhsGivenB(), and SetChargeMomentumMass().

◆ charge

G4double G4Mag_SpinEqRhs::charge =0.0

private

Definition at line 69 of file G4Mag_SpinEqRhs.hh.

Referenced by EvaluateRhsGivenB(), and SetChargeMomentumMass().

◆ fCof_val

G4double G4Mag_EqRhs::fCof_val = 0.0

privateinherited

Definition at line 69 of file G4Mag_EqRhs.hh.

Referenced by G4Mag_EqRhs::FCof(), and G4Mag_EqRhs::SetChargeMomentumMass().

◆ fUnitConstant

const G4double G4Mag_EqRhs::fUnitConstant = 0.299792458 * (GeV/(tesla*m))

staticprivateinherited

Definition at line 71 of file G4Mag_EqRhs.hh.

◆ gamma

G4double G4Mag_SpinEqRhs::gamma =0.0

private

Definition at line 71 of file G4Mag_SpinEqRhs.hh.

Referenced by EvaluateRhsGivenB(), and SetChargeMomentumMass().

◆ itsField

G4Field* G4EquationOfMotion::itsField = nullptr

privateinherited

Definition at line 90 of file G4EquationOfMotion.hh.

◆ magMoment

G4double G4Mag_SpinEqRhs::magMoment =0.0

private

Definition at line 69 of file G4Mag_SpinEqRhs.hh.

Referenced by SetChargeMomentumMass().

◆ mass

G4double G4Mag_SpinEqRhs::mass =0.0

private

Definition at line 69 of file G4Mag_SpinEqRhs.hh.

Referenced by SetChargeMomentumMass().

◆ omegac

G4double G4Mag_SpinEqRhs::omegac =0.0

private

Definition at line 70 of file G4Mag_SpinEqRhs.hh.

Referenced by EvaluateRhsGivenB(), and SetChargeMomentumMass().

◆ spin

G4double G4Mag_SpinEqRhs::spin =0.0

private

Definition at line 69 of file G4Mag_SpinEqRhs.hh.

Referenced by SetChargeMomentumMass().

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

source/geometry/magneticfield/include/G4Mag_SpinEqRhs.hh
source/geometry/magneticfield/src/G4Mag_SpinEqRhs.cc

Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4Mag_SpinEqRhs()

◆ ~G4Mag_SpinEqRhs()

Member Function Documentation

◆ EvaluateRhsGivenB()

◆ EvaluateRhsReturnB()

◆ FCof()

◆ GetAnomaly()

◆ GetFieldObj() [1/2]

◆ GetFieldObj() [2/2]

◆ GetFieldValue()

◆ RightHandSide()

◆ SetAnomaly()

◆ SetChargeMomentumMass()

◆ SetFieldObj()

Field Documentation

◆ anomaly

◆ beta

◆ charge

◆ fCof_val

◆ fUnitConstant

◆ gamma

◆ itsField

◆ magMoment

◆ mass

◆ omegac

◆ spin