CMS 3D CMS Logo

List of all members | Classes | Public Member Functions | Private Attributes
MagneticFieldGrid Class Reference

#include <MagneticFieldGrid.h>

Classes

class  BVector
 
class  HeaderType3
 

Public Member Functions

int gridType ()
 returns value of GridType (and eventually prints the type + short description) More...
 
void interpolateAtPoint (double X1, double X2, double X3, float &Bx, float &By, float &Bz)
 interpolates the magnetic field at input coordinate point and returns field values More...
 
int lineNumber (int Index1, int Index2, int Index3)
 
void load (const std::string &name)
 load grid binary file More...
 
 MagneticFieldGrid ()
 
void putCoordGetInd (double X1, double X2, double X3, int &Index1, int &Index2, int &Index3)
 
void putIndGetCoord (int Index1, int Index2, int Index3, double &X1, double &X2, double &X3)
 
void putIndicesGetB (int Index1, int Index2, int Index3, float &Bx, float &By, float &Bz)
 
 ~MagneticFieldGrid ()
 

Private Attributes

double BasicDistance0 [3]
 
double BasicDistance1 [3][3]
 
double BasicDistance2 [3][3]
 
bool EasyCoordinate [3]
 
std::vector< BVectorFieldValues
 
int GridType
 
int NumberOfPoints [3]
 
double ReferencePoint [3]
 
double RParAsFunOfPhi [4]
 

Detailed Description

load magnetic field grid from binary file remark: units are either (cm,cm,cm) or (cm,rad,cm) and Tesla for the magnetic field

additional functions either translate indices <-> coordinates, transfer data, or activate the interpolation between grid points

Author
: Volke.nosp@m.r.Dr.nosp@m.ollin.nosp@m.ger@.nosp@m.cern..nosp@m.ch

Modifications:

Definition at line 31 of file MagneticFieldGrid.h.

Constructor & Destructor Documentation

◆ MagneticFieldGrid()

MagneticFieldGrid::MagneticFieldGrid ( )
inline

Definition at line 34 of file MagneticFieldGrid.h.

References mps_fire::i, and dqmiolumiharvest::j.

34  {
35  GridType = 0;
36  for (int i = 0; i < 3; ++i) {
37  NumberOfPoints[i] = 0;
38  };
39  for (int i = 0; i < 3; ++i) {
40  ReferencePoint[i] = 0.;
41  };
42  for (int i = 0; i < 3; ++i) {
43  BasicDistance0[i] = 0.;
44  };
45  for (int i = 0; i < 3; ++i) {
46  for (int j = 0; j < 3; ++j) {
47  BasicDistance1[i][j] = 0.;
48  };
49  };
50  for (int i = 0; i < 3; ++i) {
51  for (int j = 0; j < 3; ++j) {
52  BasicDistance2[i][j] = 0.;
53  };
54  };
55  for (int i = 0; i < 4; ++i) {
56  RParAsFunOfPhi[i] = 0.;
57  };
58  for (int i = 0; i < 3; ++i) {
59  EasyCoordinate[i] = false;
60  };
61  }
double BasicDistance1[3][3]
double BasicDistance2[3][3]

◆ ~MagneticFieldGrid()

MagneticFieldGrid::~MagneticFieldGrid ( )
inline

Definition at line 63 of file MagneticFieldGrid.h.

63 {}

Member Function Documentation

◆ gridType()

int MagneticFieldGrid::gridType ( )

returns value of GridType (and eventually prints the type + short description)

Definition at line 78 of file MagneticFieldGrid.cc.

References gather_cfg::cout, and submitPVValidationJobs::text.

Referenced by GlobalGridWrapper::valueInTesla().

