include/Geant4/G4HelixHeum.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 // G4HelixHeum
0027 //
0028 // Class description:
0029 //
0030 // Simple Heum stepper for magnetic field:
0031 //     x_1 = x_0 +
0032 //           h * 1/4 * dx(t0,x0)  +
0033 //               3/4 * dx(t0+2/3*h, x0+2/3*h*(dx(t0+h/3,x0+h/3*dx(t0,x0))))
0034 // Third order solver.
0035
0036 // Author: W.Wander (MIT), 03.11.1998
0037 // -------------------------------------------------------------------
0038 #ifndef G4HELIXHEUM_HH
0039 #define G4HELIXHEUM_HH
0040
0041 #include "G4MagHelicalStepper.hh"
0042
0043 /**
0044  * @brief G4HelixHeum implements a simple Heum stepper for magnetic field
0045  * with 3rd order solver.
0046  */
0047
0048 class G4HelixHeum : public G4MagHelicalStepper
0049 {
0050   public:
0051
0052     /**
0053      * Constructor for G4HelixHeum.
0054      *  @param[in] EqRhs Pointer to the provided equation of motion.
0055      */
0056     G4HelixHeum(G4Mag_EqRhs* EqRhs);
0057
0058     /**
0059      * Default Destructor.
0060      */
0061     ~G4HelixHeum() override = default;
0062
0063     /**
0064      * The stepper function for the integration.
0065      *  @param[in] y Starting values array of integration variables.
0066      *  @param[in] Bfld The field vector.
0067      *  @param[in] h The given step size.
0068      *  @param[out] yout Integration output.
0069      */
0070     void DumbStepper( const G4double y[],
0071                             G4ThreeVector Bfld,
0072                             G4double h,
0073                             G4double yout[] ) override;
0074
0075     /**
0076      * Returns the order, 2, of integration.
0077      */
0078     inline G4int IntegratorOrder() const override { return 2; }
0079
0080     /**
0081      * Returns the stepper type-ID, "kHelixHeum".
0082      */
0083     inline G4StepperType StepperType() const override { return kHelixHeum; }
0084 };
0085
0086 #endif