Changeset 4062 in Sophya for trunk/SophyaLib/BaseTools/sunitpcst.cc

Timestamp:

Apr 27, 2012, 12:26:07 AM (13 years ago)

Author:

ansari

Message:

Petites ameliorations classes Units et PhysQty, documentation doxygen, ajout fichiers pqnumber.h et sunitpcst.h ds basetools.h, passage numero de version a 2.30, Reza 27/04/2012

File:

• trunk/SophyaLib/BaseTools/sunitpcst.cc (modified) (7 diffs)

trunk/SophyaLib/BaseTools/sunitpcst.cc

@@ -7 +7 @@
    \class Units
    \ingroup BaseTools
-   Class for representing physical units
+   This class represents physical dimension and units. Static methods return Units 
+   objects corresponding to the usual units, such as meter or watt
    
    \code
-   // Create ....
+   Units w=Units::watt(); 
+   cout << " Power unit (watt) : " << w.Name() << " (" << w << ")" << endl; 
+   // define the speed SI unit (m/s) : 
+   Units mos = Units::meter()/Units::second() ;
+   cout << " SI speed unit : " << mos << "  -> "; mos.Print() ;  
+   // mutiple of an existing unit :
+   Units mw=Units::watt().mega(); 
+   cout << " Megawatt: " << mw.Name() << " (" << mw << ")  -> "; mw.Print() ; 
    \endcode
 */
@@ -26 +34 @@
 
 /* --Methode-- */
+/*!
+  The Units object is created by specifying its name and short name, and the integer powers 
+  for the seven SI base physical quantities (length, mass, time \ldots), and the value of the 
+  unit in term of the SI unit.
+*/
 Units::Units(const char* nom, const char* snom, int m, int kg, int s, r_8 val, int A, int K, int mol, int cd)
   : mLength_(m), mMass_(kg), mTime_(s), mCurr_(A), 
@@ -38 +51 @@
 {
   Set(un);
+}
+
+/* --Methode-- */
+Units::Units(Units const& un, r_8 scale, const char* nom, const char* snom)
+{
+  Set(un);
+  mSI_Value_*=scale;
+  mName_=nom;
+  mShortName_=snom;
 }
 
@@ -179 +201 @@
    \class PhysQty
    \ingroup BaseTools
-   Class for representing physical quantities and constants 
+   Class for representing physical quantities and constants. A physical quantity 
+   has a unit and a value, and optionally a precision and/or a name. A number of
+   physical constants and standard quantities can be obtained as PhysQty objects 
+   through static methods.
    
+   \sa SOPHYA::Units 
+
    \code
-   // Create ....
+   cout <<  " k_Boltzmann: " << PhysQty::k() << endl;
+   cout <<  " m_e: " << PhysQty::electron_mass() << endl;
+   // Conversion of a quantity to a different unit 
+   PhysQty aj(Units::joule(), 25.); 
+   PhysQty aev=aj.ConvertTo(Units::electronvolt().giga());
+   cout <<  " A : " << aj << " -> " << aev << endl;
    \endcode
 */
@@ -191 +223 @@
 
 /* --Methode-- */
+//! Default constructor: zero valued dimensionless quantity 
 PhysQty::PhysQty()
   : unit_(), val_(0.), prec_(0.)
@@ -197 +230 @@
 
 /* --Methode-- */
+/*! 
+  \brief standard constructor
+  The object is constructed through the specification of the unit \b u, the value \b val, 
+  and optional relative precision \b prec (=delta val/val) and an optional name.
+*/
 PhysQty::PhysQty(Units const & u, r_8 val, r_8 prec, const char* nom)
   : unit_(u), val_(val), prec_(prec), name_((nom==NULL)?"":nom)
@@ -203 +241 @@
 
 /* --Methode-- */
+//! Copy constructor
 PhysQty::PhysQty(PhysQty const & qty)
   : unit_(qty.unit_), val_(qty.val_), prec_(qty.prec_), name_(qty.name_)