#include <SolenoidTest.h>

Inheritance diagram for MagField::SolenoidTest:

Collaboration diagram for MagField::SolenoidTest:

Public Member Functions
	SolenoidTest (const std::string &name, ISvcLocator *pSvcLocator)
virtual StatusCode	initialize () override final
virtual StatusCode	execute () override final
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadCondHandleKey< AtlasFieldCacheCondObj >	m_fieldCacheKey
ServiceHandle< ITHistSvc >	m_thistSvc
	Histogram Service.
double	m_xyzt [4] {}
	Variable to write out.
double	m_field [3] {}
	stores the field components
double	m_fieldZR [3] {}
	stores the 2d field components
double	m_deriv [9] {}
	stores derivatives
double	m_derivZR [9] {}
	stores derivatives
TTree *	m_tree {nullptr}
	the ROOT tree containing the output
Gaudi::Property< std::string >	m_histStream
Gaudi::Property< std::string >	m_treeName
Gaudi::Property< double >	m_minR {this, "MinimumR", 0, "minimum R"}
Gaudi::Property< double >	m_maxR {this, "MaximumR", 1075., "maximum R"}
Gaudi::Property< double >	m_minZ {this, "MinimumZ", -2820, "minimum Z"}
Gaudi::Property< double >	m_maxZ {this, "MaximumZ", 2820., "maximum Z"}
Gaudi::Property< int >	m_stepsR
Gaudi::Property< int >	m_stepsZ
Gaudi::Property< int >	m_stepsPhi
Gaudi::Property< int >	m_event
std::atomic< long int >	m_eventsSeen {0}
	event counter
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 31 of file SolenoidTest.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ SolenoidTest()

MagField::SolenoidTest::SolenoidTest	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Definition at line 27 of file SolenoidTest.cxx.

29 : AthAlgorithm(name, pSvcLocator), m_thistSvc("THistSvc/THistSvc", name) {}

AthAlgorithm::AthAlgorithm

AthAlgorithm()

Default constructor:

MagField::SolenoidTest::m_thistSvc

ServiceHandle< ITHistSvc > m_thistSvc

Histogram Service.

Definition SolenoidTest.h:45

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode MagField::SolenoidTest::execute ( )

finaloverridevirtual

