Import Geant4 9.6.0 source tree

examples/extended/runAndEvent/RE02/include/RE02DetectorConstruction.hh

@@ -23,9 +23,11 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
+/// \file runAndEvent/RE02/include/RE02DetectorConstruction.hh
+/// \brief Definition of the RE02DetectorConstruction class
 //
-// $Id: RE02DetectorConstruction.hh,v 1.3 2006-11-18 01:37:23 asaim Exp $
-// GEANT4 tag $Name: not supported by cvs2svn $
+//
+// $Id$
 //
 
 #ifndef RE02DetectorConstruction_h
@@ -40,13 +42,78 @@ class G4LogicalVolume;
 class G4VPhysicalVolume;
 class G4Material;
 
+//
+/// Uer detector construction class
+///
+/// (Description)
+///
+///    Detector construction for example RE02.
+///   
+///  [Geometry] 
+///    The world volume is defined as 200 cm x 200 cm x 200 cm box with Air.
+///  Water phantom is defined as  200 mm x 200 mm x 400 mm box with Water.
+///  The water phantom is divided into 100 segments in x,y plane using
+///  replication,
+///  and then divided into 200 segments perpendicular to z axis using nested 
+///  parameterised volume.  
+///   These values are defined at constructor,
+///   e.g. the size of water phantom (fPhantomSize), and number of segmentation
+///  of water phantom (fNx, fNy, fNz).
+///
+///  By default, lead plates are inserted into the position of even order 
+///  segments.
+///  NIST database is used for materials.
+///
+///
+///  [Scorer]
+///   Assignment of G4MultiFunctionalDetector and G4PrimitiveScorer 
+///  is demonstrated in this example.
+///      -------------------------------------------------
+///      The collection names of defined Primitives are
+///       0       PhantomSD/totalEDep 
+///       1       PhantomSD/protonEDep
+///       2       PhantomSD/protonNStep
+///       3       PhantomSD/chargedPassCellFlux
+///       4       PhantomSD/chargedCellFlux 
+///       5       PhantomSD/chargedSurfFlux 
+///       6       PhantomSD/gammaSurfCurr000
+///       7       PhantomSD/gammaSurfCurr001
+///       9       PhantomSD/gammaSurdCurr002
+///      10       PhantomSD/gammaSurdCurr003
+///     -------------------------------------------------
+///     Please see README for detail description.
+///
+///
+/// - G4VPhysicalVolume* Construct()
+///     retrieves material from NIST database,
+///     constructs a water phantom "phantom" in the world volume "world" and
+///     sets detector sensitivities with G4MultiFunctionalDetector
+///
+/// - void SetPhantomSize(G4ThreeVector size)
+///     sets the water phantom size which is defined in G4Box
+///
+/// - const G4ThreeVector& GetPhantomSize() const
+///     gets the water phantom size
+///
+/// - void SetNumberOfSegmentsInPhantom(G4int nx, G4int ny, G4int nz) 
+///     sets the number of segments of the water phantom
+///
+/// - void GetNumberOfSegmentsInPhantom(G4int& nx, G4int& ny, G4int& nz) 
+///     gets the number of segments of the water phantom
+///
+/// - void SetLeadSegment(G4bool flag=TRUE)
+///     selects whether insert or not Lead plate in water or simple homogeneous
+///     water phantom
+///
+/// - G4bool IsLeadSegment()
+///     returns whether insert or not Lead plate
 //
 class RE02DetectorConstruction : public G4VUserDetectorConstruction
 {
 public:
-   // constructor and destructor.
-   RE02DetectorConstruction();
-   virtual ~RE02DetectorConstruction();
+  // constructor and destructor.
+  RE02DetectorConstruction();
+  virtual ~RE02DetectorConstruction();
 
 public:
   // virtual method from G4VUserDetectorCOnstruction.
@@ -55,8 +122,8 @@ public:
 public:
   // Get/Set Access methods for data members
   // Size of Whater Phantom
-  void SetPhantomSize(G4ThreeVector size) { fphantomSize=size; }
-  const G4ThreeVector& GetPhantomSize() const { return fphantomSize; }
+  void SetPhantomSize(G4ThreeVector size) { fPhantomSize=size; }
+  const G4ThreeVector& GetPhantomSize() const { return fPhantomSize; }
   // Number of segments of water phantom
   void SetNumberOfSegmentsInPhantom(G4int nx, G4int ny, G4int nz) 
       { fNx=nx; fNy=ny; fNz=nz; }
@@ -68,12 +135,9 @@ public:
 
 private:
   // Data members
-  G4ThreeVector fphantomSize;   // Size of Water Phantom
+  G4ThreeVector fPhantomSize;   // Size of Water Phantom
   G4int         fNx,fNy,fNz;    // Number of segmentation of water phantom.
   G4bool        fInsertLead;    // Flag for inserting lead plate in water phantom
 
-
-
-
 };
 #endif

examples/extended/runAndEvent/RE02/include/RE02EMPhysics.hh

