G4TMagFieldEquation.hh

Go to the documentation of this file.

//
// ********************************************************************
// * 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.          *
// ********************************************************************
//
// G4TMagFieldEquation
//
// Class description:
//
// Templated version of equation of motion of a particle in a pure
// magnetic field.
// Enables use of inlined code for field, equation, stepper, driver,
// avoiding all virtual calls.
//
// Adapted from G4Mag_UsualEqRhs.
//
// Author: Josh Xie (CERN, Google Summer of Code 2014), June 2014
// Supervisors:  Sandro Wenzel, John Apostolakis (CERN)
// --------------------------------------------------------------------
#ifndef G4TMAGFIELD_EQUATION_HH
#define G4TMAGFIELD_EQUATION_HH
 
#include "G4Mag_UsualEqRhs.hh"
 
/**
 * @brief G4TMagFieldEquation is a templated version of G4MagFieldEquation.
 */
 
template <class T_Field>
class G4TMagFieldEquation : public G4Mag_UsualEqRhs
{
  public:
 
    G4TMagFieldEquation(T_Field* f) : G4Mag_UsualEqRhs(f)
    {
      itsField = f;
    }
 
    virtual ~G4TMagFieldEquation() = default;
 
    inline void GetFieldValue(const G4double Point[4],
                              G4double Field[]) const
    {
      itsField->T_Field::GetFieldValue(Point, Field);
    }
 
    inline void TEvaluateRhsGivenB( const G4double y[],
                                    const G4double B[3],
                                    G4double dydx[] ) const
    {
      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 ;
    }
 
    __attribute__((always_inline)) 
    void RightHandSide( const G4double y[], G4double dydx[] )
    //  const
    {
      G4double Field[G4maximum_number_of_field_components]; 
      G4double  PositionAndTime[4];
      PositionAndTime[0] = y[0];
      PositionAndTime[1] = y[1];
      PositionAndTime[2] = y[2];
      PositionAndTime[3] = y[7];   
      GetFieldValue(PositionAndTime, Field) ;
      TEvaluateRhsGivenB(y, Field, dydx);
    }
   
  private:
 
    enum { G4maximum_number_of_field_components = 24 };
 
    // Dependent objects
    T_Field* itsField;
};
 
#endif