OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
_FM1DProfile1 Class Reference

#include <FM1DProfile1.h>

Inheritance diagram for _FM1DProfile1:
Collaboration diagram for _FM1DProfile1:

Public Member Functions

virtual ~_FM1DProfile1 ()
virtual bool getFieldDerivative (const Vector_t &X, Vector_t &E, Vector_t &B, const DiffDirection &dir) const
virtual void get1DProfile1EntranceParam (double &entranceParameter1, double &entranceParameter2, double &entranceParameter3)
virtual void get1DProfile1ExitParam (double &exitParameter1, double &exitParameter2, double &exitParameter3)
virtual double getFieldGap ()
virtual void getFieldDimensions (double &zBegin, double &zEnd) const
virtual void getFieldDimensions (double &xIni, double &xFinal, double &yIni, double &yFinal, double &zIni, double &zFinal) const
virtual bool getFieldstrength (const Vector_t &X, Vector_t &strength, Vector_t &info) const
virtual double getFrequency () const
virtual void getInfo (Inform *)
virtual void setFrequency (double freq)
virtual void get1DProfile1EngeCoeffs (std::vector< double > &engeCoeffsEntry, std::vector< double > &engeCoeffsExit)
virtual void swap ()
virtual void setFieldGap (double gap)
virtual void setEdgeConstants (const double &bendAngle, const double &entranceAngle, const double &exitAngle)
virtual void setFieldLength (const double &)
MapType getType ()
virtual void getOnaxisEz (std::vector< std::pair< double, double > > &onaxis)
virtual bool isInside (const Vector_t &) const
template<class T>
bool interpretLine (std::ifstream &in, T &value, const bool &file_length_known)

Static Public Member Functions

static Fieldmap getFieldmap (std::string Filename, bool fast=false)
static std::vector< std::string > getListFieldmapNames ()
static void deleteFieldmap (std::string Filename)
static void clearDictionary ()
static MapType readHeader (std::string Filename)
static void readMap (std::string Filename)
static void freeMap (std::string Filename)
static std::string typeset_msg (const std::string &msg, const std::string &title)

Protected Member Functions

void getLine (std::ifstream &in, std::string &buffer)
template<class S>
bool interpretLine (std::ifstream &in, S &value, const bool &file_length_known=true)
template<class S, class T>
bool interpretLine (std::ifstream &in, S &value1, T &value2, const bool &file_length_known=true)
template<class S, class T, class U>
bool interpretLine (std::ifstream &in, S &value1, T &value2, U &value3, const bool &file_length_known=true)
template<class S, class T, class U, class V>
bool interpretLine (std::ifstream &in, S &value1, T &value2, U &value3, V &value4, const bool &file_length_known=true)
template<class S>
bool interpretLine (std::ifstream &in, S &value1, S &value2, S &value3, S &value4, S &value5, S &value6, const bool &file_length_known=true)
bool interpreteEOF (std::ifstream &in)
void interpretWarning (const std::ios_base::iostate &state, const bool &read_all, const std::string &error_msg, const std::string &found)
void missingValuesWarning ()
void exceedingValuesWarning ()
void disableFieldmapWarning ()
void noFieldmapWarning ()
void lowResolutionWarning (double squareError, double maxError)
void checkMap (unsigned int accuracy, std::pair< double, double > fieldDimensions, double deltaZ, const std::vector< double > &fourierCoefficients, gsl_spline *splineCoefficients, gsl_interp_accel *splineAccelerator)
void checkMap (unsigned int accuracy, double length, const std::vector< double > &zSampling, const std::vector< double > &fourierCoefficients, gsl_spline *splineCoefficients, gsl_interp_accel *splineAccelerator)
void write3DField (unsigned int nx, unsigned int ny, unsigned int nz, const std::pair< double, double > &xrange, const std::pair< double, double > &yrange, const std::pair< double, double > &zrange, const std::vector< Vector_t > &ef, const std::vector< Vector_t > &bf)

Static Protected Member Functions

static void getLine (std::ifstream &in, int &lines_read, std::string &buffer)

Protected Attributes

MapType Type
std::string Filename_m
int lines_read_m
bool normalize_m

Private Member Functions

 _FM1DProfile1 (const std::string &filename)
 Constructor with field map file name.
virtual void freeMap ()
virtual void readMap ()
double computeEntranceFringe (double z) const
double computeExitFringe (double z) const
double computeFringe (const std::vector< double > &coefs, double z) const

Static Private Member Functions

static FM1DProfile1 create (const std::string &filename)

Private Attributes

double entranceParameter1_m
double entranceParameter2_m
double entranceParameter3_m
double exitParameter1_m
double exitParameter2_m
double exitParameter3_m
std::vector< double > engeCoeffsEntry_m
 Enge coefficients for map entry and exit regions.
std::vector< double > engeCoeffsExit_m
int polyOrderEntry_m
int polyOrderExit_m
 Enge function order for entry region.
double gapHeight_m
 Enge function order for entry region.
double sBegin_m
 Full gap height of field map.
double sEnd_m
 Start of field map in s coordinates (m).

Static Private Attributes

static char buffer_m [256]
static std::string alpha_numeric
static std::map< std::string, FieldmapDescription > FieldmapDictionary = std::map<std::string, _Fieldmap::FieldmapDescription>()

Friends

class _Fieldmap
 End of field map in s coordinates (m).

Detailed Description

Definition at line 14 of file FM1DProfile1.h.

Constructor & Destructor Documentation

◆ ~_FM1DProfile1()

_FM1DProfile1::~_FM1DProfile1 ( )
virtual

Definition at line 126 of file FM1DProfile1.cpp.

◆ _FM1DProfile1()