78  {
79  int type = GridType;
80  bool text = false;
81  if (text) {
82  if (type == 0)
83  cout << " grid type = " << type << " --> not determined" << endl;
84  if (type == 1)
85  cout << " grid type = " << type << " --> (x,y,z) cube" << endl;
86  if (type == 2)
87  cout << " grid type = " << type << " --> (x,y,z) trapezoid" << endl;
88  if (type == 3)
89  cout << " grid type = " << type << " --> (r,phi,z) cube" << endl;
90  if (type == 4)
91  cout << " grid type = " << type << " --> (r,phi,z) trapezoid" << endl;
92  if (type == 5)
93  cout << " grid type = " << type << " --> (r,phi,z) 1/sin(phi)" << endl;
94  }
95  return type;
96 }

◆ interpolateAtPoint()

void MagneticFieldGrid::interpolateAtPoint ( double  X1,
double  X2,
double  X3,
float &  Bx,
float &  By,
float &  Bz 
)

interpolates the magnetic field at input coordinate point and returns field values

Definition at line 98 of file MagneticFieldGrid.cc.

References VectorFieldInterpolation::defineCellPoint000(), VectorFieldInterpolation::defineCellPoint001(), VectorFieldInterpolation::defineCellPoint010(), VectorFieldInterpolation::defineCellPoint011(), VectorFieldInterpolation::defineCellPoint100(), VectorFieldInterpolation::defineCellPoint101(), VectorFieldInterpolation::defineCellPoint110(), VectorFieldInterpolation::defineCellPoint111(), nano_mu_digi_cff::float, mps_fire::i, SiStripPI::max, and VectorFieldInterpolation::putSCoordGetVField().

Referenced by GlobalGridWrapper::valueInTesla().

