Files
geant4/examples/extended/field/field04/include/F04SimpleSolenoid.hh
2025-12-05 08:54:02 +01:00

85 lines
3.3 KiB
C++

//
// ********************************************************************
// * License and Disclaimer *
// * *
// * The Geant4 software is copyright of the Copyright Holders of *
// * the Geant4 Collaboration. It is provided under the terms and *
// * conditions of the Geant4 Software License, included in the file *
// * LICENSE and available at http://cern.ch/geant4/license . These *
// * include a list of copyright holders. *
// * *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work make any representation or warranty, express or implied, *
// * regarding this software system or assume any liability for its *
// * use. Please see the license in the file LICENSE and URL above *
// * for the full disclaimer and the limitation of liability. *
// * *
// * This code implementation is the result of the scientific and *
// * technical work of the GEANT4 collaboration. *
// * By using, copying, modifying or distributing the software (or *
// * any work based on the software) you agree to acknowledge its *
// * use in resulting scientific publications, and indicate your *
// * acceptance of all terms of the Geant4 Software license. *
// ********************************************************************
//
/// \file F04SimpleSolenoid.hh
/// \brief Definition of the F04SimpleSolenoid class
#ifndef F04SimpleSolenoid_h
#define F04SimpleSolenoid_h 1
#include "F04ElementField.hh"
#include "F04GlobalField.hh"
#include "G4LogicalVolume.hh"
#include "G4Tubs.hh"
// F04SimpleSolenoid implements a solenoid magnet with a constant
// cylindrical magnetic field in z-direction
class F04SimpleSolenoid : public F04ElementField
{
public:
/// Default constructor.
F04SimpleSolenoid(G4double, G4double, G4LogicalVolume*, G4ThreeVector);
/// Destructor.
~F04SimpleSolenoid() override = default;
/// GetLength() returns the length of the solenoid
G4double GetLength() override { return fFieldLength; }
/// GetWidth() returns the solenoid diameter
G4double GetWidth() override { return fFieldRadius * 2.0; }
/// GetHeight() returns the solenoid diameter
G4double GetHeight() override { return fFieldRadius * 2.0; }
/// SetFringeZ(G4double) sets the solenoid fringe field z-length
void SetFringeZ(G4double z) { fFringeZ = z; }
/// GetFringeZ() returns the solenoid fringe field z-length
G4double GetFringeZ() { return fFringeZ; }
/// IsOutside() returns true when outside the solenoid
G4bool IsOutside(G4ThreeVector& local) const;
/// IsWithin() returns true when inside the solenoid
G4bool IsWithin(G4ThreeVector& local) const;
/// AddFieldValue() adds the field for this solenoid into field[].
/// point[] is in global coordinates.
void AddFieldValue(const G4double point[4], G4double field[6]) const override;
private:
G4double fBfield = 0.;
G4double fFringeZ = 0.;
G4double fFieldLength = 0.;
G4double fFieldRadius = 0.;
};
#endif