G4ParameterisationBoxY Class Reference

G4ParameterisationBoxY represents the parameterised positioning equivalent to dividing a G4Box along Y axis. More...

#include <G4ParameterisationBox.hh>

Inheritance diagram for G4ParameterisationBoxY:

Public Member Functions
	G4ParameterisationBoxY (EAxis axis, G4int nCopies, G4double offset, G4double step, G4VSolid *pSolid, DivisionType divType)
	~G4ParameterisationBoxY () override
G4double	GetMaxParameter () const override
void	ComputeTransformation (const G4int copyNo, G4VPhysicalVolume *physVol) const override
void	ComputeDimensions (G4Box &box, const G4int copyNo, const G4VPhysicalVolume *physVol) const override
Public Member Functions inherited from G4VParameterisationBox
	G4VParameterisationBox (EAxis axis, G4int nCopies, G4double offset, G4double step, G4VSolid *pSolid, DivisionType divType)
	~G4VParameterisationBox () override
Public Member Functions inherited from G4VDivisionParameterisation
	G4VDivisionParameterisation (EAxis axis, G4int nDiv, G4double width, G4double offset, DivisionType divType, G4VSolid *motherSolid=nullptr)
	~G4VDivisionParameterisation () override
G4VSolid *	ComputeSolid (const G4int, G4VPhysicalVolume *pv) override
const G4String &	GetType () const
EAxis	GetAxis () const
G4int	GetNoDiv () const
G4double	GetWidth () const
G4double	GetOffset () const
G4VSolid *	GetMotherSolid () const
void	SetType (const G4String &type)
void	SetHalfGap (G4double hg)
G4double	GetHalfGap () const
Public Member Functions inherited from G4VPVParameterisation
	G4VPVParameterisation ()=default
virtual	~G4VPVParameterisation ()=default
virtual G4Material *	ComputeMaterial (const G4int repNo, G4VPhysicalVolume *currentVol, const G4VTouchable *parentTouch=nullptr)
virtual G4bool	IsNested () const
virtual G4VVolumeMaterialScanner *	GetMaterialScanner ()

Additional Inherited Members
Protected Member Functions inherited from G4VDivisionParameterisation
void	ChangeRotMatrix (G4VPhysicalVolume *physVol, G4double rotZ=0.0) const
G4int	CalculateNDiv (G4double motherDim, G4double width, G4double offset) const
G4double	CalculateWidth (G4double motherDim, G4int nDiv, G4double offset) const
virtual void	CheckParametersValidity ()
void	CheckOffset (G4double maxPar)
void	CheckNDivAndWidth (G4double maxPar)
G4double	OffsetZ () const
Protected Attributes inherited from G4VDivisionParameterisation
G4String	ftype
EAxis	faxis
G4int	fnDiv = 0
G4double	fwidth = 0.0
G4double	foffset = 0.0
DivisionType	fDivisionType
G4VSolid *	fmotherSolid = nullptr
G4bool	fReflectedSolid = false
G4bool	fDeleteSolid = false
G4double	kCarTolerance
G4double	fhgap = 0.0
Static Protected Attributes inherited from G4VDivisionParameterisation
static G4ThreadLocal G4RotationMatrix *	fRot = nullptr
static const G4int	verbose = 5

Detailed Description

G4ParameterisationBoxY represents the parameterised positioning equivalent to dividing a G4Box along Y axis.

Definition at line 161 of file G4ParameterisationBox.hh.

Constructor & Destructor Documentation

G4ParameterisationBoxY()

G4ParameterisationBoxY::G4ParameterisationBoxY	(	EAxis	axis,
		G4int	nCopies,
		G4double	offset,
		G4double	step,
		G4VSolid *	pSolid,
		DivisionType	divType )

Initialises a parameterised box along Y axis.

Parameters

[in]	axis	The axis along which apply the parameterisation.
[in]	nCopies	The total number of divided copies.
[in]	offset	Potential initial offset along the axis.
[in]	step	The width of the divided entity.
[in]	pSolid	Pointer to the original shape to parameterise.
[in]	divType	String identifier for the kind of division.