_FM1DProfile1::_FM1DProfile1 ( const std::string & filename)
private

Constructor with field map file name.

Definition at line 10 of file FM1DProfile1.cpp.

References _Fieldmap, Units::cm2m, _Fieldmap::disableFieldmapWarning(), entranceParameter1_m, entranceParameter2_m, entranceParameter3_m, exitParameter1_m, exitParameter2_m, exitParameter3_m, _Fieldmap::Filename_m, gapHeight_m, _Fieldmap::interpreteEOF(), _Fieldmap::interpretLine(), _Fieldmap::noFieldmapWarning(), polyOrderEntry_m, polyOrderExit_m, sBegin_m, sEnd_m, T1DProfile1, and _Fieldmap::Type.

Referenced by create().

Here is the call graph for this function:

Member Function Documentation

◆ checkMap() [1/2]

void _Fieldmap::checkMap ( unsigned int accuracy,
double length,
const std::vector< double > & zSampling,
const std::vector< double > & fourierCoefficients,
gsl_spline * splineCoefficients,
gsl_interp_accel * splineAccelerator )
protectedinherited

Definition at line 464 of file Fieldmap.cpp.

References Util::combineFilePath(), end(), Filename_m, OpalData::getInstance(), lowResolutionWarning(), IpplInfo::myNode(), and Physics::two_pi.

Here is the call graph for this function:

◆ checkMap() [2/2]

void _Fieldmap::checkMap ( unsigned int accuracy,
std::pair< double, double > fieldDimensions,
double deltaZ,
const std::vector< double > & fourierCoefficients,
gsl_spline * splineCoefficients,
gsl_interp_accel * splineAccelerator )
protectedinherited

Definition at line 448 of file Fieldmap.cpp.

References checkMap().

Referenced by checkMap(), _FM1DDynamic_fast::prepareForMapCheck(), _FM1DElectroStatic_fast::prepareForMapCheck(), _FM1DMagnetoStatic_fast::prepareForMapCheck(), _Astra1DDynamic_fast::readMap(), _Astra1DElectroStatic_fast::readMap(), and _Astra1DMagnetoStatic_fast::readMap().

Here is the call graph for this function:

◆ clearDictionary()

void _Fieldmap::clearDictionary ( )
staticinherited

Definition at line 274 of file Fieldmap.cpp.

References FieldmapDictionary.

Referenced by opalMain(), and run_opal().

◆ computeEntranceFringe()

double _FM1DProfile1::computeEntranceFringe ( double z) const
private

Definition at line 296 of file FM1DProfile1.cpp.

References computeFringe(), engeCoeffsEntry_m, and gapHeight_m.

Referenced by readMap().

Here is the call graph for this function:

◆ computeExitFringe()

double _FM1DProfile1::computeExitFringe ( double z) const
private

Definition at line 300 of file FM1DProfile1.cpp.

References computeFringe(), engeCoeffsExit_m, and gapHeight_m.

Referenced by readMap().

Here is the call graph for this function:

◆ computeFringe()

double _FM1DProfile1::computeFringe ( const std::vector< double > & coefs,
double z ) const
private

Definition at line 304 of file FM1DProfile1.cpp.

References exp().

Referenced by computeEntranceFringe(), and computeExitFringe().

Here is the call graph for this function:

◆ create()

FM1DProfile1 _FM1DProfile1::create ( const std::string & filename)
staticprivate

Definition at line 129 of file FM1DProfile1.cpp.

References _FM1DProfile1().

Referenced by _Fieldmap::getFieldmap().

Here is the call graph for this function:

◆ deleteFieldmap()

void _Fieldmap::deleteFieldmap ( std::string Filename)
staticinherited

Definition at line 270 of file Fieldmap.cpp.

References freeMap().

Here is the call graph for this function:

◆ disableFieldmapWarning()

void _Fieldmap::disableFieldmapWarning ( )
protectedinherited

Definition at line 610 of file Fieldmap.cpp.

References Filename_m.

Referenced by _Astra1DDynamic::_Astra1DDynamic(), _Astra1DDynamic_fast::_Astra1DDynamic_fast(), _Astra1DElectroStatic::_Astra1DElectroStatic(), _Astra1DElectroStatic_fast::_Astra1DElectroStatic_fast(), _Astra1DMagnetoStatic::_Astra1DMagnetoStatic(), _Astra1DMagnetoStatic_fast::_Astra1DMagnetoStatic_fast(), _FM1DDynamic::_FM1DDynamic(), _FM1DDynamic_fast::_FM1DDynamic_fast(), _FM1DElectroStatic::_FM1DElectroStatic(), _FM1DElectroStatic_fast::_FM1DElectroStatic_fast(), _FM1DMagnetoStatic::_FM1DMagnetoStatic(), _FM1DMagnetoStatic_fast::_FM1DMagnetoStatic_fast(), _FM1DProfile1::_FM1DProfile1(), _FM1DProfile2::_FM1DProfile2(), _FM2DDynamic::_FM2DDynamic(), _FM2DElectroStatic::_FM2DElectroStatic(), _FM2DMagnetoStatic::_FM2DMagnetoStatic(), _FM3DDynamic::_FM3DDynamic(), and _FM3DMagnetoStaticExtended::_FM3DMagnetoStaticExtended().

◆ exceedingValuesWarning()

void _Fieldmap::exceedingValuesWarning ( )
protectedinherited

Definition at line 600 of file Fieldmap.cpp.

References Filename_m, and lines_read_m.

Referenced by interpreteEOF().

◆ freeMap() [1/2]

void _Fieldmap::freeMap ( std::string Filename)
staticinherited

Definition at line 431 of file Fieldmap.cpp.

References FieldmapDictionary.

◆ freeMap() [2/2]

