G4AssemblyVolume Class Reference

G4AssemblyVolume is a helper class to make the build process of geometry easier. It allows one to combine several volumes together in an arbitrary way in 3D space and then work with the result as with a single logical volume for placement. The resulting objects are independent copies of each of the assembled logical volumes. The placements are not, however, bound one to each other when placement is done. They are seen as independent physical volumes in space. More...

#include <G4AssemblyVolume.hh>

Public Member Functions
	G4AssemblyVolume ()
	G4AssemblyVolume (G4LogicalVolume *volume, G4ThreeVector &translation, G4RotationMatrix *rotation)
	~G4AssemblyVolume ()
void	AddPlacedVolume (G4LogicalVolume *pPlacedVolume, G4ThreeVector &translation, G4RotationMatrix *rotation)
void	AddPlacedVolume (G4LogicalVolume *pPlacedVolume, G4Transform3D &transformation)
void	AddPlacedAssembly (G4AssemblyVolume *pAssembly, G4Transform3D &transformation)
void	AddPlacedAssembly (G4AssemblyVolume *pAssembly, G4ThreeVector &translation, G4RotationMatrix *rotation)
void	MakeImprint (G4LogicalVolume *pMotherLV, G4ThreeVector &translationInMother, G4RotationMatrix *pRotationInMother, G4int copyNumBase=0, G4bool surfCheck=false)
void	MakeImprint (G4LogicalVolume *pMotherLV, G4Transform3D &transformation, G4int copyNumBase=0, G4bool surfCheck=false)
std::vector< G4VPhysicalVolume * >::iterator	GetVolumesIterator ()
std::size_t	TotalImprintedVolumes () const
G4Transform3D &	GetImprintTransformation (unsigned int imprintID)
std::vector< G4AssemblyTriplet >::iterator	GetTripletsIterator ()
std::size_t	TotalTriplets () const
unsigned int	GetImprintsCount () const
unsigned int	GetInstanceCount () const
unsigned int	GetAssemblyID () const

Protected Member Functions
void	SetInstanceCount (unsigned int value)
void	SetAssemblyID (unsigned int value)
void	InstanceCountPlus ()
void	InstanceCountMinus ()
void	SetImprintsCount (unsigned int value)
void	ImprintsCountPlus ()
void	ImprintsCountMinus ()

Detailed Description

G4AssemblyVolume is a helper class to make the build process of geometry easier. It allows one to combine several volumes together in an arbitrary way in 3D space and then work with the result as with a single logical volume for placement. The resulting objects are independent copies of each of the assembled logical volumes. The placements are not, however, bound one to each other when placement is done. They are seen as independent physical volumes in space.

Definition at line 62 of file G4AssemblyVolume.hh.

Constructor & Destructor Documentation

G4AssemblyVolume() [1/2]

G4AssemblyVolume::G4AssemblyVolume

(

)

Default Constructor.

Definition at line 47 of file G4AssemblyVolume.cc.

{
  InstanceCountPlus();
  SetAssemblyID( GetInstanceCount() );
  SetImprintsCount( 0 );
  G4AssemblyStore* aStore = G4AssemblyStore::GetInstance();
  if (aStore->GetAssembly(fAssemblyID,false) != nullptr)
  {
    std::ostringstream message;
    message << "The assembly has NOT been registered !" << G4endl
            << "          Assembly " << fAssemblyID
            << " already existing in store !" << G4endl;
    G4Exception("G4AssemblyVolume::G4AssemblyVolume()", "GeomVol1001",
                JustWarning, message);
  }
  else
  {
    aStore->Register(this);
  }
}

Referenced by AddPlacedAssembly(), AddPlacedAssembly(), and ImprintsCountMinus().

G4AssemblyVolume() [2/2]

G4AssemblyVolume::G4AssemblyVolume	(	G4LogicalVolume *	volume,
		G4ThreeVector &	translation,
		G4RotationMatrix *	rotation )

Constructor. The rotation matrix passed as argument can be nullptr (identity) or an address even of an object on the upper stack frame. During assembly imprint, a new matrix is created anyway and it is kept track of it so it can be automatically deleted later at the end of the application. This policy is adopted since user has no control on the way the rotations are combined.

