magneticfield::volumeHandle Class Reference

#include <DD4hep_volumeHandle.h>

Inheritance diagram for magneticfield::volumeHandle:

Public Member Functions
volumeHandle	operator= (const volumeHandle &v)=delete
DDSolidShape	shape () const override
	Shape of the solid. More...
std::vector< VolumeSide >	sides () const override
	The surfaces and they orientation, as required to build a MagVolume. More...
	volumeHandle (const cms::DDFilteredView &fv, bool expand2Pi=false, bool debugVal=false)
	volumeHandle (const volumeHandle &v)=delete
Public Member Functions inherited from magneticfield::BaseVolumeHandle
	BaseVolumeHandle (bool expand2Pi=false, bool debugVal=false)
	BaseVolumeHandle (const BaseVolumeHandle &v)=delete
const GlobalPoint &	center () const
	Return the center of the volume. More...
bool	isIron () const
	Temporary hack to pass information on material. Will eventually be replaced! More...
bool	isPlaneMatched (int which_side) const
	if the specified surface has been matched. More...
Geom::Phi< float >	maxPhi () const
	Maximum value of phi covered by the volume. More...
double	maxZ () const
Geom::Phi< float >	minPhi () const
	Minimum value of phi covered by the volume. More...
double	minR () const
	Minimum R for any point within the volume. More...
double	minZ () const
	Z limits. More...
const GloballyPositioned< float > *	placement () const
	Position and rotation. More...
int	references (int which_side) const
const double	RN () const
	Distance of (x,y) plane from origin. More...
bool	sameSurface (const Surface &s1, Sides which_side, float tolerance=0.01)
	Find out if two surfaces are the same physical surface. More...
bool	setSurface (const Surface &s1, Sides which_side)
	Assign a shared surface perorming sanity checks. More...
const Surface &	surface (int which_side) const
	Get the current surface on specified side. More...
const Surface &	surface (Sides which_side) const
bool	toExpand () const
virtual	~BaseVolumeHandle ()

Private Member Functions
void	buildBox ()
void	buildCons ()
void	buildTrap ()
void	buildTruncTubs ()
void	buildTubs ()
void	referencePlane (const cms::DDFilteredView &fv)

Private Attributes
const cms::DDFilteredView &	solid
const DDSolidShape	theShape

Additional Inherited Members
Public Types inherited from magneticfield::BaseVolumeHandle
typedef Surface::GlobalPoint	GlobalPoint
typedef Surface::LocalPoint	LocalPoint
typedef Surface::LocalVector	LocalVector
typedef SurfaceOrientation::GlobalFace	Sides
Public Attributes inherited from magneticfield::BaseVolumeHandle
unsigned short	copyno
	copy number More...
std::string	magFile
	Name of magnetic field table file. More...
MagVolume6Faces *	magVolume
	Pointer to the final MagVolume (must be set from outside) More...
int	masterSector
	The sector for which an interpolator for this class of volumes should be built. More...
std::string	name
	Name of the volume. More...
unsigned short	volumeno
	volume number More...
Protected Types inherited from magneticfield::BaseVolumeHandle
typedef ConstReferenceCountingPointer< Surface >	RCPS
Protected Member Functions inherited from magneticfield::BaseVolumeHandle
void	buildPhiZSurf (double startPhi, double deltaPhi, double zhalf, double rCentr)
Protected Attributes inherited from magneticfield::BaseVolumeHandle
GlobalPoint	center_
const bool	debug
bool	expand
bool	isAssigned [6]
bool	isIronFlag
GloballyPositioned< float > *	refPlane
RCPS	surfaces [6]
Geom::Phi< float >	thePhiMin
double	theRMax
double	theRMin
double	theRN

Detailed Description

Definition at line 23 of file DD4hep_volumeHandle.h.

Constructor & Destructor Documentation

volumeHandle::volumeHandle	(	const cms::DDFilteredView &	fv,
		bool	expand2Pi = false,
		bool	debugVal = false
	)

Definition at line 29 of file DD4hep_volumeHandle.cc.

