Beam.h

Go to the documentation of this file.

//
// Class Beam
//   The class for the OPAL BEAM command.
//   A BEAM definition is used by most physics commands to define the
//   particle charge and the reference momentum, together with some other data.
//
// Copyright (c) 200x - 2021, Paul Scherrer Institut, Villigen PSI, Switzerland
// All rights reserved
//
// This file is part of OPAL.
//
// OPAL is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// You should have received a copy of the GNU General Public License
// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
//
#ifndef OPAL_Beam_HH
#define OPAL_Beam_HH
 
#include "AbstractObjects/Definition.h"
#include "Algorithms/PartData.h"
 
#include <ostream>
#include <string>
#include <vector>
 
class Inform;
 
class Beam : public Definition {
public:
    Beam();
 
    virtual ~Beam();
 
    //  Can replace only by another BEAM.
    virtual bool canReplaceBy(Object* object);
 
    virtual Beam* clone(const std::string& name);
 
    virtual void execute();
 
    static Beam* find(const std::string& name);
 
    size_t getNumAlloc() const;
 
    const PartData& getReference() const;
 
    double getCurrent() const;
 
    double getBunchCharge() const;
 
    double getCharge() const;
 
    double getFrequency() const;
 
    std::string getParticleName() const;
 
    bool isPhoton() const;
 
    double getMass() const;
 
    // Returns Momentum in GeV/c
    double getMomentum() const;
 
    double getChargePerParticle() const;
 
    double getMassPerParticle() const;
 
    std::string getEmissionSourceListName() const;
 
    std::vector<std::string> getGlobalProcessNames() const;
 
    std::string getDaughterBeamName() const;
 
    std::vector<double> getPolarization() const;
 
    bool hasPolarization() const;
 
    bool hasExplicitEnergy() const;
 
    virtual void update();
 
    void print(std::ostream& os) const;
 
private:
    // Not implemented.
    Beam(const Beam&);
    void operator=(const Beam&);
 
    // Clone constructor.
    Beam(const std::string& name, Beam* parent);
 
    // Validate the POLARIZATION attribute (length, magnitude, muon-only).
    void validatePolarization() const;
 
    // The particle reference data.
    PartData reference;
 
    // The converstion from GeV to eV.
    static const double energy_scale;
};
 
inline std::ostream& operator<<(std::ostream& os, const Beam& b) {
    b.print(os);
    return os;
}
 
#endif  // OPAL_Beam_HH