OPALX (Object Oriented Parallel Accelerator Library for Exascale) MINIorX
OPALX
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
FM1DProfile1 Class Reference

#include <FM1DProfile1.h>

Inheritance diagram for FM1DProfile1:
Inheritance graph
Collaboration diagram for FM1DProfile1:
Collaboration graph

Public Member Functions

virtual bool getFieldDerivative (const Vector_t< double, 3 > &X, Vector_t< double, 3 > &E, Vector_t< double, 3 > &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< double, 3 > &X, Vector_t< double, 3 > &strength, Vector_t< double, 3 > &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< double, 3 > &) 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< double, 3 > > &ef, const std::vector< Vector_t< double, 3 > > &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 (std::string Filename)
 Constructor with field map file name. More...
 
virtual ~FM1DProfile1 ()
 
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
 

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. More...
 
std::vector< double > engeCoeffsExit_m
 
int polyOrderEntry_m
 
int polyOrderExit_m
 Enge function order for entry region. More...
 
double gapHeight_m
 Enge function order for entry region. More...
 
double sBegin_m
 Full gap height of field map. More...
 
double sEnd_m
 Start of field map in s coordinates (m). More...
 

Static Private Attributes

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

Friends

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

Detailed Description

Definition at line 14 of file FM1DProfile1.h.

Constructor & Destructor Documentation

◆ FM1DProfile1()

FM1DProfile1::FM1DProfile1 ( std::string  Filename)
private

Constructor with field map file name.

Definition at line 10 of file FM1DProfile1.cpp.

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

Here is the call graph for this function:

◆ ~FM1DProfile1()

FM1DProfile1::~FM1DProfile1 ( )
privatevirtual

Definition at line 104 of file FM1DProfile1.cpp.

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 428 of file Fieldmap.cpp.

References Util::combineFilePath(), ippl::Comm, Physics::e, end(), endl(), Fieldmap::Filename_m, OpalData::getInstance(), Fieldmap::lowResolutionWarning(), 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 413 of file Fieldmap.cpp.

References Fieldmap::checkMap().

Referenced by Fieldmap::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 237 of file Fieldmap.cpp.

References Fieldmap::FieldmapDictionary.

Referenced by main().

◆ computeEntranceFringe()

double FM1DProfile1::computeEntranceFringe ( double  z) const
private

Definition at line 246 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 250 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 254 of file FM1DProfile1.cpp.

Referenced by computeEntranceFringe(), and computeExitFringe().

◆ deleteFieldmap()

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

Definition at line 233 of file Fieldmap.cpp.

References Fieldmap::freeMap().

Here is the call graph for this function:

◆ disableFieldmapWarning()

void Fieldmap::disableFieldmapWarning ( )
protectedinherited

Definition at line 569 of file Fieldmap.cpp.

References Fieldmap::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(), FM1DProfile2::FM1DProfile2(), FM2DDynamic::FM2DDynamic(), FM2DElectroStatic::FM2DElectroStatic(), FM2DMagnetoStatic::FM2DMagnetoStatic(), FM3DDynamic::FM3DDynamic(), FM3DMagnetoStaticExtended::FM3DMagnetoStaticExtended(), and FMDummy::FMDummy().

◆ exceedingValuesWarning()

void Fieldmap::exceedingValuesWarning ( )
protectedinherited

Definition at line 559 of file Fieldmap.cpp.

References Fieldmap::Filename_m, and Fieldmap::lines_read_m.

Referenced by Fieldmap::interpreteEOF().

◆ freeMap() [1/2]

void FM1DProfile1::freeMap ( )
privatevirtual

Implements Fieldmap.

Definition at line 177 of file FM1DProfile1.cpp.

◆ freeMap() [2/2]

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

Definition at line 394 of file Fieldmap.cpp.

References Fieldmap::FieldmapDictionary.

◆ get1DProfile1EngeCoeffs()

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

Reimplemented from Fieldmap.

Definition at line 219 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 225 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 232 of file FM1DProfile1.cpp.

References exitParameter1_m, exitParameter2_m, and exitParameter3_m.

◆ getFieldDerivative()

bool FM1DProfile1::getFieldDerivative ( const Vector_t< double, 3 > &  X,
Vector_t< double, 3 > &  E,
Vector_t< double, 3 > &  B,
const DiffDirection &  dir 
) const
virtual

Implements Fieldmap.

Definition at line 190 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 200 of file FM1DProfile1.cpp.

◆ getFieldDimensions() [2/2]

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

Implements Fieldmap.

Definition at line 196 of file FM1DProfile1.cpp.

References sBegin_m, and sEnd_m.