void _FM1DProfile1::freeMap ( )
privatevirtual

Implements _Fieldmap.

Definition at line 214 of file FM1DProfile1.cpp.

◆ get1DProfile1EngeCoeffs()

void _FM1DProfile1::get1DProfile1EngeCoeffs ( std::vector< double > & engeCoeffsEntry,
std::vector< double > & engeCoeffsExit )
virtual

Reimplemented from _Fieldmap.

Definition at line 264 of file FM1DProfile1.cpp.

References engeCoeffsEntry_m, and engeCoeffsExit_m.

◆ get1DProfile1EntranceParam()

void _FM1DProfile1::get1DProfile1EntranceParam ( double & entranceParameter1,
double & entranceParameter2,
double & entranceParameter3 )
virtual

Reimplemented from _Fieldmap.

Definition at line 271 of file FM1DProfile1.cpp.

References entranceParameter1_m, entranceParameter2_m, and entranceParameter3_m.

◆ get1DProfile1ExitParam()

void _FM1DProfile1::get1DProfile1ExitParam ( double & exitParameter1,
double & exitParameter2,
double & exitParameter3 )
virtual

Reimplemented from _Fieldmap.

Definition at line 279 of file FM1DProfile1.cpp.

References exitParameter1_m, exitParameter2_m, and exitParameter3_m.

◆ getFieldDerivative()

bool _FM1DProfile1::getFieldDerivative ( const Vector_t & X,
Vector_t & E,
Vector_t & B,
const DiffDirection & dir ) const
virtual

Implements _Fieldmap.

Definition at line 227 of file FM1DProfile1.cpp.

◆ getFieldDimensions() [1/2]

void _FM1DProfile1::getFieldDimensions ( double & xIni,
double & xFinal,
double & yIni,
double & yFinal,
double & zIni,
double & zFinal ) const
virtual

Implements _Fieldmap.

Definition at line 239 of file FM1DProfile1.cpp.

◆ getFieldDimensions() [2/2]

void _FM1DProfile1::getFieldDimensions ( double & zBegin,
double & zEnd ) const
virtual

Implements _Fieldmap.

Definition at line 234 of file FM1DProfile1.cpp.

References sBegin_m, and sEnd_m.

◆ getFieldGap()

double _FM1DProfile1::getFieldGap ( )
virtual

Reimplemented from _Fieldmap.

Definition at line 287 of file FM1DProfile1.cpp.

References gapHeight_m.

◆ getFieldmap()

Fieldmap _Fieldmap::getFieldmap ( std::string Filename,
bool fast = false )
staticinherited

Definition at line 48 of file Fieldmap.cpp.

References _Astra1DDynamic::create(), _Astra1DDynamic_fast::create(), _Astra1DElectroStatic::create(), _Astra1DElectroStatic_fast::create(), _Astra1DMagnetoStatic::create(), _Astra1DMagnetoStatic_fast::create(), _FM1DDynamic::create(), _FM1DDynamic_fast::create(), _FM1DElectroStatic::create(), _FM1DElectroStatic_fast::create(), _FM1DMagnetoStatic::create(), _FM1DMagnetoStatic_fast::create(), _FM1DProfile1::create(), _FM1DProfile2::create(), _FM2DDynamic::create(), _FM2DElectroStatic::create(), _FM2DMagnetoStatic::create(), _FM3DDynamic::create(), _FM3DH5Block::create(), _FM3DH5Block_nonscale::create(), _FM3DMagnetoStatic::create(), _FM3DMagnetoStaticExtended::create(), _FM3DMagnetoStaticH5Block::create(), FieldmapDictionary, readHeader(), T1DDynamic, T1DElectroStatic, T1DMagnetoStatic, T1DProfile1, T1DProfile2, T2DDynamic, T2DElectroStatic, T2DMagnetoStatic, T3DDynamic, T3DDynamicH5Block, T3DMagnetoStatic, T3DMagnetoStatic_Extended, T3DMagnetoStaticH5Block, TAstraDynamic, TAstraElectroStatic, and TAstraMagnetoStatic.

Referenced by Cyclotron::getFieldFromFile_BandRF(), Cyclotron::getFieldFromFile_Synchrocyclotron(), RBend3D::initialise(), RFCavity::initialise(), Solenoid::initialise(), and Bend2D::initializeFieldMap().

Here is the call graph for this function:

◆ getFieldstrength()

bool _FM1DProfile1::getFieldstrength ( const Vector_t & X,
Vector_t & strength,
Vector_t & info ) const
virtual

Implements _Fieldmap.

Definition at line 217 of file FM1DProfile1.cpp.

◆ getFrequency()

double _FM1DProfile1::getFrequency ( ) const
virtual

Implements _Fieldmap.

Definition at line 257 of file FM1DProfile1.cpp.

◆ getInfo()

void _FM1DProfile1::getInfo ( Inform * msg)
virtual

Implements _Fieldmap.

Definition at line 251 of file FM1DProfile1.cpp.

References endl(), and _Fieldmap::Filename_m.

Here is the call graph for this function:

◆ getLine() [1/2]

void _Fieldmap::getLine ( std::ifstream & in,
int & lines_read,
std::string & buffer )
staticprotectedinherited

Definition at line 533 of file Fieldmap.cpp.

References alpha_numeric, buffer_m, and READ_BUFFER_LENGTH.

◆ getLine() [2/2]

void _Fieldmap::getLine ( std::ifstream & in,
std::string & buffer )
inlineprotectedinherited

Definition at line 122 of file Fieldmap.h.

References getLine(), and lines_read_m.

