G4LogicalVolume Class Reference

#include <G4LogicalVolume.hh>

Inheritance diagram for G4LogicalVolume:

Public Member Functions
	G4LogicalVolume (G4VSolid *pSolid, G4Material *pMaterial, const G4String &name, G4FieldManager *pFieldMgr=0, G4VSensitiveDetector *pSDetector=0, G4UserLimits *pULimits=0, G4bool optimise=true)
virtual	~G4LogicalVolume ()
const G4String &	GetName () const
void	SetName (const G4String &pName)
G4int	GetNoDaughters () const
G4VPhysicalVolume *	GetDaughter (const G4int 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
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=0)
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
	G4LogicalVolume (__void__ &)
virtual G4bool	IsExtended () 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)

Static Public Member Functions
static const G4LVManager &	GetSubInstanceManager ()
static G4VSolid *	GetSolid (G4LVData &instLVdata)
static void	SetSolid (G4LVData &instLVdata, G4VSolid *pSolid)

Detailed Description

Definition at line 190 of file G4LogicalVolume.hh.

Constructor & Destructor Documentation

G4LogicalVolume::G4LogicalVolume	(	G4VSolid *	pSolid,
		G4Material *	pMaterial,
		const G4String &	name,
		G4FieldManager *	pFieldMgr = 0,
		G4VSensitiveDetector *	pSDetector = 0,
		G4UserLimits *	pULimits = 0,
		G4bool	optimise = true
	)

Definition at line 77 of file G4LogicalVolume.cc.

 : fDaughters(0,(G4VPhysicalVolume*)0), 
   fVoxel(0), fOptimise(optimise), fRootRegion(false), fLock(false),
   fSmartless(2.), fVisAttributes(0), fRegion(0), fBiasWeight(1.)
{
  // Initialize 'Shadow'/master pointers - for use in copying to workers
  fSolid = pSolid;
  fSensitiveDetector = pSDetector;
  fFieldManager = pFieldMgr;

  instanceID = subInstanceManager.CreateSubInstance();
  AssignFieldManager(pFieldMgr); // G4MT_fmanager = pFieldMgr;
  
  // fMasterFieldMgr= pFieldMgr;
  G4MT_mass = 0.;
  G4MT_ccouple = 0;

  SetSolid(pSolid);
  SetMaterial(pMaterial);
  SetName(name);
  SetSensitiveDetector(pSDetector);
  SetUserLimits(pULimits);    

  // Initialize 'Shadow' data structure - for use by object persistency
  lvdata = new G4LVData();
  lvdata->fSolid = pSolid;
  lvdata->fMaterial = pMaterial;

  //
  // Add to store
  //
  G4LogicalVolumeStore::Register(this);
}

Here is the call graph for this function:

G4LogicalVolume::~G4LogicalVolume ( )

virtual

Definition at line 147 of file G4LogicalVolume.cc.

{
  if (!fLock && fRootRegion)  // De-register root region first if not locked
  {                           // and flagged as root logical-volume
    fRegion->RemoveRootLogicalVolume(this, true);
  }
  delete lvdata;
  G4LogicalVolumeStore::DeRegister(this);
}

Here is the call graph for this function:

G4LogicalVolume::G4LogicalVolume

(

__void__ &

)

Definition at line 122 of file G4LogicalVolume.cc.

 : fDaughters(0,(G4VPhysicalVolume*)0),
   fName(""), fUserLimits(0),
   fVoxel(0), fOptimise(true), fRootRegion(false), fLock(false),
   fSmartless(2.), fVisAttributes(0), fRegion(0), fBiasWeight(1.),
   fSolid(0), fSensitiveDetector(0), fFieldManager(0), lvdata(0)
{
  instanceID = subInstanceManager.CreateSubInstance();
  
  SetSensitiveDetector(0);    // G4MT_sdetector = 0;
  SetFieldManager(0, false);  // G4MT_fmanager = 0;

  G4MT_mass = 0.;
  G4MT_ccouple = 0;
  
  // Add to store
  //
  G4LogicalVolumeStore::Register(this);
}

Here is the call graph for this function:

Member Function Documentation

void G4LogicalVolume::AddDaughter

(

G4VPhysicalVolume *

p

)

