G4TwistedBox Class Reference

G4TwistedBox is a twisted cuboid of given half lengths and twist angle. The box is centred on the origin with sides parallel to the Cartesian axes. More...

#include <G4TwistedBox.hh>

Inheritance diagram for G4TwistedBox:

Public Member Functions
	G4TwistedBox (const G4String &pName, G4double pPhiTwist, G4double pDx, G4double pDy, G4double pDz)
	~G4TwistedBox () override=default
G4double	GetXHalfLength () const
G4double	GetYHalfLength () const
G4double	GetZHalfLength () const
G4double	GetPhiTwist () const
G4GeometryType	GetEntityType () const override
G4double	GetCubicVolume () override
G4double	GetSurfaceArea () override
G4VSolid *	Clone () const override
std::ostream &	StreamInfo (std::ostream &os) const override
	G4TwistedBox (__void__ &)
	G4TwistedBox (const G4TwistedBox &rhs)
G4TwistedBox &	operator= (const G4TwistedBox &rhs)
Public Member Functions inherited from G4VTwistedFaceted
	G4VTwistedFaceted (const G4String &pname, G4double PhiTwist, G4double pDz, G4double pTheta, G4double pPhi, G4double pDy1, G4double pDx1, G4double pDx2, G4double pDy2, G4double pDx3, G4double pDx4, G4double pAlph)
	~G4VTwistedFaceted () override
void	ComputeDimensions (G4VPVParameterisation *, const G4int, const G4VPhysicalVolume *) override
void	BoundingLimits (G4ThreeVector &pMin, G4ThreeVector &pMax) const override
G4bool	CalculateExtent (const EAxis pAxis, const G4VoxelLimits &pVoxelLimit, const G4AffineTransform &pTransform, G4double &pMin, G4double &pMax) const override
G4double	DistanceToIn (const G4ThreeVector &p, const G4ThreeVector &v) const override
G4double	DistanceToIn (const G4ThreeVector &p) const override
G4double	DistanceToOut (const G4ThreeVector &p, const G4ThreeVector &v, const G4bool calcnorm=false, G4bool *validnorm=nullptr, G4ThreeVector *n=nullptr) const override
G4double	DistanceToOut (const G4ThreeVector &p) const override
EInside	Inside (const G4ThreeVector &p) const override
G4ThreeVector	SurfaceNormal (const G4ThreeVector &p) const override
G4ThreeVector	GetPointOnSurface () const override
G4double	GetCubicVolume () override
G4double	GetSurfaceArea () override
void	DescribeYourselfTo (G4VGraphicsScene &scene) const override
G4Polyhedron *	CreatePolyhedron () const override
G4Polyhedron *	GetPolyhedron () const override
G4VisExtent	GetExtent () const override
std::ostream &	StreamInfo (std::ostream &os) const override
G4double	GetTwistAngle () const
G4double	GetDx1 () const
G4double	GetDx2 () const
G4double	GetDx3 () const
G4double	GetDx4 () const
G4double	GetDy1 () const
G4double	GetDy2 () const
G4double	GetDz () const
G4double	GetPhi () const
G4double	GetTheta () const
G4double	GetAlpha () const
G4double	Xcoef (G4double u, G4double phi, G4double ftg) const
G4double	GetValueA (G4double phi) const
G4double	GetValueB (G4double phi) const
G4double	GetValueD (G4double phi) const
G4GeometryType	GetEntityType () const override
	G4VTwistedFaceted (__void__ &)
	G4VTwistedFaceted (const G4VTwistedFaceted &rhs)
G4VTwistedFaceted &	operator= (const G4VTwistedFaceted &rhs)
Public Member Functions inherited from G4VSolid
	G4VSolid (const G4String &name)
virtual	~G4VSolid ()
	G4VSolid (const G4VSolid &rhs)
G4VSolid &	operator= (const G4VSolid &rhs)
G4bool	operator== (const G4VSolid &s) const
G4String	GetName () const
void	SetName (const G4String &name)
G4double	GetTolerance () const
virtual G4int	GetNumOfConstituents () const
virtual G4bool	IsFaceted () const
void	DumpInfo () const
virtual const G4VSolid *	GetConstituentSolid (G4int no) const
virtual G4VSolid *	GetConstituentSolid (G4int no)
virtual const G4DisplacedSolid *	GetDisplacedSolidPtr () const
virtual G4DisplacedSolid *	GetDisplacedSolidPtr ()
	G4VSolid (__void__ &)
