MagGeometry Class Reference

#include <MagGeometry.h>

Public Types
typedef Surface::GlobalPoint	GlobalPoint
typedef Surface::GlobalVector	GlobalVector

Public Member Functions
const std::vector< MagVolume6Faces const * > &	barrelVolumes () const
const std::vector< MagVolume6Faces const * > &	endcapVolumes () const
GlobalVector	fieldInTesla (const GlobalPoint &gp) const
	Return field vector at the specified global point. More...
MagVolume const *	findVolume (const GlobalPoint &gp, double tolerance=0.) const
	Find a volume. More...
bool	isZSymmetric () const
	MagGeometry (int geomVersion, const std::vector< MagBLayer * > &, const std::vector< MagESector * > &, const std::vector< MagVolume6Faces * > &, const std::vector< MagVolume6Faces * > &)
	Constructor. More...
	MagGeometry (int geomVersion, const std::vector< MagBLayer const * > &, const std::vector< MagESector const * > &, const std::vector< MagVolume6Faces const * > &, const std::vector< MagVolume6Faces const * > &)
	~MagGeometry ()
	Destructor. More...

Private Member Functions
MagVolume const *	findVolume1 (const GlobalPoint &gp, double tolerance=0.) const
bool	inBarrel (const GlobalPoint &gp) const

Private Attributes
bool	cacheLastVolume
int	geometryVersion
std::atomic< MagVolume const * >	lastVolume
MagBinFinders::GeneralBinFinderInR< double > const *	theBarrelBinFinder
std::vector< MagBLayer const * >	theBLayers
std::vector< MagVolume6Faces const * >	theBVolumes
PeriodicBinFinderInPhi< float > const *	theEndcapBinFinder
std::vector< MagESector const * >	theESectors
std::vector< MagVolume6Faces const * >	theEVolumes

Friends
class	MagGeometryExerciser

Detailed Description

Entry point to the geometry of magnetic volumes.

Author

N. Amapane - INFN Torino

Definition at line 23 of file MagGeometry.h.

Member Typedef Documentation

typedef Surface::GlobalPoint MagGeometry::GlobalPoint

Definition at line 27 of file MagGeometry.h.

typedef Surface::GlobalVector MagGeometry::GlobalVector

Definition at line 26 of file MagGeometry.h.

Constructor & Destructor Documentation

MagGeometry::MagGeometry	(	int	geomVersion,
		const std::vector< MagBLayer * > &	tbl,
		const std::vector< MagESector * > &	tes,
		const std::vector< MagVolume6Faces * > &	tbv,
		const std::vector< MagVolume6Faces * > &	tev
	)

Constructor.

Definition at line 23 of file MagGeometry.cc.

                                                     :
  MagGeometry(geomVersion, reinterpret_cast<std::vector<MagBLayer const*> const&>(tbl), reinterpret_cast<std::vector<MagESector const*> const&>(tes), 
          reinterpret_cast<std::vector<MagVolume6Faces const*> const&>(tbv), reinterpret_cast<std::vector<MagVolume6Faces const*> const&>(tev)) {}

MagGeometry::MagGeometry	(	int	geomVersion,
		const std::vector< MagBLayer const * > &	tbl,
		const std::vector< MagESector const * > &	tes,
		const std::vector< MagVolume6Faces const * > &	tbv,
		const std::vector< MagVolume6Faces const * > &	tev
	)

Definition at line 30 of file MagGeometry.cc.

References gather_cfg::cout, verbose::debugOut, Geom::pi(), theBarrelBinFinder, theBLayers, theEndcapBinFinder, and theESectors.

                                                           : 
  lastVolume(0), theBLayers(tbl), theESectors(tes), theBVolumes(tbv), theEVolumes(tev), cacheLastVolume(true), geometryVersion(geomVersion)
{
  vector<double> rBorders;

  for (vector<MagBLayer const*>::const_iterator ilay = theBLayers.begin();
       ilay != theBLayers.end(); ++ilay) {
    if (verbose::debugOut) cout << "  Barrel layer at " << (*ilay)->minR() <<endl;
    //FIXME assume layers are already sorted in minR
    rBorders.push_back((*ilay)->minR());
  }

  theBarrelBinFinder = new MagBinFinders::GeneralBinFinderInR<double>(rBorders);

  if (verbose::debugOut) {
    for (vector<MagESector const*>::const_iterator isec = theESectors.begin();
     isec != theESectors.end(); ++isec) {
      cout << "  Endcap sector at " << (*isec)->minPhi() << endl;
    }
  }

  //FIXME assume sectors are already sorted in phi
  //FIXME: PeriodicBinFinderInPhi gets *center* of first bin
  int nEBins = theESectors.size();
  theEndcapBinFinder = new PeriodicBinFinderInPhi<float>(theESectors.front()->minPhi()+Geom::pi()/nEBins, nEBins);

}