98  {
99  double dB[3] = {0., 0., 0.};
100  // define interpolation object
101  VectorFieldInterpolation MagInterpol;
102  // calculate indices for "CellPoint000"
103  int index[3];
104  putCoordGetInd(X1, X2, X3, index[0], index[1], index[2]);
105  int index0[3] = {0, 0, 0};
106  int index1[3] = {0, 0, 0};
107  for (int i = 0; i < 3; ++i) {
108  if (NumberOfPoints[i] > 1) {
109  index0[i] = max(0, index[i]);
110  if (index0[i] > NumberOfPoints[i] - 2)
111  index0[i] = NumberOfPoints[i] - 2;
112  index1[i] = max(1, index[i] + 1);
113  if (index1[i] > NumberOfPoints[i] - 1)
114  index1[i] = NumberOfPoints[i] - 1;
115  }
116  }
117  double tmpX[3];
118  float tmpB[3];
119  // define the corners of interpolation volume
120  // FIXME: should not unpack the arrays to then repack them as first thing.
121  putIndicesGetB(index0[0], index0[1], index0[2], tmpB[0], tmpB[1], tmpB[2]);
122  putIndGetCoord(index0[0], index0[1], index0[2], tmpX[0], tmpX[1], tmpX[2]);
123  MagInterpol.defineCellPoint000(tmpX[0], tmpX[1], tmpX[2], double(tmpB[0]), double(tmpB[1]), double(tmpB[2]));
124  putIndicesGetB(index1[0], index0[1], index0[2], tmpB[0], tmpB[1], tmpB[2]);
125  putIndGetCoord(index1[0], index0[1], index0[2], tmpX[0], tmpX[1], tmpX[2]);
126  MagInterpol.defineCellPoint100(tmpX[0], tmpX[1], tmpX[2], double(tmpB[0]), double(tmpB[1]), double(tmpB[2]));
127  putIndicesGetB(index0[0], index1[1], index0[2], tmpB[0], tmpB[1], tmpB[2]);
128  putIndGetCoord(index0[0], index1[1], index0[2], tmpX[0], tmpX[1], tmpX[2]);
129  MagInterpol.defineCellPoint010(tmpX[0], tmpX[1], tmpX[2], double(tmpB[0]), double(tmpB[1]), double(tmpB[2]));
130  putIndicesGetB(index1[0], index1[1], index0[2], tmpB[0], tmpB[1], tmpB[2]);
131  putIndGetCoord(index1[0], index1[1], index0[2], tmpX[0], tmpX[1], tmpX[2]);
132  MagInterpol.defineCellPoint110(tmpX[0], tmpX[1], tmpX[2], double(tmpB[0]), double(tmpB[1]), double(tmpB[2]));
133  putIndicesGetB(index0[0], index0[1], index1[2], tmpB[0], tmpB[1], tmpB[2]);
134  putIndGetCoord(index0[0], index0[1], index1[2], tmpX[0], tmpX[1], tmpX[2]);
135  MagInterpol.defineCellPoint001(tmpX[0], tmpX[1], tmpX[2], double(tmpB[0]), double(tmpB[1]), double(tmpB[2]));
136  putIndicesGetB(index1[0], index0[1], index1[2], tmpB[0], tmpB[1], tmpB[2]);
137  putIndGetCoord(index1[0], index0[1], index1[2], tmpX[0], tmpX[1], tmpX[2]);
138  MagInterpol.defineCellPoint101(tmpX[0], tmpX[1], tmpX[2], double(tmpB[0]), double(tmpB[1]), double(tmpB[2]));
139  putIndicesGetB(index0[0], index1[1], index1[2], tmpB[0], tmpB[1], tmpB[2]);
140  putIndGetCoord(index0[0], index1[1], index1[2], tmpX[0], tmpX[1], tmpX[2]);
141  MagInterpol.defineCellPoint011(tmpX[0], tmpX[1], tmpX[2], double(tmpB[0]), double(tmpB[1]), double(tmpB[2]));
142  putIndicesGetB(index1[0], index1[1], index1[2], tmpB[0], tmpB[1], tmpB[2]);
143  putIndGetCoord(index1[0], index1[1], index1[2], tmpX[0], tmpX[1], tmpX[2]);
144  MagInterpol.defineCellPoint111(tmpX[0], tmpX[1], tmpX[2], double(tmpB[0]), double(tmpB[1]), double(tmpB[2]));
145  // interpolate
146  MagInterpol.putSCoordGetVField(X1, X2, X3, dB[0], dB[1], dB[2]);
147  Bx = float(dB[0]);
148  By = float(dB[1]);
149  Bz = float(dB[2]);
150  return;
151 }
void putCoordGetInd(double X1, double X2, double X3, int &Index1, int &Index2, int &Index3)
void defineCellPoint100(double X1, double X2, double X3, double F1, double F2, double F3)
void defineCellPoint110(double X1, double X2, double X3, double F1, double F2, double F3)
void putIndGetCoord(int Index1, int Index2, int Index3, double &X1, double &X2, double &X3)
void defineCellPoint101(double X1, double X2, double X3, double F1, double F2, double F3)
void putSCoordGetVField(double X1, double X2, double X3, double &F1, double &F2, double &F3)
receive the interpolated field (out) at any point in space (in)
void defineCellPoint010(double X1, double X2, double X3, double F1, double F2, double F3)
void defineCellPoint111(double X1, double X2, double X3, double F1, double F2, double F3)
void defineCellPoint000(double X1, double X2, double X3, double F1, double F2, double F3)
provide the interpolation algorithm with 8 points, where the field is known (in)
void putIndicesGetB(int Index1, int Index2, int Index3, float &Bx, float &By, float &Bz)
void defineCellPoint001(double X1, double X2, double X3, double F1, double F2, double F3)
void defineCellPoint011(double X1, double X2, double X3, double F1, double F2, double F3)

◆ lineNumber()

int MagneticFieldGrid::lineNumber ( int  Index1,
int  Index2,
int  Index3 
)

Definition at line 311 of file MagneticFieldGrid.cc.

311  {
312  return Index1 * NumberOfPoints[1] * NumberOfPoints[2] + Index2 * NumberOfPoints[2] + Index3;
313 }

◆ load()

void MagneticFieldGrid::load ( const std::string &  name)

load grid binary file

Definition at line 8 of file MagneticFieldGrid.cc.

References cms::cuda::assert(), gather_cfg::cout, testHGCalDigi_cfg::inFile, Skims_PA_cff::name, submitDQMOfflineCAF::nLines, and MagneticFieldGrid::BVector::putB3().