Parameters

[in]	volume	Pointer to the logical volume of the assembly.
[in]	translation	Translation vector of the assembly.
[in]	rotation	Pointer to the rotation matrix of the assembly.

Definition at line 71 of file G4AssemblyVolume.cc.

{
  InstanceCountPlus();
  SetAssemblyID( GetInstanceCount() );
  SetImprintsCount( 0 );
  AddPlacedVolume(volume, translation, rotation);
  G4AssemblyStore* aStore = G4AssemblyStore::GetInstance();
  if (aStore->GetAssembly(fAssemblyID,false) != nullptr)
  {
    std::ostringstream message;
    message << "The assembly has NOT been registered !" << G4endl
            << "          Assembly " << fAssemblyID
            << " already existing in store !" << G4endl;
    G4Exception("G4Assembly::G4Assembly()", "GeomVol1001",
                JustWarning, message);
  }
  else
  {
    aStore->Register(this);
  }
}

~G4AssemblyVolume()

G4AssemblyVolume::~G4AssemblyVolume

(

)

Destructor. At destruction all the generated physical volumes and associated rotation matrices of the imprints will be destroyed.

Definition at line 98 of file G4AssemblyVolume.cc.

{
  std::size_t howmany = fTriplets.size();
  if( howmany != 0 )
  {
    for( std::size_t i = 0; i < howmany; ++i )
    {
      G4RotationMatrix* pRotToClean = fTriplets[i].GetRotation();
      delete pRotToClean;
    }
  }
  fTriplets.clear();
  
  // No need to delete physical volumes, as these are deleted
  // by physical-volumes store.
  //
  fPVStore.clear();
  InstanceCountMinus();
  G4AssemblyStore::GetInstance()->DeRegister(this);
}

Member Function Documentation

AddPlacedAssembly() [1/2]

void G4AssemblyVolume::AddPlacedAssembly	(	G4AssemblyVolume *	pAssembly,
		G4ThreeVector &	translation,
		G4RotationMatrix *	rotation )

The same as previous method, but takes an assembly volume as its argument with translation and rotation.

Parameters

[in]	pAssembly	Pointer to the assembly volume to be added to the assembly.
[in]	translation	Translation vector of the volume.
[in]	rotation	Pointer to the rotation matrix of the volume.

Definition at line 169 of file G4AssemblyVolume.cc.

{
  auto toStore = new G4RotationMatrix;
  
  if( pRotation != nullptr )  { *toStore = *pRotation; }
  
  G4AssemblyTriplet toAdd( pAssembly, translation, toStore );
  fTriplets.push_back( toAdd );
}

AddPlacedAssembly() [2/2]

void G4AssemblyVolume::AddPlacedAssembly	(	G4AssemblyVolume *	pAssembly,
		G4Transform3D &	transformation )

The same as previous method, but takes an assembly volume as argument.

Parameters

[in]	pAssembly	Pointer to the assembly volume to be added to the assembly.
[in]	transformation	The 3D transformation in space.

Definition at line 185 of file G4AssemblyVolume.cc.

{
  // Decompose transformation
  //
  G4Scale3D     scale;
  G4Rotate3D    rotation;
  G4Translate3D translation;
  transformation.getDecomposition(scale, rotation, translation);
 
  G4ThreeVector      v = translation.getTranslation();
  auto r = new G4RotationMatrix;
      *r = rotation.getRotation();
  
  G4bool isReflection = false;
  if (scale(0,0)*scale(1,1)*scale(2,2) < 0.)  { isReflection = true; }
  
  G4AssemblyTriplet toAdd( pAssembly, v, r, isReflection );
  fTriplets.push_back( toAdd );
}

Referenced by G4GDMLReadStructure::PhysvolRead().

AddPlacedVolume() [1/2]

void G4AssemblyVolume::AddPlacedVolume	(	G4LogicalVolume *	pPlacedVolume,
		G4ThreeVector &	translation,
		G4RotationMatrix *	rotation )

Places the given volume 'pPlacedVolume' inside the assembly.

The adopted approach:

• Place it w.r.t. the assembly coordinate system. This step is applied to each of the participating volumes.

