G4LogicalCrystalVolume is a specialised logical volume for the description of crystals. The object can be created only with an extended material with a crystal extension. The class handles the orientation of the crystal axes wrt the solid to which the crystal is attached. More...

#include <G4LogicalCrystalVolume.hh>

Inheritance diagram for G4LogicalCrystalVolume:

Public Member Functions
	G4LogicalCrystalVolume (G4VSolid pSolid, G4ExtendedMaterial pMaterial, const G4String &name, G4FieldManager pFieldMgr=nullptr, G4VSensitiveDetector pSDetector=nullptr, G4UserLimits *pULimits=nullptr, G4bool optimise=true, G4int h=0, G4int k=0, G4int l=0, G4double rot=0.0)
	~G4LogicalCrystalVolume () override
G4bool	IsExtended () const override
void	SetMillerOrientation (G4int h, G4int k, G4int l, G4double rot=0.0)
const G4ThreeVector &	RotateToLattice (G4ThreeVector &dir) const
const G4ThreeVector &	RotateToSolid (G4ThreeVector &dir) const
const G4CrystalExtension *	GetCrystal () const
const G4ThreeVector &	GetBasis (G4int i) const
void	SetVerbose (G4int aInt)
Public Member Functions inherited from G4LogicalVolume
	G4LogicalVolume (G4VSolid pSolid, G4Material pMaterial, const G4String &name, G4FieldManager pFieldMgr=nullptr, G4VSensitiveDetector pSDetector=nullptr, G4UserLimits *pULimits=nullptr, G4bool optimise=true)
virtual	~G4LogicalVolume ()
	G4LogicalVolume (const G4LogicalVolume &)=delete
G4LogicalVolume &	operator= (const G4LogicalVolume &)=delete
const G4String &	GetName () const
void	SetName (const G4String &pName)
std::size_t	GetNoDaughters () const
G4VPhysicalVolume *	GetDaughter (const std::size_t i) const
void	AddDaughter (G4VPhysicalVolume *p)
G4bool	IsDaughter (const G4VPhysicalVolume *p) const
G4bool	IsAncestor (const G4VPhysicalVolume *p) const
void	RemoveDaughter (const G4VPhysicalVolume *p)
void	ClearDaughters ()
G4int	TotalVolumeEntities () const
EVolume	CharacteriseDaughters () const
EVolume	DeduceDaughtersType () const
G4VSolid *	GetSolid () const
void	SetSolid (G4VSolid *pSolid)
G4Material *	GetMaterial () const
void	SetMaterial (G4Material *pMaterial)
void	UpdateMaterial (G4Material *pMaterial)
G4double	GetMass (G4bool forced=false, G4bool propagate=true, G4Material *parMaterial=nullptr)
void	ResetMass ()
G4FieldManager *	GetFieldManager () const
void	SetFieldManager (G4FieldManager *pFieldMgr, G4bool forceToAllDaughters)
G4VSensitiveDetector *	GetSensitiveDetector () const
void	SetSensitiveDetector (G4VSensitiveDetector *pSDetector)
G4UserLimits *	GetUserLimits () const
void	SetUserLimits (G4UserLimits *pULimits)
G4SmartVoxelHeader *	GetVoxelHeader () const
void	SetVoxelHeader (G4SmartVoxelHeader *pVoxel)
G4double	GetSmartless () const
void	SetSmartless (G4double s)
G4bool	IsToOptimise () const
void	SetOptimisation (G4bool optim)
G4bool	IsRootRegion () const
void	SetRegionRootFlag (G4bool rreg)
G4bool	IsRegion () const
void	SetRegion (G4Region *reg)
G4Region *	GetRegion () const
void	PropagateRegion ()
const G4MaterialCutsCouple *	GetMaterialCutsCouple () const
void	SetMaterialCutsCouple (G4MaterialCutsCouple *cuts)
G4bool	operator== (const G4LogicalVolume &lv) const
const G4VisAttributes *	GetVisAttributes () const
void	SetVisAttributes (const G4VisAttributes *pVA)
void	SetVisAttributes (const G4VisAttributes &VA)
G4FastSimulationManager *	GetFastSimulationManager () const
void	SetBiasWeight (G4double w)
G4double	GetBiasWeight () const
G4FieldManager *	GetMasterFieldManager () const
G4VSensitiveDetector *	GetMasterSensitiveDetector () const
G4VSolid *	GetMasterSolid () const
G4int	GetInstanceID () const
void	Lock ()
void	InitialiseWorker (G4LogicalVolume ptrMasterObject, G4VSolid pSolid, G4VSensitiveDetector *pSDetector)
void	TerminateWorker (G4LogicalVolume *ptrMasterObject)
void	AssignFieldManager (G4FieldManager *fldMgr)
G4bool	ChangeDaughtersType (EVolume atype)
	G4LogicalVolume (__void__ &)

