Geant4 11.4.0
Toolkit for the simulation of the passage of particles through matter
Loading...
Searching...
No Matches
G4Mag_UsualEqRhs Class Reference

G4Mag_UsualEqRhs defines the standard right-hand side for equation of motion. More...

#include <G4Mag_UsualEqRhs.hh>

Inheritance diagram for G4Mag_UsualEqRhs:

Public Member Functions

 G4Mag_UsualEqRhs (G4MagneticField *MagField)
 ~G4Mag_UsualEqRhs () override=default
void EvaluateRhsGivenB (const G4double y[], const G4double B[3], G4double dydx[]) const override
void SetChargeMomentumMass (G4ChargeState particleCharge, G4double MomentumXc, G4double mass) override
G4EquationType GetEquationType () const override
Public Member Functions inherited from G4Mag_EqRhs
 G4Mag_EqRhs (G4MagneticField *magField)
 ~G4Mag_EqRhs () override=default
G4double FCof () const
Public Member Functions inherited from G4EquationOfMotion
 G4EquationOfMotion (G4Field *Field)
virtual ~G4EquationOfMotion ()=default
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 G4FieldGetFieldObj () const
G4FieldGetFieldObj ()
void SetFieldObj (G4Field *pField)

Detailed Description

G4Mag_UsualEqRhs defines the standard right-hand side for equation of motion.

Definition at line 50 of file G4Mag_UsualEqRhs.hh.

Constructor & Destructor Documentation

◆ G4Mag_UsualEqRhs()

G4Mag_UsualEqRhs::G4Mag_UsualEqRhs ( G4MagneticField * MagField)

Constructor for G4Mag_UsualEqRhs.

Parameters
[in]MagFieldPointer to the associated magnetic field.

Definition at line 36 of file G4Mag_UsualEqRhs.cc.

37 : G4Mag_EqRhs( MagField )
38{
39}
G4Mag_EqRhs(G4MagneticField *magField)

Referenced by G4ErrorMag_UsualEqRhs::G4ErrorMag_UsualEqRhs(), and G4TMagFieldEquation< T_Field >::G4TMagFieldEquation().

◆ ~G4Mag_UsualEqRhs()

G4Mag_UsualEqRhs::~G4Mag_UsualEqRhs ( )
overridedefault

Default Destructor.

Member Function Documentation

◆ EvaluateRhsGivenB()

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

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

Parameters
[in]yCoefficients array.
[in]BField value.
[out]dydxDerivatives array.

Implements G4Mag_EqRhs.

Definition at line 42 of file G4Mag_UsualEqRhs.cc.

45{
46 G4double momentum_mag_square = y[3]*y[3] + y[4]*y[4] + y[5]*y[5];
47 G4double inv_momentum_magnitude = 1.0 / std::sqrt( momentum_mag_square );
48
49 G4double cof = FCof()*inv_momentum_magnitude;
50
51 dydx[0] = y[3]*inv_momentum_magnitude; // (d/ds)x = Vx/V
52 dydx[1] = y[4]*inv_momentum_magnitude; // (d/ds)y = Vy/V
53 dydx[2] = y[5]*inv_momentum_magnitude; // (d/ds)z = Vz/V
54
55 dydx[3] = cof*(y[4]*B[2] - y[5]*B[1]) ; // Ax = a*(Vy*Bz - Vz*By)
56 dydx[4] = cof*(y[5]*B[0] - y[3]*B[2]) ; // Ay = a*(Vz*Bx - Vx*Bz)
57 dydx[5] = cof*(y[3]*B[1] - y[4]*B[0]) ; // Az = a*(Vx*By - Vy*Bx)
58
59 return;
60}
G4double B(G4double temperature)
double G4double
Definition G4Types.hh:83
G4double FCof() const

Referenced by G4ErrorMag_UsualEqRhs::EvaluateRhsGivenB().

◆ GetEquationType()

G4EquationType G4Mag_UsualEqRhs::GetEquationType ( ) const
inlineoverridevirtual

Returns the equation of motion type ID, i.e. "kEqMagnetic".

Reimplemented from G4EquationOfMotion.

Definition at line 86 of file G4Mag_UsualEqRhs.hh.

86{ return kEqMagnetic; }
@ kEqMagnetic

◆ SetChargeMomentumMass()

void G4Mag_UsualEqRhs::SetChargeMomentumMass ( G4ChargeState particleCharge,
G4double MomentumXc,
G4double mass )
overridevirtual

Sets the charge momentum mass value.

Reimplemented from G4Mag_EqRhs.

Definition at line 63 of file G4Mag_UsualEqRhs.cc.

67{
68 G4Mag_EqRhs::SetChargeMomentumMass( particleCharge, MomentumXc, mass);
69}
void SetChargeMomentumMass(G4ChargeState particleCharge, G4double MomentumXc, G4double mass) override

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