◆ getFieldGap()

double FM1DProfile1::getFieldGap ( )
virtual

Reimplemented from Fieldmap.

Definition at line 239 of file FM1DProfile1.cpp.

References gapHeight_m.

◆ getFieldmap()

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

Definition at line 54 of file Fieldmap.cpp.

References Fieldmap::FieldmapDictionary, Fieldmap::readHeader(), T1DDynamic, T1DElectroStatic, T1DMagnetoStatic, T1DProfile1, T1DProfile2, T2DDynamic, T2DElectroStatic, T2DMagnetoStatic, T3DDynamic, T3DDynamicH5Block, T3DMagnetoStatic, T3DMagnetoStatic_Extended, T3DMagnetoStaticH5Block, TAstraDynamic, TAstraElectroStatic, and TAstraMagnetoStatic.

Referenced by RFCavity::initialise(), and Solenoid::initialise().

Here is the call graph for this function:

◆ getFieldstrength()

bool FM1DProfile1::getFieldstrength ( const Vector_t< double, 3 > &  X,
Vector_t< double, 3 > &  strength,
Vector_t< double, 3 > &  info 
) const
virtual

Implements Fieldmap.

Definition at line 180 of file FM1DProfile1.cpp.

◆ getFrequency()

double FM1DProfile1::getFrequency ( ) const
virtual

Implements Fieldmap.

Definition at line 212 of file FM1DProfile1.cpp.

◆ getInfo()

void FM1DProfile1::getInfo ( Inform *  msg)
virtual

Implements Fieldmap.

Definition at line 208 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 494 of file Fieldmap.cpp.

References Fieldmap::alpha_numeric, Fieldmap::buffer_m, and READ_BUFFER_LENGTH.

◆ getLine() [2/2]

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

Definition at line 124 of file Fieldmap.h.

References Fieldmap::getLine(), and Fieldmap::lines_read_m.

Referenced by Fieldmap::getLine(), Fieldmap::interpretLine(), Fieldmap::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 224 of file Fieldmap.cpp.

References Fieldmap::FieldmapDictionary.

◆ getOnaxisEz()

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

Reimplemented in FM1DDynamic, FM1DDynamic_fast, Astra1D_fast, Astra1DDynamic, Astra1DDynamic_fast, FM2DDynamic, FM3DDynamic, and FM3DH5BlockBase.

Definition at line 668 of file Fieldmap.cpp.

Referenced by RFCavity::getAutoPhaseEstimate(), and TravelingWave::getAutoPhaseEstimate().

◆ getType()

MapType Fieldmap::getType ( )
inlineinherited

Definition at line 96 of file Fieldmap.h.

References Fieldmap::Type.

◆ interpreteEOF()

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

Definition at line 516 of file Fieldmap.cpp.

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

Referenced by FM1DDynamic::checkFileData(), FM1DDynamic_fast::checkFileData(), FM1DElectroStatic::checkFileData(), FM1DElectroStatic_fast::checkFileData(), FM1DMagnetoStatic::checkFileData(), FM1DMagnetoStatic_fast::checkFileData(), FM1DProfile1(), FM1DProfile2::FM1DProfile2(), FM2DDynamic::FM2DDynamic(), FM2DElectroStatic::FM2DElectroStatic(), FM2DMagnetoStatic::FM2DMagnetoStatic(), FM3DDynamic::FM3DDynamic(), FM3DMagnetoStatic::FM3DMagnetoStatic(), and FM3DMagnetoStaticExtended::FM3DMagnetoStaticExtended().

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

◆ 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 Fieldmap::getLine(), Fieldmap::interpretWarning(), and Fieldmap::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 Fieldmap::getLine(), Fieldmap::interpretWarning(), and Fieldmap::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 Fieldmap::getLine(), Fieldmap::interpretWarning(), and Fieldmap::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 Fieldmap::getLine(), Fieldmap::interpretWarning(), and Fieldmap::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 Fieldmap::getLine(), Fieldmap::interpretWarning(), and Fieldmap::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 532 of file Fieldmap.cpp.

References endl(), Fieldmap::Filename_m, and Fieldmap::lines_read_m.

Referenced by Fieldmap::interpretLine().

Here is the call graph for this function:

◆ isInside()

virtual bool Fieldmap::isInside ( const Vector_t< double, 3 > &  ) 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.

Referenced by TravelingWave::apply(), TravelingWave::applyToReferenceParticle(), RFCavity::isInside(), and Solenoid::isInside().

◆ lowResolutionWarning()

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

Definition at line 583 of file Fieldmap.cpp.

