Gabriele Cosmo
246 lines
9.7 KiB
C++
246 lines
9.7 KiB
C++
//
|
|
// ********************************************************************
|
|
// * License and Disclaimer *
|
|
// * *
|
|
// * The Geant4 software is copyright of the Copyright Holders of *
|
|
// * the Geant4 Collaboration. It is provided under the terms and *
|
|
// * conditions of the Geant4 Software License, included in the file *
|
|
// * LICENSE and available at http://cern.ch/geant4/license . These *
|
|
// * include a list of copyright holders. *
|
|
// * *
|
|
// * Neither the authors of this software system, nor their employing *
|
|
// * institutes,nor the agencies providing financial support for this *
|
|
// * work make any representation or warranty, express or implied, *
|
|
// * regarding this software system or assume any liability for its *
|
|
// * use. Please see the license in the file LICENSE and URL above *
|
|
// * for the full disclaimer and the limitation of liability. *
|
|
// * *
|
|
// * This code implementation is the result of the scientific and *
|
|
// * technical work of the GEANT4 collaboration. *
|
|
// * By using, copying, modifying or distributing the software (or *
|
|
// * any work based on the software) you agree to acknowledge its *
|
|
// * use in resulting scientific publications, and indicate your *
|
|
// * acceptance of all terms of the Geant4 Software license. *
|
|
// ********************************************************************
|
|
//
|
|
// G4GeneralParticleSourceMessenger
|
|
//
|
|
// Class Description:
|
|
//
|
|
// The function of the G4GeneralParticleSourceMessenger is to allow the user to
|
|
// enter commands either in interactive command line mode or through macros to
|
|
// control the G4GeneralParticleSource.
|
|
|
|
// Author: Fan Lei, QinetiQ ltd.
|
|
// Customer: ESA/ESTEC
|
|
// History:
|
|
// - Version 2.0, 05/02/2004, Fan Lei - Created.
|
|
// Multiple particle source definition
|
|
// - Version 2.1, 20/03/2014, Andrew Green - Modifications for MT
|
|
// Added a check to force only one thread to parse the macro file.
|
|
// This information is fed into the GPS which now has a split mechanism
|
|
// for the large data (hence need to only read in 1 thread)
|
|
// - Version 3.0, Aug-Oct 2014, Andrea Dotti
|
|
// Transformations for thread safety and use in MT application
|
|
// Messenger is now a singleton w/ explicit Destroy() method for deletion
|
|
// Note the following: the class should be instantiated only once
|
|
// by a worker thread. It relies on a new feature of basic messenger class
|
|
// that allows for UI commands to be created by worker threads but being
|
|
// executed by master thread. For this reason the messenger itself should
|
|
// be created once, form here the singleton pattern
|
|
// --------------------------------------------------------------------
|
|
#ifndef G4GeneralParticleSourceMessenger_hh
|
|
#define G4GeneralParticleSourceMessenger_hh 1
|
|
|
|
#include "G4UImessenger.hh"
|
|
#include "globals.hh"
|
|
|
|
class G4ParticleTable;
|
|
class G4UIcommand;
|
|
class G4UIdirectory;
|
|
class G4UIcmdWithoutParameter;
|
|
class G4UIcmdWithAString;
|
|
class G4UIcmdWithADoubleAndUnit;
|
|
class G4UIcmdWith3Vector;
|
|
class G4UIcmdWith3VectorAndUnit;
|
|
class G4UIcmdWithAnInteger;
|
|
class G4UIcmdWithADouble;
|
|
class G4UIcmdWithABool;
|
|
class G4UIcmdWithoutParameter;
|
|
|
|
class G4SingleParticleSource;
|
|
class G4GeneralParticleSource;
|
|
|
|
class G4GeneralParticleSourceMessenger: public G4UImessenger
|
|
{
|
|
public:
|
|
|
|
void SetParticleGun(G4SingleParticleSource *fpg) { fParticleGun = fpg; } ;
|
|
// Select the particle gun to be defined/modified
|
|
|
|
void SetNewValue(G4UIcommand* command, G4String newValues) override;
|
|
// Identifies the command which has been invoked by the user, extracts the
|
|
// parameters associated with that command (held in newValues), and uses
|
|
// these values with the appropriate member function of
|
|
// G4GeneralParticleSource
|
|
|
|
G4String GetCurrentValue(G4UIcommand* command) override;
|
|
// Allows the user to retrieve the current values of parameters.
|
|
// NOT yet implemented!
|
|
|
|
static G4GeneralParticleSourceMessenger* GetInstance(G4GeneralParticleSource*);
|
|
static void Destroy();
|
|
|
|
private:
|
|
|
|
explicit G4GeneralParticleSourceMessenger(G4GeneralParticleSource*);
|
|
// Constructor: sets up commands
|
|
~G4GeneralParticleSourceMessenger() override;
|
|
// Destructor: deletes commands
|
|
|
|
void IonCommand(const G4String& newValues);
|
|
void IonLvlCommand(const G4String& newValues);
|
|
|
|
private:
|
|
|
|
G4GeneralParticleSource* fGPS = nullptr;
|
|
G4SingleParticleSource* fParticleGun = nullptr;
|
|
G4ParticleTable* particleTable = nullptr;
|
|
G4String histtype;
|
|
|
|
G4UIdirectory* gpsDirectory;
|
|
|
|
// Multiple source control commands
|
|
//
|
|
G4UIdirectory *sourceDirectory;
|
|
G4UIcmdWithADouble *addsourceCmd;
|
|
G4UIcmdWithoutParameter *listsourceCmd;
|
|
G4UIcmdWithoutParameter *clearsourceCmd;
|
|
G4UIcmdWithoutParameter *getsourceCmd;
|
|
G4UIcmdWithAnInteger *setsourceCmd;
|
|
G4UIcmdWithADouble *setintensityCmd;
|
|
G4UIcmdWithAnInteger *deletesourceCmd;
|
|
G4UIcmdWithABool *multiplevertexCmd;
|
|
G4UIcmdWithABool *flatsamplingCmd;
|
|
|
|
// Positional commands
|
|
//
|
|
G4UIdirectory *positionDirectory;
|
|
G4UIcmdWithAString *typeCmd1;
|
|
G4UIcmdWithAString *shapeCmd1;
|
|
G4UIcmdWith3VectorAndUnit *centreCmd1;
|
|
G4UIcmdWith3Vector *posrot1Cmd1;
|
|
G4UIcmdWith3Vector *posrot2Cmd1;
|
|
G4UIcmdWithADoubleAndUnit *halfxCmd1;
|
|
G4UIcmdWithADoubleAndUnit *halfyCmd1;
|
|
G4UIcmdWithADoubleAndUnit *halfzCmd1;
|
|
G4UIcmdWithADoubleAndUnit *radiusCmd1;
|
|
G4UIcmdWithADoubleAndUnit *radius0Cmd1;
|
|
G4UIcmdWithADoubleAndUnit *possigmarCmd1;
|
|
G4UIcmdWithADoubleAndUnit *possigmaxCmd1;
|
|
G4UIcmdWithADoubleAndUnit *possigmayCmd1;
|
|
G4UIcmdWithADoubleAndUnit *paralpCmd1;
|
|
G4UIcmdWithADoubleAndUnit *partheCmd1;
|
|
G4UIcmdWithADoubleAndUnit *parphiCmd1;
|
|
G4UIcmdWithAString *confineCmd1;
|
|
|
|
// Angular commands
|
|
//
|
|
G4UIdirectory* angularDirectory;
|
|
G4UIcmdWithAString *angtypeCmd1;
|
|
G4UIcmdWith3Vector *angrot1Cmd1;
|
|
G4UIcmdWith3Vector *angrot2Cmd1;
|
|
G4UIcmdWithADoubleAndUnit *minthetaCmd1;
|
|
G4UIcmdWithADoubleAndUnit *maxthetaCmd1;
|
|
G4UIcmdWithADoubleAndUnit *minphiCmd1;
|
|
G4UIcmdWithADoubleAndUnit *maxphiCmd1;
|
|
G4UIcmdWithADoubleAndUnit *angsigmarCmd1;
|
|
G4UIcmdWithADoubleAndUnit *angsigmaxCmd1;
|
|
G4UIcmdWithADoubleAndUnit *angsigmayCmd1;
|
|
G4UIcmdWith3VectorAndUnit *angfocusCmd;
|
|
G4UIcmdWithABool *useuserangaxisCmd1;
|
|
G4UIcmdWithABool *surfnormCmd1;
|
|
|
|
// Energy commands
|
|
//
|
|
G4UIdirectory* energyDirectory;
|
|
G4UIcmdWithAString *energytypeCmd1;
|
|
G4UIcmdWithADoubleAndUnit *eminCmd1;
|
|
G4UIcmdWithADoubleAndUnit *emaxCmd1;
|
|
G4UIcmdWithADoubleAndUnit *monoenergyCmd1;
|
|
G4UIcmdWithADoubleAndUnit *engsigmaCmd1;
|
|
G4UIcmdWithADouble *alphaCmd1;
|
|
G4UIcmdWithADouble *tempCmd1;
|
|
G4UIcmdWithADouble *ezeroCmd1;
|
|
G4UIcmdWithADouble *gradientCmd1;
|
|
G4UIcmdWithADouble *interceptCmd1;
|
|
G4UIcmdWithADouble *arbeintCmd1;
|
|
G4UIcmdWithoutParameter *calculateCmd1;
|
|
G4UIcmdWithABool *energyspecCmd1;
|
|
G4UIcmdWithABool *diffspecCmd1;
|
|
G4UIcmdWithABool *applyEnergyWeightCmd1;
|
|
|
|
// Histogram commands
|
|
//
|
|
G4UIdirectory *histDirectory;
|
|
G4UIcmdWith3Vector *histpointCmd1;
|
|
G4UIcmdWithAString *histfileCmd1;
|
|
G4UIcmdWithAString *histnameCmd1;
|
|
G4UIcmdWithAString *arbintCmd1;
|
|
G4UIcmdWithAString *resethistCmd1;
|
|
|
|
G4UIcmdWithAnInteger* verbosityCmd;
|
|
G4UIcmdWithABool* volChkCmd;
|
|
|
|
// Commands from G4ParticleGun
|
|
//
|
|
G4UIcommand* ionCmd;
|
|
G4UIcommand* ionLvlCmd;
|
|
G4UIcmdWithAString* particleCmd;
|
|
G4UIcmdWithADoubleAndUnit* timeCmd;
|
|
G4UIcmdWith3Vector* polCmd;
|
|
G4UIcmdWithAnInteger* numberCmd;
|
|
G4UIcmdWith3VectorAndUnit* positionCmd;
|
|
G4UIcmdWith3Vector* directionCmd;
|
|
G4UIcmdWithADoubleAndUnit* energyCmd;
|
|
G4UIcmdWithoutParameter* listCmd;
|
|
|
|
// For ion shooting
|
|
//
|
|
G4bool fShootIon = false;
|
|
|
|
G4int fAtomicNumber = 0;
|
|
G4int fAtomicMass = 0;
|
|
G4int fIonCharge = 0;
|
|
G4double fIonExciteEnergy = 0.0;
|
|
|
|
G4int fAtomicNumberL = 0;
|
|
G4int fAtomicMassL = 0;
|
|
G4int fIonChargeL = 0;
|
|
G4int fIonEnergyLevel = 0;
|
|
|
|
/** Andrea Dotti Feb 2015
|
|
* GPS messenger design requires some explanation for what distributions
|
|
* parameters are concerned : Each thread has its own GPS
|
|
* since primary generation is a user action.
|
|
* However to save memory the underlying structures that provide the
|
|
* GPS functionalities ( the G4SPS*Distribution classes and the
|
|
* G4SPSRandomGenerator class)
|
|
* are shared among threads. This implies that modifying parameters of sources
|
|
* requires some attention:
|
|
* 1- Only one thread should change source parameters.
|
|
* 2- Changing of parameters can happen only between runs, when is guaranteed
|
|
* that no thread is accessing them
|
|
* 2- UI commands require that even if messenger is instantiated in a thread
|
|
* the commands are executed in the master (this is possible since V10.1)
|
|
* The simplest solution is to use UI commands to change GPS parameters and
|
|
* avoid C++ APIs. If this is inevitable a simple solution is to instantiate
|
|
* an instance of G4GeneralParticleSource explicitly in the master thread
|
|
* (for example in G4VUserActionInitialization::BuildForMaster() and set the
|
|
* defaults parameter there).
|
|
*/
|
|
|
|
};
|
|
|
|
#endif
|