Referenced by getLine(), interpretLine(), interpretLine(), interpretLine(), interpretLine(), interpretLine(), readHeader(), _Astra1DDynamic::readMap(), _Astra1DElectroStatic::readMap(), _Astra1DMagnetoStatic::readMap(), _FM2DDynamic::readMap(), _FM2DElectroStatic::readMap(), _FM2DMagnetoStatic::readMap(), _FM3DDynamic::readMap(), _FM3DMagnetoStatic::readMap(), _FM3DMagnetoStaticExtended::readMap(), _FM1DDynamic::stripFileHeader(), _FM1DDynamic_fast::stripFileHeader(), _FM1DElectroStatic::stripFileHeader(), _FM1DElectroStatic_fast::stripFileHeader(), _FM1DMagnetoStatic::stripFileHeader(), and _FM1DMagnetoStatic_fast::stripFileHeader().

Here is the call graph for this function:

◆ getListFieldmapNames()

std::vector< std::string > _Fieldmap::getListFieldmapNames ( )
staticinherited

Definition at line 262 of file Fieldmap.cpp.

References FieldmapDictionary.

◆ getOnaxisEz()

void _Fieldmap::getOnaxisEz ( std::vector< std::pair< double, double > > & onaxis)
virtualinherited

Reimplemented in _Astra1D_fast, _Astra1DDynamic, _Astra1DDynamic_fast, _FM1DDynamic, _FM1DDynamic_fast, _FM2DDynamic, _FM3DDynamic, and _FM3DH5BlockBase.

Definition at line 706 of file Fieldmap.cpp.

◆ getType()

MapType _Fieldmap::getType ( )
inlineinherited

Definition at line 98 of file Fieldmap.h.

References Type.

◆ interpreteEOF()

bool _Fieldmap::interpreteEOF ( std::ifstream & in)
protectedinherited

Definition at line 555 of file Fieldmap.cpp.

References alpha_numeric, buffer_m, exceedingValuesWarning(), lines_read_m, and READ_BUFFER_LENGTH.

Referenced by _FM1DProfile1::_FM1DProfile1(), _FM1DProfile2::_FM1DProfile2(), _FM2DDynamic::_FM2DDynamic(), _FM2DElectroStatic::_FM2DElectroStatic(), _FM2DMagnetoStatic::_FM2DMagnetoStatic(), _FM3DDynamic::_FM3DDynamic(), _FM3DMagnetoStatic::_FM3DMagnetoStatic(), _FM3DMagnetoStaticExtended::_FM3DMagnetoStaticExtended(), _FM1DDynamic::checkFileData(), _FM1DDynamic_fast::checkFileData(), _FM1DElectroStatic::checkFileData(), _FM1DElectroStatic_fast::checkFileData(), _FM1DMagnetoStatic::checkFileData(), and _FM1DMagnetoStatic_fast::checkFileData().

Here is the call graph for this function:

◆ interpretLine() [1/6]

template<class S>
bool _Fieldmap::interpretLine ( std::ifstream & in,
S & value,
const bool & file_length_known = true )
protectedinherited

Referenced by _Astra1DDynamic::_Astra1DDynamic(), _Astra1DElectroStatic::_Astra1DElectroStatic(), _Astra1DMagnetoStatic::_Astra1DMagnetoStatic(), _FM1DProfile1::_FM1DProfile1(), _FM1DProfile2::_FM1DProfile2(), _FM2DDynamic::_FM2DDynamic(), _FM2DElectroStatic::_FM2DElectroStatic(), _FM2DMagnetoStatic::_FM2DMagnetoStatic(), _FM3DDynamic::_FM3DDynamic(), _FM3DMagnetoStatic::_FM3DMagnetoStatic(), _FM3DMagnetoStaticExtended::_FM3DMagnetoStaticExtended(), _FM1DDynamic::checkFileData(), _FM1DDynamic_fast::checkFileData(), _FM1DElectroStatic::checkFileData(), _FM1DElectroStatic_fast::checkFileData(), _FM1DMagnetoStatic::checkFileData(), _FM1DMagnetoStatic_fast::checkFileData(), _Astra1D_fast::determineNumSamplingPoints(), _Astra1DDynamic::getOnaxisEz(), _Astra1DDynamic_fast::getOnaxisEz(), _Astra1D_fast::readFieldData(), _FM1DDynamic::readFileData(), _FM1DDynamic::readFileData(), _FM1DDynamic_fast::readFileData(), _FM1DDynamic_fast::readFileData(), _FM1DElectroStatic::readFileData(), _FM1DElectroStatic_fast::readFileData(), _FM1DMagnetoStatic::readFileData(), _FM1DMagnetoStatic_fast::readFileData(), _Astra1DDynamic_fast::readFileHeader(), _Astra1DElectroStatic_fast::readFileHeader(), _Astra1DMagnetoStatic_fast::readFileHeader(), _FM1DDynamic::readFileHeader(), _FM1DDynamic_fast::readFileHeader(), _FM1DElectroStatic::readFileHeader(), _FM1DElectroStatic_fast::readFileHeader(), _FM1DMagnetoStatic::readFileHeader(), _FM1DMagnetoStatic_fast::readFileHeader(), _Astra1DDynamic::readMap(), _Astra1DElectroStatic::readMap(), _Astra1DMagnetoStatic::readMap(), _FM1DProfile1::readMap(), _FM1DProfile2::readMap(), _FM2DDynamic::readMap(), _FM2DElectroStatic::readMap(), _FM2DMagnetoStatic::readMap(), _FM3DDynamic::readMap(), _FM3DMagnetoStatic::readMap(), _FM3DMagnetoStaticExtended::readMap(), _Astra1DDynamic_fast::stripFileHeader(), _Astra1DElectroStatic_fast::stripFileHeader(), and _Astra1DMagnetoStatic_fast::stripFileHeader().

