field04/include/F04FocusSolenoid.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 //
0027 /// \file field/field04/include/F04FocusSolenoid.hh
0028 /// \brief Definition of the F04FocusSolenoid class
0029 //
0030
0031 #ifndef F04FocusSolenoid_h
0032 #define F04FocusSolenoid_h 1
0033
0034 #include "F04SimpleSolenoid.hh"
0035
0036 #include "G4LogicalVolume.hh"
0037
0038 //  F04FocusSolenoid implements a solenoid magnet with an increased
0039 //  cylindrical magnetic field in +/- z-direction (or half focusing)
0040
0041 class F04FocusSolenoid : public F04SimpleSolenoid
0042 {
0043   public:
0044     ///  Default constructor.
0045     F04FocusSolenoid(G4double, G4double, G4double, G4LogicalVolume*, G4ThreeVector);
0046
0047     ///  Destructor.
0048     ~F04FocusSolenoid() override = default;
0049
0050     ///  Set F04FocusSolenoid to only half-focusing (default negative z)
0051     void SetHalf(G4bool h) { fHalf = h; }
0052
0053     ///  AddFieldValue() adds the field for this solenoid into field[].
0054     ///  point[] is in global coordinates.
0055     void AddFieldValue(const G4double point[4], G4double field[6]) const override;
0056
0057   private:
0058     G4bool fHalf = false;
0059
0060     G4double fB1 = 0.;
0061     G4double fB2 = 0.;
0062 };
0063
0064 #endif