#include <EDepSimVConstrainedPositionGenerator.hh>

Inheritance diagram for EDepSim::VConstrainedPositionGenerator:

Classes
class	PositionTest

Public Types
typedef std::vector< PositionTest * >	PositionTests

Public Member Functions
	VConstrainedPositionGenerator (const G4String &name)

virtual	~VConstrainedPositionGenerator ()

virtual bool	ForcePosition ()

void	SetVolumeName (const G4String &volume)
	Set the name of the volume to be sampled for a vertex. More...

void	ClearPositionTests (void)
	Clear the current set of vertex checks. More...

void	CheckVolumeName (const G4String &name)

void	CheckNotVolumeName (const G4String &name)

void	CheckVolumeMaterial (const G4String &name)
	Check that the vertex is inside of a material specified by name. More...

void	CheckNotVolumeMaterial (const G4String &name)
	Check that the vertex is not inside of a material specified by name. More...

void	CheckMinX (double x)
	Check that the vertex X position is greater than some value. More...

void	CheckMaxX (double x)
	Check that the vertex X position is less than some value. More...

void	CheckMinY (double y)
	Check that the vertex Y position is greater than some value. More...

void	CheckMaxY (double y)
	Check that the vertex Y position is less than some value. More...

void	CheckMinZ (double z)
	Check that the vertex Z position is greater than some value. More...

void	CheckMaxZ (double z)
	Check that the vertex Z position is less than some value. More...

Public Member Functions inherited from EDepSim::VPositionGenerator
	VPositionGenerator (const G4String &name)

virtual	~VPositionGenerator ()

virtual G4LorentzVector	GetPosition ()=0
	Return the candidate position for the primary vertex. More...

G4String	GetName () const
	Return the name of the generator. More...

Protected Member Functions
virtual bool	ValidPosition (const G4LorentzVector &vtx)
	Return true if the vertex is valid. This is used in the derived class. More...

G4LorentzVector	TrialPosition ()
	Generate a trial position uniformly in the sample box. More...

Private Member Functions
void	FindLimits ()
	Find the limits of the volume to be sampled for a good vertex. More...

Private Attributes
G4String	fSampleVolume
	The name of the volume to be sampled. More...

bool	fLimitsFound
	True if the limits have been initialized. More...

PositionTests	fPositionTests
	The vertex tests to apply. More...

G4ThreeVector	fMinimumCorner
	The lower boundary of the volume to be sampled for the vertex. More...

G4ThreeVector	fMaximumCorner
	The upper boundary of the volume to be sampled for the vertex. More...

Detailed Description

Definition at line 13 of file EDepSimVConstrainedPositionGenerator.hh.

Member Typedef Documentation

typedef std::vector<PositionTest*> EDepSim::VConstrainedPositionGenerator::PositionTests

Definition at line 28 of file EDepSimVConstrainedPositionGenerator.hh.

Constructor & Destructor Documentation

EDepSim::VConstrainedPositionGenerator::VConstrainedPositionGenerator ( const G4String & name )

Definition at line 18 of file EDepSimVConstrainedPositionGenerator.cc.

     : EDepSim::VPositionGenerator(name), fSampleVolume("Cryostat"),
       fLimitsFound(false) {
     fMaximumCorner.set(1000000*meter,1000000*meter,1000000*meter);
     fMinimumCorner.set(-1000000*meter,-1000000*meter,-1000000*meter);
 }

EDepSim::VConstrainedPositionGenerator::~VConstrainedPositionGenerator ( )

virtual

Definition at line 26 of file EDepSimVConstrainedPositionGenerator.cc.

26 {}

Member Function Documentation

void EDepSim::VConstrainedPositionGenerator::CheckMaxX ( double x )

Check that the vertex X position is less than some value.

Definition at line 193 of file EDepSimVConstrainedPositionGenerator.cc.

                                                              {
     if (fMaximumCorner.x() > x) fMaximumCorner.setX(x);
     fPositionTests.push_back(new InternalMaximumCoordinate(0,x));
 }

void EDepSim::VConstrainedPositionGenerator::CheckMaxY ( double y )

Check that the vertex Y position is less than some value.

Definition at line 198 of file EDepSimVConstrainedPositionGenerator.cc.

                                                              {
     if (fMaximumCorner.y() > y) fMaximumCorner.setY(y);
     fPositionTests.push_back(new InternalMaximumCoordinate(1,y));
 }

