VolumeBasedMagneticField Class Reference

#include <VolumeBasedMagneticField.h>

Inheritance diagram for VolumeBasedMagneticField:

Public Member Functions
MagneticField *	clone () const override
	Returns a shallow copy. More...
const MagVolume *	findVolume (const GlobalPoint &gp) const
GlobalVector	inTesla (const GlobalPoint &g) const override
	Field value ad specified global point, in Tesla. More...
GlobalVector	inTeslaUnchecked (const GlobalPoint &g) const override
bool	isDefined (const GlobalPoint &gp) const override
	True if the point is within the region where the concrete field. More...
	VolumeBasedMagneticField (int geomVersion, const std::vector< MagBLayer * > &theBLayers, const std::vector< MagESector * > &theESectors, const std::vector< MagVolume6Faces * > &theBVolumes, const std::vector< MagVolume6Faces * > &theEVolumes, float rMax, float zMax, const MagneticField *param=nullptr, bool isParamFieldOwned=false)
	VolumeBasedMagneticField (const VolumeBasedMagneticField &vbf)
	Copy constructor implement a shallow copy (ie no ownership of actual engines) More...
	~VolumeBasedMagneticField () override
Public Member Functions inherited from MagneticField
GlobalVector	inInverseGeV (const GlobalPoint &gp) const
	Field value ad specified global point, in 1/Gev. More...
GlobalVector	inKGauss (const GlobalPoint &gp) const
	Field value ad specified global point, in KGauss. More...
float	inverseBzAtOriginInGeV () const
	The inverse of field z component for this map in GeV. More...
	MagneticField ()
	MagneticField (const MagneticField &orig)
int	nominalValue () const
	The nominal field value for this map in kGauss. More...
virtual	~MagneticField ()

Private Attributes
const MagGeometry *	field
bool	magGeomOwned
float	maxRsq
float	maxZ
const MagneticField *	paramField
bool	paramFieldOwned

Friends
class	testMagGeometryAnalyzer
class	testMagneticField

Additional Inherited Members
Protected Member Functions inherited from MagneticField
void	setNominalValue ()

Detailed Description

Field engine providing interpolation within the full CMS region.

Author

N. Amapane - CERN

Definition at line 18 of file VolumeBasedMagneticField.h.

Constructor & Destructor Documentation

VolumeBasedMagneticField::VolumeBasedMagneticField	(	int	geomVersion,
		const std::vector< MagBLayer * > &	theBLayers,
		const std::vector< MagESector * > &	theESectors,
		const std::vector< MagVolume6Faces * > &	theBVolumes,
		const std::vector< MagVolume6Faces * > &	theEVolumes,
		float	rMax,
		float	zMax,
		const MagneticField *	param = nullptr,
		bool	isParamFieldOwned = false
	)

Definition at line 4 of file VolumeBasedMagneticField.cc.

References MagneticField::setNominalValue().

Referenced by clone().

    : field(new MagGeometry(geomVersion, theBLayers, theESectors, theBVolumes, theEVolumes)),
      maxRsq(rMax * rMax),
      maxZ(zMax),
      paramField(param),
      magGeomOwned(true),
      paramFieldOwned(isParamFieldOwned) {
  setNominalValue();
}

VolumeBasedMagneticField::~VolumeBasedMagneticField ( )

override

Definition at line 36 of file VolumeBasedMagneticField.cc.

References field, magGeomOwned, paramField, and paramFieldOwned.

                                                    {
  if (magGeomOwned)
    delete field;
  if (paramFieldOwned)
    delete paramField;
}

VolumeBasedMagneticField::VolumeBasedMagneticField

(

const VolumeBasedMagneticField &

vbf

)

Copy constructor implement a shallow copy (ie no ownership of actual engines)

Definition at line 22 of file VolumeBasedMagneticField.cc.

References MagneticField::setNominalValue().

    : MagneticField::MagneticField(vbf),
      field(vbf.field),
      maxRsq(vbf.maxRsq),
      maxZ(vbf.maxZ),
      paramField(vbf.paramField),
      magGeomOwned(false),
      paramFieldOwned(false) {
  // std::cout << "VolumeBasedMagneticField::clone() (shallow copy)" << std::endl;
  setNominalValue();
}

