G4TMagFieldEquation< T_Field > Class Template Reference

#include <G4TMagFieldEquation.hh>

Inheritance diagram for G4TMagFieldEquation< T_Field >:

Public Member Functions
	__attribute__ ((always_inline)) void RightHandSide(const G4double y[]
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
	G4TMagFieldEquation (T_Field *f)
G4Field *	GetFieldObj ()
const G4Field *	GetFieldObj () const
void	GetFieldValue (const G4double Point[4], G4double Field[]) const
	GetFieldValue (PositionAndTime, Field)
void	RightHandSide (const G4double y[], G4double dydx[]) const
virtual void	SetChargeMomentumMass (G4ChargeState particleCharge, G4double MomentumXc, G4double mass)
void	SetFieldObj (G4Field *pField)
void	TEvaluateRhsGivenB (const G4double y[], const G4double B[3], G4double dydx[]) const
	TEvaluateRhsGivenB (y, Field, dydx)
virtual	~G4TMagFieldEquation ()

Data Fields
G4double	dydx []
	PositionAndTime [0] = y[0]
G4double	PositionAndTime [4]

Private Types
enum	{ G4maximum_number_of_field_components = 24 }

Private Attributes
G4double	fCof_val = 0.0
T_Field *	itsField

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

Detailed Description

template<class T_Field>
class G4TMagFieldEquation< T_Field >

Definition at line 44 of file G4TMagFieldEquation.hh.

Member Enumeration Documentation

anonymous enum

template<class T_Field >

anonymous enum

private

Enumerator
G4maximum_number_of_field_components

Definition at line 96 of file G4TMagFieldEquation.hh.

{ G4maximum_number_of_field_components = 24 };

Constructor & Destructor Documentation

G4TMagFieldEquation()

template<class T_Field >

G4TMagFieldEquation< T_Field >::G4TMagFieldEquation ( T_Field *  f )

inline

Definition at line 48 of file G4TMagFieldEquation.hh.

       : G4Mag_UsualEqRhs(f)
    {
            itsField = f;
    }

References G4TMagFieldEquation< T_Field >::itsField.

~G4TMagFieldEquation()

template<class T_Field >

virtual G4TMagFieldEquation< T_Field >::~G4TMagFieldEquation ( )

inlinevirtual

Definition at line 54 of file G4TMagFieldEquation.hh.

{;}

Member Function Documentation

__attribute__()

template<class T_Field >

G4TMagFieldEquation< T_Field >::__attribute__

(

(always_inline)

)

const

EvaluateRhsGivenB()

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

virtualinherited

Implements G4Mag_EqRhs.

Definition at line 46 of file G4Mag_UsualEqRhs.cc.

{
   G4double momentum_mag_square = y[3]*y[3] + y[4]*y[4] + y[5]*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
 
   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)
 
   return;
}

References B(), and G4Mag_EqRhs::FCof().

Referenced by G4ErrorMag_UsualEqRhs::EvaluateRhsGivenB().

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.

{ return fCof_val; }

References G4Mag_EqRhs::fCof_val.

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

GetFieldObj() [1/2]

G4Field * G4EquationOfMotion::GetFieldObj ( )

inlineinherited

GetFieldObj() [2/2]

const G4Field * G4EquationOfMotion::GetFieldObj ( ) const

inlineinherited

Referenced by G4NystromRK4::GetField().

GetFieldValue() [1/2]

template<class T_Field >

void G4TMagFieldEquation< T_Field >::GetFieldValue ( const G4double  Point[4], G4double  Field[]  ) const

inline

Definition at line 56 of file G4TMagFieldEquation.hh.

    {
      itsField->T_Field::GetFieldValue(Point, Field);
    }

References G4TMagFieldEquation< T_Field >::itsField.

GetFieldValue() [2/2]

template<class T_Field >

G4TMagFieldEquation< T_Field >::GetFieldValue	(	PositionAndTime	,
		Field
	)

RightHandSide()

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

inlineinherited

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

SetChargeMomentumMass()

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

virtualinherited

Reimplemented from G4Mag_EqRhs.

Definition at line 67 of file G4Mag_UsualEqRhs.cc.

{
   G4Mag_EqRhs::SetChargeMomentumMass( particleCharge, MomentumXc, mass);
}

References G4Mag_EqRhs::SetChargeMomentumMass().

SetFieldObj()

void G4EquationOfMotion::SetFieldObj ( G4Field *  pField )

inlineinherited

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

TEvaluateRhsGivenB() [1/2]

template<class T_Field >

void G4TMagFieldEquation< T_Field >::TEvaluateRhsGivenB ( const G4double  y[], const G4double  B[3], G4double  dydx[]  ) const

inline

Definition at line 62 of file G4TMagFieldEquation.hh.

    {
      G4double momentum_mag_square = y[3]*y[3] + y[4]*y[4] + y[5]*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
      
      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)
      
      return ;
    }

References B(), G4TMagFieldEquation< T_Field >::dydx, and G4Mag_EqRhs::FCof().

TEvaluateRhsGivenB() [2/2]

template<class T_Field >

G4TMagFieldEquation< T_Field >::TEvaluateRhsGivenB	(	y	,
		Field	,
		dydx
	)

Field Documentation

dydx

template<class T_Field >

G4double G4TMagFieldEquation< T_Field >::dydx[]

Initial value:

{
      G4double Field[G4maximum_number_of_field_components]

Definition at line 82 of file G4TMagFieldEquation.hh.

Referenced by G4TMagFieldEquation< T_Field >::TEvaluateRhsGivenB().

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.

itsField

template<class T_Field >

T_Field* G4TMagFieldEquation< T_Field >::itsField

private

Definition at line 99 of file G4TMagFieldEquation.hh.

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

PositionAndTime [1/2]

template<class T_Field >

G4TMagFieldEquation< T_Field >::PositionAndTime[3] = y[0]

Definition at line 87 of file G4TMagFieldEquation.hh.

PositionAndTime [2/2]

template<class T_Field >

G4double G4TMagFieldEquation< T_Field >::PositionAndTime[4]

Definition at line 86 of file G4TMagFieldEquation.hh.

---

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

• source/geometry/magneticfield/include/G4TMagFieldEquation.hh