BlineTracer/include/G4BlineEquation.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 /// \file G4BlineEquation.hh
0027 /// \brief Definition of the G4BlineEquation class
0028
0029 // --------------------------------------------------------------------
0030 //
0031 // G4BlineEquation
0032 //
0033 // Class description:
0034 //
0035 // This class defines the equation of motion needed to trace magnetic
0036 // field lines in the simulation.
0037
0038 // --------------------------------------------------------------------
0039 // Author: Laurent Desorgher (desorgher@phim.unibe.ch)
0040 //         Created - 2003-10-06
0041 // --------------------------------------------------------------------
0042 #ifndef G4BlineEquation_h
0043 #define G4BlineEquation_h 1
0044
0045 #include "G4Mag_EqRhs.hh"
0046 #include "G4MagneticField.hh"
0047
0048 class G4BlineEquation : public G4Mag_EqRhs
0049 {
0050   public:  // with description
0051     G4BlineEquation(G4MagneticField* magField);
0052     ~G4BlineEquation() override = default;
0053     // Constructor and destructor.
0054
0055     void EvaluateRhsGivenB(const G4double y[], const G4double B[3], G4double dydx[]) const override;
0056     // Given the value of the magnetic field B, this function
0057     // calculates the value of the derivative dydx.
0058
0059     void SetBackwardDirectionOfIntegration(G4bool abool);
0060
0061   private:
0062     G4bool fBackward_direction = false;
0063     G4double fDirection = 1.;
0064 };
0065
0066 #endif