void EDepSim::VConstrainedPositionGenerator::CheckMaxZ ( double z )

Check that the vertex Z position is less than some value.

Definition at line 203 of file EDepSimVConstrainedPositionGenerator.cc.

                                                              {
     if (fMaximumCorner.z() > z) fMaximumCorner.setZ(z);
     fPositionTests.push_back(new InternalMaximumCoordinate(2,z));
 }

void EDepSim::VConstrainedPositionGenerator::CheckMinX ( double x )

Check that the vertex X position is greater than some value.

Definition at line 178 of file EDepSimVConstrainedPositionGenerator.cc.

                                                              {
     if (fMinimumCorner.x() < x) fMinimumCorner.setX(x);
     fPositionTests.push_back(new InternalMinimumCoordinate(0,x));
 }

void EDepSim::VConstrainedPositionGenerator::CheckMinY ( double y )

Check that the vertex Y position is greater than some value.

Definition at line 183 of file EDepSimVConstrainedPositionGenerator.cc.

                                                              {
     if (fMinimumCorner.y() < y) fMinimumCorner.setY(y);
     fPositionTests.push_back(new InternalMinimumCoordinate(1,y));
 }

void EDepSim::VConstrainedPositionGenerator::CheckMinZ ( double z )

Check that the vertex Z position is greater than some value.

Definition at line 188 of file EDepSimVConstrainedPositionGenerator.cc.

                                                              {
     if (fMinimumCorner.z() < z) fMinimumCorner.setZ(z);
     fPositionTests.push_back(new InternalMinimumCoordinate(2,z));
 }

void EDepSim::VConstrainedPositionGenerator::CheckNotVolumeMaterial ( const G4String & name )

Check that the vertex is not inside of a material specified by name.

Definition at line 173 of file EDepSimVConstrainedPositionGenerator.cc.

                           {
     fPositionTests.push_back(new InternalNotVolumeMaterial(name));
 }

void EDepSim::VConstrainedPositionGenerator::CheckNotVolumeName ( const G4String & name )

Check that the vertex is not inside of a volume specified by name. Name may be a sub-string contained in the full volume name.

Definition at line 163 of file EDepSimVConstrainedPositionGenerator.cc.

                           {
     fPositionTests.push_back(new InternalNotVolumeName(name));
 }

void EDepSim::VConstrainedPositionGenerator::CheckVolumeMaterial ( const G4String & name )

Check that the vertex is inside of a material specified by name.

Definition at line 168 of file EDepSimVConstrainedPositionGenerator.cc.

                           {
     fPositionTests.push_back(new InternalVolumeMaterial(name));
 }

void EDepSim::VConstrainedPositionGenerator::CheckVolumeName ( const G4String & name )

Check that the vertex is inside of a volume specified by name. Name may be a sub-string contanied in the full volume name.

Definition at line 158 of file EDepSimVConstrainedPositionGenerator.cc.

                           {
     fPositionTests.push_back(new InternalVolumeName(name));
 }

void EDepSim::VConstrainedPositionGenerator::ClearPositionTests ( void )

inline

Clear the current set of vertex checks.

Definition at line 34 of file EDepSimVConstrainedPositionGenerator.hh.

34 {fPositionTests.clear();}

EDepSim::VConstrainedPositionGenerator::fPositionTests

PositionTests fPositionTests

The vertex tests to apply.

Definition: EDepSimVConstrainedPositionGenerator.hh:86

void EDepSim::VConstrainedPositionGenerator::FindLimits ( )

private

Find the limits of the volume to be sampled for a good vertex.