Referenced by GlobalGridWrapper::GlobalGridWrapper().

8  {
10  inFile >> GridType;
11  // reading the header
12  switch (GridType) {
13  case 1:
17  break;
18  case 2:
22  inFile >> BasicDistance1[0][0] >> BasicDistance1[1][0] >> BasicDistance1[2][0];
23  inFile >> BasicDistance1[0][1] >> BasicDistance1[1][1] >> BasicDistance1[2][1];
24  inFile >> BasicDistance1[0][2] >> BasicDistance1[1][2] >> BasicDistance1[2][2];
25  inFile >> BasicDistance2[0][0] >> BasicDistance2[1][0] >> BasicDistance2[2][0];
26  inFile >> BasicDistance2[0][1] >> BasicDistance2[1][1] >> BasicDistance2[2][1];
27  inFile >> BasicDistance2[0][2] >> BasicDistance2[1][2] >> BasicDistance2[2][2];
29  break;
30  case 3:
34  break;
35  case 4:
39  inFile >> BasicDistance1[0][0] >> BasicDistance1[1][0] >> BasicDistance1[2][0];
40  inFile >> BasicDistance1[0][1] >> BasicDistance1[1][1] >> BasicDistance1[2][1];
41  inFile >> BasicDistance1[0][2] >> BasicDistance1[1][2] >> BasicDistance1[2][2];
42  inFile >> BasicDistance2[0][0] >> BasicDistance2[1][0] >> BasicDistance2[2][0];
43  inFile >> BasicDistance2[0][1] >> BasicDistance2[1][1] >> BasicDistance2[2][1];
44  inFile >> BasicDistance2[0][2] >> BasicDistance2[1][2] >> BasicDistance2[2][2];
46  break;
47  case 5:
52  break;
53  default:
54  assert(0); //this is a bug
55  }
56  //reading the field
57  float Bx, By, Bz;
58  BVector FieldEntry;
60  FieldValues.reserve(nLines);
61 
62  for (int iLine = 0; iLine < nLines; ++iLine) {
63  inFile >> Bx >> By >> Bz;
64  FieldEntry.putB3(Bx, By, Bz);
65  FieldValues.push_back(FieldEntry);
66  }
67  // check completeness and close file
68  string lastEntry;
69  inFile >> lastEntry;
70  inFile.close();
71  if (lastEntry != "complete") {
72  GridType = 0;
73  cout << "error during file reading: file is not complete" << endl;
74  }
75  return;
76 }
assert(be >=bs)
std::vector< BVector > FieldValues
double BasicDistance1[3][3]
double BasicDistance2[3][3]

◆ putCoordGetInd()

void MagneticFieldGrid::putCoordGetInd ( double  X1,
double  X2,
double  X3,
int &  Index1,
int &  Index2,
int &  Index3 
)

Definition at line 157 of file MagneticFieldGrid.cc.

References cms::cuda::assert(), mps_fire::i, createfilelist::int, dqmiolumiharvest::j, hltrates_dqm_sourceclient-live_cfg::offset, funct::sin(), and l1tSlwPFPuppiJets_cfi::sinPhi.

