include/Geant4/G4ErrorCylSurfaceTarget.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // G4ErrorCylSurfaceTarget
0027 //
0028 // Class Description:
0029 //
0030 // Limits step when track reaches a cylindrical surface.
0031
0032 // Author: Pedro Arce (CIEMAT), September 2004
0033 // --------------------------------------------------------------------
0034 #ifndef G4ERRORCYLSURFACETARGET_HH
0035 #define G4ERRORCYLSURFACETARGET_HH
0036
0037 #include "globals.hh"
0038 #include "G4ErrorSurfaceTarget.hh"
0039 #include "G4ThreeVector.hh"
0040 #include "G4RotationMatrix.hh"
0041 #include "G4AffineTransform.hh"
0042 #include "G4Plane3D.hh"
0043
0044 /**
0045  * @brief G4ErrorCylSurfaceTarget is a utility class for limiting
0046  * the step when a track reaches a cylindrical surface.
0047  */
0048
0049 class G4ErrorCylSurfaceTarget : public G4ErrorSurfaceTarget
0050 {
0051   public:
0052
0053     /**
0054      * Constructor for G4ErrorCylSurfaceTarget. It constructs a cylindrical
0055      * surface by radius, translation and rotation.
0056      *  @param[in] radius Cylinder radius.
0057      *  @param[in] trans Translation vector.
0058      *  @param[in] rotm Rotation matrix.
0059      */
0060     G4ErrorCylSurfaceTarget( const G4double& radius,
0061                              const G4ThreeVector& trans = G4ThreeVector(),
0062                              const G4RotationMatrix& rotm = G4RotationMatrix() );
0063
0064     /**
0065      * Constructor for G4ErrorCylSurfaceTarget. It constructs a cylindrical
0066      * surface by radius and affine transformation.
0067      *  @param[in] radius Cylinder radius.
0068      *  @param[in] trans The affine transformation in input.
0069      */
0070     G4ErrorCylSurfaceTarget( const G4double& radius,
0071                              const G4AffineTransform& trans );
0072
0073     /**
0074      * Default Destructor.
0075      */
0076     ~G4ErrorCylSurfaceTarget() override = default;
0077
0078     /**
0079      * Intersects the cylindrical surface with the line in local (cylinder)
0080      * coordinates, given by point and direction.
0081      *  @param[in] point The point of reference.
0082      *  @param[in] direc The direction vector.
0083      *  @returns The intersection point.
0084      */
0085     G4ThreeVector IntersectLocal( const G4ThreeVector& point,
0086                                   const G4ThreeVector& direc ) const;
0087
0088     /**
0089      * Computes the distance from a point to the cylindrical surface in a
0090      * given direction.
0091      *  @param[in] point The point of reference.
0092      *  @param[in] direc The direction vector.
0093      *  @returns The distance value.
0094      */
0095     G4double GetDistanceFromPoint( const G4ThreeVector& point,
0096                                    const G4ThreeVector& direc ) const override;
0097
0098     /**
0099      * Computes the minimal distance from a point to the cylindrical surface
0100      * in any direction.
0101      *  @param[in] point The point of reference.
0102      *  @returns The distance value.
0103      */
0104     G4double GetDistanceFromPoint( const G4ThreeVector& point ) const override;
0105
0106     /**
0107      * Computes the plane tangent to cylindrical surface at a given point.
0108      *  @param[in] point The point of reference.
0109      *  @returns The tangent plane.
0110      */
0111     G4Plane3D GetTangentPlane( const G4ThreeVector& point ) const override;
0112
0113     /**
0114      * Dumps to standard output the cylindrical surface parameters.
0115      */
0116     void Dump( const G4String& msg ) const override;
0117
0118   private:
0119
0120      G4double fradius;
0121      G4AffineTransform ftransform;
0122 };
0123
0124 #endif