References buildBox(), buildCons(), buildTrap(), buildTruncTubs(), buildTubs(), magneticfield::BaseVolumeHandle::center(), magneticfield::BaseVolumeHandle::center_, magneticfield::BaseVolumeHandle::copyno, cms::DDFilteredView::copyNum(), ddbox, ddcons, ddtrap, ddtrunctubs, ddtubs, magneticfield::BaseVolumeHandle::debug, mps_fire::i, magneticfield::BaseVolumeHandle::isAssigned, magneticfield::BaseVolumeHandle::isIronFlag, LogTrace, magneticfield::BaseVolumeHandle::magFile, magneticfield::BaseVolumeHandle::masterSector, cms::DDFilteredView::materialName(), magneticfield::BaseVolumeHandle::name, cms::DDFilteredView::name(), magneticfield::newln, PV3DBase< T, PVType, FrameType >::perp(), PV3DBase< T, PVType, FrameType >::phi(), referencePlane(), AlCaHLTBitMon_QueryRunRegistry::string, magneticfield::BaseVolumeHandle::surfaces, magneticfield::BaseVolumeHandle::theRMax, magneticfield::BaseVolumeHandle::theRMin, magneticfield::BaseVolumeHandle::theRN, theShape, cms::DDFilteredView::trans(), and magneticfield::BaseVolumeHandle::volumeno.

    : BaseVolumeHandle(expand2Pi, debugVal), theShape(fv.legacyShape(cms::dd::getCurrentShape(fv))), solid(fv) {
  name = fv.name();
  copyno = fv.copyNum();
  const auto *const transArray = fv.trans();
  center_ = GlobalPoint(transArray[0], transArray[1], transArray[2]);

  // ASSUMPTION: volume names ends with "_NUM" where NUM is the volume number
  string volName = name;
  volName.erase(0, volName.rfind('_') + 1);
  volumeno = static_cast<unsigned short>(std::atoi(volName.c_str()));

  for (int i = 0; i < 6; ++i) {
    isAssigned[i] = false;
  }
  referencePlane(fv);
  switch (theShape) {
    case DDSolidShape::ddbox:
      buildBox();
      break;
    case DDSolidShape::ddtrap:
      buildTrap();
      break;
    case DDSolidShape::ddcons:
      buildCons();
      break;
    case DDSolidShape::ddtubs:
      buildTubs();
      break;
    case DDSolidShape::ddtrunctubs:
      buildTruncTubs();
      break;
    default:
      LogError("magneticfield::volumeHandle")
          << "ctor: Unexpected shape # " << static_cast<int>(theShape) << " for vol " << name;
  }

  // Get material for this volume
  if (fv.materialName() == "Iron")
    isIronFlag = true;

  if (debug) {
    LogTrace("magneticfield::volumeHandle") << " RMin =  " << theRMin << newln << " RMax =  " << theRMax;

    if (theRMin < 0 || theRN < theRMin || theRMax < theRN)
      LogTrace("magneticfield::volumeHandle") << "*** WARNING: wrong RMin/RN/RMax";

    LogTrace("magneticfield::volumeHandle")
        << "Summary: " << name << " " << copyno << " shape = " << theShape << " trasl " << center() << " R "
        << center().perp() << " phi " << center().phi() << " magFile " << magFile << " Material= " << fv.materialName()
        << " isIron= " << isIronFlag << " masterSector= " << masterSector;

    LogTrace("magneticfield::volumeHandle") << " Orientation of surfaces:";
    std::string sideName[3] = {"positiveSide", "negativeSide", "onSurface"};
    for (int i = 0; i < 6; ++i) {
      if (surfaces[i] != nullptr)
        LogTrace("magneticfield::volumeHandle") << "  " << i << ":" << sideName[surfaces[i]->side(center_, 0.3)];
    }
  }
}

magneticfield::volumeHandle::volumeHandle ( const volumeHandle &  v )

delete

Member Function Documentation

void magneticfield::volumeHandle::buildBox ( )

private

Referenced by shape(), and volumeHandle().

void magneticfield::volumeHandle::buildCons ( )

private

Referenced by shape(), and volumeHandle().

void magneticfield::volumeHandle::buildTrap ( )

private

Referenced by shape(), and volumeHandle().

void magneticfield::volumeHandle::buildTruncTubs ( )

private

Referenced by shape(), and volumeHandle().

void magneticfield::volumeHandle::buildTubs ( )

private

Referenced by shape(), and volumeHandle().

volumeHandle magneticfield::volumeHandle::operator= ( const volumeHandle &  v )

delete

void volumeHandle::referencePlane ( const cms::DDFilteredView &  fv )

private

Definition at line 90 of file DD4hep_volumeHandle.cc.

References magneticfield::BaseVolumeHandle::center_, magneticfield::BaseVolumeHandle::debug, LogTrace, GloballyPositioned< T >::position(), magneticfield::BaseVolumeHandle::refPlane, cms::DDFilteredView::rot(), GloballyPositioned< T >::toGlobal(), and PV3DBase< T, PVType, FrameType >::z().