References ippl::Comm, endl(), ippl::Error, Fieldmap::Filename_m, OpalData::getAuxiliaryOutputDirectory(), OpalData::getInstance(), and Fieldmap::typeset_msg().

Referenced by Fieldmap::checkMap().

Here is the call graph for this function:

◆ missingValuesWarning()

void Fieldmap::missingValuesWarning ( )
protectedinherited

Definition at line 550 of file Fieldmap.cpp.

References Fieldmap::Filename_m, and Fieldmap::lines_read_m.

Referenced by Fieldmap::interpretLine().

◆ noFieldmapWarning()

void Fieldmap::noFieldmapWarning ( )
protectedinherited

Definition at line 576 of file Fieldmap.cpp.

References Fieldmap::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(), FM1DProfile2::FM1DProfile2(), FM2DDynamic::FM2DDynamic(), FM2DElectroStatic::FM2DElectroStatic(), FM2DMagnetoStatic::FM2DMagnetoStatic(), and FM3DDynamic::FM3DDynamic().

◆ readHeader()

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

Definition at line 246 of file Fieldmap.cpp.

References ippl::Comm, endl(), Fieldmap::getLine(), Fieldmap::lines_read_m, PAssert, T1DDynamic, T1DElectroStatic, T1DMagnetoStatic, T1DProfile1, T2DDynamic, T2DElectroStatic, T2DMagnetoStatic, T3DDynamic, T3DDynamicH5Block, T3DElectroStatic, T3DMagnetoStatic, T3DMagnetoStatic_Extended, T3DMagnetoStaticH5Block, TAstraDynamic, TAstraElectroStatic, TAstraMagnetoStatic, and UNKNOWN.

Referenced by Fieldmap::getFieldmap().

Here is the call graph for this function:

◆ readMap() [1/2]

void FM1DProfile1::readMap ( )
privatevirtual

Implements Fieldmap.

Definition at line 107 of file FM1DProfile1.cpp.

References computeEntranceFringe(), computeExitFringe(), endl(), engeCoeffsEntry_m, engeCoeffsExit_m, entranceParameter1_m, entranceParameter3_m, exitParameter1_m, exitParameter3_m, Fieldmap::Filename_m, ippl::Info, level3(), polyOrderEntry_m, polyOrderExit_m, and Fieldmap::typeset_msg().

Here is the call graph for this function:

◆ readMap() [2/2]

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

Definition at line 384 of file Fieldmap.cpp.

References Fieldmap::FieldmapDictionary.

◆ setEdgeConstants()

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

Reimplemented in FM1DProfile2.

Definition at line 489 of file Fieldmap.cpp.

◆ setFieldGap()

void FM1DProfile1::setFieldGap ( double  gap)
virtual

Reimplemented from Fieldmap.

Definition at line 242 of file FM1DProfile1.cpp.

References gapHeight_m.

◆ setFieldLength()

void Fieldmap::setFieldLength ( const double &  )
virtualinherited

Definition at line 492 of file Fieldmap.cpp.

◆ setFrequency()

void FM1DProfile1::setFrequency ( double  freq)
virtual

Implements Fieldmap.

Definition at line 216 of file FM1DProfile1.cpp.

◆ swap()

void FM1DProfile1::swap ( )
virtual

Implements Fieldmap.

Definition at line 205 of file FM1DProfile1.cpp.

◆ typeset_msg()

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

Definition at line 607 of file Fieldmap.cpp.

References Physics::c.

Referenced by FMDummy::FMDummy(), Astra1D_fast::freeMap(), Astra1DDynamic::freeMap(), Astra1DElectroStatic::freeMap(), Astra1DMagnetoStatic::freeMap(), FM1DDynamic::freeMap(), FM1DDynamic_fast::freeMap(), FM1DElectroStatic::freeMap(), FM1DElectroStatic_fast::freeMap(), FM1DMagnetoStatic::freeMap(), FM1DMagnetoStatic_fast::freeMap(), FM1DProfile2::freeMap(), FM2DDynamic::freeMap(), FM2DElectroStatic::freeMap(), FM2DMagnetoStatic::freeMap(), FM3DDynamic::freeMap(), FM3DH5Block::freeMap(), FM3DH5Block_nonscale::freeMap(), FM3DMagnetoStatic::freeMap(), FM3DMagnetoStaticExtended::freeMap(), FM3DMagnetoStaticH5Block::freeMap(), RFCavity::initialise(), Fieldmap::lowResolutionWarning(), 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(), 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< double, 3 > > &  ef,
const std::vector< Vector_t< double, 3 > > &  bf 
)
protectedinherited

Definition at line 691 of file Fieldmap.cpp.

