include/Geant4/G4ErrorPlaneSurfaceTarget.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 // G4ErrorPlaneSurfaceTarget
0027 //
0028 // Class Description:
0029 //
0030 // Limits step when track reaches a plane surface.
0031
0032 // Author: Pedro Arce (CIEMAT), September 2004
0033 // --------------------------------------------------------------------
0034 #ifndef G4ERRORPLANESURFACETARGET_HH
0035 #define G4ERRORPLANESURFACETARGET_HH
0036
0037 #include "globals.hh"
0038 #include "G4ErrorSurfaceTarget.hh"
0039 #include "G4ThreeVector.hh"
0040 #include "G4Normal3D.hh"
0041 #include "G4Plane3D.hh"
0042 #include "G4Point3D.hh"
0043
0044 /**
0045  * @brief G4ErrorPlaneSurfaceTarget is an utility class for limiting
0046  * the step when a track reaches a plane surface.
0047  */
0048
0049 class G4ErrorPlaneSurfaceTarget : public G4ErrorSurfaceTarget, G4Plane3D
0050 {
0051   public:
0052
0053     /**
0054      * Constructor for G4ErrorPlaneSurfaceTarget. It constructs a plane
0055      * by parameters: ax+by+cz+d = 0.
0056      */
0057     G4ErrorPlaneSurfaceTarget(G4double a=0., G4double b=0.,
0058                               G4double c=0., G4double d=0.);
0059
0060     /**
0061      * Constructor for G4ErrorPlaneSurfaceTarget. It constructs a plane
0062      * by point 'p' and normal 'n'.
0063      */
0064     G4ErrorPlaneSurfaceTarget(const G4Normal3D& n,
0065                               const G4Point3D& p);
0066
0067     /**
0068      * Constructor for G4ErrorPlaneSurfaceTarget. It constructs a plane
0069      * by three points, 'p1', 'p2', 'p3'.
0070      */
0071     G4ErrorPlaneSurfaceTarget(const G4Point3D& p1,
0072                               const G4Point3D& p2,
0073                               const G4Point3D& p3);
0074
0075     /**
0076      * Default Destructor.
0077      */
0078     ~G4ErrorPlaneSurfaceTarget() override = default;
0079
0080     /**
0081      * Intersects the surface with the line given by point and direction.
0082      *  @param[in] point The point of reference.
0083      *  @param[in] direc The direction vector.
0084      *  @returns The intersection point.
0085      */
0086     G4ThreeVector Intersect( const G4ThreeVector& point,
0087                              const G4ThreeVector& direc ) const;
0088
0089     /**
0090      * Computes the distance from a point to the surface in a 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 surface.
0100      *  @param[in] point The point of reference.
0101      *  @returns The distance value.
0102      */
0103     G4double GetDistanceFromPoint( const G4ThreeVector& pt ) const override;
0104
0105     /**
0106      * Computes the plane tangent to itself at a given point.
0107      *  @param[in] point The point of reference.
0108      *  @returns The tangent plane.
0109      */
0110     G4Plane3D GetTangentPlane( const G4ThreeVector& point ) const override;
0111
0112     /**
0113      * Dumps to standard output the surface parameters.
0114      */
0115     void Dump( const G4String& msg ) const override;
0116 };
0117
0118 #endif