SpecialCylindricalMFGrid Class Reference

#include <SpecialCylindricalMFGrid.h>

Inheritance diagram for SpecialCylindricalMFGrid:

Public Member Functions
virtual void	dump () const
virtual LocalPoint	fromGridFrame (double a, double b, double c) const
	find grid coordinates for point. For debugging and validation only. More...
	SpecialCylindricalMFGrid (binary_ifstream &istr, const GloballyPositioned< float > &vol, int gridType)
virtual void	toGridFrame (const LocalPoint &p, double &a, double &b, double &c) const
	find grid coordinates for point. For debugging and validation only. More...
virtual LocalVector	uncheckedValueInTesla (const LocalPoint &p) const
	Interpolated field value at given point; does not check for exceptions. More...
Public Member Functions inherited from MFGrid3D
virtual Dimensions	dimensions (void) const
virtual Indexes	index (const LocalPoint &p) const
	MFGrid3D (const GloballyPositioned< float > &vol)
virtual LocalPoint	nodePosition (int i, int j, int k) const
	Position of node in local frame. More...
virtual LocalVector	nodeValue (int i, int j, int k) const
	Field value at node. More...
virtual LocalVector	valueInTesla (const LocalPoint &p) const
	Interpolated field value at given point. More...
Public Member Functions inherited from MFGrid
const GloballyPositioned< float > &	frame () const
	Local reference frame. More...
	MFGrid (const GloballyPositioned< float > &vol)
virtual	~MFGrid ()
Public Member Functions inherited from MagneticFieldProvider< float >
virtual LocalVectorType	derivativeInTeslaPerMeter (const LocalPointType &p, int N) const
virtual int	hasDerivatives () const
virtual LocalVectorType	valueInTesla (const LocalPointType &p) const =0
virtual	~MagneticFieldProvider ()

Private Member Functions
double	startingPoint (double sinPhi) const
double	stepSize (double sinPhi) const

Private Attributes
bool	sector1
double	startConstTerm_
double	startPhiTerm_
double	stepConstTerm_
double	stepPhiTerm_

Additional Inherited Members
Public Types inherited from MFGrid
typedef GloballyPositioned< float >::GlobalPoint	GlobalPoint
typedef GloballyPositioned< float >::GlobalVector	GlobalVector
typedef GloballyPositioned< float >::LocalPoint	LocalPoint
typedef GloballyPositioned< float >::LocalVector	LocalVector
Public Types inherited from MagneticFieldProvider< float >
typedef Point3DBase< float, GlobalTag >	GlobalPointType
typedef Vector3DBase< float, GlobalTag >	GlobalVectorType
typedef Point3DBase< float, LocalTag >	LocalPointType
typedef Vector3DBase< float, LocalTag >	LocalVectorType
Protected Types inherited from MFGrid3D
using	BVector = Grid3D::BVector
using	GridType = Grid3D
Protected Member Functions inherited from MFGrid3D
void	setGrid (const GridType &grid)
Protected Attributes inherited from MFGrid3D
GridType	grid_

Detailed Description

Interpolator for cylindrical grids type 5 or 6 (r,phi,z) 1/sin(phi) or 1/cos(phi)

Author

T. Todorov - updated 08 N. Amapane

Definition at line 17 of file SpecialCylindricalMFGrid.h.

Constructor & Destructor Documentation

SpecialCylindricalMFGrid::SpecialCylindricalMFGrid	(	binary_ifstream &	istr,
		const GloballyPositioned< float > &	vol,
		int	gridType
	)

Constructor. gridType = 5 => 1/sin(phi); i.e. master sector is #4 gridType = 6 => 1/cos(phi); i.e. master sector is #1

Definition at line 10 of file SpecialCylindricalMFGrid.cc.

