FM1DDynamic Class Reference

#include <FM1DDynamic.h>

Inheritance diagram for FM1DDynamic:

Collaboration diagram for FM1DDynamic:

Public Member Functions
virtual bool	getFieldstrength (const Vector_t< double, 3 > &R, Vector_t< double, 3 > &E, Vector_t< double, 3 > &B) const
virtual bool	getFieldDerivative (const Vector_t< double, 3 > &R, Vector_t< double, 3 > &E, Vector_t< double, 3 > &B, const DiffDirection &dir) const
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 void	swap ()
virtual void	getInfo (Inform *)
virtual double	getFrequency () const
virtual void	setFrequency (double freq)
virtual void	getOnaxisEz (std::vector< std::pair< double, double > > &eZ)
virtual bool	isInside (const Vector_t< double, 3 > &r) const
virtual void	setEdgeConstants (const double &bendAngle, const double &entranceAngle, const double &exitAngle)
virtual void	setFieldLength (const double &)
virtual void	get1DProfile1EngeCoeffs (std::vector< double > &engeCoeffsEntry, std::vector< double > &engeCoeffsExit)
virtual void	get1DProfile1EntranceParam (double &entranceParameter1, double &entranceParameter2, double &entranceParameter3)
virtual void	get1DProfile1ExitParam (double &exitParameter1, double &exitParameter2, double &exitParameter3)
virtual double	getFieldGap ()
virtual void	setFieldGap (double gap)
MapType	getType ()
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
	FM1DDynamic (std::string aFilename)
	~FM1DDynamic ()
virtual void	readMap ()
virtual void	freeMap ()
bool	checkFileData (std::ifstream &fieldFile, bool parsingPassed)
void	computeFieldOffAxis (const Vector_t< double, 3 > &R, Vector_t< double, 3 > &E, Vector_t< double, 3 > &B, std::vector< double > fieldComponents) const
void	computeFieldOnAxis (double z, std::vector< double > &fieldComponents) const
void	computeFourierCoefficients (double maxEz, double fieldData[])
void	convertHeaderData ()
double	readFileData (std::ifstream &fieldFile, double fieldData[])
double	readFileData (std::ifstream &fieldFile, std::vector< std::pair< double, double > > &eZ)
bool	readFileHeader (std::ifstream &fieldFile)
void	scaleField (double maxEz, std::vector< std::pair< double, double > > &eZ)
void	stripFileHeader (std::ifstream &fieldFile)

Private Attributes
double	frequency_m
double	twoPiOverLambdaSq_m
	Field angular frequency (Hz). More...
double	rBegin_m
	2 Pi divided by the field RF wavelength squared. More...
double	rEnd_m
	Minimum radius of field. More...
double	zBegin_m
	Maximum radius of field. More...
double	zEnd_m
	Longitudinal start of field. More...
double	length_m
	Longitudinal end of field. More...
int	numberOfGridPoints_m
	Field length. More...
int	accuracy_m
	Number of grid points in field input file. More...
std::vector< double >	fourierCoefs_m
	Number of Fourier coefficients to use reconstructing field. More...

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

Friends
class	Fieldmap
	Fourier coefficients derived from field map. More...

Detailed Description

Definition at line 6 of file FM1DDynamic.h.

Constructor & Destructor Documentation

FM1DDynamic()

FM1DDynamic::FM1DDynamic ( std::string  aFilename )

private

Definition at line 13 of file FM1DDynamic.cpp.

References checkFileData(), convertHeaderData(), Fieldmap::disableFieldmapWarning(), Physics::e, Fieldmap::Filename_m, length_m, Fieldmap::noFieldmapWarning(), numberOfGridPoints_m, readFileHeader(), T1DDynamic, Fieldmap::Type, zBegin_m, and zEnd_m.

Here is the call graph for this function:

~FM1DDynamic()

FM1DDynamic::~FM1DDynamic ( )

private

Definition at line 37 of file FM1DDynamic.cpp.

References freeMap().

Here is the call graph for this function:

Member Function Documentation

checkFileData()