Member Function Documentation

MagneticField * VolumeBasedMagneticField::clone ( void  ) const

overridevirtual

Returns a shallow copy.

Reimplemented from MagneticField.

Definition at line 34 of file VolumeBasedMagneticField.cc.

References VolumeBasedMagneticField().

{ return new VolumeBasedMagneticField(*this); }

const MagVolume * VolumeBasedMagneticField::findVolume

(

const GlobalPoint &

gp

)

const

Definition at line 62 of file VolumeBasedMagneticField.cc.

References field, and MagGeometry::findVolume().

Referenced by SteppingHelixPropagator::getNextState(), and SteppingHelixPropagator::loadState().

{ return field->findVolume(gp); }

GlobalVector VolumeBasedMagneticField::inTesla ( const GlobalPoint &  gp ) const

overridevirtual

Field value ad specified global point, in Tesla.

Implements MagneticField.

Definition at line 43 of file VolumeBasedMagneticField.cc.

References field, MagGeometry::fieldInTesla(), MagneticField::inTeslaUnchecked(), MagneticField::isDefined(), isDefined(), and paramField.

Referenced by IsolatedPixelTrackCandidateProducer::beginRun(), and IsolatedPixelTrackCandidateL1TProducer::beginRun().

                                                                          {
  // If parametrization of the inner region is available, use it.
  if (paramField && paramField->isDefined(gp))
    return paramField->inTeslaUnchecked(gp);

  // If point is outside magfield map, return 0 field (not an error)
  if (!isDefined(gp))
    return GlobalVector();

  return field->fieldInTesla(gp);
}

GlobalVector VolumeBasedMagneticField::inTeslaUnchecked ( const GlobalPoint &  gp ) const

overridevirtual

Optional implementation that derived classes can implement to provide faster query by skipping the check to isDefined.

Reimplemented from MagneticField.

Definition at line 55 of file VolumeBasedMagneticField.cc.

References field, MagGeometry::fieldInTesla(), MagneticField::inTeslaUnchecked(), MagneticField::isDefined(), and paramField.

                                                                                   {
  //same as above, but do not check range
  if (paramField && paramField->isDefined(gp))
    return paramField->inTeslaUnchecked(gp);
  return field->fieldInTesla(gp);
}

bool VolumeBasedMagneticField::isDefined ( const GlobalPoint &  ) const

overridevirtual

True if the point is within the region where the concrete field.

Reimplemented from MagneticField.

Definition at line 64 of file VolumeBasedMagneticField.cc.

References maxRsq, maxZ, PV3DBase< T, PVType, FrameType >::perp2(), and PV3DBase< T, PVType, FrameType >::z().

Referenced by inTesla().

                                                                    {
  return (fabs(gp.z()) < maxZ && gp.perp2() < maxRsq);
}

Friends And Related Function Documentation

friend class testMagGeometryAnalyzer

friend

Definition at line 21 of file VolumeBasedMagneticField.h.

friend class testMagneticField

friend

Definition at line 20 of file VolumeBasedMagneticField.h.

Member Data Documentation

const MagGeometry* VolumeBasedMagneticField::field

private

Definition at line 51 of file VolumeBasedMagneticField.h.

Referenced by findVolume(), inTesla(), inTeslaUnchecked(), and ~VolumeBasedMagneticField().

bool VolumeBasedMagneticField::magGeomOwned

private

Definition at line 55 of file VolumeBasedMagneticField.h.

Referenced by ~VolumeBasedMagneticField().

float VolumeBasedMagneticField::maxRsq

private

Definition at line 52 of file VolumeBasedMagneticField.h.

Referenced by isDefined().

float VolumeBasedMagneticField::maxZ

private

Definition at line 53 of file VolumeBasedMagneticField.h.

Referenced by isDefined().

const MagneticField* VolumeBasedMagneticField::paramField

private

Definition at line 54 of file VolumeBasedMagneticField.h.

Referenced by inTesla(), inTeslaUnchecked(), and ~VolumeBasedMagneticField().

bool VolumeBasedMagneticField::paramFieldOwned

private

Definition at line 56 of file VolumeBasedMagneticField.h.

Referenced by ~VolumeBasedMagneticField().