◆ interpretLine() [2/6]

template<class S>
bool _Fieldmap::interpretLine ( std::ifstream & in,
S & value1,
S & value2,
S & value3,
S & value4,
S & value5,
S & value6,
const bool & file_length_known = true )
protectedinherited

Definition at line 141 of file Fieldmap.hpp.

References getLine(), interpretWarning(), and missingValuesWarning().

Here is the call graph for this function:

◆ interpretLine() [3/6]

template<class S, class T>
bool _Fieldmap::interpretLine ( std::ifstream & in,
S & value1,
T & value2,
const bool & file_length_known = true )
protectedinherited

Definition at line 39 of file Fieldmap.hpp.

References getLine(), interpretWarning(), and missingValuesWarning().

Here is the call graph for this function:

◆ interpretLine() [4/6]

template<class S, class T, class U>
bool _Fieldmap::interpretLine ( std::ifstream & in,
S & value1,
T & value2,
U & value3,
const bool & file_length_known = true )
protectedinherited

Definition at line 70 of file Fieldmap.hpp.

References getLine(), interpretWarning(), and missingValuesWarning().

Here is the call graph for this function:

◆ interpretLine() [5/6]

template<class S, class T, class U, class V>
bool _Fieldmap::interpretLine ( std::ifstream & in,
S & value1,
T & value2,
U & value3,
V & value4,
const bool & file_length_known = true )
protectedinherited

Definition at line 104 of file Fieldmap.hpp.

References getLine(), interpretWarning(), and missingValuesWarning().

Here is the call graph for this function:

◆ interpretLine() [6/6]

template<class T>
bool _Fieldmap::interpretLine ( std::ifstream & in,
T & value,
const bool & file_length_known )
inherited

Definition at line 12 of file Fieldmap.hpp.

References getLine(), interpretWarning(), and missingValuesWarning().

Here is the call graph for this function:

◆ interpretWarning()

void _Fieldmap::interpretWarning ( const std::ios_base::iostate & state,
const bool & read_all,
const std::string & error_msg,
const std::string & found )
protectedinherited

Definition at line 571 of file Fieldmap.cpp.

References Filename_m, and lines_read_m.

Referenced by interpretLine(), interpretLine(), interpretLine(), interpretLine(), and interpretLine().

◆ isInside()

virtual bool _Fieldmap::isInside ( const Vector_t & ) const
inlinevirtualinherited

Reimplemented in _Astra1D_fast, _Astra1DDynamic, _Astra1DElectroStatic, _Astra1DMagnetoStatic, _FM1DDynamic, _FM1DDynamic_fast, _FM1DElectroStatic, _FM1DElectroStatic_fast, _FM1DMagnetoStatic, _FM1DMagnetoStatic_fast, _FM2DDynamic, _FM2DElectroStatic, _FM2DMagnetoStatic, _FM3DDynamic, _FM3DH5BlockBase, _FM3DMagnetoStatic, and _FM3DMagnetoStaticExtended.

Definition at line 102 of file Fieldmap.h.

◆ lowResolutionWarning()

void _Fieldmap::lowResolutionWarning ( double squareError,
double maxError )
protectedinherited

Definition at line 626 of file Fieldmap.cpp.

References endl(), ERRORMSG, Filename_m, OpalData::getAuxiliaryOutputDirectory(), OpalData::getInstance(), IpplInfo::myNode(), and typeset_msg().

Referenced by checkMap().

Here is the call graph for this function:

◆ missingValuesWarning()

void _Fieldmap::missingValuesWarning ( )
protectedinherited

Definition at line 590 of file Fieldmap.cpp.

References Filename_m, and lines_read_m.

Referenced by interpretLine(), interpretLine(), interpretLine(), interpretLine(), and interpretLine().

◆ noFieldmapWarning()

void _Fieldmap::noFieldmapWarning ( )
protectedinherited

Definition at line 618 of file Fieldmap.cpp.

References Filename_m.

Referenced by _Astra1DDynamic_fast::_Astra1DDynamic_fast(), _Astra1DElectroStatic_fast::_Astra1DElectroStatic_fast(), _Astra1DMagnetoStatic_fast::_Astra1DMagnetoStatic_fast(), _FM1DDynamic::_FM1DDynamic(), _FM1DDynamic_fast::_FM1DDynamic_fast(), _FM1DElectroStatic::_FM1DElectroStatic(), _FM1DElectroStatic_fast::_FM1DElectroStatic_fast(), _FM1DMagnetoStatic::_FM1DMagnetoStatic(), _FM1DMagnetoStatic_fast::_FM1DMagnetoStatic_fast(), _FM1DProfile1::_FM1DProfile1(), _FM1DProfile2::_FM1DProfile2(), and _FM3DDynamic::_FM3DDynamic().

◆ readHeader()

MapType _Fieldmap::readHeader ( std::string Filename)
staticinherited

Definition at line 282 of file Fieldmap.cpp.

References IpplInfo::getComm(), getLine(), lines_read_m, name, PAssert, T1DDynamic, T1DElectroStatic, T1DMagnetoStatic, T1DProfile1, T2DDynamic, T2DElectroStatic, T2DMagnetoStatic, T3DDynamic, T3DDynamicH5Block, T3DElectroStatic, T3DMagnetoStatic, T3DMagnetoStatic_Extended, T3DMagnetoStaticH5Block, TAstraDynamic, TAstraElectroStatic, TAstraMagnetoStatic, and UNKNOWN.

Referenced by getFieldmap().

Here is the call graph for this function:

◆ readMap() [1/2]

void _Fieldmap::readMap ( std::string Filename)
staticinherited

Definition at line 422 of file Fieldmap.cpp.

References FieldmapDictionary.

