include/Geant4/G4IntersectingCone.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 // G4IntersectingCone
0027 //
0028 // Class description:
0029 //
0030 // Utility class which calculates the intersection
0031 // of an arbitrary line with a fixed cone.
0032
0033 // Author: David C. Williams (UCSC), 1998 - Created
0034 // --------------------------------------------------------------------
0035 #ifndef G4INTERSECTINGCONE_HH
0036 #define G4INTERSECTINGCONE_HH
0037
0038 #include "G4Types.hh"
0039 #include "geomdefs.hh"
0040 #include "G4ThreeVector.hh"
0041
0042 /**
0043  * @brief G4IntersectingCone is a utility class used to calculate the
0044  * intersection of an arbitrary line with a fixed cone.
0045  */
0046
0047 class G4IntersectingCone
0048 {
0049   public:
0050
0051     /**
0052      * Constructor given r,z values.
0053      *  @param[in] r r values.
0054      *  @param[in] z Z values.
0055      */
0056     G4IntersectingCone( const G4double r[2], const G4double z[2] );
0057
0058     /**
0059      * Default Destructor.
0060      */
0061     ~G4IntersectingCone() = default;
0062
0063     /**
0064      * Calculates the intersection of a line with the conical surface,
0065      * ignoring any Phi division.
0066      */
0067     G4int LineHitsCone( const G4ThreeVector& p, const G4ThreeVector& v,
0068                               G4double* s1, G4double* s2 );
0069
0070     /**
0071      * Checks r or z extent, as appropriate, to see if the point is
0072      * possibly on the cone.
0073      */
0074     G4bool HitOn( const G4double r, const G4double z );
0075
0076     /**
0077      * Accessors for R and Z bounds of side.
0078      */
0079     inline G4double RLo() const { return rLo; }
0080     inline G4double RHi() const { return rHi; }
0081     inline G4double ZLo() const { return zLo; }
0082     inline G4double ZHi() const { return zHi; }
0083
0084     /**
0085      * Fake default constructor for usage restricted to direct object
0086      * persistency for clients requiring preallocation of memory for
0087      * persistifiable objects.
0088      */
0089     G4IntersectingCone(__void__&);
0090
0091   private:
0092
0093     /**
0094      * Calculating the intersection of a line with the conical surface.
0095      * Internal methods used by LineHitsCone().
0096      */
0097     G4int LineHitsCone1( const G4ThreeVector& p, const G4ThreeVector& v,
0098                                G4double* s1, G4double* s2 );
0099     G4int LineHitsCone2( const G4ThreeVector& p, const G4ThreeVector& v,
0100                                G4double* s1, G4double* s2 );
0101   private:
0102
0103     /** Z, R bounds of side. */
0104     G4double zLo, zHi, rLo, rHi;
0105
0106     /** True if cone is type 1. */
0107     G4bool type1 = false; // (std::fabs(z1-z2)>std::fabs(r1-r2))
0108
0109     /** Cone radius parameters - type 1: r = A + B*z; type 2: z = A + B*r. */
0110     G4double A, B;
0111 };
0112
0113 #endif