References gather_cfg::cout, MFGrid::frame(), MFGrid3D::grid_, mps_fire::i, sector1, startConstTerm_, startPhiTerm_, stepConstTerm_, stepPhiTerm_, GloballyPositioned< T >::toLocal(), PV3DBase< T, VectorTag, FrameTag >::x(), PV3DBase< T, VectorTag, FrameTag >::y(), and PV3DBase< T, VectorTag, FrameTag >::z().

  : MFGrid3D(vol)
{
  if (gridType == 5 ) {
    sector1 = false;
  } else if (gridType == 6 ) {
    sector1 = true;
  } else {
    cout << "ERROR wrong SpecialCylindricalMFGrid type " << gridType << endl;
    sector1 = false;
  }

  int n1, n2, n3;
  inFile >> n1 >> n2 >> n3;
#ifdef DEBUG_GRID
  cout << "n1 " << n1 << " n2 " << n2 << " n3 " << n3 << endl;
#endif
  double xref, yref, zref;
  inFile >> xref >> yref >> zref;
  double stepx, stepy, stepz;
  inFile >> stepx    >> stepy    >> stepz;

  double RParAsFunOfPhi[4];  // R = f(phi) or const. (0,2: const. par. ; 1,3: const./sin(phi));
  inFile >> RParAsFunOfPhi[0] >> RParAsFunOfPhi[1] >> RParAsFunOfPhi[2] >> RParAsFunOfPhi[3];

  vector<BVector> fieldValues;
  float Bx, By, Bz;
  int nLines = n1*n2*n3;
  fieldValues.reserve(nLines);
  for (int iLine=0; iLine<nLines; ++iLine){
    inFile >> Bx >> By >> Bz;
    // This would be fine only if local r.f. has the axes oriented as the global r.f.
    // For this volume we know that the local and global r.f. have different axis
    // orientation, so we do not try to be clever.
    //    fieldValues.push_back(BVector(Bx,By,Bz));
    
    // Preserve double precision!
    Vector3DBase<double, LocalTag>  lB = frame().toLocal(Vector3DBase<double, GlobalTag>(Bx,By,Bz));
    fieldValues.push_back(BVector(lB.x(), lB.y(), lB.z()));
  }
  // check completeness
  string lastEntry;
  inFile >> lastEntry;
  if (lastEntry != "complete"){
    cout << "ERROR during file reading: file is not complete" << endl;
  }

  GlobalPoint grefp( GlobalPoint::Cylindrical( xref, yref, zref));

#ifdef DEBUG_GRID
  LocalPoint lrefp = frame().toLocal( grefp);
  cout << "Grid reference point in grid system: " << xref << "," << yref << "," << zref << endl;
  cout << "Grid reference point in global x,y,z: " << grefp << endl;
  cout << "Grid reference point in local x,y,z: " << lrefp << endl;
  cout << "steps " << stepx << "," <<  stepy << "," << stepz << endl;
  cout << "RParAsFunOfPhi[0...4] = ";
  for (int i=0; i<4; ++i) cout << RParAsFunOfPhi[i] << " "; cout << endl;
#endif

  Grid1D gridX( 0, n1-1, n1); // offset and step size not constant
  Grid1D gridY( yref, yref + stepy*(n2-1), n2);
  Grid1D gridZ( grefp.z(), grefp.z() + stepz*(n3-1), n3);

  grid_ = GridType( gridX, gridY, gridZ, fieldValues);

  stepConstTerm_ = (RParAsFunOfPhi[0] - RParAsFunOfPhi[2]) / (n1-1);
  stepPhiTerm_   = (RParAsFunOfPhi[1] - RParAsFunOfPhi[3]) / (n1-1);
  startConstTerm_ = RParAsFunOfPhi[2];
  startPhiTerm_   = RParAsFunOfPhi[3];

  // Activate/deactivate timers
//   static SimpleConfigurable<bool> timerOn(false,"MFGrid:timing");
//   (*TimingReport::current()).switchOn("MagneticFieldProvider::valueInTesla(SpecialCylindricalMFGrid)",timerOn);
}

Member Function Documentation

void SpecialCylindricalMFGrid::dump ( void  ) const

virtual

Reimplemented from MFGrid.

Definition at line 101 of file SpecialCylindricalMFGrid.cc.

{}

MFGrid::LocalPoint SpecialCylindricalMFGrid::fromGridFrame ( double  a, double  b, double  c  ) const

virtual

find grid coordinates for point. For debugging and validation only.

Implements MFGrid.

Definition at line 104 of file SpecialCylindricalMFGrid.cc.

References funct::cos(), MFGrid::frame(), runTauDisplay::gp, dttmaxenums::R, sector1, funct::sin(), startingPoint(), stepSize(), and GloballyPositioned< T >::toLocal().