Referenced by Cyclotron::getFieldFromFile_BandRF(), and Cyclotron::getFieldFromFile_Synchrocyclotron().

◆ readMap() [2/2]

void _FM1DProfile1::readMap ( )
privatevirtual

Implements _Fieldmap.

Definition at line 134 of file FM1DProfile1.cpp.

References computeEntranceFringe(), computeExitFringe(), endl(), engeCoeffsEntry_m, engeCoeffsExit_m, entranceParameter1_m, entranceParameter3_m, exitParameter1_m, exitParameter3_m, _Fieldmap::Filename_m, INFOMSG, _Fieldmap::interpretLine(), level3(), polyOrderEntry_m, polyOrderExit_m, and _Fieldmap::typeset_msg().

Here is the call graph for this function:

◆ setEdgeConstants()

void _Fieldmap::setEdgeConstants ( const double & bendAngle,
const double & entranceAngle,
const double & exitAngle )
virtualinherited

Reimplemented in _FM1DProfile2.

Definition at line 527 of file Fieldmap.cpp.

◆ setFieldGap()

void _FM1DProfile1::setFieldGap ( double gap)
virtual

Reimplemented from _Fieldmap.

Definition at line 290 of file FM1DProfile1.cpp.

References gapHeight_m.

◆ setFieldLength()

void _Fieldmap::setFieldLength ( const double & )
virtualinherited

Definition at line 530 of file Fieldmap.cpp.

◆ setFrequency()

void _FM1DProfile1::setFrequency ( double freq)
virtual

Implements _Fieldmap.

Definition at line 261 of file FM1DProfile1.cpp.

◆ swap()

void _FM1DProfile1::swap ( )
virtual

Implements _Fieldmap.

Definition at line 248 of file FM1DProfile1.cpp.

◆ typeset_msg()

std::string _Fieldmap::typeset_msg ( const std::string & msg,
const std::string & title )
staticinherited

Definition at line 649 of file Fieldmap.cpp.

References c.

Referenced by RFCavity::initialise(), lowResolutionWarning(), CCollimator::print(), FlexibleCollimator::print(), _Astra1DDynamic::readMap(), _Astra1DDynamic_fast::readMap(), _Astra1DElectroStatic::readMap(), _Astra1DElectroStatic_fast::readMap(), _Astra1DMagnetoStatic::readMap(), _Astra1DMagnetoStatic_fast::readMap(), _FM1DDynamic::readMap(), _FM1DDynamic_fast::readMap(), _FM1DElectroStatic::readMap(), _FM1DElectroStatic_fast::readMap(), _FM1DMagnetoStatic::readMap(), _FM1DMagnetoStatic_fast::readMap(), _FM1DProfile1::readMap(), _FM1DProfile2::readMap(), _FM2DDynamic::readMap(), _FM2DElectroStatic::readMap(), _FM2DMagnetoStatic::readMap(), _FM3DDynamic::readMap(), _FM3DH5Block::readMap(), _FM3DH5Block_nonscale::readMap(), _FM3DMagnetoStatic::readMap(), _FM3DMagnetoStaticExtended::readMap(), and _FM3DMagnetoStaticH5Block::readMap().

◆ write3DField()

void _Fieldmap::write3DField ( unsigned int nx,
unsigned int ny,
unsigned int nz,
const std::pair< double, double > & xrange,
const std::pair< double, double > & yrange,
const std::pair< double, double > & zrange,
const std::vector< Vector_t > & ef,
const std::vector< Vector_t > & bf )
protectedinherited

Definition at line 734 of file Fieldmap.cpp.

References Util::combineFilePath(), Filename_m, OpalData::getAuxiliaryOutputDirectory(), OpalData::getInstance(), IpplInfo::myNode(), and PAssert.

Referenced by _FM3DDynamic::readMap().

Here is the call graph for this function:

◆ _Fieldmap

friend class _Fieldmap
friend

End of field map in s coordinates (m).

Definition at line 88 of file FM1DProfile1.h.

References _Fieldmap.

Referenced by _Fieldmap, and _FM1DProfile1().

Member Data Documentation

◆ alpha_numeric

std::string _Fieldmap::alpha_numeric
staticprivateinherited

Definition at line 183 of file Fieldmap.h.

Referenced by getLine(), and interpreteEOF().

◆ buffer_m

char _Fieldmap::buffer_m
staticprivateinherited

Definition at line 182 of file Fieldmap.h.

Referenced by getLine(), and interpreteEOF().

◆ engeCoeffsEntry_m

std::vector<double> _FM1DProfile1::engeCoeffsEntry_m
private

Enge coefficients for map entry and exit regions.

Definition at line 78 of file FM1DProfile1.h.

Referenced by computeEntranceFringe(), get1DProfile1EngeCoeffs(), and readMap().

◆ engeCoeffsExit_m

std::vector<double> _FM1DProfile1::engeCoeffsExit_m
private

Definition at line 79 of file FM1DProfile1.h.

Referenced by computeExitFringe(), get1DProfile1EngeCoeffs(), and readMap().

◆ entranceParameter1_m

double _FM1DProfile1::entranceParameter1_m
private

Definition at line 70 of file FM1DProfile1.h.

Referenced by _FM1DProfile1(), get1DProfile1EntranceParam(), and readMap().

◆ entranceParameter2_m

double _FM1DProfile1::entranceParameter2_m
private

Definition at line 71 of file FM1DProfile1.h.

Referenced by _FM1DProfile1(), and get1DProfile1EntranceParam().

◆ entranceParameter3_m

double _FM1DProfile1::entranceParameter3_m
private

Definition at line 72 of file FM1DProfile1.h.

Referenced by _FM1DProfile1(), get1DProfile1EntranceParam(), and readMap().