157  {
158  double pnt[3] = {X1, X2, X3};
159  int index[3];
160  switch (GridType) {
161  case 1: {
162  for (int i = 0; i < 3; ++i) {
163  index[i] = int((pnt[i] - ReferencePoint[i]) / BasicDistance0[i]);
164  }
165  break;
166  }
167  case 2: {
168  // FIXME: Should use else!
169  for (int i = 0; i < 3; ++i) {
170  if (EasyCoordinate[i]) {
171  index[i] = int((pnt[i] - ReferencePoint[i]) / BasicDistance0[i]);
172  } else
173  index[i] = 0; //computed below
174  }
175  for (int i = 0; i < 3; ++i) {
176  if (!EasyCoordinate[i]) {
177  double stepSize = BasicDistance0[i];
178  double offset = 0.0;
179  for (int j = 0; j < 3; ++j) {
180  stepSize += BasicDistance1[i][j] * index[j];
181  offset += BasicDistance2[i][j] * index[j];
182  }
183  index[i] = int((pnt[i] - (ReferencePoint[i] + offset)) / stepSize);
184  }
185  }
186  break;
187  }
188  case 3: {
189  for (int i = 0; i < 3; ++i) {
190  index[i] = int((pnt[i] - ReferencePoint[i]) / BasicDistance0[i]);
191  }
192  break;
193  }
194  case 4: {
195  // FIXME: should use else!
196  for (int i = 0; i < 3; ++i) {
197  if (EasyCoordinate[i]) {
198  index[i] = int((pnt[i] - ReferencePoint[i]) / BasicDistance0[i]);
199  } else
200  index[i] = 0; //computed below
201  }
202  for (int i = 0; i < 3; ++i) {
203  if (!EasyCoordinate[i]) {
204  double stepSize = BasicDistance0[i];
205  double offset = 0.0;
206  for (int j = 0; j < 3; ++j) {
207  stepSize += BasicDistance1[i][j] * index[j];
208  offset += BasicDistance2[i][j] * index[j];
209  }
210  index[i] = int((pnt[i] - (ReferencePoint[i] + offset)) / stepSize);
211  }
212  }
213  break;
214  }
215  case 5: {
216  double sinPhi = sin(pnt[1]);
217  double stepSize = RParAsFunOfPhi[0] + RParAsFunOfPhi[1] / sinPhi - RParAsFunOfPhi[2] - RParAsFunOfPhi[3] / sinPhi;
218  stepSize = stepSize / (NumberOfPoints[0] - 1);
219  double startingPoint = RParAsFunOfPhi[2] + RParAsFunOfPhi[3] / sinPhi;
220  index[0] = int((pnt[0] - startingPoint) / stepSize);
221  index[1] = int((pnt[1] - ReferencePoint[1]) / BasicDistance0[1]);
222  index[2] = int((pnt[2] - ReferencePoint[2]) / BasicDistance0[2]);
223  break;
224  }
225  default:
226  assert(0); //shouldn't be here
227  }
228  Index1 = index[0];
229  Index2 = index[1];
230  Index3 = index[2];
231  return;
232 }
Sin< T >::type sin(const T &t)
Definition: Sin.h:22
assert(be >=bs)
double BasicDistance1[3][3]
double BasicDistance2[3][3]

◆ putIndGetCoord()

void MagneticFieldGrid::putIndGetCoord ( int  Index1,
int  Index2,
int  Index3,
double &  X1,
double &  X2,
double &  X3 
)

Definition at line 244 of file MagneticFieldGrid.cc.

References cms::cuda::assert(), mps_fire::i, dqmiolumiharvest::j, hltrates_dqm_sourceclient-live_cfg::offset, funct::sin(), and l1tSlwPFPuppiJets_cfi::sinPhi.