G4double	EstimateCubicVolume (G4int nStat, G4double epsilon) const
G4double	EstimateSurfaceArea (G4int nStat, G4double epsilon) const

Additional Inherited Members
Protected Member Functions inherited from G4VSolid
void	CalculateClippedPolygonExtent (G4ThreeVectorList &pPolygon, const G4VoxelLimits &pVoxelLimit, const EAxis pAxis, G4double &pMin, G4double &pMax) const
void	ClipCrossSection (G4ThreeVectorList *pVertices, const G4int pSectionIndex, const G4VoxelLimits &pVoxelLimit, const EAxis pAxis, G4double &pMin, G4double &pMax) const
void	ClipBetweenSections (G4ThreeVectorList *pVertices, const G4int pSectionIndex, const G4VoxelLimits &pVoxelLimit, const EAxis pAxis, G4double &pMin, G4double &pMax) const
void	ClipPolygon (G4ThreeVectorList &pPolygon, const G4VoxelLimits &pVoxelLimit, const EAxis pAxis) const
Protected Attributes inherited from G4VTwistedFaceted
G4bool	fRebuildPolyhedron = false
G4Polyhedron *	fpPolyhedron = nullptr
G4double	fCubicVolume = 0.0
G4double	fSurfaceArea = 0.0
Protected Attributes inherited from G4VSolid
G4double	kCarTolerance

Detailed Description

G4TwistedBox is a twisted cuboid of given half lengths and twist angle. The box is centred on the origin with sides parallel to the Cartesian axes.

Definition at line 54 of file G4TwistedBox.hh.

Constructor & Destructor Documentation

G4TwistedBox() [1/3]

G4TwistedBox::G4TwistedBox	(	const G4String &	pName,
		G4double	pPhiTwist,
		G4double	pDx,
		G4double	pDy,
		G4double	pDz )

Constructs a twisted box, given its parameters.

Parameters

[in]	pName	The solid name.
[in]	pPhiTwist	Twist angle.
[in]	pDx	Half-length along X axis.
[in]	pDy	Half-length along Y axis.
[in]	pDz	Half-length along Z axis.

Definition at line 44 of file G4TwistedBox.cc.

  : G4VTwistedFaceted( pName, pPhiTwist,pDz,0.,0.,
                       pDy, pDx, pDx, pDy, pDx, pDx,0. )
{
}

Referenced by Clone(), G4TwistedBox(), and operator=().

~G4TwistedBox()

G4TwistedBox::~G4TwistedBox ( )

overridedefault

Default destructor.

G4TwistedBox() [2/3]

G4TwistedBox::G4TwistedBox

(

__void__ &

a

)

Fake default constructor for usage restricted to direct object persistency for clients requiring preallocation of memory for persistifiable objects.

Definition at line 58 of file G4TwistedBox.cc.

  : G4VTwistedFaceted(a)
{
}

G4TwistedBox() [3/3]

G4TwistedBox::G4TwistedBox

(

const G4TwistedBox &

rhs

)

Copy constructor and assignment operator.

Definition at line 66 of file G4TwistedBox.cc.

  : G4VTwistedFaceted(rhs)
{
  fpPolyhedron = GetPolyhedron();
}

Member Function Documentation

Clone()

G4VSolid * G4TwistedBox::Clone ( ) const

overridevirtual

Makes a clone of the object for use in multi-treading.

Returns

A pointer to the new cloned allocated solid.

Reimplemented from G4VSolid.

Definition at line 122 of file G4TwistedBox.cc.

{
  return new G4TwistedBox(*this);
}

GetCubicVolume()

double G4TwistedBox::GetCubicVolume ( )

overridevirtual

Returning an estimation of the solid volume (capacity) and surface area, in internal units.

Reimplemented from G4VSolid.

Definition at line 130 of file G4TwistedBox.cc.

{
  if (fCubicVolume == 0)
  {
    G4AutoLock l(&twboxMutex);
    fCubicVolume = 8.*GetXHalfLength()*GetYHalfLength()*GetZHalfLength();
    l.unlock();
  }
  return fCubicVolume;
}

GetEntityType()

G4GeometryType G4TwistedBox::GetEntityType ( ) const

overridevirtual

Returns the type ID, "G4TwistedBox" of the solid.

Implements G4VSolid.

Definition at line 114 of file G4TwistedBox.cc.