◆ exitParameter1_m

double _FM1DProfile1::exitParameter1_m
private

Definition at line 73 of file FM1DProfile1.h.

Referenced by _FM1DProfile1(), get1DProfile1ExitParam(), and readMap().

◆ exitParameter2_m

double _FM1DProfile1::exitParameter2_m
private

Definition at line 74 of file FM1DProfile1.h.

Referenced by _FM1DProfile1(), and get1DProfile1ExitParam().

◆ exitParameter3_m

double _FM1DProfile1::exitParameter3_m
private

Definition at line 75 of file FM1DProfile1.h.

Referenced by _FM1DProfile1(), get1DProfile1ExitParam(), and readMap().

◆ FieldmapDictionary

std::map< std::string, _Fieldmap::FieldmapDescription > _Fieldmap::FieldmapDictionary = std::map<std::string, _Fieldmap::FieldmapDescription>()
staticprivateinherited

Definition at line 198 of file Fieldmap.h.

Referenced by clearDictionary(), freeMap(), getFieldmap(), getListFieldmapNames(), and readMap().

◆ Filename_m

std::string _Fieldmap::Filename_m
protectedinherited

Definition at line 118 of file Fieldmap.h.

Referenced by _Astra1DDynamic::_Astra1DDynamic(), _Astra1DDynamic_fast::_Astra1DDynamic_fast(), _Astra1DElectroStatic::_Astra1DElectroStatic(), _Astra1DElectroStatic_fast::_Astra1DElectroStatic_fast(), _Astra1DMagnetoStatic::_Astra1DMagnetoStatic(), _Astra1DMagnetoStatic_fast::_Astra1DMagnetoStatic_fast(), _Fieldmap(), _FM1DDynamic::_FM1DDynamic(), _FM1DDynamic_fast::_FM1DDynamic_fast(), _FM1DElectroStatic::_FM1DElectroStatic(), _FM1DElectroStatic_fast::_FM1DElectroStatic_fast(), _FM1DMagnetoStatic::_FM1DMagnetoStatic(), _FM1DMagnetoStatic_fast::_FM1DMagnetoStatic_fast(), _FM1DProfile1::_FM1DProfile1(), _FM1DProfile2::_FM1DProfile2(), _FM2DDynamic::_FM2DDynamic(), _FM2DElectroStatic::_FM2DElectroStatic(), _FM2DMagnetoStatic::_FM2DMagnetoStatic(), _FM3DDynamic::_FM3DDynamic(), _FM3DMagnetoStatic::_FM3DMagnetoStatic(), _FM3DMagnetoStaticExtended::_FM3DMagnetoStaticExtended(), checkMap(), _FM3DH5BlockBase::closeFile(), disableFieldmapWarning(), exceedingValuesWarning(), _FM3DH5BlockBase::getFieldInfo(), _Astra1DDynamic::getInfo(), _Astra1DDynamic_fast::getInfo(), _Astra1DElectroStatic::getInfo(), _Astra1DElectroStatic_fast::getInfo(), _Astra1DMagnetoStatic::getInfo(), _Astra1DMagnetoStatic_fast::getInfo(), _FM1DDynamic::getInfo(), _FM1DDynamic_fast::getInfo(), _FM1DElectroStatic::getInfo(), _FM1DElectroStatic_fast::getInfo(), _FM1DMagnetoStatic::getInfo(), _FM1DMagnetoStatic_fast::getInfo(), _FM1DProfile1::getInfo(), _FM1DProfile2::getInfo(), _FM2DDynamic::getInfo(), _FM2DElectroStatic::getInfo(), _FM2DMagnetoStatic::getInfo(), _FM3DDynamic::getInfo(), _FM3DH5BlockBase::getInfo(), _FM3DMagnetoStatic::getInfo(), _FM3DMagnetoStaticExtended::getInfo(), _FM3DH5BlockBase::getNumSteps(), _Astra1DDynamic::getOnaxisEz(), _Astra1DDynamic_fast::getOnaxisEz(), _FM1DDynamic::getOnaxisEz(), _FM1DDynamic_fast::getOnaxisEz(), _FM3DDynamic::getOnaxisEz(), _FM3DH5BlockBase::getResonanceFrequency(), interpretWarning(), lowResolutionWarning(), missingValuesWarning(), noFieldmapWarning(), _FM3DH5BlockBase::readField(), _Astra1DDynamic::readMap(), _Astra1DDynamic_fast::readMap(), _Astra1DElectroStatic::readMap(), _Astra1DElectroStatic_fast::readMap(), _Astra1DMagnetoStatic::readMap(), _Astra1DMagnetoStatic_fast::readMap(), _FM1DDynamic::readMap(), _FM1DDynamic_fast::readMap(), _FM1DElectroStatic::readMap(), _FM1DElectroStatic_fast::readMap(), _FM1DMagnetoStatic::readMap(), _FM1DMagnetoStatic_fast::readMap(), _FM1DProfile1::readMap(), _FM1DProfile2::readMap(), _FM2DDynamic::readMap(), _FM2DElectroStatic::readMap(), _FM2DMagnetoStatic::readMap(), _FM3DDynamic::readMap(), _FM3DH5Block::readMap(), _FM3DH5Block_nonscale::readMap(), _FM3DMagnetoStatic::readMap(), _FM3DMagnetoStaticExtended::readMap(), _FM3DMagnetoStaticH5Block::readMap(), _FM3DH5BlockBase::setStep(), and write3DField().

◆ gapHeight_m

double _FM1DProfile1::gapHeight_m
private

Enge function order for entry region.

Definition at line 83 of file FM1DProfile1.h.

Referenced by _FM1DProfile1(), computeEntranceFringe(), computeExitFringe(), getFieldGap(), and setFieldGap().