@@ -23,12 +23,14 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
-// $Id: RE02EMPhysics.hh,v 1.3 2010-04-07 01:29:00 asaim Exp $
+/// \file runAndEvent/RE02/include/RE02EMPhysics.hh
+/// \brief Definition of the RE02EMPhysics class
+//
+// $Id$
 // --------------------------------------------------------------
 //
 // 09-Oct-2003 Chhange gamma, electron, positorn process T. Koi
 
-
 #ifndef RE02EMPhysics_h
 #define RE02EMPhysics_h 1
 
@@ -45,6 +47,24 @@
 #include "G4eBremsstrahlung.hh"
 #include "G4eplusAnnihilation.hh"
 
+//
+/// User electromagnetic physics constructor
+///
+///  applys related processes to gamma and e-/+
+///
+/// - void ConstructParticle()
+///     does nothing
+///
+/// - void ConstructProcess()
+///     adds processes to each particles
+///     gamma :
+///       G4GammaConversion, G4ComptonScattering and G4PHotoElectricEffect
+///     electron : 
+///       G4eMultipleScattering, G4eIonisation and G4eBremsstrahlung
+///     positron :
+///       G4eMultipleScattering, G4eIonisation, G4eBremsstrahlung and
+///       G4ePlusAnnihilation
+//
 class RE02EMPhysics : public G4VPhysicsConstructor
 {
   public:
@@ -65,5 +85,4 @@ class RE02EMPhysics : public G4VPhysicsConstructor
 
 };
 
-
 #endif

examples/extended/runAndEvent/RE02/include/RE02EventAction.hh

@@ -23,9 +23,11 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
+/// \file runAndEvent/RE02/include/RE02EventAction.hh
+/// \brief Definition of the RE02EventAction class
 //
-// $Id: RE02EventAction.hh,v 1.3 2006-11-18 01:37:23 asaim Exp $
-// GEANT4 tag $Name: not supported by cvs2svn $
+//
+// $Id$
 //
  
 #ifndef RE02EventAction_h
@@ -35,16 +37,24 @@
 
 class G4Event;
 
+//
+/// User event action class
+///
+/// - void BeginOfEventAction(const G4Event *)
+///     does nothing
+///
+/// - void EndOfEventAction(const G4Event *)
+///     shows the number of stored trajectories in each event
 //
 class RE02EventAction : public G4UserEventAction
 {
-  public:
-    RE02EventAction();
-   ~RE02EventAction();
+public:
+  RE02EventAction();
+  ~RE02EventAction();
 
-  public:
-    void BeginOfEventAction(const G4Event*);
-    void EndOfEventAction(const G4Event*);
+public:
+  virtual void BeginOfEventAction(const G4Event*);
+  virtual void EndOfEventAction(const G4Event*);
 };
 
 //

examples/extended/runAndEvent/RE02/include/RE02GeneralPhysics.hh

@@ -23,7 +23,10 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
-// $Id: RE02GeneralPhysics.hh,v 1.2 2006-06-29 17:44:47 gunter Exp $
+/// \file runAndEvent/RE02/include/RE02GeneralPhysics.hh
+/// \brief Definition of the RE02GeneralPhysics class
+//
+// $Id$
 // --------------------------------------------------------------
 //
 
@@ -35,6 +38,18 @@
 
 #include "G4VPhysicsConstructor.hh"
 