Static Public Member Functions
static G4bool	IsLattice (G4LogicalVolume *aLV)
Static Public Member Functions inherited from G4LogicalVolume
static const G4LVManager &	GetSubInstanceManager ()
static void	Clean ()
static G4VSolid *	GetSolid (G4LVData &instLVdata)
static void	SetSolid (G4LVData &instLVdata, G4VSolid *pSolid)

Detailed Description

G4LogicalCrystalVolume is a specialised logical volume for the description of crystals. The object can be created only with an extended material with a crystal extension. The class handles the orientation of the crystal axes wrt the solid to which the crystal is attached.

Definition at line 53 of file G4LogicalCrystalVolume.hh.

Constructor & Destructor Documentation

◆ G4LogicalCrystalVolume()

G4LogicalCrystalVolume::G4LogicalCrystalVolume	(	G4VSolid *	pSolid,
		G4ExtendedMaterial *	pMaterial,
		const G4String &	name,
		G4FieldManager *	pFieldMgr = nullptr,
		G4VSensitiveDetector *	pSDetector = nullptr,
		G4UserLimits *	pULimits = nullptr,
		G4bool	optimise = true,
		G4int	h = 0,
		G4int	k = 0,
		G4int	l = 0,
		G4double	rot = 0.0 )

Constructor for G4LogicalCrystalVolume.

Parameters

[in]	pSolid	Pointer to the associated solid primitive.
[in]	pMaterial	Pointer to the associated extended crystal material.
[in]	name	The volume name.
[in]	pFieldMgr	Pointer to optional magnetic field manager.
[in]	pSDetector	Pointer to optional associated sensitive detector.
[in]	pULimits	Pointer to optional user limits.
[in]	optimise	Flag to enable/disable optimisation structure.
[in]	h	Miller orientation parameter h.
[in]	k	Miller orientation parameter k.
[in]	l	Miller orientation parameter l.
[in]	rot	Miller rotation parameter.

Definition at line 40 of file G4LogicalCrystalVolume.cc.

: G4LogicalVolume(pSolid,pMaterial,name,pFieldMgr,pSDetector,pULimits,optimise)
{
  SetMillerOrientation(h, k, l, rot);
  fLCVvec.push_back(this);
}

◆ ~G4LogicalCrystalVolume()

G4LogicalCrystalVolume::~G4LogicalCrystalVolume ( )

override

Destructor.

Definition at line 54 of file G4LogicalCrystalVolume.cc.

{
  fLCVvec.erase( std::remove(fLCVvec.begin(),fLCVvec.end(), this ),
                 fLCVvec.end() );
}

Member Function Documentation

◆ GetBasis()

const G4ThreeVector & G4LogicalCrystalVolume::GetBasis ( G4int i ) const

Calls through to get crystal basis vectors.

Definition at line 78 of file G4LogicalCrystalVolume.cc.