{
  double sinPhi; // sin or cos depending on wether we are at phi=0 or phi=pi/2
  if (sector1) {
    sinPhi = cos(b);
  } else {
    sinPhi = sin(b);
  }
  
  double R = a*stepSize(sinPhi) + startingPoint(sinPhi);
  // "OLD" convention of phi.
  //  GlobalPoint gp( GlobalPoint::Cylindrical(R, Geom::pi() - b, c));
  GlobalPoint gp( GlobalPoint::Cylindrical(R, b, c));
  return frame().toLocal(gp);
}

double SpecialCylindricalMFGrid::startingPoint ( double  sinPhi ) const

inlineprivate

Definition at line 45 of file SpecialCylindricalMFGrid.h.

Referenced by fromGridFrame(), and toGridFrame().

{return startConstTerm_ + startPhiTerm_/sinPhi;}

double SpecialCylindricalMFGrid::stepSize ( double  sinPhi ) const

inlineprivate

Definition at line 44 of file SpecialCylindricalMFGrid.h.

Referenced by fromGridFrame(), and toGridFrame().

{return stepConstTerm_ + stepPhiTerm_ /sinPhi;}

void SpecialCylindricalMFGrid::toGridFrame ( const LocalPoint &  p, double &  a, double &  b, double &  c  ) const

virtual

find grid coordinates for point. For debugging and validation only.

Implements MFGrid.

Definition at line 120 of file SpecialCylindricalMFGrid.cc.

References funct::cos(), gather_cfg::cout, MFGrid::frame(), runTauDisplay::gp, sector1, funct::sin(), startingPoint(), stepSize(), and GloballyPositioned< T >::toGlobal().

Referenced by uncheckedValueInTesla().

{
  GlobalPoint gp = frame().toGlobal(p);
  double sinPhi; // sin or cos depending on wether we are at phi=0 or phi=pi/2
  if (sector1) {
    sinPhi = cos(gp.phi());
  } else {
    sinPhi = sin(gp.phi());
  }
  a = (gp.perp()-startingPoint(sinPhi))/stepSize(sinPhi);
  // FIXME: "OLD" convention of phi.
  // b = Geom::pi() - gp.phi();
  b = gp.phi();
  c = gp.z();

#ifdef DEBUG_GRID
  if (sector1) {
    cout << "toGridFrame: sinPhi " ;
  } else {
    cout << "toGridFrame: cosPhi " ;
  }
  cout << sinPhi << " LocalPoint " << p 
       << " GlobalPoint " << gp << endl 
       << " a " << a << " b " << b << " c " << c << endl;
    
#endif
}

MFGrid::LocalVector SpecialCylindricalMFGrid::uncheckedValueInTesla ( const LocalPoint &  p ) const

virtual

Interpolated field value at given point; does not check for exceptions.

Implements MFGrid3D.

Definition at line 87 of file SpecialCylindricalMFGrid.cc.

References a, b, EnergyCorrector::c, MFGrid3D::grid_, LinearGridInterpolator3D::interpolate(), and toGridFrame().

{
//   static TimingReport::Item & timer= (*TimingReport::current())["MagneticFieldProvider::valueInTesla(SpecialCylindricalMFGrid)"];
//   TimeMe t(timer,false);

  LinearGridInterpolator3D interpol( grid_);
  double a, b, c;
  toGridFrame( p, a, b, c);
  // the following holds if B values was not converted to local coords -- see ctor
//   GlobalVector gv( interpol.interpolate( a, b, c)); // grid in global frame
//   return frame().toLocal(gv);           // must return a local vector
  return LocalVector(interpol.interpolate( a, b, c));
}

Member Data Documentation

bool SpecialCylindricalMFGrid::sector1

private

Definition at line 46 of file SpecialCylindricalMFGrid.h.

Referenced by fromGridFrame(), SpecialCylindricalMFGrid(), and toGridFrame().

double SpecialCylindricalMFGrid::startConstTerm_

private

Definition at line 41 of file SpecialCylindricalMFGrid.h.

Referenced by SpecialCylindricalMFGrid().

double SpecialCylindricalMFGrid::startPhiTerm_

private

Definition at line 42 of file SpecialCylindricalMFGrid.h.

Referenced by SpecialCylindricalMFGrid().

double SpecialCylindricalMFGrid::stepConstTerm_

private

Definition at line 39 of file SpecialCylindricalMFGrid.h.

Referenced by SpecialCylindricalMFGrid().

double SpecialCylindricalMFGrid::stepPhiTerm_

private

Definition at line 40 of file SpecialCylindricalMFGrid.h.

Referenced by SpecialCylindricalMFGrid().