◆ lines_read_m

int _Fieldmap::lines_read_m
protectedinherited

Definition at line 119 of file Fieldmap.h.

Referenced by _Astra1DDynamic::_Astra1DDynamic(), _Astra1DElectroStatic::_Astra1DElectroStatic(), _Astra1DMagnetoStatic::_Astra1DMagnetoStatic(), _Fieldmap(), _FM1DProfile2::_FM1DProfile2(), _FM2DDynamic::_FM2DDynamic(), _FM2DElectroStatic::_FM2DElectroStatic(), _FM2DMagnetoStatic::_FM2DMagnetoStatic(), _FM3DMagnetoStaticExtended::_FM3DMagnetoStaticExtended(), _Astra1D_fast::determineNumSamplingPoints(), exceedingValuesWarning(), getLine(), interpreteEOF(), interpretWarning(), missingValuesWarning(), and readHeader().

◆ normalize_m

bool _Fieldmap::normalize_m
protectedinherited

Definition at line 121 of file Fieldmap.h.

Referenced by _Astra1D_fast::_Astra1D_fast(), _Astra1DDynamic::_Astra1DDynamic(), _Astra1DElectroStatic::_Astra1DElectroStatic(), _Astra1DMagnetoStatic::_Astra1DMagnetoStatic(), _Fieldmap(), _FM2DDynamic::_FM2DDynamic(), _FM2DElectroStatic::_FM2DElectroStatic(), _FM2DMagnetoStatic::_FM2DMagnetoStatic(), _FM3DMagnetoStatic::_FM3DMagnetoStatic(), _FM3DMagnetoStaticExtended::_FM3DMagnetoStaticExtended(), _FM1DMagnetoStatic_fast::normalizeField(), _Astra1D_fast::readFieldData(), _FM1DDynamic::readFileData(), _FM1DDynamic::readFileData(), _FM1DDynamic_fast::readFileData(), _FM1DDynamic_fast::readFileData(), _FM1DElectroStatic::readFileData(), _FM1DElectroStatic_fast::readFileData(), _FM1DMagnetoStatic::readFileData(), _Astra1DDynamic_fast::readFileHeader(), _Astra1DElectroStatic_fast::readFileHeader(), _Astra1DMagnetoStatic_fast::readFileHeader(), _FM1DDynamic::readFileHeader(), _FM1DDynamic_fast::readFileHeader(), _FM1DElectroStatic::readFileHeader(), _FM1DElectroStatic_fast::readFileHeader(), _FM1DMagnetoStatic::readFileHeader(), _FM1DMagnetoStatic_fast::readFileHeader(), _Astra1DDynamic::readMap(), _Astra1DElectroStatic::readMap(), _Astra1DMagnetoStatic::readMap(), _FM2DDynamic::readMap(), _FM2DElectroStatic::readMap(), _FM2DMagnetoStatic::readMap(), _FM3DMagnetoStatic::readMap(), _FM3DMagnetoStaticExtended::readMap(), and _FM1DDynamic_fast::scaleField().

◆ polyOrderEntry_m

int _FM1DProfile1::polyOrderEntry_m
private

Definition at line 81 of file FM1DProfile1.h.

Referenced by _FM1DProfile1(), and readMap().

◆ polyOrderExit_m

int _FM1DProfile1::polyOrderExit_m
private

Enge function order for entry region.

Definition at line 82 of file FM1DProfile1.h.

Referenced by _FM1DProfile1(), and readMap().

◆ sBegin_m

double _FM1DProfile1::sBegin_m
private

Full gap height of field map.

Definition at line 85 of file FM1DProfile1.h.

Referenced by _FM1DProfile1(), and getFieldDimensions().

◆ sEnd_m

double _FM1DProfile1::sEnd_m
private

Start of field map in s coordinates (m).

Definition at line 86 of file FM1DProfile1.h.

Referenced by _FM1DProfile1(), and getFieldDimensions().

◆ Type

MapType _Fieldmap::Type
protectedinherited

Definition at line 116 of file Fieldmap.h.

Referenced by _Astra1DDynamic::_Astra1DDynamic(), _Astra1DDynamic_fast::_Astra1DDynamic_fast(), _Astra1DElectroStatic::_Astra1DElectroStatic(), _Astra1DElectroStatic_fast::_Astra1DElectroStatic_fast(), _Astra1DMagnetoStatic::_Astra1DMagnetoStatic(), _Astra1DMagnetoStatic_fast::_Astra1DMagnetoStatic_fast(), _FM1DDynamic::_FM1DDynamic(), _FM1DDynamic_fast::_FM1DDynamic_fast(), _FM1DElectroStatic::_FM1DElectroStatic(), _FM1DElectroStatic_fast::_FM1DElectroStatic_fast(), _FM1DMagnetoStatic::_FM1DMagnetoStatic(), _FM1DMagnetoStatic_fast::_FM1DMagnetoStatic_fast(), _FM1DProfile1::_FM1DProfile1(), _FM1DProfile2::_FM1DProfile2(), _FM2DDynamic::_FM2DDynamic(), _FM2DElectroStatic::_FM2DElectroStatic(), _FM2DMagnetoStatic::_FM2DMagnetoStatic(), _FM3DDynamic::_FM3DDynamic(), _FM3DH5Block::_FM3DH5Block(), _FM3DH5Block_nonscale::_FM3DH5Block_nonscale(), _FM3DMagnetoStatic::_FM3DMagnetoStatic(), _FM3DMagnetoStaticExtended::_FM3DMagnetoStaticExtended(), _FM3DMagnetoStaticH5Block::_FM3DMagnetoStaticH5Block(), and getType().

The documentation for this class was generated from the following files: