element.h

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) BDSIM Collaboration, 2001 - 2026.
 
This file is part of BDSIM.
 
BDSIM 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 version 3 of the License.
 
BDSIM is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with BDSIM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef ELEMENT_H
#define ELEMENT_H
 
#include <exception>
#include <iomanip>
#include <iostream>
#include <list>
#include <map>
#include <sstream>
#include <string>
#if __cplusplus >= 201703L
#include <variant>
#endif
 
#include "published.h"
 
namespace GMAD
{
  enum class ElementType;
 
  struct Parameters;
 
  struct Element: public Published<Element>
  {
    ElementType type; 
    std::string name;
    std::string userTypeName; 
    std::string userParameters; 
 
    double l; 
    double scaling; 
    double scalingFieldOuter; 
    double ks; 
    // double k0; // for dipole field B or angle is used
    double k1; 
    double k2; 
    double k3; 
    double k4; 
    double angle; 
    double B; 
    double e1; 
    double e2; 
    double fint; 
    double fintx;  
    double fintK2; 
    double fintxK2;
    double hgap;   
    double h1; 
    double h2; 
    double kick;   
    double hkick;  
    double vkick;  
    std::list<double> knl; 
    std::list<double> ksl; 
    double gradient;  
    double E;         
    double frequency; 
    double phase;     
    double tOffset;   
    std::string fieldModulator;
    double kg; 
 
    double kick1;
    double kick2;
    double kick3;
    double kick4;
    double rmat11;
    double rmat12;
    double rmat13;
    double rmat14;
    double rmat21;
    double rmat22;
    double rmat23;
    double rmat24;
    double rmat31;
    double rmat32;
    double rmat33;
    double rmat34;
    double rmat41;
    double rmat42;
    double rmat43;
    double rmat44;
 
 
    double beampipeThickness;
    double aper1;
    double aper2;
    double aper3;
    double aper4;
    std::string apertureType;
    std::string beampipeMaterial;
    std::string vacuumMaterial;
  
    // magnet geometry
    std::string magnetGeometryType;
    double horizontalWidth; // formerly outerDiameter
    bool   yokeOnInside;
    int    hStyle;  
    double vhRatio; 
    double coilWidthFraction; 
    double coilHeightFraction; 
    double tilt;    
    double xsize, ysize; 
    double xsizeOut, ysizeOut; 
    double xsizeLeft, xsizeRight; 
    double jawTiltLeft, jawTiltRight; 
    double offsetX; 
    double offsetY; 
 
    // PWFA
    double xsize2, ysize2; 
    double offsetX2, offsetY2; 
    double tilt2; 
    std::string outerShape; 
 
    // screen parameters
    double tscint; 
    double twindow; 
    double tmount; 
    double windowScreenGap; 
    double screenXSize, screenYSize; 
    std::list<double>      layerThicknesses;
    std::list<std::string> layerMaterials;
    std::list<int>         layerIsSampler;
    
    double screenPSize; 
    double screenEndZ;
    double poleStartZ;
    double screenWidth;
    double awakeMagnetOffsetX;
    std::string windowmaterial;
    std::string scintmaterial;
    std::string mountmaterial;
 
    double xdir;
    double ydir;
    double zdir;
    double wavelength; 
    double phi, theta, psi; 
    double axisX, axisY, axisZ;
    bool   axisAngle;
 
    int    numberWedges;
    double wedgeLength;
    double degraderHeight;
    double materialThickness;
    double degraderOffset;
 
    std::string laserBeam;
    double laserOffsetTheta;
    double laserOffsetPhi;
    double laserOffsetX;
    double laserOffsetY;
    double laserOffsetZ;
 
    double wireDiameter;
    double wireLength;
    double wireOffsetX;
    double wireOffsetY;
    double wireOffsetZ;
    double wireAngle;
    
    double undulatorPeriod;
    double undulatorGap;
    double undulatorMagnetHeight;
 
    double anodeLength;
    double anodeRadius;
    double anodeThickness;
    double electrodeLength;
    double electrodeRadius;
    double electrodeThickness;
 
 
    double tipThickness; 
    std::string tipMaterial; 
 
    std::string bias;
    std::string biasMaterial;
    std::string biasVacuum;
    std::string biasMaterialLV;
    std::list<std::string> biasMaterialList;
    std::list<std::string> biasVacuumList;
    std::list<std::string> biasMaterialLVList;
 
    double minimumKineticEnergy;
 
    std::string samplerName;      
    std::string samplerType;      
    double samplerRadius;         
    int    samplerParticleSetID;
    
    std::string region;      
    std::string fieldOuter;  
    std::string fieldVacuum; 
    std::string fieldAll;    
    
    std::string geometryFile;     
    bool        stripOuterVolume; 
    bool        autoColour;       
 
    bool        elementLengthIsArcLength; 
 
    std::string material;
    std::string namedVacuumVolumes; 
    bool        markAsCollimator;
    std::string spec;            
    std::string cavityModel;     
    std::string cavityFieldType; 
 
    std::string dicomDataPath; 
    std::string dicomDataFile; 
 
    std::string colour;
 
    std::string crystalLeft;
    std::string crystalRight;
    std::string crystalBoth;
    double      crystalAngleYAxisLeft;
    double      crystalAngleYAxisRight;
 
    std::string coolingDefinition;
 
    bool   angleSet;
 
    bool   scalingFieldOuterSet;
 
    std::list<Element>* lst;
 
    void print(int ident=0) const;
 
    void flush();
 
    bool isSpecial() const;
    double property_lookup(std::string property_name) const;
 
    void setSamplerInfo(std::string samplerType,
                        std::string samplerName,
                        double samplerRadius,
                        int samplerParticleSetIDIn = -1);
 
    void set(const Parameters& params);
    void set(const Parameters& params,std::string nameIn, ElementType typeIn);
    template <typename T>
    void set_value(std::string property, T value, bool exceptionSafe = true);
    void set_value_array(const std::string& property, Array* value, bool bExit = true); // TODO keep separate as template calling order
#if __cplusplus >= 201703L
    std::list<std::variant<bool, int, double, std::string>> get_value_array(const std::string &);
#endif
    Element();
 
  private:
    void PublishMembers();
    std::map<std::string,std::string> alternativeNames;
 
 
  protected:
    std::string getPublishedName(const std::string& name) const;
 
    std::map<std::string, std::list<int>*> attribute_map_list_int;
    std::map<std::string, std::list<double>*> attribute_map_list_double;
    std::map<std::string, std::list<std::string>*> attribute_map_list_string;
  };
 
  template <typename T>
  void Element::set_value(std::string property, T value, bool exceptionSafe)
  {
#ifdef BDSDEBUG
    std::cout << "element> Setting value " << std::setw(25) << std::left << property << value << std::endl;
#endif
    // member method can throw runtime_error, catch and exit gracefully
    try
      {Published<Element>::set(this, property, value);}
    catch(const std::runtime_error&)
      {
        std::stringstream ss;
        ss << "Error: element> unknown property \"" << property
           << "\" with value \"" << value << "\" in definition \"" << this->name << "\"";
        if (!exceptionSafe)
          {throw std::invalid_argument(ss.str());}
        else
          {std::cerr << ss.str() << std::endl;}
      }
  }
}
 
#endif