field04/include/F04SimpleSolenoid.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 F04SimpleSolenoid.hh
0027 /// \brief Definition of the F04SimpleSolenoid class
0028
0029 #ifndef F04SimpleSolenoid_h
0030 #define F04SimpleSolenoid_h 1
0031
0032 #include "F04ElementField.hh"
0033 #include "F04GlobalField.hh"
0034
0035 #include "G4LogicalVolume.hh"
0036 #include "G4Tubs.hh"
0037
0038 //  F04SimpleSolenoid implements a solenoid magnet with a constant
0039 //  cylindrical magnetic field in z-direction
0040
0041 class F04SimpleSolenoid : public F04ElementField
0042 {
0043   public:
0044     ///  Default constructor.
0045     F04SimpleSolenoid(G4double, G4double, G4LogicalVolume*, G4ThreeVector);
0046
0047     ///  Destructor.
0048     ~F04SimpleSolenoid() override = default;
0049
0050     ///  GetLength() returns the length of the solenoid
0051     G4double GetLength() override { return fFieldLength; }
0052
0053     ///  GetWidth() returns the solenoid diameter
0054     G4double GetWidth() override { return fFieldRadius * 2.0; }
0055
0056     ///  GetHeight() returns the solenoid diameter
0057     G4double GetHeight() override { return fFieldRadius * 2.0; }
0058
0059     /// SetFringeZ(G4double) sets the solenoid fringe field z-length
0060     void SetFringeZ(G4double z) { fFringeZ = z; }
0061
0062     /// GetFringeZ() returns the solenoid fringe field z-length
0063     G4double GetFringeZ() { return fFringeZ; }
0064
0065     ///  IsOutside() returns true when outside the solenoid
0066     G4bool IsOutside(G4ThreeVector& local) const;
0067
0068     /// IsWithin() returns true when inside the solenoid
0069     G4bool IsWithin(G4ThreeVector& local) const;
0070
0071     ///  AddFieldValue() adds the field for this solenoid into field[].
0072     ///  point[] is in global coordinates.
0073     void AddFieldValue(const G4double point[4], G4double field[6]) const override;
0074
0075   private:
0076     G4double fBfield = 0.;
0077
0078     G4double fFringeZ = 0.;
0079
0080     G4double fFieldLength = 0.;
0081     G4double fFieldRadius = 0.;
0082 };
0083
0084 #endif