G4VDivisionParameterisation is the base class for parameterisations defining divisions of volumes for different kind of CSG and specific solids. More...

#include <G4VDivisionParameterisation.hh>

Inheritance diagram for G4VDivisionParameterisation:

Public Member Functions
	G4VDivisionParameterisation (EAxis axis, G4int nDiv, G4double width, G4double offset, DivisionType divType, G4VSolid *motherSolid=nullptr)
	~G4VDivisionParameterisation () override
G4VSolid *	ComputeSolid (const G4int, G4VPhysicalVolume *pv) override
void	ComputeTransformation (const G4int copyNo, G4VPhysicalVolume *physVol) const override=0
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 ()
virtual void	ComputeDimensions (G4Box &, const G4int, const G4VPhysicalVolume *) const
virtual void	ComputeDimensions (G4Tubs &, const G4int, const G4VPhysicalVolume *) const
virtual void	ComputeDimensions (G4Trd &, const G4int, const G4VPhysicalVolume *) const
virtual void	ComputeDimensions (G4Trap &, const G4int, const G4VPhysicalVolume *) const
virtual void	ComputeDimensions (G4Cons &, const G4int, const G4VPhysicalVolume *) const
virtual void	ComputeDimensions (G4Sphere &, const G4int, const G4VPhysicalVolume *) const
virtual void	ComputeDimensions (G4Orb &, const G4int, const G4VPhysicalVolume *) const
virtual void	ComputeDimensions (G4Ellipsoid &, const G4int, const G4VPhysicalVolume *) const
virtual void	ComputeDimensions (G4Torus &, const G4int, const G4VPhysicalVolume *) const
virtual void	ComputeDimensions (G4Para &, const G4int, const G4VPhysicalVolume *) const
virtual void	ComputeDimensions (G4Polycone &, const G4int, const G4VPhysicalVolume *) const
virtual void	ComputeDimensions (G4Polyhedra &, const G4int, const G4VPhysicalVolume *) const
virtual void	ComputeDimensions (G4Hype &, const G4int, const G4VPhysicalVolume *) const

Protected Member Functions
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)
virtual G4double	GetMaxParameter () const =0
G4double	OffsetZ () const

Protected Attributes
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
static G4ThreadLocal G4RotationMatrix *	fRot = nullptr
static const G4int	verbose = 5

Detailed Description

G4VDivisionParameterisation is the base class for parameterisations defining divisions of volumes for different kind of CSG and specific solids.

Definition at line 55 of file G4VDivisionParameterisation.hh.

Constructor & Destructor Documentation

◆ G4VDivisionParameterisation()

G4VDivisionParameterisation::G4VDivisionParameterisation	(	EAxis	axis,
		G4int	nDiv,
		G4double	width,
		G4double	offset,
		DivisionType	divType,
		G4VSolid *	motherSolid = nullptr )

Constructor with number of divisions and width.

Parameters

[in]	axis	The axis along which do the division.
[in]	nDiv	The number of division copies to replicate.
[in]	width	The witdh of the divided slice along the axis.
[in]	offset	The optional offset distance from mother's border.
[in]	divType	The kind of division type, based on input parameters.
[in]	motherSolid	Pointer to the solid to be divided.

Definition at line 45 of file G4VDivisionParameterisation.cc.

  : faxis(axis), fnDiv( nDiv), fwidth(step), foffset(offset),
    fDivisionType(divType), fmotherSolid( motherSolid )
{
#ifdef G4DIVDEBUG
  if (verbose >= 1)
  {
    G4cout << " G4VDivisionParameterisation  no divisions " << fnDiv
           << " = " << nDiv << G4endl
           << " offset " << foffset << " = " << offset << G4endl
           << " step " << fwidth << " = " << step << G4endl;
  }
#endif
  kCarTolerance = G4GeometryTolerance::GetInstance()->GetSurfaceTolerance();
}

