From cbd1e4d70df2131714ed84773dd7be74ee922572 Mon Sep 17 00:00:00 2001
From: zhang <zhang@9a6e40ed-f3a0-4838-9b4a-bf418f78e88d>
Date: Tue, 2 Nov 2010 15:39:12 +0000
Subject: [PATCH] 02/11/2010

1) Add comments
---
 tracy/tracy/inc/tracy_global.h | 12 +++----
 tracy/tracy/src/t2elem.cc      | 59 +++++++++++++++++++++++++++++++---
 2 files changed, 61 insertions(+), 10 deletions(-)

diff --git a/tracy/tracy/inc/tracy_global.h b/tracy/tracy/inc/tracy_global.h
index 53b5ff5..b45859a 100644
--- a/tracy/tracy/inc/tracy_global.h
+++ b/tracy/tracy/inc/tracy_global.h
@@ -81,18 +81,18 @@ struct MpoleType {
   // Displacement Errors
   Vector2     PdSsys;    // systematic [m] 
   Vector2     PdSrms;    // rms [m]
-  Vector2     PdSrnd;    // random number
+  Vector2     PdSrnd;    // random error? [m]
   // Roll angle
   double      PdTpar;    // design [deg], if not equal zero, then skew multipole
   double      PdTsys;    // systematic [deg]
   double      PdTrms;    // rms [deg]
-  double      PdTrnd;    // random number
+  double      PdTrnd;    // random error??? [deg]
   // Multipole strengths
   mpolArray   PBpar;     // design
-  mpolArray   PBsys;     // systematic, with multipole errors
-  mpolArray   PBrms;     // rms
-  mpolArray   PBrnd;     // random number, random error?
-  mpolArray   PB;        // total
+  mpolArray   PBsys;     // systematic multipole errors
+  mpolArray   PBrms;     // rms multipole field errors
+  mpolArray   PBrnd;     // random number, random error?????
+  mpolArray   PB;        // total field strength
   int         Porder;    // The highest order in PB
   int         n_design;  // multipole order (design)
   pthicktype  Pthick;
diff --git a/tracy/tracy/src/t2elem.cc b/tracy/tracy/src/t2elem.cc
index 5cec548..a71654d 100644
--- a/tracy/tracy/src/t2elem.cc
+++ b/tracy/tracy/src/t2elem.cc
@@ -2756,7 +2756,34 @@ void Elem_Print(FILE *f, int Fnum1)
 
 double Mpole_GetPB(int Fnum1, int Knum1, int Order);
 
+/****************************************************************************
+ * double Elem_GetKval(int Fnum1, int Knum1, int Order)
+
+   Purpose: 
+       Get the n-th order integrated field strength of the element with
+       family index "Fnum1" and kid number "Knum1".
+
+   Input:
+       Fnum1:   Family number
+       Knum1:   kid number
+       Order:   field order
+        
+   Output:
+       none
+
+   Return:
+       Integrated n-th field strength
+
+   Global variables:
+       none
+
+   Specific functions:
+       none
+
+   Comments:
+       comments by Jianfeng Zhang  11/2010
 
+****************************************************************************/
 double Elem_GetKval(int Fnum1, int Knum1, int Order)
 {
   double    Result = 0.0;
@@ -3571,13 +3598,37 @@ void Mpole_SetPB(int Fnum1, int Knum1, int Order)
   cellconcat = false;
 }
 
+/**************************************************************************************
+double Mpole_GetPB(int Fnum1, int Knum1, int Order)
 
+  Purpose:
+         Return multipole strength (of order Order) for Knum1 element of
+      family Fnum1
+       Order =  2 for normal quadrupole, bn components
+             = -2 for skew quadrupole    an components
+       
+  Input:
+      Fnum1        family name
+      Knum1        kid number
+      Order        order of the multipole
+      
+  Output: 
+      None
+  
+  Return:
+      None
+     
+  Gloval variables:
+      None
+      
+  Specific functions:
+  
+  Comments:
+     None
+  
+**************************************************************************************/
 double Mpole_GetPB(int Fnum1, int Knum1, int Order)
 {
-  /*  Return multipole strength (of order Order) for Knum1 element of
-      family Fnum1
-       Order =  2 for normal quadrupole
-             = -2 for skew quadrupole                                        */
        
   MpoleType *M; /* Pointer on the multipole */
 
-- 
GitLab