MagGeometry::~MagGeometry

(

)

Destructor.

Definition at line 61 of file MagGeometry.cc.

References theBarrelBinFinder, theBLayers, theEndcapBinFinder, and theESectors.

                         {
  delete theBarrelBinFinder;
  delete theEndcapBinFinder;

  for (vector<MagBLayer const*>::const_iterator ilay = theBLayers.begin();
       ilay != theBLayers.end(); ++ilay) {
    delete (*ilay);
  }

  for (vector<MagESector const*>::const_iterator ilay = theESectors.begin();
       ilay != theESectors.end(); ++ilay) {
    delete (*ilay);
  }
}

Member Function Documentation

const std::vector<MagVolume6Faces const*>& MagGeometry::barrelVolumes ( ) const

inline

Definition at line 52 of file MagGeometry.h.

References theBVolumes.

{return theBVolumes;}

const std::vector<MagVolume6Faces const*>& MagGeometry::endcapVolumes ( ) const

inline

Definition at line 53 of file MagGeometry.h.

References theEVolumes.

{return theEVolumes;}

GlobalVector MagGeometry::fieldInTesla

(

const GlobalPoint &

gp

)

const

Return field vector at the specified global point.

Definition at line 78 of file MagGeometry.cc.

References MagVolume::fieldInTesla(), findVolume(), edm::isNotFinite(), PV3DBase< T, PVType, FrameType >::mag(), and findQualityFiles::v.

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

                                                                   {
  MagVolume const * v = 0;

  
  v = findVolume(gp);
  if (v!=0) {
    return v->fieldInTesla(gp);
  }
  
  // Fall-back case: no volume found
  
  if (edm::isNotFinite(gp.mag())) {
    LogWarning("InvalidInput") << "Input value invalid (not a number): " << gp << endl;
      
  } else {
    LogWarning("MagneticField") << "MagGeometry::fieldInTesla: failed to find volume for " << gp << endl;
  }
  return GlobalVector();
}

MagVolume const * MagGeometry::findVolume	(	const GlobalPoint &	gp,
		double	tolerance = 0.
	)		const

Find a volume.

Definition at line 137 of file MagGeometry.cc.

References stringResolutionProvider_cfi::bin, PeriodicBinFinderInPhi< T >::binIndex(), MagBinFinders::GeneralBinFinderInR< T >::binIndex(), cacheLastVolume, gather_cfg::cout, verbose::debugOut, inBarrel(), lastVolume, hpstanc_transforms::max, PV3DBase< T, PVType, FrameType >::perp(), phi, PV3DBase< T, PVType, FrameType >::phi(), dttmaxenums::R, mps_fire::result, theBarrelBinFinder, theBLayers, theEndcapBinFinder, and theESectors.

Referenced by fieldInTesla(), and VolumeBasedMagneticField::findVolume().

                                                                     {
  // Check volume cache
  auto lastVolumeCheck = lastVolume.load(std::memory_order_acquire);
  if (lastVolumeCheck!=nullptr && lastVolumeCheck->inside(gp)){
    return lastVolumeCheck;
  }

  MagVolume const* result=0;
  if (inBarrel(gp)) { // Barrel
    double R = gp.perp();
    int bin = theBarrelBinFinder->binIndex(R);
    
    // Search up to 3 layers inwards. This may happen for very thin layers.
    for (int bin1 = bin; bin1 >= max(0,bin-3); --bin1) {
      if (verbose::debugOut) cout << "Trying layer at R " << theBLayers[bin1]->minR()
              << " " << R << endl ;
      result = theBLayers[bin1]->findVolume(gp, tolerance);
      if (verbose::debugOut) cout << "***In blayer " << bin1-bin << " " 
              << (result==0? " failed " : " OK ") <<endl;
      if (result != 0) break;
    }

  } else { // Endcaps
    Geom::Phi<float> phi = gp.phi();
    int bin = theEndcapBinFinder->binIndex(phi);
    if (verbose::debugOut) cout << "Trying endcap sector at phi "
            << theESectors[bin]->minPhi() << " " << phi << endl ;
    result = theESectors[bin]->findVolume(gp, tolerance);
    if (verbose::debugOut) cout << "***In guessed esector "
            << (result==0? " failed " : " OK ") <<endl;
  }


  if (result==0 && tolerance < 0.0001) {
    // If search fails, retry with a 300 micron tolerance.
    // This is a hack for thin gaps on air-iron boundaries,
    // which will not be present anymore once surfaces are matched.
    if (verbose::debugOut) cout << "Increasing the tolerance to 0.03" <<endl;
    result = findVolume(gp, 0.03);
  }

  if (cacheLastVolume) lastVolume.store(result,std::memory_order_release);

  return result;
}

