include/Geant4/G4EqGravityField.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // G4EqGravityField
0027 //
0028 // Class description:
0029 //
0030 // This is the right-hand side of equation of motion in a gravity field.
0031
0032 // Author: Peter Gumplinger (TRIUMF), 14.06.11 - Adopted from G4EqMagElectricField
0033 //         Thanks to P.Fierlinger (PSI) and A.Capra and A.Fontana (INFN Pavia)
0034 // -------------------------------------------------------------------
0035 #ifndef G4EQGRAVITYFIELD_HH
0036 #define G4EQGRAVITYFIELD_HH
0037
0038 #include "G4ChargeState.hh"
0039 #include "G4EquationOfMotion.hh"
0040 #include "G4UniformGravityField.hh"
0041
0042 /**
0043  * @brief G4EqGravityField implements the right-hand side of equation
0044  * of motion in a gravity field.
0045  */
0046
0047 class G4EqGravityField : public G4EquationOfMotion
0048 {
0049   public:
0050
0051     /**
0052      * Constructor for G4EqGravityField.
0053      *  @param[in] gField Pointer to the uniform gravity field.
0054      */
0055     G4EqGravityField(G4UniformGravityField* gField);
0056
0057     /**
0058      * Default Destructor.
0059      */
0060     ~G4EqGravityField() override = default;
0061
0062     /**
0063      * Sets the charge, momentum and mass of the current particle.
0064      * Used to set the equation's coefficients.
0065      *  @param[in] particleCharge Magnetic charge and moments in e+ units.
0066      *  @param[in] MomentumXc Particle momentum.
0067      *  @param[in] mass Particle mass.
0068      */
0069     void SetChargeMomentumMass(G4ChargeState particleCharge, // in e+ units
0070                                G4double MomentumXc,
0071                                G4double mass) override;
0072
0073     /**
0074      * Calculates the value of the derivative, given the value of the
0075      * electromagnetic field.
0076      *  @param[in] y Coefficients array.
0077      *  @param[in] Field Field value.
0078      *  @param[out] dydx Derivatives array.
0079      */
0080     void EvaluateRhsGivenB( const G4double y[],
0081                             const G4double Field[],
0082                                   G4double dydx[] ) const override;
0083
0084     /**
0085      * Returns the equation type-ID, "kEqGravity".
0086      */
0087     inline G4EquationType GetEquationType() const override { return kEqGravity; }
0088
0089   private:
0090
0091     G4double fMass = 0.0;
0092 };
0093
0094 #endif