G4Mag_EqRhs Class Reference

G4Mag_EqRhs is the "standard" equation of motion of a particle in a pure magnetic field. More...

#include <G4Mag_EqRhs.hh>

Inheritance diagram for G4Mag_EqRhs:

Public Member Functions
	G4Mag_EqRhs (G4MagneticField *magField)
	~G4Mag_EqRhs () override=default
void	EvaluateRhsGivenB (const G4double y[], const G4double B[3], G4double dydx[]) const override=0
G4double	FCof () const
void	SetChargeMomentumMass (G4ChargeState particleCharge, G4double MomentumXc, G4double mass) override
Public Member Functions inherited from G4EquationOfMotion
	G4EquationOfMotion (G4Field *Field)
virtual	~G4EquationOfMotion ()=default
virtual G4EquationType	GetEquationType () const
void	RightHandSide (const G4double y[], G4double dydx[]) const
void	EvaluateRhsReturnB (const G4double y[], G4double dydx[], G4double Field[]) const
void	GetFieldValue (const G4double Point[4], G4double Field[]) const
const G4Field *	GetFieldObj () const
G4Field *	GetFieldObj ()
void	SetFieldObj (G4Field *pField)

Detailed Description

G4Mag_EqRhs is the "standard" equation of motion of a particle in a pure magnetic field.

Definition at line 51 of file G4Mag_EqRhs.hh.

Constructor & Destructor Documentation

G4Mag_EqRhs()

G4Mag_EqRhs::G4Mag_EqRhs

(

G4MagneticField *

magField

)

Constructor for G4Mag_EqRhs.

Parameters

[in]

magField

Pointer to the associated magnetic field.

Definition at line 39 of file G4Mag_EqRhs.cc.

  : G4EquationOfMotion(magField)
{ 
}

Referenced by G4KM_NucleonEqRhs::G4KM_NucleonEqRhs(), G4KM_OpticalEqRhs::G4KM_OpticalEqRhs(), G4Mag_SpinEqRhs::G4Mag_SpinEqRhs(), and G4Mag_UsualEqRhs::G4Mag_UsualEqRhs().

~G4Mag_EqRhs()

G4Mag_EqRhs::~G4Mag_EqRhs ( )

overridedefault

Default Destructor.

Member Function Documentation

EvaluateRhsGivenB()

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

overridepure virtual

Calculates the value of the derivative, given the value of the field.

Parameters

[in]	y	Coefficients array.
[in]	B	Field value.
[out]	dydx	Derivatives array.

Implements G4EquationOfMotion.

Implemented in G4ErrorMag_UsualEqRhs, G4KM_NucleonEqRhs, G4KM_OpticalEqRhs, G4Mag_SpinEqRhs, and G4Mag_UsualEqRhs.

FCof()

G4double G4Mag_EqRhs::FCof ( ) const

inline

Returns and sets the charge momentum mass value.

Definition at line 79 of file G4Mag_EqRhs.hh.

{ return fCof_val; }

Referenced by G4ErrorMag_UsualEqRhs::EvaluateRhsGivenB(), G4Mag_SpinEqRhs::EvaluateRhsGivenB(), G4Mag_UsualEqRhs::EvaluateRhsGivenB(), and G4TMagFieldEquation< T_Field >::TEvaluateRhsGivenB().

SetChargeMomentumMass()

void G4Mag_EqRhs::SetChargeMomentumMass ( G4ChargeState particleCharge, G4double MomentumXc, G4double MassXc2 )

overridevirtual

Sets the charge, momentum and mass of the current particle. Used to set the equation's coefficients.

Parameters

[in]	particleCharge	Magnetic charge and moments in e+ units.
[in]	MomentumXc	Particle momentum.
[in]	mass	Particle mass.

Implements G4EquationOfMotion.

Reimplemented in G4Mag_SpinEqRhs, and G4Mag_UsualEqRhs.

Definition at line 45 of file G4Mag_EqRhs.cc.

{
   G4double pcharge = particleCharge.GetCharge();
   fCof_val = pcharge*eplus*c_light ; //  B must be in Tesla
   // fCof_val = fUnitConstant*pcharge/MomentumXc; //  B must be in Tesla
   // fMass = particleMass;
}

Referenced by G4Mag_SpinEqRhs::SetChargeMomentumMass(), and G4Mag_UsualEqRhs::SetChargeMomentumMass().

---

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

• G4Mag_EqRhs.hh
• G4Mag_EqRhs.cc