+//
+/// User general physics constructor
+///
+///   creates all particles and applys decay
+///
+/// - void ConstructParticle()
+///     construcs all barions, all bosons (including geantinos),
+///     all ions, all leptons, all mesons, resonaces and quarks
+///
+/// - void ConstructProcess()
+///     adds the decay process
+//
 class RE02GeneralPhysics : public G4VPhysicsConstructor
 {
   public:

examples/extended/runAndEvent/RE02/include/RE02HadronPhysics.hh

@@ -23,7 +23,10 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
-// $Id: RE02HadronPhysics.hh,v 1.3 2010-04-07 01:29:00 asaim Exp $
+/// \file runAndEvent/RE02/include/RE02HadronPhysics.hh
+/// \brief Definition of the RE02HadronPhysics class
+//
+// $Id$
 // --------------------------------------------------------------
 //
 //  10-Oct-2003 Full Hadron Processes with Parameterization Model  T. Koi
@@ -133,6 +136,122 @@
 #include "G4AntiProtonAnnihilationAtRest.hh"
 #include "G4AntiNeutronAnnihilationAtRest.hh"
 
+//
+/// User hadron  physics constructor
+///
+///  applys related processes to hadrons
+///
+/// - void ConstructParticle()
+///     does nothing
+///
+/// - void ConstructProcess()
+///     adds processes to each particle
+///     pi+ :
+///       G4HadronElasticProcess with G4LElastic,
+///       G4PionPlusInelasticProcess with G4LEPionPlusInelastic and
+///       G4HEPionPlusInelastic,
+///       G4hMultipleScattering and G4hIonisation
+///     pi- :
+///       G4HadronElasticProcess with G4LElastic,
+///       G4PionMinusInelasticProcess with G4LEPionMinusInelastic and
+///       G4HEPionMinusInelastic,
+///       G4hMultipleScattering and G4hIonisation
+///     K+ :
+///       G4HadronElasticProcess with G4LElastic,
+///       G4KaonPlusInelasticProcess with G4LEKaonPlusInelastic and
+///       G4HEKaonPlusInelastic,
+///       G4hMultipleScattering and G4hIonisation
+///     K- :
+///       G4HadronElasticProcess with G4LElastic,
+///       G4KaonMinusInelasticProcess with G4LEKaonMinusInelastic and
+///       G4HEKaonMinusInelastic,
+///       G4hMultipleScattering and G4hIonisation
+///     K0L :
+///       G4HadronElasticProcess with G4LEastic and 
+///       G4KaonZeoLInelasticProcess with G4LEKaonZeroLInelastic and
+///       G4HEKaonZeroInelastic
+///     K0S :
+///       G4HadronElasticProcess with G4LEastic and
+///       G4KaonZeroSInelasticProcess with G4LEKaonZeroSInelastic and
+///       G4HEKaonZeroInelastic.
+///     proton :
+///       G4HadronElasticProcess with G4LElastic,
+///       G4ProtonInelasticProcess with G4BinaryCascade, G4LEProtonInelastic and 
+///       G4HEProtonInelastic,
+///       G4hMultipleScattering and G4hIonisation
+///     anti proton :
+///       G4HadronElasticProcess with G4LElastic,
+///       G4AntiProtonInelasticProcess with G4LEAntiProtonInelastic and 
+///       G4HEAntiProtonInelastic,
+///       G4AntiProtonAnnihilationAtRest, G4hMultipleScattering and G4hIonisation
+///     neutron :
+///       G4HadronElasticProcess with G4LElastic,
+///       G4NeutronInelasticProcess with G4BinaryCascade, G4LENeutronInelastic
+///       and G4HENeutronInelastic,
+///       G4HadronFissionProcess with G4LFission and
+///       G4HadronCaptureProcess with G4LCapture
+///     anti neutron :
+///       G4HadronElasticProcess with G4LElastic,
+///       G4AntiNeutronInelasticProcess with G4LEAntiNeutronInelastic and 
+///       G4HEAntiNeutronInelastic and
+///       G4AntiNeutronAnnihilationAtRest
+///     lambda :
+///       G4HadronElasticProcess with G4LElastic,
+///       G4LambdaInelasticProcess with G4LELambdaInelastic and 
+///       G4HELambdaInelastic
+///     anti lambda :
+///       G4HadronElasticProcess with G4LElastic,
+///       G4AntiLambdaInelasticProcess with G4LEAntiLambdaInelastic and 
+///       G4HEAntiLambdaInelastic
+///     sigma+ :
+///       G4HadronElasticProcess with G4LElastic,
+///       G4SigmaPlusInelasticProcess with G4LESigmaPlusInelastic and 
+///       G4HESigmaPlusInelastic,
+///       G4hMultipleScattering and G4hIonisation
+///     anti sigma+ :
+///       G4HadronElasticProcess with G4LElastic,
+///       G4AntiSigmaPlusInelasticProcess with G4LEAntiSigmaPlusInelastic and 
+///       G4HEAntiSigmaPlusInelastic,
+///       G4hMultipleScattering and G4hIonisation
+///     sigma- :
+///       G4HadronElasticProcess with G4LElastic,
+///       G4SigmaMinusInelasticProcess with G4LESigmaMinusInelastic and 
+///       G4HESigmaMinusInelastic,
+///       G4hMultipleScattering and G4hIonisation
+///     anti sigma- :
+///       G4HadronElasticProcess with G4LElastic,
+///       G4AntiSigmaMinusInelasticProcess with G4LEAntiSigmaMinusInelastic and 
+///       G4HEAntiSigmaMinusInelastic,
+///       G4hMultipleScattering and G4hIonisation
+///     Xi0 :
+///       G4HadronElasticProcess with G4LElastic,
+///       G4XiZeroInelasticProcess with G4LEXiZeroInelastic and 
+///       G4HEXiZeroInelastic
+///     anti Xi0 :
+///       G4HadronElasticProcess with G4LElastic,
+///       G4AntiXiZeroInelasticProcess with G4LEAntiXiZeroInelastic and 
+///       G4HEAntiXiZeroInelastic
+///     Xi- :
+///       G4HadronElasticProcess with G4LElastic,
+///       G4XiMinusInelasticProcess with G4LEXiMinusInelastic and 
+///       G4HEXiMinusInelastic,
+///       G4hMultipleScattering and G4hIonisation
+///     anti Xi- :
+///       G4HadronElasticProcess with G4LElastic,
+///       G4AntiXiMinusInelasticProcess with G4LEAntiXiMinusInelastic and 
+///       G4HEAntiXiMinusInelastic,
+///       G4hMultipleScattering and G4hIonisation
+///     omega- :
+///       G4HadronElasticProcess with G4LElastic,
+///       G4OmegaMinusInelasticProcess with G4LEOmegaMinusInelastic and 
+///       G4HEOmegaMinusInelastic,
+///       G4hMultipleScattering and G4hIonisation
+///     anti omega- :
+///       G4HadronElasticProcess with G4LElastic,
+///       G4AntiOmegaMinusInelasticProcess with G4LEAntiOmegaMinusInelastic and 
+///       G4HEAntiOmegaMinusInelastic,
+///       G4hMultipleScattering and G4hIonisation
+//
 class RE02HadronPhysics : public G4VPhysicsConstructor
 {
   public: 
@@ -153,6 +272,5 @@ class RE02HadronPhysics : public G4VPhysicsConstructor
 
 };
 
-
 #endif
 

examples/extended/runAndEvent/RE02/include/RE02IonPhysics.hh

@@ -23,7 +23,10 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
-// $Id: RE02IonPhysics.hh,v 1.3 2010-04-07 01:29:00 asaim Exp $
+/// \file runAndEvent/RE02/include/RE02IonPhysics.hh
+/// \brief Definition of the RE02IonPhysics class
+//
+// $Id$
 // --------------------------------------------------------------
 // 05-Jan-2004 Add G4ionIonisation T. Koi
 //
@@ -56,6 +59,35 @@
 #include "G4ionIonisation.hh"
 #include "G4hMultipleScattering.hh"
 
+//
+/// User ion physics constructor
+///
+///  applys related processes to ions
+///
+/// - void ConstructParticle()
+///     does nothing
+///
+/// - void ConstructProcess()
+///     adds processes to each particle
+///     generic ion :
+///       G4HadronInelasticProcess with G4TripathiCrossSection,
+///       G4IonsShenCrossSection and G4BinaryLightIonReaction,
+///       G4hMultipleScattering and G4ionIonisation
+///     deuteron :
+///       G4HadronElasticProcess with G4HadronElastic,
+///       G4DeuteronInelasticProcess with G4LEDeuteronInelastic,
+///       G4hMultipleScattering and G4hIonisation
+///     triton :
+///       G4HadronElasticProcess with G4HadronElastic,
+///       G4TritonInelasticProcess with G4LETritonInelastic,
+///       G4hMultipleScattering and G4hIonisation
+///     alpha :
+///       G4HadronElasticProcess with G4HadronElastic,
+///       G4AlphaInelasticProcess with G4LEAlphaInelastic,
+///       G4hMultipleScattering and G4hIonisation
+///     He3 :
+///       G4hMultipleScattering and G4hIonisation
+//
 class RE02IonPhysics : public G4VPhysicsConstructor
 {
   public:
@@ -75,6 +107,5 @@ class RE02IonPhysics : public G4VPhysicsConstructor
   protected:
 };
 
-
 #endif
 

examples/extended/runAndEvent/RE02/include/RE02MuonPhysics.hh

@@ -23,12 +23,14 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
-// $Id: RE02MuonPhysics.hh,v 1.3 2010-04-07 01:29:00 asaim Exp $
+/// \file runAndEvent/RE02/include/RE02MuonPhysics.hh
+/// \brief Definition of the RE02MuonPhysics class
+//
+// $Id$
 // --------------------------------------------------------------
 //
 // 09-Oct-2003 mu+- tau+- processes are changed by T. Koi
 
-
 #ifndef RE02MuonPhysics_h
 #define RE02MuonPhysics_h 1
 
@@ -43,6 +45,27 @@
 #include "G4MuIonisation.hh"
 #include "G4hIonisation.hh"
 
+//
+/// User muon physics constructor
+///
+///  applys related processes to mu and tau
+///
+/// - void ConstructParticle()
+///     does nothing
+///
+/// - void ConstructProcess()
+///     adds processes to each particle
+///     mu+:
+///       G4MuMultipleScattering, G4MuBremsstrahlung, G4MuPairProduction and
+///       G4MuIonisation
+///     mu-:
+///       G4MuMultipleScattering, G4MuBremsstrahlung, G4MuPairProduction and
+///       G4MuIonisation
+///     tau+:
+///       G4hMultipleScattering and G4hIonisation
+///     tau-:
+///       G4hMultipleScattering and G4hIonisation
+//
 class RE02MuonPhysics : public G4VPhysicsConstructor
 {
   public:
@@ -63,6 +86,5 @@ class RE02MuonPhysics : public G4VPhysicsConstructor
 
 };
 
-
 #endif
 

examples/extended/runAndEvent/RE02/include/RE02NestedPhantomParameterisation.hh

@@ -23,32 +23,12 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
+/// \file runAndEvent/RE02/include/RE02NestedPhantomParameterisation.hh
+/// \brief Definition of the RE02NestedPhantomParameterisation class
 //
-// $Id: RE02NestedPhantomParameterisation.hh,v 1.4 2010-11-09 19:46:30 asaim Exp $
-// GEANT4 tag $Name: not supported by cvs2svn $
 //
-// class G4VNestedParameterisation
+// $Id$
 //
-// Class description:
-//
-// Base class for parameterisations that use information from the parent
-// volume to compute the material of a copy/instance of this volume. 
-// This is in addition to using the current replication number.
-// 
-// Notes:
-//  - Such a volume can be nested inside a placement volume or a parameterised  
-//    volume.
-//  - The user can modify the solid type, size or transformation using only
-//    the replication number of this parameterised volume.
-//    He/she is NOT allowed to change these attributes using information of
-//    parent volumes - otherwise incorrect results will occur.
-//  Also note that the usual restrictions apply: 
-//   - the mother volume, in which these copies are placed, must always be
-//     of the same dimensions
-
-// History:
-// 24.02.05 - J.Apostolakis - First created version.
-// --------------------------------------------------------------------
 #ifndef RE02NESTEDPARAMETERISATION_HH
 #define RE02NESTEDPARAMETERISATION_HH
 
@@ -77,19 +57,50 @@ class G4Polycone;
 class G4Polyhedra;
 class G4Hype;
 
+//
+/// A nested parameterisation class for a phantom
+///
+///  (Description)
+///     This parameterisation handles material and transfomation of voxles.
+///
+/// - G4Material* ComputeMaterial(G4VPhysicalVolume *currentVol,
+///                               const G4int repNo,
+///                               const G4VTouchable *parentTouch=0)
+///     returns material.
+///       if ix%2==0 && iy%2==0 && iz%2==0 then fMat[0]
+///       else fMat[1]
+///
+/// - G4int GetNumberOfMaterials() const
+///     returns the number of material defined in fMat
+///
+/// - G4Material* GetMaterial(G4int idx) const
+///     returns the i-th material of fMat
+///
+/// - void ComputeTransformation(const G4int no,
+///                              G4VPhysicalVolume *currentPV) const
+///     returns a transformation with the physical volume of the 2nd argument
+///     according to copyNo
+///     Its position is defined as G4ThreeVector(0.,0.,fpZ[copyNo]).
+///
+/// - void ComputeDimensions(G4Box &, const G4int, 
+///                          const G4VPhysicalVolume *) const
+///     returns dimensions of this parameterized volume with the physical 
+///     volume of the 3rd argument.
+///
+//
 class RE02NestedPhantomParameterisation: public G4VNestedParameterisation
 {
   public:  // with description
 
     RE02NestedPhantomParameterisation(const G4ThreeVector& voxelSize,
-				      G4int nz,
-				      std::vector<G4Material*>& mat);
+                                      G4int nz,
+                                      std::vector<G4Material*>& mat);
     virtual ~RE02NestedPhantomParameterisation(); 
 
     // Methods required in derived classes
     // -----------------------------------
     virtual G4Material* ComputeMaterial(G4VPhysicalVolume *currentVol,
-					const G4int repNo, 
+                                        const G4int repNo, 
                                         const G4VTouchable *parentTouch=0
                                         );
   // Required method, as it is the reason for this class.
@@ -115,27 +126,27 @@ class RE02NestedPhantomParameterisation: public G4VNestedParameterisation
                                    const G4VPhysicalVolume *) const;
 
 private:  // Dummy declarations to get rid of warnings ...