bool FM1DDynamic::checkFileData ( std::ifstream &  fieldFile, bool  parsingPassed  )

private

Definition at line 128 of file FM1DDynamic.cpp.

References Fieldmap::interpreteEOF(), and numberOfGridPoints_m.

Referenced by FM1DDynamic().

Here is the call graph for this function:

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().

computeFieldOffAxis()

void FM1DDynamic::computeFieldOffAxis ( const Vector_t< double, 3 > &  R, Vector_t< double, 3 > &  E, Vector_t< double, 3 > &  B, std::vector< double >  fieldComponents  ) const

private

Definition at line 136 of file FM1DDynamic.cpp.

References frequency_m, and twoPiOverLambdaSq_m.

Referenced by getFieldstrength().

computeFieldOnAxis()

void FM1DDynamic::computeFieldOnAxis ( double  z, std::vector< double > &  fieldComponents  ) const

private

Definition at line 158 of file FM1DDynamic.cpp.

References accuracy_m, fourierCoefs_m, length_m, Physics::pi, and Physics::two_pi.

Referenced by getFieldstrength().

computeFourierCoefficients()

void FM1DDynamic::computeFourierCoefficients ( double  maxEz, double  fieldData[]  )

private

Definition at line 191 of file FM1DDynamic.cpp.

References accuracy_m, fourierCoefs_m, numberOfGridPoints_m, and Units::Vpm2MVpm.

Referenced by readMap().

convertHeaderData()

void FM1DDynamic::convertHeaderData ( )

private

Definition at line 211 of file FM1DDynamic.cpp.

References Physics::c, Units::cm2m, frequency_m, Units::MHz2Hz, rBegin_m, rEnd_m, Physics::two_pi, twoPiOverLambdaSq_m, zBegin_m, and zEnd_m.

Referenced by FM1DDynamic().

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_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(), 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 FM1DDynamic::freeMap ( )

privatevirtual

Implements Fieldmap.

Definition at line 56 of file FM1DDynamic.cpp.

References endl(), Fieldmap::Filename_m, fourierCoefs_m, ippl::Info, and Fieldmap::typeset_msg().

Referenced by ~FM1DDynamic().

Here is the call graph for this function:

freeMap() [2/2]

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

staticinherited

Definition at line 394 of file Fieldmap.cpp.

References Fieldmap::FieldmapDictionary.

get1DProfile1EngeCoeffs()

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

virtualinherited

Reimplemented in FM1DProfile1.

Definition at line 671 of file Fieldmap.cpp.

get1DProfile1EntranceParam()

void Fieldmap::get1DProfile1EntranceParam ( double &  entranceParameter1, double &  entranceParameter2, double &  entranceParameter3  )

virtualinherited

Reimplemented in FM1DProfile1.

Definition at line 675 of file Fieldmap.cpp.

get1DProfile1ExitParam()

void Fieldmap::get1DProfile1ExitParam ( double &  exitParameter1, double &  exitParameter2, double &  exitParameter3  )

virtualinherited

Reimplemented in FM1DProfile1.

Definition at line 680 of file Fieldmap.cpp.

getFieldDerivative()

bool FM1DDynamic::getFieldDerivative ( const Vector_t< double, 3 > &  R, Vector_t< double, 3 > &  E, Vector_t< double, 3 > &  B, const DiffDirection &  dir  ) const

virtual

Implements Fieldmap.

Definition at line 73 of file FM1DDynamic.cpp.

References accuracy_m, fourierCoefs_m, length_m, Physics::pi, Physics::two_pi, and zBegin_m.

getFieldDimensions() [1/2]

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

virtual

Implements Fieldmap.

Definition at line 98 of file FM1DDynamic.cpp.

getFieldDimensions() [2/2]

void FM1DDynamic::getFieldDimensions ( double &  zBegin, double &  zEnd  ) const

virtual

Implements Fieldmap.

Definition at line 93 of file FM1DDynamic.cpp.

References zBegin_m, and zEnd_m.

getFieldGap()

double Fieldmap::getFieldGap ( )

virtualinherited

