Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/examples/extended/field/field04/include/F04SimpleSolenoid.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ] 

  1 //
  2 // ********************************************************************
  3 // * License and Disclaimer                                           *
  4 // *                                                                  *
  5 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
  6 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
  7 // * conditions of the Geant4 Software License,  included in the file *
  8 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
  9 // * include a list of copyright holders.                             *
 10 // *                                                                  *
 11 // * Neither the authors of this software system, nor their employing *
 12 // * institutes,nor the agencies providing financial support for this *
 13 // * work  make  any representation or  warranty, express or implied, *
 14 // * regarding  this  software system or assume any liability for its *
 15 // * use.  Please see the license in the file  LICENSE  and URL above *
 16 // * for the full disclaimer and the limitation of liability.         *
 17 // *                                                                  *
 18 // * This  code  implementation is the result of  the  scientific and *
 19 // * technical work of the GEANT4 collaboration.                      *
 20 // * By using,  copying,  modifying or  distributing the software (or *
 21 // * any work based  on the software)  you  agree  to acknowledge its *
 22 // * use  in  resulting  scientific  publications,  and indicate your *
 23 // * acceptance of all terms of the Geant4 Software license.          *
 24 // ********************************************************************
 25 //
 26 //
 27 /// \file field/field04/include/F04SimpleSolenoid.hh
 28 /// \brief Definition of the F04SimpleSolenoid class
 29 //
 30 
 31 #ifndef F04SimpleSolenoid_h
 32 #define F04SimpleSolenoid_h 1
 33 
 34 #include "F04ElementField.hh"
 35 #include "F04GlobalField.hh"
 36 
 37 #include "G4LogicalVolume.hh"
 38 #include "G4Tubs.hh"
 39 
 40 //  F04SimpleSolenoid implements a solenoid magnet with a constant
 41 //  cylindrical magnetic field in z-direction
 42 
 43 class F04SimpleSolenoid : public F04ElementField
 44 {
 45   public:
 46     ///  Default constructor.
 47     F04SimpleSolenoid(G4double, G4double, G4LogicalVolume*, G4ThreeVector);
 48 
 49     ///  Destructor.
 50     ~F04SimpleSolenoid() override = default;
 51 
 52     ///  GetLength() returns the length of the solenoid
 53     G4double GetLength() override { return fFieldLength; }
 54 
 55     ///  GetWidth() returns the solenoid diameter
 56     G4double GetWidth() override { return fFieldRadius * 2.0; }
 57 
 58     ///  GetHeight() returns the solenoid diameter
 59     G4double GetHeight() override { return fFieldRadius * 2.0; }
 60 
 61     /// SetFringeZ(G4double) sets the solenoid fringe field z-length
 62     void SetFringeZ(G4double z) { fFringeZ = z; }
 63 
 64     /// GetFringeZ() returns the solenoid fringe field z-length
 65     G4double GetFringeZ() { return fFringeZ; }
 66 
 67     ///  IsOutside() returns true when outside the solenoid
 68     G4bool IsOutside(G4ThreeVector& local) const;
 69 
 70     /// IsWithin() returns true when inside the solenoid
 71     G4bool IsWithin(G4ThreeVector& local) const;
 72 
 73     ///  AddFieldValue() adds the field for this solenoid into field[].
 74     ///  point[] is in global coordinates.
 75     void AddFieldValue(const G4double point[4], G4double field[6]) const override;
 76 
 77   private:
 78     G4double fBfield = 0.;
 79 
 80     G4double fFringeZ = 0.;
 81 
 82     G4double fFieldLength = 0.;
 83     G4double fFieldRadius = 0.;
 84 };
 85 
 86 #endif
 87