-  void ComputeDimensions (G4Trd&,const G4int,const G4VPhysicalVolume*) 
+  virtual void ComputeDimensions (G4Trd&,const G4int,const G4VPhysicalVolume*) 
     const {}
-  void ComputeDimensions (G4Trap&,const G4int,const G4VPhysicalVolume*) 
+  virtual void ComputeDimensions (G4Trap&,const G4int,const G4VPhysicalVolume*) 
     const {}
-  void ComputeDimensions (G4Cons&,const G4int,const G4VPhysicalVolume*) 
+  virtual void ComputeDimensions (G4Cons&,const G4int,const G4VPhysicalVolume*) 
     const {}
-  void ComputeDimensions (G4Sphere&,const G4int,const G4VPhysicalVolume*) 
+  virtual void ComputeDimensions (G4Sphere&,const G4int,const G4VPhysicalVolume*) 
     const {}
-  void ComputeDimensions (G4Orb&,const G4int,const G4VPhysicalVolume*) 
+  virtual void ComputeDimensions (G4Orb&,const G4int,const G4VPhysicalVolume*) 
     const {}
-  void ComputeDimensions (G4Torus&,const G4int,const G4VPhysicalVolume*) 
+  virtual void ComputeDimensions (G4Torus&,const G4int,const G4VPhysicalVolume*) 
     const {}