Referenced by shape(), and volumeHandle().

                                                             {
  // The refPlane is the "main plane" for the solid. It corresponds to the
  // x,y plane in the DDD local frame, and defines a frame where the local
  // coordinates are the same as in DDD.
  // In the geometry version 85l_030919, this plane is normal to the
  // beam line for all volumes but pseudotraps, so that global R is along Y,
  // global phi is along -X and global Z along Z:
  //
  //   Global(for vol at pi/2)    Local
  //   +R (+Y)                    +Y
  //   +phi(-X)                   -X
  //   +Z                         +Z
  //
  // For pseudotraps the refPlane is parallel to beam line and global R is
  // along Z, global phi is along +-X and and global Z along Y:
  //
  //   Global(for vol at pi/2)    Local
  //   +R (+Y)                    +Z
  //   +phi(-X)                   +X
  //   +Z                         +Y
  //
  // Note that the frame is centered in the DDD volume center, which is
  // inside the volume for DDD boxes and (pesudo)trapezoids, on the beam line
  // for tubs, cons and trunctubs.

  // In geometry version 1103l, trapezoids have X and Z in the opposite direction
  // than the above.  Boxes are either oriented as described above or in some case
  // have opposite direction for Y and X.

  // The global position
  Surface::PositionType &posResult = center_;

  // The reference plane rotation
  math::XYZVector x, y, z;
  dd4hep::Rotation3D refRot;
  fv.rot(refRot);
  refRot.GetComponents(x, y, z);
  if (debug) {
    if (x.Cross(y).Dot(z) < 0.5) {
      LogTrace("magneticfield::volumeHandle") << "*** WARNING: Rotation is not RH ";
    }
  }

  // The global rotation
  Surface::RotationType rotResult(float(x.X()),
                                  float(x.Y()),
                                  float(x.Z()),
                                  float(y.X()),
                                  float(y.Y()),
                                  float(y.Z()),
                                  float(z.X()),
                                  float(z.Y()),
                                  float(z.Z()));

  refPlane = new GloballyPositioned<float>(posResult, rotResult);

  // Check correct orientation
  if (debug) {
    LogTrace("magneticfield::volumeHandle") << "Refplane pos  " << refPlane->position();

    // See comments above for the conventions for orientation.
    LocalVector globalZdir(0., 0., 1.);  // Local direction of the axis along global Z

    /* Preserve in case pseudotrap is needed again
    if (theShape == DDSolidShape::ddpseudotrap) {
      globalZdir = LocalVector(0., 1., 0.);
    }
    */
    if (refPlane->toGlobal(globalZdir).z() < 0.) {
      globalZdir = -globalZdir;
    }
    float chk = refPlane->toGlobal(globalZdir).dot(GlobalVector(0, 0, 1));
    if (chk < .999)
      LogTrace("magneticfield::volumeHandle") << "*** WARNING RefPlane check failed!***" << chk;
  }
}

DDSolidShape magneticfield::volumeHandle::shape ( ) const

inlineoverridevirtual

Shape of the solid.

Implements magneticfield::BaseVolumeHandle.

Definition at line 33 of file DD4hep_volumeHandle.h.

References buildBox(), buildCons(), buildTrap(), buildTruncTubs(), buildTubs(), referencePlane(), sides(), and theShape.

{ return (theShape); }

std::vector< VolumeSide > volumeHandle::sides ( void  ) const

overridevirtual

The surfaces and they orientation, as required to build a MagVolume.

Implements magneticfield::BaseVolumeHandle.

Definition at line 167 of file DD4hep_volumeHandle.cc.

References magneticfield::BaseVolumeHandle::center_, constexpr, ddtubs, magneticfield::BaseVolumeHandle::expand, mps_fire::i, SurfaceOrientation::inner, SurfaceOrientation::phiminus, SurfaceOrientation::phiplus, mps_fire::result, alignCSCRings::s, magneticfield::BaseVolumeHandle::surfaces, magneticfield::BaseVolumeHandle::theRMin, and theShape.

Referenced by magneticfield::MagGeoBuilder::buildInterpolator(), and shape().

                                                {
  std::vector<VolumeSide> result;
  for (int i = 0; i < 6; ++i) {
    // If this is just a master volume out of wich a 2pi volume
    // should be built (e.g. central cylinder), skip the phi boundaries.
    if (expand && (i == phiplus || i == phiminus))
      continue;

    // FIXME: Skip null inner degenerate cylindrical surface
    if (theShape == DDSolidShape::ddtubs && i == SurfaceOrientation::inner && theRMin < 0.001)
      continue;

    ReferenceCountingPointer<Surface> s = const_cast<Surface *>(surfaces[i].get());
    result.push_back(VolumeSide(s, GlobalFace(i), surfaces[i]->side(center_, 0.3)));
  }
  return result;
}

Member Data Documentation

const cms::DDFilteredView& magneticfield::volumeHandle::solid

private

Definition at line 55 of file DD4hep_volumeHandle.h.

const DDSolidShape magneticfield::volumeHandle::theShape

private

Definition at line 54 of file DD4hep_volumeHandle.h.

Referenced by shape(), sides(), and volumeHandle().