Definition at line 221 of file EDepSimVConstrainedPositionGenerator.cc.

                                                       {
     if (fLimitsFound) return;
     fLimitsFound = true;
 
     if (fSampleVolume == "") {
         EDepSimError("EDepSim::VConstrainedPositionGenerator:: "
                     "The sample volume must be set");
     }
 
     // Find the volume for sampling by something that is big enough to cover
     // all of the possible vertex locations.
     G4Navigator* navigator
         = G4TransportationManager::GetTransportationManager()
         ->GetNavigatorForTracking();
 
     std::queue<QueueElement> volumes;
     volumes.push(QueueElement(navigator->GetWorldVolume(),
                               G4ThreeVector(0,0,0),
                               G4RotationMatrix()));
     while (!volumes.empty()) {
         G4VPhysicalVolume* phyVolume = volumes.front().volume;
         G4ThreeVector translation
             = volumes.front().translation + phyVolume->GetObjectTranslation();
         G4RotationMatrix rotation = volumes.front().rotation;
         rotation.transform(phyVolume->GetObjectRotationValue());
         volumes.pop();
 
         if (phyVolume->GetName().find(fSampleVolume) != std::string::npos) {
             G4VisExtent volExtent
                 = phyVolume->GetLogicalVolume()->GetSolid()->GetExtent();
             G4ThreeVector volMin;
             G4ThreeVector volMax;
             volMin.set(volExtent.GetXmin(),
                        volExtent.GetYmin(),
                        volExtent.GetZmin());
             volMax.set(volExtent.GetXmax(),
                                volExtent.GetYmax(),
                                volExtent.GetZmax());
             volMin = rotation*volMin + translation;
             volMax = rotation*volMax + translation;
             if (fMaximumCorner.x()>volMax.x()) fMaximumCorner.setX(volMax.x());
             if (fMaximumCorner.y()>volMax.y()) fMaximumCorner.setY(volMax.y());
             if (fMaximumCorner.z()>volMax.z()) fMaximumCorner.setZ(volMax.z());
             if (fMinimumCorner.x()<volMin.x()) fMinimumCorner.setX(volMin.x());
             if (fMinimumCorner.y()<volMin.y()) fMinimumCorner.setY(volMin.y());
             if (fMinimumCorner.z()<volMin.z()) fMinimumCorner.setZ(volMin.z());
             break;
         }
 
         G4LogicalVolume* logVolume = phyVolume->GetLogicalVolume();
         for (std::size_t i=0; i< logVolume->GetNoDaughters(); ++i) {
             volumes.push(QueueElement(logVolume->GetDaughter(i),
                                       translation,
                                       rotation));
         }
     }
 
     EDepSimLog("Sampling volume extent:");
     EDepSimLog("    X: " << G4BestUnit(fMinimumCorner[0],"Length")
              << "to " << G4BestUnit(fMaximumCorner[0],"Length"));
     EDepSimLog("    Y: " << G4BestUnit(fMinimumCorner[1],"Length")
              << "to " << G4BestUnit(fMaximumCorner[1],"Length"));
     EDepSimLog("    Z: " << G4BestUnit(fMinimumCorner[2],"Length")
              << "to " << G4BestUnit(fMaximumCorner[2],"Length"));
 }

bool EDepSim::VConstrainedPositionGenerator::ForcePosition ( )

virtual

Flag if the vertex should be forced to the candidate vertex returned by GetPosition().

Implements EDepSim::VPositionGenerator.

Reimplemented in EDepSim::DensityPositionGenerator, and EDepSim::UniformPositionGenerator.

Definition at line 28 of file EDepSimVConstrainedPositionGenerator.cc.

                                                          {
     return true;
 }

void EDepSim::VConstrainedPositionGenerator::SetVolumeName ( const G4String & volume )

inline

Set the name of the volume to be sampled for a vertex.

Definition at line 31 of file EDepSimVConstrainedPositionGenerator.hh.

31 {fSampleVolume = volume;}

EDepSim::VConstrainedPositionGenerator::fSampleVolume

G4String fSampleVolume

The name of the volume to be sampled.

Definition: EDepSimVConstrainedPositionGenerator.hh:77

IMap::volume

static const std::string volume[nvol]

Definition: CommonIMapIncludes.h:78

G4LorentzVector EDepSim::VConstrainedPositionGenerator::TrialPosition ( )

protected

Generate a trial position uniformly in the sample box.

Definition at line 287 of file EDepSimVConstrainedPositionGenerator.cc.

                                                                     {
     FindLimits();
     G4LorentzVector vtx;
     for (int i=0; i<3; ++i) {
         vtx[i] = (fMaximumCorner[i] - fMinimumCorner[i])*G4UniformRand()
             + fMinimumCorner[i];
     }
     vtx[3] = 0;
     return vtx;
 }

bool EDepSim::VConstrainedPositionGenerator::ValidPosition ( const G4LorentzVector & vtx )

protectedvirtual

Return true if the vertex is valid. This is used in the derived class.

Definition at line 32 of file EDepSimVConstrainedPositionGenerator.cc.

                                 {
     for (PositionTests::iterator test = fPositionTests.begin();
          test != fPositionTests.end();
          ++test) {
         if (!(*test)->Apply(vtx)) return false;
     }
     return true;
 }