F02ElectricFieldSetup.hh

Go to the documentation of this file.

//
// ********************************************************************
// * 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 field/field02/include/F02ElectricFieldSetup.hh
/// \brief Definition of the F02ElectricFieldSetup class
//
//
//
//
//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
 
#ifndef F02ElectricFieldSetup_h
#define F02ElectricFieldSetup_h 1
 
#include "G4ElectricField.hh"
#include "G4UniformElectricField.hh"
 
#include "CLHEP/Units/SystemOfUnits.h"
 
class G4FieldManager;
class G4ChordFinder;
class G4EquationOfMotion;
class G4Mag_EqRhs;
class G4EqMagElectricField;
class G4MagIntegratorStepper;
class G4MagInt_Driver;
class F02FieldMessenger;
 
/// A class for control of the Electric Field of the detector.
///     The field for this case is uniform.
///
/// The field for this case is uniform.
/// It is simply a 'setup' class that creates the field and necessary
/// other parts
 
class F02ElectricFieldSetup
{
public:
  F02ElectricFieldSetup(G4ThreeVector);  //  The value of the field
  F02ElectricFieldSetup();               //  A zero field - true value set later
 
  virtual ~F02ElectricFieldSetup();
 
   // Methods to set parameters or select
  void SetStepperType( G4int i) { fStepperType = i ; CreateStepper(); }
 
  void SetMinStep(G4double s) { fMinStep = s ; }
 
  void SetFieldValue(G4ThreeVector fieldVector);
  void SetFieldZValue(G4double      fieldValue);
  G4ThreeVector GetConstantFieldValue();
   // Set/Get Field strength in Geant4 units
 
  void UpdateIntegrator();
   // Prepare all the classes required for tracking - from stepper
   //    to Chord-Finder
   //   NOTE:  field and equation must have been created before calling this.
 
protected:
 
  // Find the global Field Manager
 
  G4FieldManager*         GetGlobalFieldManager();
 
  void CreateStepper();
   // Implementation method - should not be exposed
 
private:
  G4double                fMinStep = 0.010 * CLHEP::mm;
 
  G4FieldManager*         fFieldManager = nullptr;
  G4ChordFinder*          fChordFinder = nullptr;
  G4EqMagElectricField*   fEquation = nullptr;
  G4ElectricField*        fEMfield = nullptr;
 
  G4ThreeVector           fElFieldValue;
 
  G4MagIntegratorStepper* fStepper = nullptr;
  G4MagInt_Driver*        fIntgrDriver = nullptr;
 
  G4int                   fStepperType = 4;  // ClassicalRK4 -- the default stepper;
 
  F02FieldMessenger*      fFieldMessenger = nullptr;
 
};
 
#endif