herwig is hosted by Hepforge, IPPP Durham
Herwig  7.2.1
Herwig::API Namespace Reference

A very high-level API for interacting with Herwig's different run modes. More...

Functions

void read (const HerwigUI &)
 Herwig read mode. More...
 
void build (const HerwigUI &)
 Herwig build mode. More...
 
void integrate (const HerwigUI &)
 Herwig integrate mode.
 
void mergegrids (const HerwigUI &)
 Herwig mergegrids mode.
 
ThePEG::EGPtr prepareRun (const HerwigUI &)
 Prepare Herwig run mode; prepare the event generator and return a pointer to it; it can then be used to generate single events.
 
void run (const HerwigUI &)
 Herwig run mode; prepare the event generator and run a given number of events.
 
void init (const HerwigUI &)
 Herwig init mode. More...
 

Detailed Description

A very high-level API for interacting with Herwig's different run modes.

It's not very convenient (yet), since you'll have to provide your own HerwigUI-derived object with some fairly obscure settings.

Much more fine-grained control is available through ThePEG::Repository.

Function Documentation

◆ build()

void Herwig::API::build ( const HerwigUI )

Herwig build mode.

Prepares a generator .run file and integration jobs, if desired. If an input file is not supplied through HerwigUI::inputfile() repository commands will be read from HerwigUI::inStream() instead.

◆ init()

void Herwig::API::init ( const HerwigUI )

Herwig init mode.

Creates a new default repository.

Usually, the default repo created during the Herwig installation is fine and external users will not need this mode.

◆ read()

void Herwig::API::read ( const HerwigUI )

Herwig read mode.

Prepares a generator .run file. If an input file is not supplied through HerwigUI::inputfile() repository commands will be read from HerwigUI::inStream() instead.