Reimplemented in FM1DProfile1.

Definition at line 684 of file Fieldmap.cpp.

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 FM1DDynamic::getFieldstrength ( const Vector_t< double, 3 > &  R, Vector_t< double, 3 > &  E, Vector_t< double, 3 > &  B  ) const

virtual

Implements Fieldmap.

Definition at line 64 of file FM1DDynamic.cpp.

References computeFieldOffAxis(), computeFieldOnAxis(), and zBegin_m.

Here is the call graph for this function:

getFrequency()

double FM1DDynamic::getFrequency ( ) const

virtual

Implements Fieldmap.

Definition at line 111 of file FM1DDynamic.cpp.

References frequency_m.

getInfo()

void FM1DDynamic::getInfo ( Inform *  msg )

virtual

Implements Fieldmap.

Definition at line 106 of file FM1DDynamic.cpp.

References endl(), Fieldmap::Filename_m, zBegin_m, and zEnd_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(), 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 FM1DDynamic::getOnaxisEz ( std::vector< std::pair< double, double > > &  eZ )

virtual

Reimplemented from Fieldmap.

Definition at line 119 of file FM1DDynamic.cpp.

References Fieldmap::Filename_m, numberOfGridPoints_m, readFileData(), scaleField(), and stripFileHeader().

Here is the call graph for this function:

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 checkFileData(), FM1DDynamic_fast::checkFileData(), FM1DElectroStatic::checkFileData(), FM1DElectroStatic_fast::checkFileData(), FM1DMagnetoStatic::checkFileData(), FM1DMagnetoStatic_fast::checkFileData(), FM1DProfile1::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()

bool FM1DDynamic::isInside ( const Vector_t< double, 3 > &  r ) const

inlinevirtual

Reimplemented from Fieldmap.

Definition at line 60 of file FM1DDynamic.h.

References zBegin_m, and zEnd_m.

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_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(), and FM3DDynamic::FM3DDynamic().

readFileData() [1/2]

double FM1DDynamic::readFileData ( std::ifstream &  fieldFile, double  fieldData[]  )

private

Definition at line 224 of file FM1DDynamic.cpp.

References Fieldmap::normalize_m, and numberOfGridPoints_m.

Referenced by getOnaxisEz(), and readMap().

readFileData() [2/2]

double FM1DDynamic::readFileData ( std::ifstream &  fieldFile, std::vector< std::pair< double, double > > &  eZ  )

private

Definition at line 246 of file FM1DDynamic.cpp.

References Fieldmap::normalize_m, numberOfGridPoints_m, zBegin_m, and zEnd_m.

readFileHeader()

bool FM1DDynamic::readFileHeader ( std::ifstream &  fieldFile )

private

Definition at line 263 of file FM1DDynamic.cpp.

References accuracy_m, Physics::e, frequency_m, Fieldmap::normalize_m, numberOfGridPoints_m, rBegin_m, rEnd_m, Util::toUpper(), zBegin_m, and zEnd_m.

Referenced by FM1DDynamic().

Here is the call graph for this function:

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 FM1DDynamic::readMap ( )

privatevirtual

Implements Fieldmap.

Definition at line 41 of file FM1DDynamic.cpp.

References computeFourierCoefficients(), endl(), Fieldmap::Filename_m, fourierCoefs_m, ippl::Info, numberOfGridPoints_m, readFileData(), stripFileHeader(), 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.

scaleField()

void FM1DDynamic::scaleField ( double  maxEz, std::vector< std::pair< double, double > > &  eZ  )

private

Definition at line 299 of file FM1DDynamic.cpp.

References numberOfGridPoints_m.

Referenced by getOnaxisEz().

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 Fieldmap::setFieldGap ( double  gap )

virtualinherited

Reimplemented in FM1DProfile1.

Definition at line 688 of file Fieldmap.cpp.

setFieldLength()

void Fieldmap::setFieldLength ( const double &  )

virtualinherited

Definition at line 492 of file Fieldmap.cpp.

setFrequency()

void FM1DDynamic::setFrequency ( double  freq )

virtual