MagVolume const * MagGeometry::findVolume1 ( const GlobalPoint &  gp, double  tolerance = 0.  ) const

private

Definition at line 101 of file MagGeometry.cc.

References gather_cfg::cout, runEdmFileComparison::found, inBarrel(), theBVolumes, theEVolumes, and findQualityFiles::v.

                                                                       {  

  MagVolume6Faces const* found = 0;

  if (inBarrel(gp)) { // Barrel
    for (vector<MagVolume6Faces const*>::const_iterator v = theBVolumes.begin();
     v!=theBVolumes.end(); ++v){
      if ((*v)==0) { //FIXME: remove this check
    cout << endl << "***ERROR: MagGeometry::findVolume: MagVolume not set" << endl;
    continue;
      }
      if ((*v)->inside(gp,tolerance)) {
    found = (*v);
    break;
      }
    }

  } else { // Endcaps
    for (vector<MagVolume6Faces const*>::const_iterator v = theEVolumes.begin();
     v!=theEVolumes.end(); ++v){
      if ((*v)==0) {  //FIXME: remove this check
    cout << endl << "***ERROR: MagGeometry::findVolume: MagVolume not set" << endl;
    continue;
      }
      if ((*v)->inside(gp,tolerance)) {
    found = (*v);
    break;
      }
    }
  }  
  
  return found;
}

bool MagGeometry::inBarrel ( const GlobalPoint &  gp ) const

private

Definition at line 186 of file MagGeometry.cc.

References geometryVersion, PV3DBase< T, PVType, FrameType >::perp(), dttmaxenums::R, DOFs::Z, and PV3DBase< T, PVType, FrameType >::z().

Referenced by findVolume(), and findVolume1().

                                                      {
  float Z = fabs(gp.z());
  float R = gp.perp();

  // FIXME: Get these dimensions from the builder. 
  if (geometryVersion>=120812) {
    return (Z<350. ||
        (R>172.4 && Z<633.29) || 
        (R>308.735 && Z<662.01));    
  } else if (geometryVersion>=90812) { // FIXME no longer supported
    return (Z<350. ||
        (R>172.4 && Z<633.89) || 
        (R>308.755 && Z<662.01));
  } else { // versions 71212, 90322
    return (Z<350. ||
        (R>172.4 && Z<633.29) || 
        (R>308.755 && Z<661.01));
  }
}

bool MagGeometry::isZSymmetric ( ) const

inline

Definition at line 49 of file MagGeometry.h.

Referenced by VolumeBasedMagneticField::isZSymmetric().

{return false;}

Friends And Related Function Documentation

friend class MagGeometryExerciser

friend

Definition at line 57 of file MagGeometry.h.

Member Data Documentation

bool MagGeometry::cacheLastVolume

private

Definition at line 77 of file MagGeometry.h.

Referenced by findVolume().

int MagGeometry::geometryVersion

private

Definition at line 78 of file MagGeometry.h.

Referenced by inBarrel().

std::atomic<MagVolume const*> MagGeometry::lastVolume

mutableprivate

Definition at line 65 of file MagGeometry.h.

Referenced by findVolume().

MagBinFinders::GeneralBinFinderInR<double> const* MagGeometry::theBarrelBinFinder

private

Definition at line 74 of file MagGeometry.h.

Referenced by findVolume(), MagGeometry(), and ~MagGeometry().

std::vector<MagBLayer const*> MagGeometry::theBLayers

private

Definition at line 67 of file MagGeometry.h.

Referenced by findVolume(), MagGeometry(), and ~MagGeometry().

std::vector<MagVolume6Faces const*> MagGeometry::theBVolumes

private

Definition at line 71 of file MagGeometry.h.

Referenced by barrelVolumes(), and findVolume1().

PeriodicBinFinderInPhi<float> const* MagGeometry::theEndcapBinFinder

private

Definition at line 75 of file MagGeometry.h.

Referenced by findVolume(), MagGeometry(), and ~MagGeometry().

std::vector<MagESector const*> MagGeometry::theESectors

private

Definition at line 68 of file MagGeometry.h.

Referenced by findVolume(), MagGeometry(), and ~MagGeometry().

std::vector<MagVolume6Faces const*> MagGeometry::theEVolumes

private

Definition at line 72 of file MagGeometry.h.

Referenced by endcapVolumes(), and findVolume1().