Changeset 568 in Sophya for trunk/SophyaLib/Samba/circle.cc

Timestamp:

Nov 10, 1999, 3:17:10 PM (26 years ago)

Author:

ansari

Message:

ajout doc GLM

File:

• trunk/SophyaLib/Samba/circle.cc (modified) (8 diffs)

trunk/SophyaLib/Samba/circle.cc

@@ -1 +1 @@
 #include <math.h>
 #include "circle.h"
-
+//++ 
+// Class        Circle
+//
+// include      circle.h math.h
+//--
+//++
+//
+// Links        Parents
+//
+//    Geometry
+//    
+//-- 
+//++
+// Titre        Constructors
+//--
+//++
 Circle::Circle() 
+//
+//--
 {
   UnitVector temp;
   SetCircle(temp,M_PI/2.);
 }
-
+//++
 Circle::Circle(double theta, double phi, double aperture) 
+//
+//--
 {
   UnitVector temp(theta,phi);
   SetCircle(temp,aperture);
 }
-
+//++
 Circle::Circle(double x, double y, double z, double aperture) 
+//
+//--
 {
   UnitVector temp(x,y,z);
   SetCircle(temp,aperture);
 }
-
+//++
 Circle::Circle(const Vector3d& v, double aperture) 
+//
+//--
 {
   UnitVector temp=v;
   SetCircle(temp,aperture);
 }
-
+//++
 Circle::Circle(const Circle& c) 
+//
+//    copy constructor
+//--
 {
   UnitVector temp=c.Omega();
   SetCircle(temp,c._angouv);
 }
-
+//++
+// Titre        Public Methods
+//--
+//++
 void Circle::SetCircle(const UnitVector& temp, double aperture) 
+//
+//--
 {
   _spinunitaxis=temp;
@@ -43 +74 @@
   _z=_spinunitaxis.Z();
 }
-
+//++
 void Circle::SetSpinAxis(double theta, double phi)
+//
+//--
 { 
   UnitVector temp(theta,phi);
   SetCircle(temp,_angouv);
 }
-
+//++
 void Circle::SetSpinAxis(const Vector3d& u) 
+//
+//--
 {
   UnitVector temp=u;
   SetCircle(temp,_angouv);
 }
-
+//++
 void Circle::SetSpinAxis(double x, double y, double z) 
+//
+//--
 {
   UnitVector temp(x,y,z);
   SetCircle(temp,_angouv);
 }
-
+//++
 void Circle::SetApertureAngle(double aperture) 
+//
+//--
 { 
   SetCircle(_spinunitaxis,aperture);
 }
-
+//++
 void Circle::SetApertureAngle(const Circle& c) 
+//
+//--
 {
   SetCircle(_spinunitaxis,c._angouv);
 }
-
+//++
 bool Circle::Intersection(const Circle& c, double* psi) const 
+//
+//    psi contains  4 values of the intersection  angles. 
+//    -1 if  circles do not intersect
+//    psi[0]=psi(i,j,0)
+//    psi[1]=psi(i,j,1)
+//    psi[2]=psi(j,i,0)
+//    psi[3]=psi(j,i,1)
+//--
 {
   double alphak=_angouv;
@@ -119 +168 @@
     }
 }
-
+//++
 UnitVector Circle::ConvToSphere(double psi) const 
+//
+//    Return UnitVector corresponding to a given position donnee on the circle
+//--
 {
   psi=mod(psi,pi2);
@@ -137 +189 @@
   return UnitVector(xout,yout,zout);
 }
-
+//++
 UnitVector Circle::TanOnCircle(double psi) const 
+//
+//    Return UnitVector corresponding to the tangent to the circle 
+//    at given position on the circle.
+//--
 {
   psi=mod(psi,pi2);
@@ -153 +209 @@
   return UnitVector(xout,yout,zout);
 }
-
+//++
 UnitVector Circle::EPhi(double psi) const 
+//
+//    Return the  vector  tangent to the sphere in the plane (xy) 
+//    at a given position on the circle.
+//--
 {
   psi=mod(psi,pi2);
   return ConvToSphere(psi).EPhi();
 }
-
+//++
 UnitVector Circle::ETheta(double psi) const 
+//
+//    Return the other tangent  vector( orthogonal to EPhi)-- 
+//    see previous method
+//--
 {
   psi=mod(psi,pi2);
   return ConvToSphere(psi).ETheta();
 }
-
+//++
 double Circle::SepAngleTanEPhi02PI(double psi) const
+//
+//    Return separation angle in [0,2Pi] at a given position on the 
+//    circle and EPhi
+//--
 {
   psi=mod(psi,pi2);
@@ -175 +243 @@
   return angle;
 }
+//++
+void Circle::Print(ostream& os) const 
+//
+//--
+{
+  os << "1 - Circle - Axe de Spin Unitaire : " << _spinunitaxis << endl;
+  os << "1 - Circle - Axe de Spin : " << _spinaxis << endl;
+  os << "2 - Circle - Angle d'ouverture : " << _angouv << endl;
+  os << "3 - Circle - Theta,Phi : " << _theta << "," << _phi << endl;
+  os << "4 - Circle - x,y,z : " << _x << "," << _y << "," << _z << endl;
+}
+//++
+//
+// inline double Theta() const
+// inline double Phi() const 
+// inline double ApertureAngle() const 
+// inline Vector3d Omega() const 
+//--
+//++
+// Titre        Operators
+//--
 
 Circle& Circle::operator=(const Circle& c) 
@@ -185 +274 @@
   return *this;
 }
-
+//++
 bool Circle::operator==(const Circle& c) const 
+//
+//--
 {
   bool flag;
@@ -193 +284 @@
   return flag;
 }
-
+//++
 bool Circle::operator!=(const Circle& c) const 
+//
+//--
 {
   return (bool)(1-(this->operator==(c)));
 }
-
-void Circle::Print(ostream& os) const 
-{
-  os << "1 - Circle - Axe de Spin Unitaire : " << _spinunitaxis << endl;
-  os << "1 - Circle - Axe de Spin : " << _spinaxis << endl;
-  os << "2 - Circle - Angle d'ouverture : " << _angouv << endl;
-  os << "3 - Circle - Theta,Phi : " << _theta << "," << _phi << endl;
-  os << "4 - Circle - x,y,z : " << _x << "," << _y << "," << _z << endl;
-}