G4Mag_EqRhs.hh

Go to the documentation of this file.
00001 //
00002 // ********************************************************************
00003 // * License and Disclaimer                                           *
00004 // *                                                                  *
00005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
00006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
00007 // * conditions of the Geant4 Software License,  included in the file *
00008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
00009 // * include a list of copyright holders.                             *
00010 // *                                                                  *
00011 // * Neither the authors of this software system, nor their employing *
00012 // * institutes,nor the agencies providing financial support for this *
00013 // * work  make  any representation or  warranty, express or implied, *
00014 // * regarding  this  software system or assume any liability for its *
00015 // * use.  Please see the license in the file  LICENSE  and URL above *
00016 // * for the full disclaimer and the limitation of liability.         *
00017 // *                                                                  *
00018 // * This  code  implementation is the result of  the  scientific and *
00019 // * technical work of the GEANT4 collaboration.                      *
00020 // * By using,  copying,  modifying or  distributing the software (or *
00021 // * any work based  on the software)  you  agree  to acknowledge its *
00022 // * use  in  resulting  scientific  publications,  and indicate your *
00023 // * acceptance of all terms of the Geant4 Software license.          *
00024 // ********************************************************************
00025 //
00026 //
00027 // $Id: G4Mag_EqRhs.hh 69786 2013-05-15 09:38:51Z gcosmo $
00028 //
00029 //
00030 // class G4Mag_EqRhs
00031 //
00032 // Class description:
00033 //
00034 // The "standard" equation of motion of a particle in a pure magnetic field.
00035 
00036 // History:
00037 // - Created. J.Apostolakis, January 13th 1997
00038 // --------------------------------------------------------------------
00039 
00040 #ifndef G4_MAG_EQRHS_DEF
00041 #define G4_MAG_EQRHS_DEF
00042 
00043 #include "G4Types.hh"
00044 #include "G4EquationOfMotion.hh"
00045 
00046 class G4MagneticField;
00047 
00048 class G4Mag_EqRhs : public G4EquationOfMotion
00049 {
00050   public: // with description
00051 
00052      G4Mag_EqRhs( G4MagneticField *magField );
00053      virtual ~G4Mag_EqRhs();
00054        // Constructor and destructor. No actions.
00055 
00056      virtual void EvaluateRhsGivenB( const  G4double y[],
00057                                      const  G4double B[3],
00058                                             G4double dydx[] ) const = 0;
00059        // Given the value of the  field "B", this function 
00060        // calculates the value of the derivative dydx.
00061        // This is the _only_ function a subclass must define.
00062        // The other two functions use Rhs_givenB.
00063 
00064      inline G4double FCof() const;
00065 
00066      virtual void SetChargeMomentumMass( G4double particleCharge, // in e+ units
00067                                          G4double MomentumXc,
00068                                          G4double mass);
00069      
00070   private:
00071 
00072      G4double fCof_val;
00073 
00074      static const G4double fUnitConstant;     // Set in G4Mag_EqRhs.cc 
00075                                               // to 0.299792458
00076        // Coefficient in the Lorentz motion equation (Lorentz force), if the
00077        //  magnetic field B is in Tesla, the particle charge in units of the 
00078        //  elementary (positron?) charge, the momentum P in MeV/c, and the
00079        //  space coordinates and path along the trajectory in mm .
00080 };
00081 
00082 inline
00083 G4double G4Mag_EqRhs::FCof() const
00084 {
00085   return fCof_val;
00086 }
00087 
00088 #endif /* G4_MAG_EQRHS_DEF */

Generated on Mon May 27 17:48:50 2013 for Geant4 by  doxygen 1.4.7