G4EllipticalCone.hh

Go to the documentation of this file.

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
// G4EllipticalCone
//
// Class description:
//
// G4EllipticalCone is a full cone with elliptical base which can be cut in Z.
//
// Member Data:
//
//      xSemiAxis       semi-axis, x, without dimentions
//      ySemiAxis       semi-axis, y, without dimentions
//      zheight         height, z
//      zTopCut         upper cut plane level, z 
//
// The height in Z corresponds to where the elliptical cone hits the 
// Z-axis if it had no Z cut. Also the cone is centered at zero having a
// base at zTopCut and another at -zTopCut. The semi-major axes at the Z=0
// plane are given by xSemiAxis*zheight and ySemiAxis*zheight so that the
// curved surface of our cone satisfies the equation: 
//
// ***************************************************************************
// *                                                                         *
// *           (x/xSemiAxis)^2 + (y/ySemiAxis)^2 = (zheight - z)^2           * 
// *                                                                         *
// ***************************************************************************
//
// In case you want to construct G4EllipticalCone from:
//   1. halflength in Z = zTopCut
//   2. Dx and Dy =  halflength of ellipse axis  at  z = -zTopCut
//   3. dx and dy =  halflength of ellipse axis  at  z =  zTopCut
//      ! Attention :  dx/dy=Dx/Dy 
//
// You need to find xSemiAxis,ySemiAxis and zheight:
//
//  xSemiAxis = (Dx-dx)/(2*zTopCut)
//  ySemiAxis = (Dy-dy)/(2*zTopCut)
//    zheight = (Dx+dx)/(2*xSemiAxis)
 
// Author: Dionysios Anninos, 8.9.2005
// Revisions:
//   Lukas Lindroos, Tatiana Nikitina, 20.08.2007
//   Evgueni Tcherniaev, 20.07.2017
// --------------------------------------------------------------------
#ifndef G4ELLIPTICALCONE_HH
#define G4ELLIPTICALCONE_HH
 
#include "G4GeomTypes.hh"
 
#if defined(G4GEOM_USE_USOLIDS)
#define G4GEOM_USE_UELLIPTICALCONE 1
#endif
 
#if (defined(G4GEOM_USE_UELLIPTICALCONE) && defined(G4GEOM_USE_SYS_USOLIDS))
  #define G4UEllipticalCone G4EllipticalCone
  #include "G4UEllipticalCone.hh"
#else
 
#include <CLHEP/Units/PhysicalConstants.h>
 
#include "G4VSolid.hh"
#include "G4Polyhedron.hh"
 
class G4EllipticalCone : public G4VSolid
{
  public:  // with description
   
    G4EllipticalCone(const G4String& pName,
                           G4double  pxSemiAxis,
                           G4double  pySemiAxis,
                           G4double  zMax,
                           G4double  pzTopCut);
 
    virtual ~G4EllipticalCone();
 
    // Access functions
    //
    inline G4double GetSemiAxisMin () const;
    inline G4double GetSemiAxisMax () const;
    inline G4double GetSemiAxisX () const;
    inline G4double GetSemiAxisY () const;
    inline G4double GetZMax() const;
    inline G4double GetZTopCut() const;
    inline void SetSemiAxis (G4double x, G4double y, G4double z);
    inline void SetZCut (G4double newzTopCut);
 
    G4double GetCubicVolume(); 
    G4double GetSurfaceArea();
 
    // Solid standard methods
    //
    void BoundingLimits(G4ThreeVector& pMin, G4ThreeVector& pMax) const;
 
    G4bool CalculateExtent(const EAxis pAxis,
                           const G4VoxelLimits& pVoxelLimit,
                           const G4AffineTransform& pTransform,
                                 G4double& pMin, G4double& pMax) const;
 
    EInside Inside(const G4ThreeVector& p) const;
 
    G4ThreeVector SurfaceNormal( const G4ThreeVector& p) const;
 
    G4double DistanceToIn(const G4ThreeVector& p,
                          const G4ThreeVector& v) const;
 
    G4double DistanceToIn(const G4ThreeVector& p) const;
 
    G4double DistanceToOut(const G4ThreeVector& p,
                           const G4ThreeVector& v,
                           const G4bool calcNorm = false,
                                 G4bool* validNorm = nullptr,
                                 G4ThreeVector* n = nullptr) const;
 
    G4double DistanceToOut(const G4ThreeVector& p) const;
 
    G4GeometryType GetEntityType() const;
  
    G4VSolid* Clone() const;
 
    G4ThreeVector GetPointOnSurface() const;
 
    std::ostream& StreamInfo(std::ostream& os) const;
 
    // Visualisation functions
    //
    G4Polyhedron* GetPolyhedron () const;
    void DescribeYourselfTo(G4VGraphicsScene& scene) const;
    G4VisExtent   GetExtent() const;
    G4Polyhedron* CreatePolyhedron() const;
       
  public:  // without description
 
    G4EllipticalCone(__void__&);
      // Fake default constructor for usage restricted to direct object
      // persistency for clients requiring preallocation of memory for
      // persistifiable objects.
 
    G4EllipticalCone(const G4EllipticalCone& rhs);
    G4EllipticalCone& operator=(const G4EllipticalCone& rhs); 
      // Copy constructor and assignment operator.
 
  protected:  // without description
 
    mutable G4bool fRebuildPolyhedron = false;
    mutable G4Polyhedron* fpPolyhedron = nullptr;
 
  private:
 
    G4ThreeVector ApproxSurfaceNormal(const G4ThreeVector& p) const;
      // Algorithm for SurfaceNormal() following the original
      // specification for points not on the surface
 
  private:
 
    G4double halfCarTol;
    G4double fCubicVolume = 0.0;
    G4double fSurfaceArea = 0.0;
    G4double xSemiAxis, ySemiAxis, zheight, zTopCut;
    G4double cosAxisMin, invXX, invYY;
};
 
#include "G4EllipticalCone.icc"
 
#endif  // defined(G4GEOM_USE_UELLIPTICALCONE) && defined(G4GEOM_USE_SYS_USOLIDS)
 
#endif // G4ELLIPTICALCONE_HH