Definition at line 63 of file SolenoidTest.cxx.

                                         {
  SG::ReadCondHandle<AtlasFieldCacheCondObj> rh{m_fieldCacheKey,
                                                Gaudi::Hive::currentContext()};
  const AtlasFieldCacheCondObj* fieldCondObj{*rh};
  if (fieldCondObj == nullptr) {
    ATH_MSG_ERROR("Failed to retrieve AtlasFieldCacheCondObj with key "
                  << m_fieldCacheKey.key());
    return StatusCode::FAILURE;
  }
 
  MagField::AtlasFieldCache fieldCache;
  fieldCondObj->getInitializedCache(fieldCache);
 
  if (m_eventsSeen == m_event) {
 
    double deltaZ = (m_maxZ - m_minZ) / (m_stepsZ - 1);
    double deltaR = (m_maxR - m_minR) / m_stepsR - 1;
    double deltaPhi = (2 * M_PI) / (m_stepsPhi - 1);
 
    for (int k = 0; k < m_stepsPhi; k++) {  // loop over phi
      double phi = deltaPhi * k;
      for (int j = 0; j < m_stepsZ; j++) {  // loop over Z
        m_xyzt[2] = m_minZ + deltaZ * j;
        for (int i = 0; i < m_stepsR; i++) {  // loop over R
          double r = m_minR + deltaR * i;
          m_xyzt[0] = r * cos(phi);
          m_xyzt[1] = r * sin(phi);
 
          fieldCache.getField(m_xyzt, m_field, m_deriv);
          fieldCache.getFieldZR(m_xyzt, m_fieldZR, nullptr);
          ATH_MSG_INFO("Field at r,phi " << r << ", " << phi << ", "
                                        << " with xyz: " << m_xyzt[0] << ", "
                                        << m_xyzt[1] << ", " << m_xyzt[2]
                                        << " with value " << m_field[0] << ", "
                                        << m_field[1] << ", " << m_field[2]);
 
          m_tree->Fill();
        }
      }
    }
  }
  m_eventsSeen++;
  return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

◆ initialize()

StatusCode MagField::SolenoidTest::initialize ( )

finaloverridevirtual

Definition at line 32 of file SolenoidTest.cxx.

                                            {
  ATH_CHECK(m_fieldCacheKey.initialize());
  // retrieve the histogram service
  if (m_thistSvc.retrieve().isFailure()) {
    ATH_MSG_ERROR("Unable to retrieve HistogramSvc");
    return StatusCode::FAILURE;
  }
  // Create the prefix of histogram names for the THistSvc
  std::string prefix = "/" + m_histStream + "/";
 
  std::string treeName = m_treeName.value();
  // the ROOT tree
  m_tree = new TTree(treeName.c_str(), "Magnetic field in the solenoid");
  m_tree->Branch("pos", &m_xyzt, "x/D:y/D:z/D");
  m_tree->Branch("fieldFull", &m_field, "Bx/D:By/D:Bz/D");
  m_tree->Branch("deriv", &m_deriv,
                 "dBxdx/D:dBxdy/D:dBxdz/D:dBydx/D:dBydy/D:dBydz/"
                 "D:dBzdx/D:dBzdy/D:dBzdz/D");
  m_tree->Branch("fieldFast", &m_fieldZR, "Bx2/D:By2/D:Bz2/D");
  m_tree->Branch("derivZR", &m_derivZR,
                 "dBxdx2/D:dBxdy2/D:dBxdz2/D:dBydx2/D:dBydy2/D:dBydz2/"
                 "D:dBzdx2/D:dBzdy2/D:dBzdz2/D");
  // register this ROOT TTree to the THistSvc
  if (m_thistSvc->regTree(prefix + treeName, m_tree).isFailure()) {
    ATH_MSG_ERROR("Unable to register TTree to THistSvc");
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg()

MsgStream & AthCommonMsg< Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_deriv

double MagField::SolenoidTest::m_deriv[9] {}

private

stores derivatives

Definition at line 50 of file SolenoidTest.h.

50{};

◆ m_derivZR

double MagField::SolenoidTest::m_derivZR[9] {}

private

stores derivatives

Definition at line 51 of file SolenoidTest.h.

51{};

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_event

Gaudi::Property<int> MagField::SolenoidTest::m_event

private

Initial value:

{this, "eventTodump", 0,

"Event to dump the magnetic field for"}

Definition at line 71 of file SolenoidTest.h.

71 {this, "eventTodump", 0,

72 "Event to dump the magnetic field for"};

◆ m_eventsSeen

std::atomic<long int> MagField::SolenoidTest::m_eventsSeen {0}

private

event counter

Definition at line 73 of file SolenoidTest.h.

73{0};

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_field

double MagField::SolenoidTest::m_field[3] {}

private

stores the field components

Definition at line 48 of file SolenoidTest.h.

48{};

◆ m_fieldCacheKey

SG::ReadCondHandleKey<AtlasFieldCacheCondObj> MagField::SolenoidTest::m_fieldCacheKey

private

Initial value:

{
      this, "AtlasFieldCacheCondObj", "fieldCondObj",
      "Magnetic Field conditions object key"}

Definition at line 40 of file SolenoidTest.h.

                                                             {
      this, "AtlasFieldCacheCondObj", "fieldCondObj",
      "Magnetic Field conditions object key"};

◆ m_fieldZR

double MagField::SolenoidTest::m_fieldZR[3] {}

private

stores the 2d field components

Definition at line 49 of file SolenoidTest.h.

49{};

◆ m_histStream

Gaudi::Property<std::string> MagField::SolenoidTest::m_histStream

private

Initial value:

{
      this, "HistStreamName", "SolenoidTest",
      "Name of the THistSvc output stream"}

Definition at line 55 of file SolenoidTest.h.

                                       {
      this, "HistStreamName", "SolenoidTest",
      "Name of the THistSvc output stream"};

◆ m_maxR

Gaudi::Property<double> MagField::SolenoidTest::m_maxR {this, "MaximumR", 1075., "maximum R"}

private

Definition at line 62 of file SolenoidTest.h.

62{this, "MaximumR", 1075., "maximum R"};

◆ m_maxZ

Gaudi::Property<double> MagField::SolenoidTest::m_maxZ {this, "MaximumZ", 2820., "maximum Z"}

private

Definition at line 64 of file SolenoidTest.h.

64{this, "MaximumZ", 2820., "maximum Z"};

◆ m_minR

Gaudi::Property<double> MagField::SolenoidTest::m_minR {this, "MinimumR", 0, "minimum R"}

private

Definition at line 61 of file SolenoidTest.h.

61{this, "MinimumR", 0, "minimum R"};

◆ m_minZ

Gaudi::Property<double> MagField::SolenoidTest::m_minZ {this, "MinimumZ", -2820, "minimum Z"}

private

Definition at line 63 of file SolenoidTest.h.

63{this, "MinimumZ", -2820, "minimum Z"};

◆ m_stepsPhi

Gaudi::Property<int> MagField::SolenoidTest::m_stepsPhi

private

Initial value:

{this, "StepsPhi", 200,

"Number of steps along phi (granularity)"}

Definition at line 69 of file SolenoidTest.h.

69 {this, "StepsPhi", 200,

70 "Number of steps along phi (granularity)"};

◆ m_stepsR

Gaudi::Property<int> MagField::SolenoidTest::m_stepsR

private

Initial value:

{this, "StepsR", 200,

"Number of steps along radius (granularity)"}

Definition at line 65 of file SolenoidTest.h.

65 {this, "StepsR", 200,

66 "Number of steps along radius (granularity)"};

◆ m_stepsZ

Gaudi::Property<int> MagField::SolenoidTest::m_stepsZ

private

Initial value:

{this, "StepsZ", 200,

"Number of steps along z (granularity)"}

Definition at line 67 of file SolenoidTest.h.

67 {this, "StepsZ", 200,

68 "Number of steps along z (granularity)"};

◆ m_thistSvc

ServiceHandle<ITHistSvc> MagField::SolenoidTest::m_thistSvc

private

Histogram Service.

Definition at line 45 of file SolenoidTest.h.

◆ m_tree

TTree* MagField::SolenoidTest::m_tree {nullptr}

private

the ROOT tree containing the output

Definition at line 53 of file SolenoidTest.h.

53{nullptr};

◆ m_treeName

Gaudi::Property<std::string> MagField::SolenoidTest::m_treeName

private

Initial value:

{
      this, "ROOTTreeName", "field",
      "Name of the TTree object in the output file."}

Definition at line 58 of file SolenoidTest.h.

                                     {
      this, "ROOTTreeName", "field",
      "Name of the TTree object in the output file."};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

◆ m_xyzt

double MagField::SolenoidTest::m_xyzt[4] {}

private

Variable to write out.

stores the current xyzt position

Definition at line 47 of file SolenoidTest.h.

47{};

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ SolenoidTest()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_deriv

◆ m_derivZR

◆ m_detStore

◆ m_event

◆ m_eventsSeen

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_field

◆ m_fieldCacheKey

◆ m_fieldZR

◆ m_histStream

◆ m_maxR

◆ m_maxZ

◆ m_minR

◆ m_minZ

◆ m_stepsPhi

◆ m_stepsR

◆ m_stepsZ

◆ m_thistSvc

◆ m_tree

◆ m_treeName

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_xyzt