/data/refman/pasoursint/CMSSW_4_1_8_patch13/src/MagneticField/GeomBuilder/src/volumeHandle.h

Go to the documentation of this file.

#ifndef volumeHandle_H
#define volumeHandle_H

#include "MagneticField/GeomBuilder/src/MagGeoBuilderFromDDD.h"

/* #include "DDD/DDCore/interface/DDSolid.h" */
#include "DetectorDescription/Core/interface/DDSolid.h"
#include "DataFormats/GeometrySurface/interface/Surface.h"
//#include "ClassReuse/SurfaceGeometry/interface/BoundPlane.h"
#include "MagneticField/VolumeGeometry/interface/VolumeSide.h"

class DDExpandedView;
class MagVolume6Faces;


class MagGeoBuilderFromDDD::volumeHandle {
public:
  typedef Surface::GlobalPoint     GlobalPoint;
  typedef Surface::LocalPoint      LocalPoint;
  typedef Surface::LocalVector     LocalVector;
  typedef SurfaceOrientation::GlobalFace Sides;
  volumeHandle(const DDExpandedView & fv, bool expand2Pi=false);
  ~volumeHandle();

  const GlobalPoint & center() const;
  const double RN() const {return theRN;}
  const Surface & surface(int which_side) const;
  const Surface & surface(Sides which_side) const;
  bool sameSurface(const Surface & s1, Sides which_side, float tolerance = 0.01);
  bool setSurface(const Surface & s1, Sides which_side);
  bool isPlaneMatched(int which_side) const {
    return isAssigned[which_side];
  }

  int references(int which_side) const { // FIXME!
/*     return surfaces[which_side]->references(); */
    return 0;
  }

  std::string name;
  std::string magFile;
  int copyno;

  static void printUniqueNames(handles::const_iterator begin,
                               handles::const_iterator end);


  // Phi ranges: Used by: LessDPhiMax; bSector; bSlab::[min|max]Phi();
  // MagBSector, MagBRod

  // FIXME: actually returns phi of the point on median plane of the -phi 
  // surface, except for trapezoids where the absoulte min has been implemented
  Geom::Phi<float> minPhi() const {return thePhiMin;}
  // FIXME: actually returns phi of the point on median plane of the +phi 
  // surface
  Geom::Phi<float> maxPhi() const {return surface(SurfaceOrientation::phiplus).position().phi();}

  // ASSUMPTION: Computed on median Z plane, but this is not a problem since
  // all Z planes are orthogonal to the beam line in the current geometry.
  double minZ() const {return surface(SurfaceOrientation::zminus).position().z();}
  double maxZ() const {return surface(SurfaceOrientation::zplus).position().z();}

  double minR() const {return theRMin;}

  //  double maxR() const {return theRMax;}  

  const GloballyPositioned<float> * placement() const {return refPlane;}

  DDSolidShape shape() const {return solid.shape();}

  std::vector<VolumeSide> sides() const;

  MagVolume6Faces* magVolume;

  bool toExpand() const {return expand;}

  bool isIron() const{return isIronFlag;}

  int masterSector;

private:
  // Disallow Default/copy ctor & assignment op.
  // (we want to handle only pointers!!!)
  volumeHandle(const volumeHandle& v);
  volumeHandle operator=(const volumeHandle &v);

  // The volume's six surfaces.
  RCPS surfaces[6];
  // If the corresponding surface has been assigned to a shared surface.
  bool isAssigned[6];

  // initialise the refPlane
  void referencePlane(const DDExpandedView &fv);
  // Build the surfaces for a box
  void buildBox(const DDExpandedView & fv);
  // Build the surfaces for a trapezoid
  void buildTrap(const DDExpandedView & fv);
  // Build the surfaces for a ddtubs shape
  void buildTubs(const DDExpandedView & fv);  
  // Build the surfaces for a ddcons shape
  void buildCons(const DDExpandedView & fv);  
  // Build the surfaces for a ddpseudotrap shape
  void buildPseudoTrap(const DDExpandedView & fv);
  // Build the surfaces for a ddtrunctubs shape
  void buildTruncTubs(const DDExpandedView & fv);

  // Build phi, z surfaces (common for ddtubs and ddcons)
  void buildPhiZSurf(double startPhi, double deltaPhi, double zhalf,
                     double rCentr);

  // Distance from the origin along the normal to the volume's zphi plane.
  double theRN;
  
  // Max and min radius for _any_ point within the volume
  // FIXME!
  double theRMin;
  double theRMax;
  Geom::Phi<float> thePhiMin;

  // 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.
  GloballyPositioned<float> * refPlane;

  // the DDSolid.
  DDSolid solid;  

  // the center of the volume
  GlobalPoint center_;

  // Flag this as a master volume out of wich a 2pi volume should be built 
  // (e.g. central cylinder); this is taken into account by sides().
  bool expand;

  // Temporary hack to keep information on material. Will eventually be replaced!  
  bool isIronFlag;

};


// Extractors for precomputed_value_sort() (safe sorting)

// To sort volumes in Z
struct MagGeoBuilderFromDDD::ExtractZ : public uFcn {
  double operator()(const volumeHandle* v) const {
    return v->center().z();
  }
};

// To sort volumes in abs(Z)
struct MagGeoBuilderFromDDD::ExtractAbsZ : public uFcn {
  double operator()(const volumeHandle* v) const {
    return fabs(v->center().z());
  }
};


// To sort volumes in phi (from -pi to pi).
struct MagGeoBuilderFromDDD::ExtractPhi : public uFcn {
  double operator()(const volumeHandle* v) const {
    // note that Geom::Phi is implicitly converted to double.
    // Periodicity is guaranteed.
    return v->center().phi();
  }
};

// To sort volumes based on max phi(from -pi to pi).
struct MagGeoBuilderFromDDD::ExtractPhiMax : public uFcn {
  double operator()(const volumeHandle* v) const {
    // note that Geom::Phi is implicitly converted to double.
    // Periodicity is guaranteed.
    return v->maxPhi();
  }  
};

// To sort volumes in R
struct MagGeoBuilderFromDDD::ExtractR : public uFcn {
  double operator()(const volumeHandle* v) const {
    return v->center().perp();
  }
};

// To sort volumes in RN (distance of (x,y) plane from origin)
  struct MagGeoBuilderFromDDD::ExtractRN : public uFcn {
  double operator()(const volumeHandle* v) const {
    return v->RN();
  }
};


// To sort angles within any range SMALLER THAN PI "counter-clockwise",
// even if the angles cross the pi boundary.
// CAVEAT: // The result is undefined if the input values cover a 
// range larger than pi!!!
struct MagGeoBuilderFromDDD::LessDPhi{
  bool operator()(double phi1, double phi2) const {
    // handle periodicity
    return ((Geom::Phi<float>(phi2)-Geom::Phi<float>(phi1))>0.);
  }  
};

// Compare the Z of volumes.
// Should be used ONLY for std::max_element and std::min_element 
// and NEVER for sorting (use precomputed_value_sort with ExtractZ instead)
struct MagGeoBuilderFromDDD::LessZ{
  bool operator()(const volumeHandle * v1, const volumeHandle * v2) const
  {
    if (v1->center().z() < v2->center().z()) return true;
    return false;
  }
};

#endif