Referenced by G4VParameterisationBox::G4VParameterisationBox(), G4VParameterisationCons::G4VParameterisationCons(), G4VParameterisationPara::G4VParameterisationPara(), G4VParameterisationPolycone::G4VParameterisationPolycone(), G4VParameterisationPolyhedra::G4VParameterisationPolyhedra(), G4VParameterisationTrd::G4VParameterisationTrd(), and G4VParameterisationTubs::G4VParameterisationTubs().

◆ ~G4VDivisionParameterisation()

G4VDivisionParameterisation::~G4VDivisionParameterisation ( )

override

Destructor.

Definition at line 65 of file G4VDivisionParameterisation.cc.

{
  if (fDeleteSolid)  { delete fmotherSolid; }
}

Member Function Documentation

◆ CalculateNDiv()

G4int G4VDivisionParameterisation::CalculateNDiv	(	G4double	motherDim,
		G4double	width,
		G4double	offset ) const

protected

Calculates the number of divisions, based on the input parameters.

Parameters

[in]	motherDim	The width of the volume to divide.
[in]	width	The width of the division slice.
[in]	offset	The optional offset distance from mother's border.

Returns: The number of divisions.

Definition at line 99 of file G4VDivisionParameterisation.cc.

{
#ifdef G4DIVDEBUG
  G4cout << " G4VDivisionParameterisation::CalculateNDiv: "
         << ( motherDim - offset ) / width 
         << " Motherdim: " <<  motherDim << ", Offset: " << offset
         << ", Width: " << width << G4endl;
#endif
 
  return G4int( ( motherDim - offset ) / width );
}

◆ CalculateWidth()

G4double G4VDivisionParameterisation::CalculateWidth	(	G4double	motherDim,
		G4int	nDiv,
		G4double	offset ) const

protected

Calculates the slice width, based on the input parameters.

Parameters

[in]	motherDim	The width of the volume to divide.
[in]	nDiv	The number of division slices to create.
[in]	offset	The optional offset distance from mother's border.

Returns: The width of the division slice.

Definition at line 114 of file G4VDivisionParameterisation.cc.

{ 
#ifdef G4DIVDEBUG
  G4cout << " G4VDivisionParameterisation::CalculateWidth: "
         << ( motherDim - offset ) / nDiv
         << ", Motherdim: " << motherDim << ", Offset: " << offset
         << ", Number of divisions: " << nDiv << G4endl;
#endif
 
  return ( motherDim - offset ) / nDiv;
}

◆ ChangeRotMatrix()

void G4VDivisionParameterisation::ChangeRotMatrix	(	G4VPhysicalVolume *	physVol,
		G4double	rotZ = 0.0 ) const

protected

Defines and sets rotation on Z in trasformation for given volume.

Parameters

[in,out]	physVol	Pointer to the physical volume to apply rotation.
[in]	rotZ	The rotation on Z (default is 0).

Definition at line 85 of file G4VDivisionParameterisation.cc.

{
  if (fRot == nullptr)
  {
    fRot = new G4RotationMatrix();
    G4AutoDelete::Register(fRot);
  }
  fRot->rotateZ( rotZ );
  physVol->SetRotation(fRot);
}

◆ CheckNDivAndWidth()

void G4VDivisionParameterisation::CheckNDivAndWidth ( G4double maxPar )

protected

Definition at line 151 of file G4VDivisionParameterisation.cc.

{
  if( (fDivisionType == DivNDIVandWIDTH)
      && (foffset + fwidth*fnDiv - maxPar > kCarTolerance ) )
  {
    std::ostringstream message;
    message << "Configuration not supported." << G4endl
            << "Division of solid " << fmotherSolid->GetName()
           << " has too big offset + width*nDiv = " << G4endl
           << "        " << foffset + fwidth*fnDiv << " > "
           << foffset << ". Width = "
           << G4endl
           << "        " << fwidth << ". nDiv = " << fnDiv << " !";
    G4Exception("G4VDivisionParameterisation::CheckNDivAndWidth()",
                "GeomDiv0001", FatalException, message);
  }
}