-  void ComputeDimensions (G4Para&,const G4int,const G4VPhysicalVolume*) 
+  virtual void ComputeDimensions (G4Para&,const G4int,const G4VPhysicalVolume*) 
     const {}
-  void ComputeDimensions (G4Hype&,const G4int,const G4VPhysicalVolume*) 
+  virtual void ComputeDimensions (G4Hype&,const G4int,const G4VPhysicalVolume*) 
     const {}
-  void ComputeDimensions (G4Tubs&,const G4int,const G4VPhysicalVolume*) 
+  virtual void ComputeDimensions (G4Tubs&,const G4int,const G4VPhysicalVolume*) 
     const {}
-  void ComputeDimensions (G4Polycone&,const G4int,const G4VPhysicalVolume*)
+  virtual void ComputeDimensions (G4Polycone&,const G4int,const G4VPhysicalVolume*)
     const {}
-  void ComputeDimensions (G4Polyhedra&,const G4int,const G4VPhysicalVolume*) 
+  virtual void ComputeDimensions (G4Polyhedra&,const G4int,const G4VPhysicalVolume*) 
     const {}
 //  G4Material* ComputeMaterial(const G4int repNo,
 //                              G4VPhysicalVolume* currentVol,
@@ -148,7 +159,7 @@ private:
   G4int fNz;
   //
   std::vector<G4double>  fpZ;
