BuildInitialState Class Reference

Build the initial partons given the whole final state. More...

Detailed Description

Build the initial partons given the whole final state.

Define the initial partons 4-momenta given the particles present in the final state.

If the parameter do_transverse_boost is set to true, the partons are boosted in the transverse direction to satisfy energy-momentum conservation. Otherwise, the partons are simply built using the total energy and longitudinal momentum, without enforcing conservation of transverse momentum.

Use of the transverse boost or not can depend on how the invisibles are reconstructed by the blocks: if the block already enforces momentum conservation, applying the boost or not will yield the same result.

Integration dimension

This module requires 0 phase-space point.

Global parameters

Name Type Description
energy double Collision energy.

Parameters

Name Type Description
do_transverse_boost bool, default: false Boost the initial partons in the transverse direction to match total transverse momentum.

Inputs

Name Type Description
particles vector(LorentzVector) Set of all particles.

Outputs

Name Type Description
partons vector(LorentzVector) Sets of initial parton 4-momenta.

Definition at line 70 of file BuildInitialState.cc.

Inheritance diagram for BuildInitialState:

Public Member Functions

 BuildInitialState (PoolPtr pool, const ParameterSet &parameters)
 
virtual Status work () override
 Main function. More...
 
- Public Member Functions inherited from Module
 Module (PoolPtr pool, const std::string &name)
 Constructor. More...
 
virtual void configure ()
 Called once at the beginning of the job.
 
virtual void beginIntegration ()
 Called once at the beginning of the integration.
 
virtual void beginPoint ()
 Called once when a new PS point is started. More...
 
virtual void beginLoop ()
 Called once at the beginning of a loop. More...
 
virtual void endLoop ()
 Called once at the end of a loop. More...
 
virtual void endPoint ()
 Called once when a PS point is finished. More...
 
virtual void endIntegration ()
 Called once at the end of the integration.
 
virtual void finish ()
 Called once at the end of the job.
 
virtual std::string name () const final
 

Additional Inherited Members

- Public Types inherited from Module
enum  Status : std::int8_t { OK, NEXT, ABORT }
 
- Static Public Member Functions inherited from Module
static std::string statusToString (const Status &status)
 
static bool is_virtual_module (const std::string &name)
 Test if a given name correspond to a virtual module. More...
 
- Protected Member Functions inherited from Module
template<typename T , typename... Args>
std::shared_ptr< T > produce (const std::string &name, Args... args)
 Add a new output to the module. More...
 
template<typename T >
Value< T > get (const std::string &module, const std::string &name)
 
template<typename T >
Value< T > get (const InputTag &tag)
 
- Protected Attributes inherited from Module
PoolPtr m_pool
 

Member Function Documentation

◆ work()

virtual Status BuildInitialState::work ( )
inlineoverridevirtual

Main function.

This method is called for each integration step. The module's logic and work happen here.

You'll usually want to override this function if you want your module to perform some task.

Reimplemented from Module.

Definition at line 87 of file BuildInitialState.cc.


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