BDSMagnet.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway, 
University of London 2001 - 2023.
 
This file is part of BDSIM.
 
BDSIM is free software: you can redistribute it and/or modify 
it under the terms of the GNU General Public License as published 
by the Free Software Foundation version 3 of the License.
 
BDSIM is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with BDSIM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef BDSMAGNET_H
#define BDSMAGNET_H
 
#include "globals.hh"
#include "BDSAcceleratorComponent.hh"
#include "BDSFieldInfo.hh"
#include "BDSMagnetType.hh"
 
class BDSBeamPipe;
class BDSBeamPipeInfo;
class BDSMagnetOuter;
class BDSMagnetOuterInfo;
class BDSMagnetStrength;
 
class BDSMagnet: public BDSAcceleratorComponent
{
public:
  BDSMagnet(BDSMagnetType       type,
            const G4String&     name, 
            G4double            length,
            BDSBeamPipeInfo*    beamPipeInfo,
            BDSMagnetOuterInfo* magnetOuterInfo,
            BDSFieldInfo*       vacuumFieldInfoIn,
            G4double            angle            = 0,
            BDSFieldInfo*       outerFieldInfoIn = nullptr,
            G4bool              isThin           = false);
  
  virtual ~BDSMagnet();
  
  inline const BDSMagnetStrength* MagnetStrength() const {return vacuumFieldInfo ? vacuumFieldInfo->MagnetStrength() : nullptr;}
 
  void SetOuterField(BDSFieldInfo* outerFieldInfoIn);
  void SetVacuumField(BDSFieldInfo* vacuumFieldInfoIn);
 
  static G4String DetermineScalingKey(BDSMagnetType typeIn);
 
  virtual void SetInputFaceNormal(const G4ThreeVector& input);
  virtual void SetOutputFaceNormal(const G4ThreeVector& output);
 
  virtual G4String Material() const;
 
  virtual G4bool HasAField() const {return vacuumFieldInfo || outerFieldInfo;}
  
  virtual void SetFieldUsePlacementWorldTransform();
  
protected:
  BDSMagnet() = delete;
 
  BDSMagnet& operator=(const BDSMagnet&) = delete;
  BDSMagnet(BDSMagnet&) = delete;
  
  virtual void Build();
  
  virtual void BuildBeampipe();
 
  virtual void BuildVacuumField();
 
  virtual void BuildOuter();
  
  virtual void BuildOuterField();
 
  virtual void BuildContainerLogicalVolume();
 
  virtual void PlaceComponents();
  
  BDSMagnetType magnetType;
 
  BDSMagnetOuterInfo* magnetOuterInfo;
 
  BDSFieldInfo* vacuumFieldInfo;
 
  BDSFieldInfo* outerFieldInfo;
  
  BDSBeamPipe*    beampipe;
 
  G4bool          placeBeamPipe;
 
  G4double        horizontalWidth;
 
  G4double        containerRadius;
  
  G4ThreeVector magnetOuterOffset;
  
  BDSMagnetOuter* outer;
 
  G4Transform3D beamPipePlacementTransform;
 
  G4bool isThin;
};
 
#endif