EDepSim::PrimaryGenerator Class Reference

#include <EDepSimPrimaryGenerator.hh>

Inheritance diagram for EDepSim::PrimaryGenerator:

Public Member Functions
	PrimaryGenerator (EDepSim::VKinematicsGenerator *kine, EDepSim::VCountGenerator *count, EDepSim::VPositionGenerator *position, EDepSim::VTimeGenerator *time)
virtual	~PrimaryGenerator ()
virtual void	GeneratePrimaryVertex (G4Event *evt)
G4String	GetName ()
	Return the name of this generator. More...
const EDepSim::VKinematicsGenerator *	GetKinematicsGenerator () const
	Return the kinematics generator;. More...
const EDepSim::VCountGenerator *	GetCountGenerator () const
	Return the count generator. More...
const EDepSim::VPositionGenerator *	GetPositionGenerator () const
	Return the position generator. More...
const EDepSim::VTimeGenerator *	GetTimeGenerator () const
	Return the time generator. More...

Private Attributes
EDepSim::VKinematicsGenerator *	fKinematics
EDepSim::VCountGenerator *	fCount
EDepSim::VPositionGenerator *	fPosition
EDepSim::VTimeGenerator *	fTime

Detailed Description

Definition at line 20 of file EDepSimPrimaryGenerator.hh.

Constructor & Destructor Documentation

EDepSim::PrimaryGenerator::PrimaryGenerator	(	EDepSim::VKinematicsGenerator *	kine,
		EDepSim::VCountGenerator *	count,
		EDepSim::VPositionGenerator *	position,
		EDepSim::VTimeGenerator *	time
	)

Definition at line 24 of file EDepSimPrimaryGenerator.cc.

    : fKinematics(kine), fCount(count), fPosition(position), fTime(time) {
}

EDepSim::PrimaryGenerator::~PrimaryGenerator ( void  )

virtual

Definition at line 31 of file EDepSimPrimaryGenerator.cc.

{}

Member Function Documentation

void EDepSim::PrimaryGenerator::GeneratePrimaryVertex ( G4Event *  evt )

virtual

A pure virtual method to generate the actual primary particles which must be implemented in each derived class.

Definition at line 33 of file EDepSimPrimaryGenerator.cc.

                                                                {

    int count = fCount->GetCount();
    int brake = 0;
    EDepSimVerbose("# Generate " << count << " vertices w/ " << GetName());
    while (count > 0 && brake<1000) {
        // Stash the most recent primary vertex.  This is saving the last
        // existing primary vertex before the call to the
        // EDepSim::VKinematicsGenerator::GeneratePrimaryVertex().
        G4PrimaryVertex* vtx = evt->GetPrimaryVertex();
        for (;vtx && vtx->GetNext(); vtx = vtx->GetNext());
        // Generate a candidate position and time for the event vertex.
        G4LorentzVector vertex = fPosition->GetPosition();
        vertex.setT(fTime->GetTime(vertex));
        // Generate the new kinematics.  This will add new primary vertices to
        // the G4Event.
        EDepSim::VKinematicsGenerator::GeneratorStatus generatorStatus
            = fKinematics->GeneratePrimaryVertex(evt,vertex);
        if (generatorStatus == EDepSim::VKinematicsGenerator::kFail) {
            ++brake; // Apply the brakes
            continue;
        }
        if (generatorStatus == EDepSim::VKinematicsGenerator::kEndEvent) {
            break;
        }
        // If the vertex should be forced, then make sure that it is.  This
        // updates the position and time for all of the vertices that were
        // added to the event by the previous EDepSim::VKinematicsGenerator
        // call.  Get the first new vertex.
        if (!vtx) vtx = evt->GetPrimaryVertex();
        else vtx = vtx->GetNext();
        // Update the vertex for the new vertices.
        for (;vtx; vtx = vtx->GetNext()) {
            // Update the vertex info (and make sure it exists).  This sets
            // the generator name.
            EDepSim::VertexInfo* vInfo 
                = dynamic_cast<EDepSim::VertexInfo*>(vtx->GetUserInformation());
            if (!vInfo) {
                vInfo = new EDepSim::VertexInfo();
                vtx->SetUserInformation(vInfo);
            }
            vInfo->SetName(GetName());
            if (fPosition->ForcePosition()) {
                EDepSimVerbose("#    Force position to" 
                         << " x: " << vertex.x()/cm << " cm"
                         << " y: " << vertex.y()/cm << " cm"
                         << " z: " << vertex.z()/cm << " cm");
                vtx->SetPosition(vertex.x(), vertex.y(), vertex.z());
            }
            if (fTime->ForceTime()) {
                EDepSimVerbose("#    Force time to " 
                            << vertex.t()/ns << " ns");
                vtx->SetT0(vertex.t());
            }
        }
        brake = 0;  // Remove the brakes.
        --count;

        // Check if the generator flagged that this vertex must end an event.
        if (generatorStatus == EDepSim::VKinematicsGenerator::kLastVertex) {
            break;
        }
    }
}