-  std::vector<G4Material*> fmat;
+  std::vector<G4Material*> fMat;
 };
 
 #endif

examples/extended/runAndEvent/RE02/include/RE02PSCellFlux.hh

@@ -23,9 +23,11 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
+/// \file runAndEvent/RE02/include/RE02PSCellFlux.hh
+/// \brief Definition of the RE02PSCellFlux class
 //
-// $Id: RE02PSCellFlux.hh,v 1.2 2006-12-13 15:42:47 gunter Exp $
-// GEANT4 tag $Name: not supported by cvs2svn $
+//
+// $Id$
 //
 
 #ifndef RE02PSCellFlux_h
@@ -33,22 +35,23 @@
 
 #include "G4PSCellFlux.hh"
 ///////////////////////////////////////////////////////////////////////////////
-// (Description)
-//   This is a primitive scorer class for scoring cell flux.
-//   The Cell Flux is defined by  a sum of track length divided
-//   by the geometry volume, where all of the tracks in the geometry
-//   are taken into account. e.g. the unit of Cell Flux is mm/mm3.
-//
-//
-//   If you want to score only tracks passing through the geometry volume,
-//  please use G4PSPassageCellFlux.
-//
 //
+/// Cell flux class for a parameterized volume in a three dimentional structure
+///
+/// (Description)
+///   This is a primitive scorer class for scoring cell flux.
+///   The Cell Flux is defined by a sum of track length divided by the geometry
+///   volume, where all of the tracks in the geometry are taken into account.
+///   e.g. the unit of Cell Flux is mm/mm3.
+///
+///   If you score only tracks passing through the geometry volume, use
+///   G4PSPassageCellFlux.
+///
+///
 // Created: 2005-11-14  Tsukasa ASO, Akinori Kimura.
 // 
 ///////////////////////////////////////////////////////////////////////////////
 