{
  return GetCrystal()->GetUnitCell()->GetBasis(i);
}

Referenced by SetMillerOrientation().

◆ GetCrystal()

const G4CrystalExtension * G4LogicalCrystalVolume::GetCrystal ( ) const

Returns a pointer to the crystal extension object.

Definition at line 69 of file G4LogicalCrystalVolume.cc.

{
  return dynamic_cast<G4CrystalExtension*>(
         dynamic_cast<G4ExtendedMaterial*>(GetMaterial() )
                                ->RetrieveExtension("crystal"));
}               

Referenced by GetBasis().

◆ IsExtended()

G4bool G4LogicalCrystalVolume::IsExtended ( ) const

inlineoverridevirtual

Returns true as it is not a base-class object.

Reimplemented from G4LogicalVolume.

Definition at line 91 of file G4LogicalCrystalVolume.hh.

91{ return true; }

◆ IsLattice()

G4bool G4LogicalCrystalVolume::IsLattice ( G4LogicalVolume * aLV )

static

Returns true if the logical volume 'aLV' is a lattice.

Definition at line 62 of file G4LogicalCrystalVolume.cc.

{
  return std::find(fLCVvec.begin(), fLCVvec.end(), aLV) != fLCVvec.end();
}

Referenced by G4Channeling::GetMeanFreePath(), and G4Channeling::PostStepDoIt().

◆ RotateToLattice()

const G4ThreeVector & G4LogicalCrystalVolume::RotateToLattice ( G4ThreeVector & dir ) const

Methods to rotate input vector between lattice and solid orientations.

Returns: The new vector value for convenience.

Definition at line 122 of file G4LogicalCrystalVolume.cc.

{
  return dir.transform(fOrient);
}

◆ RotateToSolid()

const G4ThreeVector & G4LogicalCrystalVolume::RotateToSolid ( G4ThreeVector & dir ) const

Definition at line 128 of file G4LogicalCrystalVolume.cc.

{
  return dir.transform(fInverse);
}

Referenced by G4Channeling::PostStepDoIt().

◆ SetMillerOrientation()

void G4LogicalCrystalVolume::SetMillerOrientation	(	G4int	h,
		G4int	k,
		G4int	l,
		G4double	rot = 0.0 )

Sets the physical lattice orientation, relative to G4VSolid coordinates. Miller orientation aligns lattice normal (hkl) with geometry +Z.

Definition at line 85 of file G4LogicalCrystalVolume.cc.

{
  // Align Miller normal vector (hkl) with +Z axis, and rotation about axis
 
  if (verboseLevel != 0)
  {
    G4cout << "G4LatticePhysical::SetMillerOrientation(" << h << " "
           << k << " " << l << ", " << rot/CLHEP::deg << " deg)" << G4endl;
  }
    
   hMiller = h;
   kMiller = k;
   lMiller = l;
   fRot = rot;
    
   G4ThreeVector norm = (h*GetBasis(0)+k*GetBasis(1)+l*GetBasis(2)).unit();
    
   if (verboseLevel>1) { G4cout << " norm = " << norm << G4endl; }
    
   // Aligns geometry +Z axis with lattice (hkl) normal
   fOrient = G4RotationMatrix::IDENTITY;
   fOrient.rotateZ(rot).rotateY(norm.theta()).rotateZ(norm.phi());
   fInverse = fOrient.inverse();
    
   if (verboseLevel>1) { G4cout << " fOrient = " << fOrient << G4endl; }
    
   // FIXME:  Is this equivalent to (phi,theta,rot) Euler angles???
}

Referenced by G4LogicalCrystalVolume().

◆ SetVerbose()

void G4LogicalCrystalVolume::SetVerbose ( G4int aInt )

inline

Setter for verbosity level.

Definition at line 119 of file G4LogicalCrystalVolume.hh.

119{ verboseLevel = aInt; }

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

Public Member Functions

Static Public Member Functions