Implements Fieldmap.

Definition at line 115 of file FM1DDynamic.cpp.

References frequency_m.

stripFileHeader()

void FM1DDynamic::stripFileHeader ( std::ifstream &  fieldFile )

private

Definition at line 304 of file FM1DDynamic.cpp.

References Fieldmap::getLine().

Referenced by getOnaxisEz(), and readMap().

Here is the call graph for this function:

swap()

void FM1DDynamic::swap ( )

virtual

Implements Fieldmap.

Definition at line 103 of file FM1DDynamic.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(), 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(), 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< 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

Fourier coefficients derived from field map.

Definition at line 57 of file FM1DDynamic.h.

Member Data Documentation

accuracy_m

int FM1DDynamic::accuracy_m

private

Number of grid points in field input file.

Definition at line 54 of file FM1DDynamic.h.

Referenced by computeFieldOnAxis(), computeFourierCoefficients(), getFieldDerivative(), and readFileHeader().

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().

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_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(), FMDummy::FMDummy(), Astra1D_fast::freeMap(), Astra1DDynamic::freeMap(), Astra1DElectroStatic::freeMap(), Astra1DMagnetoStatic::freeMap(), 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(), 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(), 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(), 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 Fieldmap::write3DField().

fourierCoefs_m

std::vector<double> FM1DDynamic::fourierCoefs_m

private

Number of Fourier coefficients to use reconstructing field.

Definition at line 55 of file FM1DDynamic.h.

Referenced by computeFieldOnAxis(), computeFourierCoefficients(), freeMap(), getFieldDerivative(), and readMap().

frequency_m

double FM1DDynamic::frequency_m

private

Definition at line 44 of file FM1DDynamic.h.

Referenced by computeFieldOffAxis(), convertHeaderData(), getFrequency(), readFileHeader(), and setFrequency().

length_m

double FM1DDynamic::length_m

private

Longitudinal end of field.

Definition at line 51 of file FM1DDynamic.h.

Referenced by computeFieldOnAxis(), FM1DDynamic(), and getFieldDerivative().

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(), readFileData(), FM1DDynamic_fast::readFileData(), FM1DElectroStatic::readFileData(), FM1DElectroStatic_fast::readFileData(), FM1DMagnetoStatic::readFileData(), 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().

numberOfGridPoints_m

int FM1DDynamic::numberOfGridPoints_m

private

Field length.

Definition at line 52 of file FM1DDynamic.h.

Referenced by checkFileData(), computeFourierCoefficients(), FM1DDynamic(), getOnaxisEz(), readFileData(), readFileHeader(), readMap(), and scaleField().

rBegin_m

double FM1DDynamic::rBegin_m

private

2 Pi divided by the field RF wavelength squared.

Definition at line 47 of file FM1DDynamic.h.

Referenced by convertHeaderData(), and readFileHeader().

rEnd_m

double FM1DDynamic::rEnd_m

private

Minimum radius of field.

Definition at line 48 of file FM1DDynamic.h.

Referenced by convertHeaderData(), and readFileHeader().

twoPiOverLambdaSq_m

double FM1DDynamic::twoPiOverLambdaSq_m

private

Field angular frequency (Hz).

Definition at line 45 of file FM1DDynamic.h.

Referenced by computeFieldOffAxis(), and convertHeaderData().

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_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 Fieldmap::getType().

zBegin_m

double FM1DDynamic::zBegin_m

private

Maximum radius of field.

Definition at line 49 of file FM1DDynamic.h.

Referenced by convertHeaderData(), FM1DDynamic(), getFieldDerivative(), getFieldDimensions(), getFieldstrength(), getInfo(), isInside(), readFileData(), and readFileHeader().

zEnd_m

double FM1DDynamic::zEnd_m

private

Longitudinal start of field.

Definition at line 50 of file FM1DDynamic.h.

Referenced by convertHeaderData(), FM1DDynamic(), getFieldDimensions(), getInfo(), isInside(), readFileData(), and readFileHeader().

---

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

• FM1DDynamic.h
• FM1DDynamic.cpp