-
 class RE02PSCellFlux : public G4PSCellFlux
 {
    public: // with description

examples/extended/runAndEvent/RE02/include/RE02PSEnergyDeposit.hh

@@ -23,9 +23,11 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
+/// \file runAndEvent/RE02/include/RE02PSEnergyDeposit.hh
+/// \brief Definition of the RE02PSEnergyDeposit class
 //
-// $Id: RE02PSEnergyDeposit.hh,v 1.2 2006-12-13 15:42:50 gunter Exp $
-// GEANT4 tag $Name: not supported by cvs2svn $
+//
+// $Id$
 //
 
 #ifndef RE02PSEnergyDeposit_h
@@ -33,13 +35,12 @@
 
 #include "G4PSEnergyDeposit.hh"
 ///////////////////////////////////////////////////////////////////////////////
-// Description:
+// (Description)
 //   This is a primitive scorer class for scoring energy deposit.
 //
 // Created: 2005-11-14  Tsukasa ASO, Akinori Kimura 
 ///////////////////////////////////////////////////////////////////////////////
 
-
 class RE02PSEnergyDeposit : public G4PSEnergyDeposit
 {
    public: // with description

examples/extended/runAndEvent/RE02/include/RE02PSFlatSurfaceCurrent.hh

@@ -23,9 +23,11 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
+/// \file runAndEvent/RE02/include/RE02PSFlatSurfaceCurrent.hh
+/// \brief Definition of the RE02PSFlatSurfaceCurrent class
 //
-// $Id: RE02PSFlatSurfaceCurrent.hh,v 1.2 2006-12-13 15:42:52 gunter Exp $
-// GEANT4 tag $Name: not supported by cvs2svn $
+//
+// $Id$
 //
 
 #ifndef RE02PSFlatSurfaceCurrent_h
@@ -51,12 +53,11 @@
 // 17-Nov-2005 T.Aso, Bug fix for area definition.
 ///////////////////////////////////////////////////////////////////////////////
 
-
 class RE02PSFlatSurfaceCurrent : public G4PSFlatSurfaceCurrent
 {
    public: // with description
       RE02PSFlatSurfaceCurrent(G4String name, G4int direction,
-			       G4int nx,G4int ny, G4int nz);
+                               G4int nx,G4int ny, G4int nz);
       virtual ~RE02PSFlatSurfaceCurrent();
 
   protected: // with description

examples/extended/runAndEvent/RE02/include/RE02PSFlatSurfaceFlux.hh

@@ -23,9 +23,11 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
+/// \file runAndEvent/RE02/include/RE02PSFlatSurfaceFlux.hh
+/// \brief Definition of the RE02PSFlatSurfaceFlux class
 //
-// $Id: RE02PSFlatSurfaceFlux.hh,v 1.2 2006-12-13 15:42:54 gunter Exp $
-// GEANT4 tag $Name: not supported by cvs2svn $
+//
+// $Id$
 //
 
 #ifndef RE02PSFlatSurfaceFlux_h
@@ -54,11 +56,11 @@
 //                      Bug fix. Area definition.
 ///////////////////////////////////////////////////////////////////////////////
 
-
 class RE02PSFlatSurfaceFlux : public G4PSFlatSurfaceFlux
 {
    public: // with description
-      RE02PSFlatSurfaceFlux(G4String name, G4int direction, G4int nx,G4int ny, G4int nz);
+      RE02PSFlatSurfaceFlux(G4String name, G4int direction,
+                            G4int nx,G4int ny, G4int nz);
       virtual ~RE02PSFlatSurfaceFlux();
 
   protected: // with description

examples/extended/runAndEvent/RE02/include/RE02PSNofStep.hh

@@ -23,9 +23,11 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
+/// \file runAndEvent/RE02/include/RE02PSNofStep.hh
+/// \brief Definition of the RE02PSNofStep class
 //
-// $Id: RE02PSNofStep.hh,v 1.2 2006-12-13 15:42:57 gunter Exp $
-// GEANT4 tag $Name: not supported by cvs2svn $
+//
+// $Id$
 //
 
 #ifndef RE02PSNofStep_h
@@ -40,7 +42,6 @@
 //
 ///////////////////////////////////////////////////////////////////////////////
 
-
 class RE02PSNofStep : public G4PSNofStep
 {
    public: // with description

examples/extended/runAndEvent/RE02/include/RE02PSPassageCellFlux.hh

@@ -23,9 +23,11 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
+/// \file runAndEvent/RE02/include/RE02PSPassageCellFlux.hh
+/// \brief Definition of the RE02PSPassageCellFlux class
 //
-// $Id: RE02PSPassageCellFlux.hh,v 1.2 2006-12-13 15:43:00 gunter Exp $
-// GEANT4 tag $Name: not supported by cvs2svn $
+//
+// $Id$
 //
 
 #ifndef RE02PSPassageCellFlux_h
@@ -45,7 +47,6 @@
 // Created: 2005-11-14  Tsukasa ASO, Akinori Kimura.
 ///////////////////////////////////////////////////////////////////////////////
 
-
 class RE02PSPassageCellFlux : public G4PSPassageCellFlux
 {
    public: // with description
@@ -58,5 +59,6 @@ class RE02PSPassageCellFlux : public G4PSPassageCellFlux
   private:
       G4int fNx, fNy, fNz;
 };
+
 #endif
 

examples/extended/runAndEvent/RE02/include/RE02PhysicsList.hh

@@ -23,7 +23,10 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
-// $Id: RE02PhysicsList.hh,v 1.2 2006-06-29 17:45:01 gunter Exp $
+/// \file runAndEvent/RE02/include/RE02PhysicsList.hh
+/// \brief Definition of the RE02PhysicsList class
+//
+// $Id$
 // --------------------------------------------------------------
 //
 #ifndef RE02PhysicsList_h
@@ -32,6 +35,15 @@
 #include "G4VModularPhysicsList.hh"
 #include "globals.hh"
 
+//
+/// Physics list class
+///
+/// - constructor
+///     registers general, standard EM, muon, hadron and ion physics
+///
+/// - void SetCuts()
+///     invokes default SetCuts methods with SetCutsWithDefault()
+//
 class RE02PhysicsList: public G4VModularPhysicsList
 {
 public:
@@ -42,10 +54,8 @@ public:
   // SetCuts()
   virtual void SetCuts();
 
-
 };
 
-
 #endif
 
 

examples/extended/runAndEvent/RE02/include/RE02PrimaryGeneratorAction.hh

@@ -23,9 +23,11 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
+/// \file runAndEvent/RE02/include/RE02PrimaryGeneratorAction.hh
+/// \brief Definition of the RE02PrimaryGeneratorAction class
 //
-// $Id: RE02PrimaryGeneratorAction.hh,v 1.3 2006-11-18 01:37:23 asaim Exp $
-// GEANT4 tag $Name: not supported by cvs2svn $
+//
+// $Id$
 //
  
 #ifndef RE02PrimaryGeneratorAction_h
@@ -38,6 +40,13 @@ class RE02DetectorConstruction;
 class G4ParticleGun;
 class G4Event;
 
+//
+/// User primary particle generator class
+///
+/// - void GeneratePrimaries(G4Event*)
+///     an incident particle is proton with 150 MeV energy at the position 
+///     (x,y,-100 cm) toward the (0,0,1) direction. The x and y positions are
+///     uniformly varied from -5 mm to 5 mm, respectively.
 //
 class RE02PrimaryGeneratorAction : public G4VUserPrimaryGeneratorAction
 {
@@ -46,11 +55,11 @@ class RE02PrimaryGeneratorAction : public G4VUserPrimaryGeneratorAction
    ~RE02PrimaryGeneratorAction();
 
   public:
-    void GeneratePrimaries(G4Event*);
+    virtual void GeneratePrimaries(G4Event*);
 
   private:
-    G4double fsigmaPosition; // Initial beam spot size in x-y plane.
-    G4ParticleGun* particleGun;
+    G4double fSigmaPosition; // Initial beam spot size in x-y plane.
+    G4ParticleGun* fParticleGun;
 };
 
 //

examples/extended/runAndEvent/RE02/include/RE02Run.hh

@@ -23,18 +23,12 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
+/// \file runAndEvent/RE02/include/RE02Run.hh
+/// \brief Definition of the RE02Run class
 //
-// $Id: RE02Run.hh,v 1.3 2006-11-18 01:37:23 asaim Exp $
-// GEANT4 tag $Name: not supported by cvs2svn $
+//
+// $Id$
 // 
-//---------------------------------------------------------------------
-// (Purpose) 
-//    Example implementation for multi-functional-detector and 
-//   primitive scorer.
-//    This RE02Run class has collections which accumulate
-//   a event information into a run information.
-//
-//---------------------------------------------------------------------
 
 #ifndef RE02Run_h
 #define RE02Run_h 1
@@ -44,7 +38,40 @@
 
 #include "G4THitsMap.hh"
 #include <vector>
-//
+
+//---------------------------------------------------------------------
+/// User run class
+///
+/// (Description) 
+///    An example implementation for the multi-functional-detector and 
+///   primitive scorers.
+///    This RE02Run class has collections which accumulate event information 
+///   into run information.
+///
+/// - constructor
+///     gets HitsCollection names, collection IDs and HitsMaps of
+///        primitive scorers from the muti-functional detector
+///
+/// - void RecordEvent(const G4Event*)
+///     accumulates HitsMaps over all events into a run HitsMap
+///
+/// - G4int GetNumberOfHitsMap() const
+///     gets the size of the run HitsMap
+///
+/// - G4THitsMap<G4double>* GetHitsMap(G4int i)
+///     gets a run HitsMap of the i-th primitive scorer
+///
+/// - G4THitsMap<G4double>* GetHitsMap(const G4String& detName, 
+///                                  const G4String& colName)
+///     gets a run HitsMap with the detName and the colName
+///
+/// - G4THitsMap<G4double>* GetHitsMap(const G4String& fullName)
+///     gets a run HitsMap with the fullName
+///
+/// - void DumpAllScorer()
+///     shows all HitsMap information of this run.
+///     This method calls G4THisMap::PrintAll() for individual HitsMap.
+//---------------------------------------------------------------------
 class RE02Run : public G4Run {
 
 public:
@@ -61,22 +88,22 @@ public:
   // Access methods for scoring information.
   // - Number of HitsMap for this RUN. 
   //   This is equal to number of collections.
-  G4int GetNumberOfHitsMap() const {return theRunMap.size();}
+  G4int GetNumberOfHitsMap() const {return fRunMap.size();}
   // - Get HitsMap of this RUN.
   //   by sequential number, by multifucntional name and collection name,
   //   and by collection name with full path.
-  G4THitsMap<G4double>* GetHitsMap(G4int i){return theRunMap[i];}
+  G4THitsMap<G4double>* GetHitsMap(G4int i){return fRunMap[i];}
   G4THitsMap<G4double>* GetHitsMap(const G4String& detName, 
-				  const G4String& colName);
+                                  const G4String& colName);
   G4THitsMap<G4double>* GetHitsMap(const G4String& fullName);
   // - Dump All HitsMap of this RUN.
   //   This method calls G4THisMap::PrintAll() for individual HitsMap.
   void DumpAllScorer();
 
 private:
-  std::vector<G4String> theCollName;
-  std::vector<G4int> theCollID;
-  std::vector<G4THitsMap<G4double>*> theRunMap;
+  std::vector<G4String> fCollName;
+  std::vector<G4int> fCollID;
+  std::vector<G4THitsMap<G4double>*> fRunMap;
 };
 
 //

examples/extended/runAndEvent/RE02/include/RE02RunAction.hh

@@ -23,10 +23,14 @@
 // * acceptance of all terms of the Geant4 Software license.          *
 // ********************************************************************
 //
+/// \file runAndEvent/RE02/include/RE02RunAction.hh
+/// \brief Definition of the RE02RunAction class
 //
-// $Id: RE02RunAction.hh,v 1.3 2006-11-18 01:37:23 asaim Exp $
-// GEANT4 tag $Name: not supported by cvs2svn $
+//
+// $Id$
 // 
+//  
+//
 
 #ifndef RE02RunAction_h
 #define RE02RunAction_h 1
@@ -46,6 +50,22 @@ class G4Run;
 //
 //=======================================================================
 //
+/// User run action class
+///
+/// - G4Run* GenerateRun()
+///     instanciates a run of RE02Run with a sensitive detector name
+///
+/// - void BeginOfRunAction(const G4Run*)
+///     shows the run number 
+///
+/// - void EndOfRunAction(const G4Run*)
+///     shows accumulated information of primitive scorers and
+///     outputs total energy deposit into "totED.txt" file
+///
+/// - G4int CopyNo(G4int ix, G4int iy, G4int iz)
+///     returns a copy number of the segment number of the water phantom
+///     indicated by three dimentional indexes
+//
 class RE02RunAction : public G4UserRunAction
 {
 public:
@@ -63,13 +83,12 @@ public:
   // Utility method for converting segment number of
   // water phantom to copyNo of HitsMap.
   G4int CopyNo(G4int ix, G4int iy, G4int iz)
-  {  return (iy*(fNx*fNy)+ix*fNz+iz); }
-
+  {  return (iy*(fNx*fNz)+ix*fNz+iz); }
 
 private:
   // Data member 
   // - vector of MultiFunctionalDetecor names.
-  std::vector<G4String> theSDName;  
+  std::vector<G4String> fSDName;  
 
   // for conversion of sengment number to copyNo.
   G4int fNx, fNy, fNz;