include/Geant4/G4UniformMagField.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 // G4UniformMagField
0027 //
0028 // Class description:
0029 //
0030 // Class for creation of Uniform Magnetic Field.
0031
0032 // Author: Vladimir Grichine (CERN), 30.01.1997
0033 // -------------------------------------------------------------------
0034 #ifndef G4UNIFORMMAGFIELD_HH
0035 #define G4UNIFORMMAGFIELD_HH
0036
0037 #include "G4Types.hh"
0038 #include "G4ThreeVector.hh"
0039 #include "G4MagneticField.hh"
0040
0041 /**
0042  * @brief G4UniformMagField is a class for defining a uniform magnetic field.
0043  */
0044
0045 class G4UniformMagField : public G4MagneticField
0046 {
0047   public:
0048
0049     /**
0050      * Constructor for G4UniformMagField, a field with value equal
0051      * to 'FieldVector'.
0052      *  @param[in] FieldVector The field vector value.
0053      */
0054     G4UniformMagField(const G4ThreeVector& FieldVector);
0055
0056     /**
0057      * Alternative constructor for G4UniformMagField.
0058      *  @param[in] vField The field component.
0059      *  @param[in] vTheta The Theta component.
0060      *  @param[in] vPhi The Phi component.
0061      */
0062     G4UniformMagField(G4double vField,
0063                       G4double vTheta,
0064                       G4double vPhi);
0065
0066     /**
0067      * Default Destructor.
0068      */
0069     ~G4UniformMagField() override = default;
0070
0071     /**
0072      * Copy constructor and assignment operator.
0073      */
0074     G4UniformMagField(const G4UniformMagField& p);
0075     G4UniformMagField& operator = (const G4UniformMagField& p);
0076
0077     /**
0078      * Returns the field value 'MagField' on given time 'yTrack'.
0079      */
0080     void GetFieldValue(const G4double yTrack[4],
0081                              G4double* MagField) const override;
0082
0083     /**
0084      * Sets the field value.
0085      */
0086     void SetFieldValue(const G4ThreeVector& newFieldValue);
0087
0088     /**
0089      * Returns the constant field value.
0090      */
0091     G4ThreeVector GetConstantFieldValue() const;
0092
0093     /**
0094      * Returns a pointer to a new allocated clone of this object.
0095      */
0096     G4Field* Clone() const override;
0097
0098   private:
0099
0100     G4double fFieldComponents[3];
0101 };
0102
0103 #endif