Definition at line 167 of file G4ParameterisationBox.cc.

  :  G4VParameterisationBox( axis, nDiv, width, offset, msolid, divType )
{
  CheckParametersValidity();
  SetType( "DivisionBoxY" );
 
  auto mbox = (G4Box*)(fmotherSolid);
  if( divType == DivWIDTH )
  {
    fnDiv = CalculateNDiv( 2*mbox->GetYHalfLength(), width, offset );
  }
  else if( divType == DivNDIV )
  {
    fwidth = CalculateWidth( 2*mbox->GetYHalfLength(), nDiv, offset );
  }
 
#ifdef G4DIVDEBUG
  if( verbose >= 1 )
  {
    G4cout << " G4ParameterisationBoxY - no divisions " << fnDiv << " = "
           << nDiv << ". Offset " << foffset << " = " << offset
           << ". Width " << fwidth << " = " << width << G4endl;
  }
#endif
}

~G4ParameterisationBoxY()

G4ParameterisationBoxY::~G4ParameterisationBoxY ( )

overridedefault

Default Destructor.

Member Function Documentation

ComputeDimensions()

void G4ParameterisationBoxY::ComputeDimensions ( G4Box & , const G4int , const G4VPhysicalVolume *  ) const

overridevirtual

Dispatch methods for the specific solids where parameterisation is allowed.

Reimplemented from G4VPVParameterisation.

Definition at line 242 of file G4ParameterisationBox.cc.

{
  auto msol = (G4Box*)(fmotherSolid);
 
  G4double pDx = msol->GetXHalfLength();
  G4double pDy = fwidth/2. - fhgap;
  G4double pDz = msol->GetZHalfLength();
 
  box.SetXHalfLength( pDx );
  box.SetYHalfLength( pDy );
  box.SetZHalfLength( pDz );
 
#ifdef G4DIVDEBUG
  if( verbose >= 2 )
  {
    G4cout << " G4ParameterisationBoxY::ComputeDimensions()" << G4endl
           << " pDx: " << pDz << G4endl;
    box.DumpInfo();
  }
#endif
}

ComputeTransformation()

void G4ParameterisationBoxY::ComputeTransformation ( const G4int copyNo, G4VPhysicalVolume * physVol ) const

overridevirtual

Concrete methods implementing the parameterisation.

Implements G4VDivisionParameterisation.

Definition at line 208 of file G4ParameterisationBox.cc.

{
  auto msol = (G4Box*)(fmotherSolid);
  G4double mdy = msol->GetYHalfLength();
 
  //----- translation 
  G4ThreeVector origin(0.,0.,0.); 
  G4double posi = -mdy + foffset + (copyNo+0.5)*fwidth;
  if( faxis == kYAxis )
  {
    origin.setY( posi ); 
  }
  else
  {
    std::ostringstream message;
    message << "Only axes along Y are allowed !  Axis: " << faxis;
    G4Exception("G4ParameterisationBoxY::ComputeTransformation()",
                "GeomDiv0002", FatalException, message);
  }
#ifdef G4DIVDEBUG
  if( verbose >= 2 )
  {
    G4cout << std::setprecision(8) << " G4ParameterisationBoxY: "
           << copyNo << G4endl
           << " Position " << origin << " Axis " << faxis << G4endl;
  }
#endif
   //----- set translation 
  physVol->SetTranslation( origin );
}

GetMaxParameter()

G4double G4ParameterisationBoxY::GetMaxParameter ( ) const

overridevirtual

Returns the max width along Y.

Returns

The maximum width of the solid to divide along the Y axis.

Implements G4VDivisionParameterisation.

Definition at line 200 of file G4ParameterisationBox.cc.

{
  auto msol = (G4Box*)(fmotherSolid);
  return 2*msol->GetYHalfLength();
}

---

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

• G4ParameterisationBox.hh
• G4ParameterisationBox.cc