References Util::combineFilePath(), ippl::Comm, endl(), Fieldmap::Filename_m, OpalData::getAuxiliaryOutputDirectory(), OpalData::getInstance(), and PAssert.

Referenced by FM3DDynamic::readMap().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ Fieldmap

friend class Fieldmap
friend

End of field map in s coordinates (m).

Definition at line 87 of file FM1DProfile1.h.

Member Data Documentation

◆ alpha_numeric

std::string Fieldmap::alpha_numeric
staticprivateinherited

Definition at line 182 of file Fieldmap.h.

Referenced by Fieldmap::getLine(), and Fieldmap::interpreteEOF().

◆ buffer_m

char Fieldmap::buffer_m
staticprivateinherited

Definition at line 181 of file Fieldmap.h.

Referenced by Fieldmap::getLine(), and Fieldmap::interpreteEOF().

◆ engeCoeffsEntry_m

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

Enge coefficients for map entry and exit regions.

Definition at line 77 of file FM1DProfile1.h.

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

◆ engeCoeffsExit_m

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

Definition at line 78 of file FM1DProfile1.h.

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

◆ entranceParameter1_m

double FM1DProfile1::entranceParameter1_m
private

Definition at line 69 of file FM1DProfile1.h.

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

◆ entranceParameter2_m

double FM1DProfile1::entranceParameter2_m
private

Definition at line 70 of file FM1DProfile1.h.

Referenced by FM1DProfile1(), and get1DProfile1EntranceParam().

◆ entranceParameter3_m

double FM1DProfile1::entranceParameter3_m
private

Definition at line 71 of file FM1DProfile1.h.

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

◆ exitParameter1_m

double FM1DProfile1::exitParameter1_m
private

Definition at line 72 of file FM1DProfile1.h.

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

◆ exitParameter2_m

double FM1DProfile1::exitParameter2_m
private

Definition at line 73 of file FM1DProfile1.h.

Referenced by FM1DProfile1(), and get1DProfile1ExitParam().

◆ exitParameter3_m

double FM1DProfile1::exitParameter3_m
private

Definition at line 74 of file FM1DProfile1.h.

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

◆ FieldmapDictionary

std::map< std::string, Fieldmap::FieldmapDescription > Fieldmap::FieldmapDictionary
staticprivateinherited
Initial value:
=
std::map<std::string, Fieldmap::FieldmapDescription>()

Definition at line 194 of file Fieldmap.h.

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

◆ Filename_m

std::string Fieldmap::Filename_m
protectedinherited

Definition at line 120 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::checkMap(), FM3DH5BlockBase::closeFile(), Fieldmap::disableFieldmapWarning(), Fieldmap::exceedingValuesWarning(), FM1DDynamic::FM1DDynamic(), FM1DDynamic_fast::FM1DDynamic_fast(), FM1DElectroStatic::FM1DElectroStatic(), FM1DElectroStatic_fast::FM1DElectroStatic_fast(), FM1DMagnetoStatic::FM1DMagnetoStatic(), FM1DMagnetoStatic_fast::FM1DMagnetoStatic_fast(), FM1DProfile1(), FM1DProfile2::FM1DProfile2(), FM2DDynamic::FM2DDynamic(), FM2DElectroStatic::FM2DElectroStatic(), FM2DMagnetoStatic::FM2DMagnetoStatic(), FM3DDynamic::FM3DDynamic(), FM3DMagnetoStatic::FM3DMagnetoStatic(), FM3DMagnetoStaticExtended::FM3DMagnetoStaticExtended(), FMDummy::FMDummy(), Astra1D_fast::freeMap(), Astra1DDynamic::freeMap(), Astra1DElectroStatic::freeMap(), Astra1DMagnetoStatic::freeMap(), FM1DDynamic::freeMap(), FM1DDynamic_fast::freeMap(), FM1DElectroStatic::freeMap(), FM1DElectroStatic_fast::freeMap(), FM1DMagnetoStatic::freeMap(), FM1DMagnetoStatic_fast::freeMap(), FM1DProfile2::freeMap(), FM2DDynamic::freeMap(), FM2DElectroStatic::freeMap(), FM2DMagnetoStatic::freeMap(), FM3DDynamic::freeMap(), FM3DH5Block::freeMap(), FM3DH5Block_nonscale::freeMap(), FM3DMagnetoStatic::freeMap(), FM3DMagnetoStaticExtended::freeMap(), FM3DMagnetoStaticH5Block::freeMap(), 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(), getInfo(), FM1DProfile2::getInfo(), FM2DDynamic::getInfo(), FM2DElectroStatic::getInfo(), FM2DMagnetoStatic::getInfo(), FM3DDynamic::getInfo(), FM3DH5BlockBase::getInfo(), FM3DMagnetoStatic::getInfo(), FM3DMagnetoStaticExtended::getInfo(), FM3DH5BlockBase::getNumSteps(), FM1DDynamic::getOnaxisEz(), FM1DDynamic_fast::getOnaxisEz(), Astra1DDynamic::getOnaxisEz(), Astra1DDynamic_fast::getOnaxisEz(), FM3DDynamic::getOnaxisEz(), FM3DH5BlockBase::getResonanceFrequency(), Fieldmap::interpretWarning(), Fieldmap::lowResolutionWarning(), Fieldmap::missingValuesWarning(), Fieldmap::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(), 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 Fieldmap::write3DField().

