include/Geant4/G4ErrorMag_UsualEqRhs.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 // G4ErrorMag_UsualEqRhs
0027 //
0028 // Class description:
0029 //
0030 // Serves to reverse the magnetic field when propagation is backwards
0031 // for error propagation.
0032
0033 // Author: Pedro Arce (CIEMAT), September 2004.
0034 // --------------------------------------------------------------------
0035 #ifndef G4ERRORMAG_USUALEQRHS_HH
0036 #define G4ERRORMAG_USUALEQRHS_HH
0037
0038 #include "G4Mag_UsualEqRhs.hh"
0039 #include "G4MagneticField.hh"
0040
0041 /**
0042  * @brief G4ErrorMag_UsualEqRhs serves to reverse the magnetic field when
0043  * propagation is backwards. It is used for error propagation.
0044  */
0045
0046 class G4ErrorMag_UsualEqRhs : public G4Mag_UsualEqRhs
0047 {
0048   public:
0049
0050     /**
0051      * Constructor for G4ErrorMag_UsualEqRhs.
0052      *  @param[in] MagField Pointer to the magnetic field.
0053      */
0054     G4ErrorMag_UsualEqRhs( G4MagneticField* MagField );
0055
0056     /**
0057      * Default Destructor.
0058      */
0059     ~G4ErrorMag_UsualEqRhs() override = default;
0060
0061     /**
0062      * Calculates the value of the derivative, given the value of the
0063      * magnetic field. Reverses dedx if propagation is backwards.
0064      *  @param[in] y Coefficients array.
0065      *  @param[in] B Field value.
0066      *  @param[out] dydx Derivatives array.
0067      */
0068     void EvaluateRhsGivenB( const G4double y[],
0069                             const G4double B[3],
0070                                   G4double dydx[] ) const override;
0071 };
0072
0073 #endif