From a3e7e27eff4648ee51da2b50b612b31c3f5b5a70 Mon Sep 17 00:00:00 2001
From: schaffer <R.D.Schaffer@cern.ch>
Date: Wed, 29 Dec 2021 13:44:23 +0100
Subject: [PATCH] removing comments from BFieldMesh.h
---
.../MagFieldElements/BFieldMesh.h | 29 ++++++++++---------
1 file changed, 16 insertions(+), 13 deletions(-)
diff --git a/MagneticField/MagFieldElements/MagFieldElements/BFieldMesh.h b/MagneticField/MagFieldElements/MagFieldElements/BFieldMesh.h
index 70d4b3b26940..f5b91b55ea56 100644
--- a/MagneticField/MagFieldElements/MagFieldElements/BFieldMesh.h
+++ b/MagneticField/MagFieldElements/MagFieldElements/BFieldMesh.h
@@ -8,12 +8,15 @@
*
* A 3-d mesh (axes z,r,phi) representing a simple field map.
*
- * The mesh is made up of 'cells'.
- * There are nz x nr x nphi cells.
- * Each cell holds z, r, phi and the field at each of its 8 corners.
+ * The mesh is made up from 'cells'
+ * We hold numz, numr , numphi positions defining
+ * the corners of the cells.
*
- * The field type is templated - it may be short (for general use)
- * or double (for a special case of a tilting solenoid field in class BFieldSolenoid)
+ * Then we have
+ * numz X numr X numphi field values at these corners
+ *
+ * The field type is templated - it may be short (for the toroid)
+ * or double (for the solenoid)
*
* Masahiro Morii, Harvard University
*
@@ -65,11 +68,11 @@ public:
void reserve(int nz, int nr, int nphi, int nfield);
/** @brief allocate space to vectors */
void reserve(int nz, int nr, int nphi);
- /** @brief add a position for a cell corner for an axis (0=z, 1=r, 2=phi) */
+ /** @brief add a position for a cell corner for an axis */
void appendMesh(int axis, double value);
- /** @brief append a field vector (in z, r, phi) for a corner */
+ /** @brief append a filed vector */
void appendField(const BFieldVector<T>& field);
- /** @brief build Look Up Table for the BFieldCache */
+ /** @brief build Look Up Table*/
void buildLUT();
/* @brief test if a point is inside this mesh*/
bool inside(double z, double r, double phi) const;
@@ -83,9 +86,9 @@ public:
void getB(const double* ATH_RESTRICT xyz,
double* ATH_RESTRICT B,
double* ATH_RESTRICT deriv = nullptr) const;
- /* @brief minimum in axis (0=z, 1=r, 2=phi) */
+ /* @brief minimum in axis*/
double min(size_t axis) const;
- /* @brief maximum in axis (0=z, 1=r, 2=phi) */
+ /* @brief maximum in axis*/
double max(size_t axis) const;
/* @brief minimum in z*/
double zmin() const;
@@ -99,11 +102,11 @@ public:
double phimin() const;
/* @brief maximum in phi*/
double phimax() const;
- /* @brief number of corner cell coordinates for a specific axis (0=z, 1=r, 2=phi) */
+ /* @brief number of corner cell coordinates for axis*/
unsigned nmesh(size_t axis) const;
- /* @brief coordinate value for the ith (index) corner of a specific axis (0=z, 1=r, 2=phi) */
+ /* @brief coordinate at axis of cell corner */
double mesh(size_t axis, size_t index) const;
- /* @brief field entries in mesh (nz x nr x nphi) */
+ /* @brief field entries in mesh*/
unsigned nfield() const;
/* @brief field vector at cell corner at index*/
const BFieldVector<T>& field(size_t index) const;
--
GitLab