The other possible approaches:

• Place w.r.t. the firstly added volume. When placed the first, the virtual coordinate system becomes the coordinate system of the first one. Every next volume being added into the assembly will be placed w.r.t to the first one.
• Place w.r.t the last placed volume. When placed the first, the virtual coordinate system becomes the coordinate system of the first one. Every next volume being added into the assembly will be placed w.r.t to the previous one.

The rotation matrix passed as argument can be nullptr (identity) or an address even of an object on the upper stack frame. During assembly imprint, a new matrix is created anyway and it is kept track of it so it can be automatically deleted later at the end of the application. This policy is adopted since user has no control on the way the rotations are combined.

Parameters

[in]	pPlacedVolume	Pointer to the logical volume of the volume to be added to the assembly.
[in]	translation	Translation vector of the volume.
[in]	rotation	Pointer to the rotation matrix of the volume.

Definition at line 130 of file G4AssemblyVolume.cc.

{
  auto toStore = new G4RotationMatrix;
  
  if( pRotation != nullptr )  { *toStore = *pRotation; }
  
  G4AssemblyTriplet toAdd( pVolume, translation, toStore );
  fTriplets.push_back( toAdd );
}

Referenced by G4AssemblyVolume(), and G4GDMLReadStructure::PhysvolRead().

AddPlacedVolume() [2/2]

void G4AssemblyVolume::AddPlacedVolume	(	G4LogicalVolume *	pPlacedVolume,
		G4Transform3D &	transformation )

The same as previous method, except that it takes the complete 3D transformation in space as its argument.

Parameters

[in]	pPlacedVolume	Pointer to the logical volume of the volume to be added to the assembly.
[in]	transformation	The 3D transformation in space.

Definition at line 145 of file G4AssemblyVolume.cc.

{
  // Decompose transformation
  G4Scale3D     scale;
  G4Rotate3D    rotation;
  G4Translate3D translation;
  transformation.getDecomposition(scale, rotation, translation);
 
  G4ThreeVector v = translation.getTranslation();
  auto r = new G4RotationMatrix;
      *r = rotation.getRotation();
  
  G4bool isReflection = false;
  if (scale(0,0)*scale(1,1)*scale(2,2) < 0.)  { isReflection = true; }
 
  G4AssemblyTriplet toAdd( pVolume, v, r, isReflection );
  fTriplets.push_back( toAdd );
}

GetAssemblyID()

unsigned int G4AssemblyVolume::GetAssemblyID ( ) const

inline

Returns the instance number of the assembly.

GetImprintsCount()

unsigned int G4AssemblyVolume::GetImprintsCount ( ) const

inline

Returns the number of currently made imprints.

GetImprintTransformation()

G4Transform3D & G4AssemblyVolume::GetImprintTransformation ( unsigned int imprintID )

inline

To access the 3D transformation in space for each imprint, given the ID.

Referenced by G4GDMLWriteStructure::TraverseVolumeTree().

GetInstanceCount()

unsigned int G4AssemblyVolume::GetInstanceCount

(

)

const

Returns the number of existing instances of G4AssemblyVolume class.

Definition at line 386 of file G4AssemblyVolume.cc.

{
  return G4AssemblyVolume::fsInstanceCounter;
}

Referenced by G4AssemblyVolume(), and G4AssemblyVolume().

GetTripletsIterator()

std::vector< G4AssemblyTriplet >::iterator G4AssemblyVolume::GetTripletsIterator ( )

inline

To access the created triplets in the assembly through an iterator.

Referenced by G4GDMLWriteStructure::AssemblyWrite().

GetVolumesIterator()

std::vector< G4VPhysicalVolume * >::iterator G4AssemblyVolume::GetVolumesIterator ( )

inline

To access the physical volumes imprinted through an iterator.

ImprintsCountMinus()

void G4AssemblyVolume::ImprintsCountMinus ( )

inlineprotected

ImprintsCountPlus()

void G4AssemblyVolume::ImprintsCountPlus ( )

inlineprotected

InstanceCountMinus()

void G4AssemblyVolume::InstanceCountMinus ( )

protected

Definition at line 404 of file G4AssemblyVolume.cc.