{
  return {"G4TwistedBox"};
}

GetPhiTwist()

G4double G4TwistedBox::GetPhiTwist ( ) const

inline

Definition at line 83 of file G4TwistedBox.hh.

{ return GetTwistAngle() ; }

Referenced by G4tgbGeometryDumper::GetSolidParams(), GetSurfaceArea(), StreamInfo(), and G4GDMLWriteSolids::TwistedboxWrite().

GetSurfaceArea()

double G4TwistedBox::GetSurfaceArea ( )

overridevirtual

Returns an estimation of the solid surface area in internal units. This method may be overloaded by derived classes to compute the exact geometrical quantity for solids where this is possible, or anyway to cache the computed value. Note: the computed value is NOT cached.

Reimplemented from G4VSolid.

Definition at line 144 of file G4TwistedBox.cc.

{
  if (fSurfaceArea == 0)
  {
    G4AutoLock l(&twboxMutex);
    G4double ang = GetPhiTwist();
    G4double dx = GetXHalfLength();
    G4double dy = GetYHalfLength();
    G4double dz = GetZHalfLength();
    if (ang == 0.)
    {
      fSurfaceArea = 8.*(dx*dy + dx*dz + dy*dz);
    }
    else
    {
      G4double h = 2.*dz;
      G4double hh = h*h;
      G4double dxang = dx*ang;
      G4double dyang = dy*ang;
      fSurfaceArea = 8.*dx*dy +
        2.*(dx*std::sqrt(hh + dxang*dxang) + hh*std::asinh(dxang/h)/ang) +
        2.*(dy*std::sqrt(hh + dyang*dyang) + hh*std::asinh(dyang/h)/ang);
    }
    l.unlock();
  }
  return fSurfaceArea;
}

GetXHalfLength()

G4double G4TwistedBox::GetXHalfLength ( ) const

inline

Accessors.

Definition at line 80 of file G4TwistedBox.hh.

{ return GetDx1() ; }

Referenced by GetCubicVolume(), G4tgbGeometryDumper::GetSolidParams(), GetSurfaceArea(), StreamInfo(), and G4GDMLWriteSolids::TwistedboxWrite().

GetYHalfLength()

G4double G4TwistedBox::GetYHalfLength ( ) const

inline

Definition at line 81 of file G4TwistedBox.hh.

{ return GetDy1() ; }

Referenced by GetCubicVolume(), G4tgbGeometryDumper::GetSolidParams(), GetSurfaceArea(), StreamInfo(), and G4GDMLWriteSolids::TwistedboxWrite().

GetZHalfLength()

G4double G4TwistedBox::GetZHalfLength ( ) const

inline

Definition at line 82 of file G4TwistedBox.hh.

{ return GetDz()  ; }

Referenced by GetCubicVolume(), G4tgbGeometryDumper::GetSolidParams(), GetSurfaceArea(), StreamInfo(), and G4GDMLWriteSolids::TwistedboxWrite().

operator=()

G4TwistedBox & G4TwistedBox::operator=

(

const G4TwistedBox &

rhs

)

Definition at line 75 of file G4TwistedBox.cc.

{
   // Check assignment to self
   //
   if (this == &rhs)  { return *this; }
 
   // Copy base class data
   //
   G4VTwistedFaceted::operator=(rhs);
   fpPolyhedron = GetPolyhedron();
 
   return *this;
}

StreamInfo()

std::ostream & G4TwistedBox::StreamInfo ( std::ostream & os ) const

overridevirtual

Streams the object contents to an output stream.

Implements G4VSolid.

Definition at line 92 of file G4TwistedBox.cc.

{
  //
  // Stream object contents to an output stream
  //
  os << "-----------------------------------------------------------\n"
     << "    *** Dump for solid - " << GetName() << " ***\n"
     << "    ===================================================\n"
     << " Solid type: G4TwistedBox\n"
     << " Parameters: \n"
     << "    pDx = "  << GetXHalfLength()/cm << " cm" << G4endl
     << "    pDy = "  << GetYHalfLength()/cm << " cm" << G4endl
     << "    pDz = "  << GetZHalfLength()/cm << " cm" << G4endl
     << "    pPhiTwist = " << GetPhiTwist()/degree << " deg" << G4endl
     << "-----------------------------------------------------------\n";
 
  return os;
}

---

The documentation for this class was generated from the following files:

• G4TwistedBox.hh
• G4TwistedBox.cc