Referenced by CheckParametersValidity().

◆ CheckOffset()

void G4VDivisionParameterisation::CheckOffset ( G4double maxPar )

protected

Internal methods for checking parameters.

Definition at line 136 of file G4VDivisionParameterisation.cc.

{
  if( foffset >= maxPar )
  {
    std::ostringstream message;
    message << "Configuration not supported." << G4endl
            << "Division of solid " << fmotherSolid->GetName()
            << " has too big offset = " << G4endl
            << "        " << foffset << " > " << maxPar << " !";
    G4Exception("G4VDivisionParameterisation::CheckOffset()",
                "GeomDiv0001", FatalException, message);
  }
}

Referenced by CheckParametersValidity().

◆ CheckParametersValidity()

void G4VDivisionParameterisation::CheckParametersValidity ( )

protectedvirtual

Checks the validity of parameters given in input, issuing an exception.

Reimplemented in G4ParameterisationPolyconeRho, G4ParameterisationPolyconeZ, G4ParameterisationPolyhedraPhi, G4ParameterisationPolyhedraRho, and G4ParameterisationPolyhedraZ.

Definition at line 128 of file G4VDivisionParameterisation.cc.

{
  G4double maxPar = GetMaxParameter();
  CheckOffset( maxPar );
  CheckNDivAndWidth( maxPar );
}

◆ ComputeSolid()

G4VSolid * G4VDivisionParameterisation::ComputeSolid	(	const G4int	i,
		G4VPhysicalVolume *	pv )

overridevirtual

Invokes the base parameterisation to compute the parameterised solid.

Parameters

[in] pv Pointer to the physical volume to divide.

Returns: The pointer to the generated solid slice.

Reimplemented from G4VPVParameterisation.

Definition at line 72 of file G4VDivisionParameterisation.cc.

{
  G4VSolid* solid = G4VPVParameterisation::ComputeSolid(i, pv);
  if (solid->GetEntityType() == "G4ReflectedSolid")
  {
    solid = ((G4ReflectedSolid*)solid)->GetConstituentMovedSolid();
  }
  return solid;
}      

◆ ComputeTransformation()

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

overridepure virtual

Base method to be implemented in derived classes for defining the transformation in the parameterisation.

Implements G4VPVParameterisation.

◆ GetAxis()

EAxis G4VDivisionParameterisation::GetAxis ( ) const

inline

◆ GetHalfGap()

G4double G4VDivisionParameterisation::GetHalfGap ( ) const

inline

◆ GetMaxParameter()

virtual G4double G4VDivisionParameterisation::GetMaxParameter ( ) const

protectedpure virtual

Returns the max width along the axis of division.

Returns: The maximum width of the solid to divide along the axis.

Referenced by CheckParametersValidity(), and OffsetZ().

◆ GetMotherSolid()

G4VSolid * G4VDivisionParameterisation::GetMotherSolid ( ) const

inline

Referenced by G4ParameterisationConsZ::ComputeTransformation().

◆ GetNoDiv()

G4int G4VDivisionParameterisation::GetNoDiv ( ) const

inline

◆ GetOffset()

G4double G4VDivisionParameterisation::GetOffset ( ) const

inline

◆ GetType()

const G4String & G4VDivisionParameterisation::GetType ( ) const

inline

Accessors and setters.

◆ GetWidth()

G4double G4VDivisionParameterisation::GetWidth ( ) const

inline

◆ OffsetZ()

G4double G4VDivisionParameterisation::OffsetZ ( ) const

protected

Sets the offset, taking into account potential reflection.

Definition at line 170 of file G4VDivisionParameterisation.cc.

{
  // take into account reflection in the offset
 
  G4double offset = foffset;
  if (fReflectedSolid)
  {
    offset = GetMaxParameter() - fwidth*fnDiv - foffset;
  }
 
  return offset;
}  