TrackRun.h

Go to the documentation of this file.

//
// Class TrackRun
//   The RUN command.
//
// Copyright (c) 200x - 2022, 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_TrackRun_HH
#define OPAL_TrackRun_HH
 
#include "OPALTypes.h"
 
#include "AbstractObjects/Action.h"
#include "Distribution/SamplingBase.hpp"
#include "PartBunch/PartBunch.h"
 
#include "Structure/FieldSolverCmd.h"
 
#include "Utilities/BiMap.h"
 
#include <memory>
#include <string>
#include <vector>
 
class Beam;
class OpalData;
class DataSink;
class Distribution;
class EmissionSource;
class GlobalProcess;
class H5PartWrapper;
class Inform;
class Tracker;
 
class TrackRun : public Action {
    using emittingSamplers_t = std::vector<std::shared_ptr<SamplingBase>>;
 
public:
    TrackRun();
 
    virtual ~TrackRun();
 
    virtual TrackRun* clone(const std::string& name);
 
    virtual void execute();
 
    // Bring base class print into scope to avoid hiding warning
    using Object::print;
 
    Inform& print(Inform& os) const;
 
private:
    enum class RunMethod : unsigned short { NONE, PARALLEL };
 
    // Not implemented.
    TrackRun(const TrackRun&);
    void operator=(const TrackRun&);
 
    // Clone constructor.
    TrackRun(const std::string& name, TrackRun* parent);
 
    void setRunMethod();
    std::string getRunMethodName() const;
 
    void initDataSink(size_t numParticleContainers);
    std::vector<H5PartWrapper*> borrowedPhaseSpaceSinks() const;
 
    void setupBoundaryGeometry();
 
    void setupGlobalProcesses(
            std::vector<std::vector<std::unique_ptr<GlobalProcess>>> globalProcessesLists);
 
    void wireDaughterContainers(const std::vector<Beam*>& beams);
 
    void setupDistributionsAndSamplers(
            const std::vector<EmissionSource*>& sources, Beam* beam,
            emittingSamplers_t& emittingSamplers, size_t index = 0);
 
    void configureImageChargeFromSources(
            const std::vector<std::vector<EmissionSource*>>& emissionSourcesLists);
 
    size_t computeTotalAllocationForBunch(
            Beam* beam, const std::vector<EmissionSource*>& sources) const;
 
    std::unique_ptr<Tracker> itsTracker_m;
 
    std::vector<Distribution*> distrs_m;
 
    // std::vector<std::shared_ptr<SamplingBase>> emittingSamplers_m;
 
    FieldSolverCmd* fs_m;
 
    DataSink* ds_m;
 
    std::vector<std::unique_ptr<H5PartWrapper>> phaseSpaceSinks_m;
 
    OpalData* opal_m;
 
    /*
 
      this is the ippl bunch
    */
 
    using bunch_type = PartBunch_t;
    std::unique_ptr<bunch_type> bunch_m;
 
    bool isFollowupTrack_m;
 
    RunMethod method_m;
    static const BiMap<RunMethod, std::string> stringMethod_s;
};
 
inline Inform& operator<<(Inform& os, const TrackRun& b) { return b.print(os); }
 
#endif  // OPAL_TrackRun_HH