◆ gapHeight_m

double FM1DProfile1::gapHeight_m
private

Enge function order for entry region.

Definition at line 82 of file FM1DProfile1.h.

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

◆ lines_read_m

int Fieldmap::lines_read_m
protectedinherited

Definition at line 121 of file Fieldmap.h.

Referenced by Astra1DDynamic::Astra1DDynamic(), Astra1DElectroStatic::Astra1DElectroStatic(), Astra1DMagnetoStatic::Astra1DMagnetoStatic(), Astra1D_fast::determineNumSamplingPoints(), Fieldmap::exceedingValuesWarning(), FM1DProfile2::FM1DProfile2(), FM2DDynamic::FM2DDynamic(), FM2DElectroStatic::FM2DElectroStatic(), FM2DMagnetoStatic::FM2DMagnetoStatic(), FM3DMagnetoStaticExtended::FM3DMagnetoStaticExtended(), Fieldmap::getLine(), Fieldmap::interpreteEOF(), Fieldmap::interpretWarning(), Fieldmap::missingValuesWarning(), and Fieldmap::readHeader().

◆ normalize_m

bool Fieldmap::normalize_m
protectedinherited

Definition at line 123 of file Fieldmap.h.

Referenced by Astra1D_fast::Astra1D_fast(), Astra1DDynamic::Astra1DDynamic(), Astra1DElectroStatic::Astra1DElectroStatic(), Astra1DMagnetoStatic::Astra1DMagnetoStatic(), FM2DDynamic::FM2DDynamic(), FM2DElectroStatic::FM2DElectroStatic(), FM2DMagnetoStatic::FM2DMagnetoStatic(), FM3DMagnetoStatic::FM3DMagnetoStatic(), FM3DMagnetoStaticExtended::FM3DMagnetoStaticExtended(), FM1DMagnetoStatic_fast::normalizeField(), Astra1D_fast::readFieldData(), FM1DDynamic::readFileData(), FM1DDynamic_fast::readFileData(), FM1DElectroStatic::readFileData(), FM1DElectroStatic_fast::readFileData(), FM1DMagnetoStatic::readFileData(), FM1DDynamic::readFileHeader(), FM1DDynamic_fast::readFileHeader(), FM1DElectroStatic::readFileHeader(), FM1DElectroStatic_fast::readFileHeader(), FM1DMagnetoStatic::readFileHeader(), FM1DMagnetoStatic_fast::readFileHeader(), Astra1DDynamic_fast::readFileHeader(), Astra1DElectroStatic_fast::readFileHeader(), Astra1DMagnetoStatic_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 80 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 81 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 84 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 85 of file FM1DProfile1.h.

Referenced by FM1DProfile1(), and getFieldDimensions().

◆ Type

MapType Fieldmap::Type
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(), FM1DDynamic::FM1DDynamic(), FM1DDynamic_fast::FM1DDynamic_fast(), FM1DElectroStatic::FM1DElectroStatic(), FM1DElectroStatic_fast::FM1DElectroStatic_fast(), FM1DMagnetoStatic::FM1DMagnetoStatic(), FM1DMagnetoStatic_fast::FM1DMagnetoStatic_fast(), FM1DProfile1(), FM1DProfile2::FM1DProfile2(), FM2DDynamic::FM2DDynamic(), FM2DElectroStatic::FM2DElectroStatic(), FM2DMagnetoStatic::FM2DMagnetoStatic(), FM3DDynamic::FM3DDynamic(), FM3DH5Block::FM3DH5Block(), FM3DH5Block_nonscale::FM3DH5Block_nonscale(), FM3DMagnetoStatic::FM3DMagnetoStatic(), FM3DMagnetoStaticExtended::FM3DMagnetoStaticExtended(), FM3DMagnetoStaticH5Block::FM3DMagnetoStaticH5Block(), and Fieldmap::getType().

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