{
  G4AssemblyVolume::fsInstanceCounter--;
}

Referenced by ~G4AssemblyVolume().

InstanceCountPlus()

void G4AssemblyVolume::InstanceCountPlus ( )

protected

Definition at line 398 of file G4AssemblyVolume.cc.

{
  G4AssemblyVolume::fsInstanceCounter++;
}

Referenced by G4AssemblyVolume(), and G4AssemblyVolume().

MakeImprint() [1/2]

void G4AssemblyVolume::MakeImprint	(	G4LogicalVolume *	pMotherLV,
		G4ThreeVector &	translationInMother,
		G4RotationMatrix *	pRotationInMother,
		G4int	copyNumBase = 0,
		G4bool	surfCheck = false )

Creates instance of an assembly volume inside the given mother volume.

Parameters

[in]	pMotherLV	Pointer to the logical volume of the assembly.
[in]	translationInMother	Translation vector of the imprint.
[in]	pRotationInMother	Pointer to the rotation of the imprint.
[in]	copyNumBase	Optional index to assign to the imprint.
[in]	surfCheck	Flag to enable overlaps checking while imprinting.

Definition at line 343 of file G4AssemblyVolume.cc.

{
  // If needed user can specify explicitely the base count from which to start
  // off for the generation of phys. vol. copy numbers.
  // The old behaviour is preserved when copyNumBase == 0, e.g. the generated
  // copy numbers start from the count equal to current number of daughter
  // volumes before an imprint is made
 
  // Compose transformation
  //
  if( pRotationInMother == nullptr )
  {
    // Make it by default an indentity matrix
    //
    pRotationInMother =
      const_cast<G4RotationMatrix*>( &G4RotationMatrix::IDENTITY );
  }
 
  G4Transform3D transform( *pRotationInMother,
                            translationInMother );
  MakeImprint(this, pMotherLV, transform, copyNumBase, surfCheck);
}

Referenced by MakeImprint(), MakeImprint(), and G4GDMLReadStructure::PhysvolRead().

MakeImprint() [2/2]

void G4AssemblyVolume::MakeImprint	(	G4LogicalVolume *	pMotherLV,
		G4Transform3D &	transformation,
		G4int	copyNumBase = 0,
		G4bool	surfCheck = false )

The same as previous Imprint() method, but takes a complete 3D transformation in space as its argument.

Parameters

[in]	pMotherLV	Pointer to the logical volume of the assembly.
[in]	transformation	The 3D transformation in space of the imprint.
[in]	copyNumBase	Optional index to assign to the imprint.
[in]	surfCheck	Flag to enable overlaps checking while imprinting.

Definition at line 371 of file G4AssemblyVolume.cc.

{
  // If needed user can specify explicitely the base count from which to start
  // off for the generation of phys. vol. copy numbers.
  // The old behaviour is preserved when copyNumBase == 0, e.g. the generated
  // copy numbers start from the count equal to current number of daughter
  // volumes before a imprint is made
 
  MakeImprint(this, pMotherLV, transformation, copyNumBase, surfCheck);
}

SetAssemblyID()

void G4AssemblyVolume::SetAssemblyID ( unsigned int value )

inlineprotected

Referenced by G4AssemblyVolume(), and G4AssemblyVolume().

SetImprintsCount()

void G4AssemblyVolume::SetImprintsCount ( unsigned int value )

inlineprotected

Referenced by G4AssemblyVolume(), and G4AssemblyVolume().

SetInstanceCount()

void G4AssemblyVolume::SetInstanceCount ( unsigned int value )

inlineprotected

Definition at line 392 of file G4AssemblyVolume.cc.

{
  G4AssemblyVolume::fsInstanceCounter = value;
}

TotalImprintedVolumes()

std::size_t G4AssemblyVolume::TotalImprintedVolumes ( ) const

inline

Returns the total number of imprinted volumes of the assembly.

TotalTriplets()

std::size_t G4AssemblyVolume::TotalTriplets ( ) const

inline

Returns the total number of triplets in the assembly.

Referenced by G4GDMLWriteStructure::AssemblyWrite().

---

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

• G4AssemblyVolume.hh
• G4AssemblyVolume.cc