244  {
245  int index[3] = {Index1, Index2, Index3};
246  double pnt[3];
247  switch (GridType) {
248  case 1: {
249  for (int i = 0; i < 3; ++i) {
250  pnt[i] = ReferencePoint[i] + BasicDistance0[i] * index[i];
251  }
252  break;
253  }
254  case 2: {
255  for (int i = 0; i < 3; ++i) {
256  if (EasyCoordinate[i]) {
257  pnt[i] = ReferencePoint[i] + BasicDistance0[i] * index[i];
258  } else {
259  double stepSize = BasicDistance0[i];
260  double offset = 0.0;
261  for (int j = 0; j < 3; ++j) {
262  stepSize += BasicDistance1[i][j] * index[j];
263  offset += BasicDistance2[i][j] * index[j];
264  }
265  pnt[i] = ReferencePoint[i] + offset + stepSize * index[i];
266  }
267  }
268  break;
269  }
270  case 3: {
271  for (int i = 0; i < 3; ++i) {
272  pnt[i] = ReferencePoint[i] + BasicDistance0[i] * index[i];
273  }
274  break;
275  }
276  case 4: {
277  for (int i = 0; i < 3; ++i) {
278  if (EasyCoordinate[i]) {
279  pnt[i] = ReferencePoint[i] + BasicDistance0[i] * index[i];
280  } else {
281  double stepSize = BasicDistance0[i];
282  double offset = 0.0;
283  for (int j = 0; j < 3; ++j) {
284  stepSize += BasicDistance1[i][j] * index[j];
285  offset += BasicDistance2[i][j] * index[j];
286  }
287  pnt[i] = ReferencePoint[i] + offset + stepSize * index[i];
288  }
289  }
290  break;
291  }
292  case 5: {
293  pnt[2] = ReferencePoint[2] + BasicDistance0[2] * index[2];
294  pnt[1] = ReferencePoint[1] + BasicDistance0[1] * index[1];
295  double sinPhi = sin(pnt[1]);
296  double stepSize = RParAsFunOfPhi[0] + RParAsFunOfPhi[1] / sinPhi - RParAsFunOfPhi[2] - RParAsFunOfPhi[3] / sinPhi;
297  stepSize = stepSize / (NumberOfPoints[0] - 1);
298  double startingPoint = RParAsFunOfPhi[2] + RParAsFunOfPhi[3] / sinPhi;
299  pnt[0] = startingPoint + stepSize * index[0];
300  break;
301  }
302  default:
303  assert(0); //bug if make it here
304  }
305  X1 = pnt[0];
306  X2 = pnt[1];
307  X3 = pnt[2];
308  return;
309 }
Sin< T >::type sin(const T &t)
Definition: Sin.h:22
assert(be >=bs)
double BasicDistance1[3][3]
double BasicDistance2[3][3]

◆ putIndicesGetB()

void MagneticFieldGrid::putIndicesGetB ( int  Index1,
int  Index2,
int  Index3,
float &  Bx,
float &  By,
float &  Bz 
)

Definition at line 234 of file MagneticFieldGrid.cc.

References MagneticFieldGrid::BVector::bx(), MagneticFieldGrid::BVector::by(), and MagneticFieldGrid::BVector::bz().

234  {
235  BVector FieldEntry;
236  FieldEntry = FieldValues.operator[](lineNumber(Index1, Index2, Index3));
237  Bx = FieldEntry.bx();
238  By = FieldEntry.by();
239  Bz = FieldEntry.bz();
240  return;
241 }
std::vector< BVector > FieldValues
int lineNumber(int Index1, int Index2, int Index3)

Member Data Documentation

◆ BasicDistance0

double MagneticFieldGrid::BasicDistance0[3]
private

Definition at line 104 of file MagneticFieldGrid.h.

◆ BasicDistance1

double MagneticFieldGrid::BasicDistance1[3][3]
private

Definition at line 105 of file MagneticFieldGrid.h.

◆ BasicDistance2

double MagneticFieldGrid::BasicDistance2[3][3]
private

Definition at line 106 of file MagneticFieldGrid.h.

◆ EasyCoordinate

bool MagneticFieldGrid::EasyCoordinate[3]
private

Definition at line 108 of file MagneticFieldGrid.h.

◆ FieldValues

std::vector<BVector> MagneticFieldGrid::FieldValues
private

Definition at line 110 of file MagneticFieldGrid.h.

◆ GridType

int MagneticFieldGrid::GridType
private

Definition at line 100 of file MagneticFieldGrid.h.

◆ NumberOfPoints

int MagneticFieldGrid::NumberOfPoints[3]
private

Definition at line 102 of file MagneticFieldGrid.h.

◆ ReferencePoint

double MagneticFieldGrid::ReferencePoint[3]
private

Definition at line 103 of file MagneticFieldGrid.h.

◆ RParAsFunOfPhi

double MagneticFieldGrid::RParAsFunOfPhi[4]
private

Definition at line 107 of file MagneticFieldGrid.h.