include/Geant4/G4LineCurrentMagField.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 // G4LineCurrentMagField
0027 //
0028 // Class description:
0029 //
0030 // Class describing line current magnetic field.
0031 // 'fFieldConstant' determines the coefficient in the field law.
0032 // The line current is directed along Z axis and crosses the XY
0033 // plane in the origin point (0,0).
0034
0035 // Author: Vladimir Grichine (CERN), 03.02.1997
0036 // --------------------------------------------------------------------
0037 #ifndef G4LINECURRENTMAGFIELD_HH
0038 #define G4LINECURRENTMAGFIELD_HH
0039
0040 #include "G4MagneticField.hh"
0041
0042 /**
0043  * @brief G4LineCurrentMagField is a class describing a line current magnetic
0044  * field. The line current is directed along the Z axis and crosses the XY
0045  * plane in the origin point.
0046  */
0047
0048 class G4LineCurrentMagField : public G4MagneticField
0049 {
0050   public:
0051
0052     /**
0053      * Constructor for G4LineCurrentMagField.
0054      *  @param[in] pFieldConstant Value of the constant field.
0055      */
0056     G4LineCurrentMagField(G4double pFieldConstant);
0057
0058     /**
0059      * Default Destructor.
0060      */
0061     ~G4LineCurrentMagField() override = default;
0062
0063     /**
0064      * Returns the field value on the given position 'yTrack'.
0065      *  @param[in] yTrack Time position array.
0066      *  @param[out] B The returned field array.
0067      */
0068     void GetFieldValue(const G4double yTrack[], G4double B[]) const override;
0069
0070     /**
0071      * Returns a pointer to a new allocated clone of this object.
0072      */
0073     G4Field* Clone() const override;
0074
0075   private:
0076
0077     G4double fFieldConstant = 0.0;
0078 };
0079
0080 #endif