const EDepSim::VCountGenerator* EDepSim::PrimaryGenerator::GetCountGenerator ( ) const

inline

Return the count generator.

Definition at line 41 of file EDepSimPrimaryGenerator.hh.

                                                            {
        return fCount;
    }

const EDepSim::VKinematicsGenerator* EDepSim::PrimaryGenerator::GetKinematicsGenerator ( ) const

inline

Return the kinematics generator;.

Definition at line 36 of file EDepSimPrimaryGenerator.hh.

                                                                      {
        return fKinematics;
    }

G4String EDepSim::PrimaryGenerator::GetName

(

void

)

Return the name of this generator.

Definition at line 98 of file EDepSimPrimaryGenerator.cc.

                                          {
    G4String name = fKinematics->GetName();
    name += ":" + fCount->GetName();
    name += "@" + fPosition->GetName();
    name += "-" + fTime->GetName();
    return name;
}

const EDepSim::VPositionGenerator* EDepSim::PrimaryGenerator::GetPositionGenerator ( ) const

inline

Return the position generator.

Definition at line 46 of file EDepSimPrimaryGenerator.hh.

                                                                  {
        return fPosition;
    }

const EDepSim::VTimeGenerator* EDepSim::PrimaryGenerator::GetTimeGenerator ( ) const

inline

Return the time generator.

Definition at line 51 of file EDepSimPrimaryGenerator.hh.

                                                          {
        return fTime;
    }

Member Data Documentation

EDepSim::VCountGenerator* EDepSim::PrimaryGenerator::fCount

private

The count generator determines the number of primary vertices that will be added to a G4Event.

Definition at line 69 of file EDepSimPrimaryGenerator.hh.

EDepSim::VKinematicsGenerator* EDepSim::PrimaryGenerator::fKinematics

private

The kinematics generator that will return the primary particles being simulated by this generator. The kinematics generator adds the primary vertex to the G4Event along with the primary particles that eminate from the vertex. The generator is passed a 4-vector position which gives the position that EDepSim::VPrimaryGenerator would like an interaction generated for. The kinematics generator can choose to ignore this information and create the vertex at any location, but it might be overriden by EDepSim::VPrimaryGenerator (depending on which EDepSim::VVertexGenerator is used).

Definition at line 65 of file EDepSimPrimaryGenerator.hh.

EDepSim::VPositionGenerator* EDepSim::PrimaryGenerator::fPosition

private

The position generator picks candidate positions for the primary vertices. The candidate vertices generated by the position generator are passed to the kinematics generator as an advisory position. If the position generator returns true from EDepSim::VPositionGenerator::ForcePosition(), then the vertex from the kinematics generator will be overridden by the EDepSim::VPrimaryGenerator.

Definition at line 77 of file EDepSimPrimaryGenerator.hh.

EDepSim::VTimeGenerator* EDepSim::PrimaryGenerator::fTime

private

The time generator picks candidate times for the primary vertices. The candidate times are passed to the kinematics generator as advisory times. If the time generator returns true from EDepSim::VTimeGenerator::ForceTime(), then the vertex from the kinematics generator will be overridden by the EDepSim::VPrimaryGenerator.

Definition at line 84 of file EDepSimPrimaryGenerator.hh.

---

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

• edep-sim/src/kinem/EDepSimPrimaryGenerator.hh
• edep-sim/src/kinem/EDepSimPrimaryGenerator.cc