Definition at line 272 of file G4LogicalVolume.cc.

{
  if( !fDaughters.empty() && fDaughters[0]->IsReplicated() )
  {
    std::ostringstream message;
    message << "ERROR - Attempt to place a volume in a mother volume" << G4endl
            << "        already containing a replicated volume." << G4endl
            << "        A volume can either contain several placements" << G4endl
            << "        or a unique replica or parameterised volume !" << G4endl
            << "           Mother logical volume: " << GetName() << G4endl
            << "           Placing volume: " << pNewDaughter->GetName() << G4endl;
    G4Exception("G4LogicalVolume::AddDaughter()", "GeomMgt0002",
                FatalException, message,
                "Replica or parameterised volume must be the only daughter !");
  }

  // Invalidate previous calculation of mass - if any - for all threads
  G4MT_mass = 0.;
  // SignalVolumeChange();  // fVolumeChanged= true;
  fDaughters.push_back(pNewDaughter);

  G4LogicalVolume* pDaughterLogical = pNewDaughter->GetLogicalVolume();

  // Propagate the Field Manager, if the daughter has no field Manager.
  //
  G4FieldManager* pDaughterFieldManager = pDaughterLogical->GetFieldManager();

  if( pDaughterFieldManager == 0 )
  {
    pDaughterLogical->SetFieldManager(G4MT_fmanager, false);
  }
  if (fRegion)
  {
    PropagateRegion();
    fRegion->RegionModified(true);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4LogicalVolume::AssignFieldManager

(

G4FieldManager *

fldMgr

)

Definition at line 230 of file G4LogicalVolume.cc.

{
  G4MT_fmanager= fldMgr;
  if(G4Threading::IsMasterThread())  fFieldManager = fldMgr;
}

Here is the call graph for this function:

Here is the caller graph for this function:

EVolume G4LogicalVolume::CharacteriseDaughters ( ) const

inline

Here is the caller graph for this function:

void G4LogicalVolume::ClearDaughters

(

)

Definition at line 336 of file G4LogicalVolume.cc.

{
  fDaughters.erase(fDaughters.begin(), fDaughters.end());
  if (fRegion)
  {
    fRegion->RegionModified(true);
  }
  G4MT_mass = 0.;
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4LogicalVolume::GetBiasWeight ( ) const

inline

Here is the caller graph for this function:

G4VPhysicalVolume* G4LogicalVolume::GetDaughter ( const G4int  i ) const

inline

Here is the caller graph for this function:

G4FastSimulationManager* G4LogicalVolume::GetFastSimulationManager ( ) const

inline

Here is the caller graph for this function:

G4FieldManager * G4LogicalVolume::GetFieldManager

(

)

const

Definition at line 221 of file G4LogicalVolume.cc.

{
  return G4MT_fmanager;
}

Here is the caller graph for this function:

G4int G4LogicalVolume::GetInstanceID ( ) const

inline

G4double G4LogicalVolume::GetMass	(	G4bool	forced = false,
		G4bool	propagate = true,
		G4Material *	parMaterial = 0
	)

Definition at line 521 of file G4LogicalVolume.cc.

{
  // Return the cached non-zero value, if not forced
  //
  if ( (G4MT_mass) && (!forced) ) return G4MT_mass;

  // Global density and computed mass associated to the logical
  // volume without considering its daughters
  //
  G4Material* logMaterial = parMaterial ? parMaterial : GetMaterial(); // G4MT_material;
  if (!logMaterial)
  {
    std::ostringstream message;
    message << "No material associated to the logical volume: " << fName << " !"
            << G4endl
            << "Sorry, cannot compute the mass ...";
    G4Exception("G4LogicalVolume::GetMass()", "GeomMgt0002",
                FatalException, message);
    return 0;
  }
  if (! GetSolid() ) // !G4MT_solid)
  {
    std::ostringstream message;
    message << "No solid is associated to the logical volume: " << fName << " !"
            << G4endl
            << "Sorry, cannot compute the mass ...";
    G4Exception("G4LogicalVolume::GetMass()", "GeomMgt0002",
                FatalException, message);
    return 0;
  }
  G4double globalDensity = logMaterial->GetDensity();
  G4double motherMass= GetSolid()->GetCubicVolume() * globalDensity;

  // G4MT_mass =
  //  SetMass( motherMmass );
  G4double massSum= motherMass;
  
  // For each daughter in the tree, subtract the mass occupied
  // and if required by the propagate flag, add the real daughter's
  // one computed recursively

  for (G4PhysicalVolumeList::const_iterator itDau = fDaughters.begin();
       itDau != fDaughters.end(); itDau++)
  {
    G4VPhysicalVolume* physDaughter = (*itDau);
    G4LogicalVolume* logDaughter = physDaughter->GetLogicalVolume();
    G4double subMass=0.;
    G4VSolid* daughterSolid = 0;
    G4Material* daughterMaterial = 0;

    // Compute the mass to subtract and to add for each daughter
    // considering its multiplicity (i.e. replicated or not) and
    // eventually its parameterisation (by solid and/or by material)
    //
    for (G4int i=0; i<physDaughter->GetMultiplicity(); i++)
    {
      G4VPVParameterisation*
        physParam = physDaughter->GetParameterisation();
      if (physParam)
      {
        daughterSolid = physParam->ComputeSolid(i, physDaughter);
        daughterSolid->ComputeDimensions(physParam, i, physDaughter);
        daughterMaterial = physParam->ComputeMaterial(i, physDaughter);
      }
      else
      {
        daughterSolid = logDaughter->GetSolid();
        daughterMaterial = logDaughter->GetMaterial();
      }
      subMass = daughterSolid->GetCubicVolume() * globalDensity;

      // Subtract the daughter's portion for the mass and, if required,
      // add the real daughter's mass computed recursively
      //
      massSum -= subMass;
      if (propagate)
      {
        massSum += logDaughter->GetMass(true, true, daughterMaterial);
      }
    }
  }
  G4MT_mass= massSum;
  return massSum;
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4FieldManager* G4LogicalVolume::GetMasterFieldManager ( ) const

inline

Here is the caller graph for this function:

G4VSensitiveDetector* G4LogicalVolume::GetMasterSensitiveDetector ( ) const

inline

Here is the caller graph for this function:

G4VSolid* G4LogicalVolume::GetMasterSolid ( ) const

inline

Here is the caller graph for this function:

G4Material * G4LogicalVolume::GetMaterial

(

)

const

Definition at line 396 of file G4LogicalVolume.cc.

{
  return G4MT_material;
}

const G4MaterialCutsCouple * G4LogicalVolume::GetMaterialCutsCouple

(

)

const

Definition at line 445 of file G4LogicalVolume.cc.

{
  return G4MT_ccouple;
}

Here is the caller graph for this function:

const G4String& G4LogicalVolume::GetName ( ) const

inline

G4int G4LogicalVolume::GetNoDaughters ( ) const

inline

Here is the caller graph for this function:

G4Region* G4LogicalVolume::GetRegion ( ) const

inline

Here is the caller graph for this function:

G4VSensitiveDetector * G4LogicalVolume::GetSensitiveDetector

(

)

const

Definition at line 426 of file G4LogicalVolume.cc.

{
  return G4MT_sdetector;
}

Here is the caller graph for this function:

G4double G4LogicalVolume::GetSmartless ( ) const

inline

Here is the caller graph for this function:

G4VSolid * G4LogicalVolume::GetSolid

(

)

const

Definition at line 364 of file G4LogicalVolume.cc.

{
  // return G4MT_solid;
  // return ((subInstanceManager.offset[instanceID]).fSolid);
  return this->GetSolid( subInstanceManager.offset[instanceID] ); 
}

G4VSolid * G4LogicalVolume::GetSolid ( G4LVData &  instLVdata )

static

Definition at line 359 of file G4LogicalVolume.cc.

{
  return instLVdata.fSolid;
}

const G4LVManager & G4LogicalVolume::GetSubInstanceManager ( )

static

Definition at line 212 of file G4LogicalVolume.cc.

{
  return subInstanceManager;
}

Here is the caller graph for this function:

G4UserLimits* G4LogicalVolume::GetUserLimits ( ) const

inline

Here is the caller graph for this function:

const G4VisAttributes* G4LogicalVolume::GetVisAttributes ( ) const

inline

Here is the caller graph for this function:

G4SmartVoxelHeader* G4LogicalVolume::GetVoxelHeader ( ) const

inline

Here is the caller graph for this function:

void G4LogicalVolume::InitialiseWorker	(	G4LogicalVolume *	ptrMasterObject,
		G4VSolid *	pSolid,
		G4VSensitiveDetector *	pSDetector
	)

Definition at line 168 of file G4LogicalVolume.cc.

{
  subInstanceManager.SlaveCopySubInstanceArray();

  SetSolid(pSolid);
  SetSensitiveDetector(pSDetector); //  How this object is available now ?
  AssignFieldManager(fFieldManager); // Should be set - but a per-thread copy is not available yet
  // G4MT_fmanager= fFieldManager;
  //  Must not call SetFieldManager(fFieldManager, false); which propagates FieldMgr

#ifdef CLONE_FIELD_MGR
  // Create a field FieldManager by cloning
  G4FieldManager workerFldMgr= fFieldManager->GetWorkerClone(G4bool* created);
  if( created || (GetFieldManager()!=workerFldMgr) )
  {
    SetFieldManager(fFieldManager, false); // which propagates FieldMgr
  }else{
    // Field manager existed and is equal to current one
    AssignFieldManager(workerFldMgr);
  }
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4bool G4LogicalVolume::IsAncestor

(

const G4VPhysicalVolume *

p

)

const

Definition at line 467 of file G4LogicalVolume.cc.

{
  G4bool isDaughter = IsDaughter(aVolume);
  if (!isDaughter)
  {
    for (G4PhysicalVolumeList::const_iterator itDau = fDaughters.begin();
         itDau != fDaughters.end(); itDau++)
    {
      isDaughter = (*itDau)->GetLogicalVolume()->IsAncestor(aVolume);
      if (isDaughter)  break;
    }
  }
  return isDaughter;
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4bool G4LogicalVolume::IsDaughter ( const G4VPhysicalVolume *  p ) const

inline

Here is the caller graph for this function:

G4bool G4LogicalVolume::IsExtended ( ) const

virtual

Reimplemented in G4LogicalCrystalVolume.

Definition at line 240 of file G4LogicalVolume.cc.

{
  return false;
}

G4bool G4LogicalVolume::IsRegion ( ) const

inline

Here is the caller graph for this function:

G4bool G4LogicalVolume::IsRootRegion ( ) const

inline

Here is the caller graph for this function:

G4bool G4LogicalVolume::IsToOptimise ( ) const

inline

Here is the caller graph for this function:

void G4LogicalVolume::Lock ( )

inline

G4bool G4LogicalVolume::operator==

(

const G4LogicalVolume &

lv

)

const

void G4LogicalVolume::PropagateRegion ( )

inline

Here is the caller graph for this function:

void G4LogicalVolume::RemoveDaughter

(

const G4VPhysicalVolume *

p

)

Definition at line 314 of file G4LogicalVolume.cc.

{
  G4PhysicalVolumeList::iterator i;
  for ( i=fDaughters.begin(); i!=fDaughters.end(); ++i )
  {
    if (**i==*p)
    {
      fDaughters.erase(i);
      break;
    }
  }
  if (fRegion)
  {
    fRegion->RegionModified(true);
  }
  G4MT_mass = 0.;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4LogicalVolume::ResetMass

(

)

Definition at line 350 of file G4LogicalVolume.cc.

{
  G4MT_mass= 0.0;
}

Here is the caller graph for this function:

void G4LogicalVolume::SetBiasWeight ( G4double  w )

inline

Here is the caller graph for this function:

void G4LogicalVolume::SetFieldManager	(	G4FieldManager *	pFieldMgr,
		G4bool	forceToAllDaughters
	)

Definition at line 250 of file G4LogicalVolume.cc.

{
  // G4MT_fmanager = pNewFieldMgr;
  AssignFieldManager(pNewFieldMgr);

  G4int NoDaughters = GetNoDaughters();
  while ( (NoDaughters--)>0 )
  {
    G4LogicalVolume* DaughterLogVol; 
    DaughterLogVol = GetDaughter(NoDaughters)->GetLogicalVolume();
    if ( forceAllDaughters || (DaughterLogVol->GetFieldManager() == 0) )
    {
      DaughterLogVol->SetFieldManager(pNewFieldMgr, forceAllDaughters);
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4LogicalVolume::SetMaterial

(

G4Material *

pMaterial

)

Definition at line 405 of file G4LogicalVolume.cc.

{
  G4MT_material=pMaterial;
  G4MT_mass = 0.;
}

Here is the caller graph for this function:

void G4LogicalVolume::SetMaterialCutsCouple

(

G4MaterialCutsCouple *

cuts

)

Definition at line 454 of file G4LogicalVolume.cc.

{
  G4MT_ccouple = cuts;
}

Here is the caller graph for this function:

void G4LogicalVolume::SetName ( const G4String &  pName )

inline

Here is the caller graph for this function:

void G4LogicalVolume::SetOptimisation ( G4bool  optim )

inline

Here is the caller graph for this function:

void G4LogicalVolume::SetRegion ( G4Region *  reg )

inline

Here is the caller graph for this function:

void G4LogicalVolume::SetRegionRootFlag ( G4bool  rreg )

inline

Here is the caller graph for this function:

void G4LogicalVolume::SetSensitiveDetector

(

G4VSensitiveDetector *

pSDetector

)

Definition at line 435 of file G4LogicalVolume.cc.

{
  G4MT_sdetector = pSDetector;
  if(G4Threading::IsMasterThread()) fSensitiveDetector = pSDetector;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4LogicalVolume::SetSmartless ( G4double  s )

inline

Here is the caller graph for this function:

void G4LogicalVolume::SetSolid

(

G4VSolid *

pSolid

)

Definition at line 375 of file G4LogicalVolume.cc.

{

  // ((subInstanceManager.offset[instanceID]).fSolid) = pSolid;
  G4MT_solid=pSolid;
  // G4MT_mass = 0.;
  this->ResetMass(); 
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4LogicalVolume::SetSolid ( G4LVData &  instLVdata, G4VSolid *  pSolid  )

static

Definition at line 384 of file G4LogicalVolume.cc.

{  
  instLVdata.fSolid = pSolid;
  // G4MT_solid=pSolid;
  instLVdata.fMass= 0;
  // A fast way to reset the mass ... ie G4MT_mass = 0.;
}

void G4LogicalVolume::SetUserLimits ( G4UserLimits *  pULimits )

inline

Here is the caller graph for this function:

void G4LogicalVolume::SetVisAttributes ( const G4VisAttributes *  pVA )

inline

void G4LogicalVolume::SetVisAttributes

(

const G4VisAttributes &

VA

)

Definition at line 608 of file G4LogicalVolume.cc.

{
  fVisAttributes = new G4VisAttributes(VA);
}

void G4LogicalVolume::SetVoxelHeader ( G4SmartVoxelHeader *  pVoxel )

inline

Here is the caller graph for this function:

void G4LogicalVolume::TerminateWorker

(

G4LogicalVolume *

ptrMasterObject

)

Definition at line 202 of file G4LogicalVolume.cc.

{
}

Here is the caller graph for this function:

G4int G4LogicalVolume::TotalVolumeEntities

(

)

const

Definition at line 489 of file G4LogicalVolume.cc.

{
  G4int vols = 1;
  for (G4PhysicalVolumeList::const_iterator itDau = fDaughters.begin();
       itDau != fDaughters.end(); itDau++)
  {
    G4VPhysicalVolume* physDaughter = (*itDau);
    vols += physDaughter->GetMultiplicity()
           *physDaughter->GetLogicalVolume()->TotalVolumeEntities();
  }
  return vols;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4LogicalVolume::UpdateMaterial

(

G4Material *

pMaterial

)

Definition at line 415 of file G4LogicalVolume.cc.

{
  G4MT_material=pMaterial;
  if(fRegion) { G4MT_ccouple = fRegion->FindCouple(pMaterial); }
  G4MT_mass = 0.;
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• source/geant4.10.03.p03/source/geometry/management/include/G4LogicalVolume.hh
• source/geant4.10.03.p03/source/geometry/management/src/G4LogicalVolume.cc