#include <FM1DElectroStatic.h>

Inheritance diagram for FM1DElectroStatic:

Collaboration diagram for FM1DElectroStatic:

Public Member Functions
virtual bool	getFieldstrength (const Vector_t< double, 3 > &R, Vector_t< double, 3 > &E, Vector_t< double, 3 > &B) 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 bool	getFieldDerivative (const Vector_t< double, 3 > &R, Vector_t< double, 3 > &E, Vector_t< double, 3 > &B, const DiffDirection &dir) const
virtual void	swap ()
virtual void	getInfo (Inform *)
virtual double	getFrequency () const
virtual void	setFrequency (double freq)
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 ()
virtual void	getOnaxisEz (std::vector< std::pair< double, double > > &onaxis)
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
	FM1DElectroStatic (std::string aFilename)
	~FM1DElectroStatic ()
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[])
bool	readFileHeader (std::ifstream &fieldFile)
void	stripFileHeader (std::ifstream &fieldFile)

Private Attributes
double	rBegin_m
double	rEnd_m
	Minimum radius of field.
double	zBegin_m
	Maximum radius of field.
double	zEnd_m
	Longitudinal start of field.
double	length_m
	Longitudinal end of field.
int	numberOfGridPoints_m
	Field length.
int	accuracy_m
	Number of grid points in field input file.
std::vector< double >	fourierCoefs_m
	Number of Fourier coefficients to use reconstructing field.

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.

Detailed Description

Definition at line 6 of file FM1DElectroStatic.h.

Constructor & Destructor Documentation

◆ FM1DElectroStatic()

FM1DElectroStatic::FM1DElectroStatic ( std::string aFilename )

private

Definition at line 13 of file FM1DElectroStatic.cpp.

References checkFileData(), convertHeaderData(), Fieldmap::disableFieldmapWarning(), Fieldmap, Fieldmap::Filename_m, FM1DElectroStatic(), length_m, Fieldmap::noFieldmapWarning(), numberOfGridPoints_m, readFileHeader(), T1DElectroStatic, Fieldmap::Type, zBegin_m, and zEnd_m.

Referenced by FM1DElectroStatic().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~FM1DElectroStatic()

FM1DElectroStatic::~FM1DElectroStatic ( )

private

Definition at line 36 of file FM1DElectroStatic.cpp.

References freeMap(), and ~FM1DElectroStatic().

Referenced by ~FM1DElectroStatic().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ checkFileData()

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

private

Definition at line 116 of file FM1DElectroStatic.cpp.

References checkFileData(), Fieldmap::interpreteEOF(), Fieldmap::interpretLine(), and numberOfGridPoints_m.

Referenced by checkFileData(), and FM1DElectroStatic().

Here is the call graph for this function:

Here is the caller 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 checkMap(), Util::combineFilePath(), end(), Filename_m, OpalData::getInstance(), 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 checkMap().

Referenced by checkMap(), 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:

Here is the caller graph for this function:

◆ clearDictionary()

void Fieldmap::clearDictionary ( )

staticinherited

Definition at line 237 of file Fieldmap.cpp.

References clearDictionary(), and FieldmapDictionary.

Referenced by clearDictionary().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeFieldOffAxis()

void FM1DElectroStatic::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 124 of file FM1DElectroStatic.cpp.

References computeFieldOffAxis().

Referenced by computeFieldOffAxis(), and getFieldstrength().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeFieldOnAxis()

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

private

Definition at line 136 of file FM1DElectroStatic.cpp.

References accuracy_m, computeFieldOnAxis(), fourierCoefs_m, length_m, Physics::pi, and Physics::two_pi.

Referenced by computeFieldOnAxis(), and getFieldstrength().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeFourierCoefficients()

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

private

Definition at line 169 of file FM1DElectroStatic.cpp.

References accuracy_m, computeFourierCoefficients(), fourierCoefs_m, numberOfGridPoints_m, and Units::Vpm2MVpm.

Referenced by computeFourierCoefficients(), and readMap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ convertHeaderData()

void FM1DElectroStatic::convertHeaderData ( )

private

Definition at line 190 of file FM1DElectroStatic.cpp.

References Units::cm2m, convertHeaderData(), rBegin_m, rEnd_m, zBegin_m, and zEnd_m.

Referenced by convertHeaderData(), and FM1DElectroStatic().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteFieldmap()

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

staticinherited

Definition at line 233 of file Fieldmap.cpp.

References deleteFieldmap(), and freeMap().

Referenced by deleteFieldmap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ disableFieldmapWarning()

void Fieldmap::disableFieldmapWarning ( )

protectedinherited

Definition at line 569 of file Fieldmap.cpp.

References disableFieldmapWarning(), and Filename_m.

Referenced by Astra1DDynamic::Astra1DDynamic(), Astra1DDynamic_fast::Astra1DDynamic_fast(), Astra1DElectroStatic::Astra1DElectroStatic(), Astra1DElectroStatic_fast::Astra1DElectroStatic_fast(), Astra1DMagnetoStatic::Astra1DMagnetoStatic(), Astra1DMagnetoStatic_fast::Astra1DMagnetoStatic_fast(), disableFieldmapWarning(), 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(), FM3DMagnetoStaticExtended::FM3DMagnetoStaticExtended(), and FMDummy::FMDummy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exceedingValuesWarning()

void Fieldmap::exceedingValuesWarning ( )

protectedinherited

Definition at line 559 of file Fieldmap.cpp.

References exceedingValuesWarning(), Filename_m, and lines_read_m.

Referenced by exceedingValuesWarning(), and interpreteEOF().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freeMap() [1/2]

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

staticinherited

Definition at line 394 of file Fieldmap.cpp.

References FieldmapDictionary, and freeMap().

Referenced by freeMap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freeMap() [2/2]

void FM1DElectroStatic::freeMap ( )

privatevirtual

Implements Fieldmap.

Definition at line 56 of file FM1DElectroStatic.cpp.

References Fieldmap::Filename_m, fourierCoefs_m, freeMap(), and Fieldmap::typeset_msg().

Referenced by freeMap(), and ~FM1DElectroStatic().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get1DProfile1EngeCoeffs()

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

virtualinherited

Reimplemented in FM1DProfile1.

Definition at line 671 of file Fieldmap.cpp.

References get1DProfile1EngeCoeffs().

Referenced by get1DProfile1EngeCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get1DProfile1EntranceParam()

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

virtualinherited

Reimplemented in FM1DProfile1.

Definition at line 675 of file Fieldmap.cpp.

References get1DProfile1EntranceParam().

Referenced by get1DProfile1EntranceParam().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get1DProfile1ExitParam()

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

virtualinherited

Reimplemented in FM1DProfile1.

Definition at line 680 of file Fieldmap.cpp.

References get1DProfile1ExitParam().

Referenced by get1DProfile1ExitParam().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFieldDerivative()

bool FM1DElectroStatic::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 FM1DElectroStatic.cpp.

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

Referenced by getFieldDerivative().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFieldDimensions() [1/2]

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

virtual

Implements Fieldmap.

Definition at line 96 of file FM1DElectroStatic.cpp.

References getFieldDimensions().

Here is the call graph for this function:

◆ getFieldDimensions() [2/2]

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

virtual

Implements Fieldmap.

Definition at line 92 of file FM1DElectroStatic.cpp.

References getFieldDimensions(), zBegin_m, and zEnd_m.

Referenced by getFieldDimensions(), and getFieldDimensions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFieldGap()

double Fieldmap::getFieldGap ( )

virtualinherited

Reimplemented in FM1DProfile1.

Definition at line 684 of file Fieldmap.cpp.

References getFieldGap().

Referenced by getFieldGap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFieldmap()

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

staticinherited

Definition at line 54 of file Fieldmap.cpp.

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

Referenced by getFieldmap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFieldstrength()

bool FM1DElectroStatic::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 FM1DElectroStatic.cpp.

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

Referenced by getFieldstrength().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFrequency()

double FM1DElectroStatic::getFrequency ( ) const

virtual

Implements Fieldmap.

Definition at line 109 of file FM1DElectroStatic.cpp.

References getFrequency().

Referenced by getFrequency().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInfo()

void FM1DElectroStatic::getInfo ( Inform * msg )

virtual

Implements Fieldmap.

Definition at line 104 of file FM1DElectroStatic.cpp.

References Fieldmap::Filename_m, getInfo(), zBegin_m, and zEnd_m.

Referenced by getInfo().

Here is the call graph for this function:

Here is the caller 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 alpha_numeric, buffer_m, getLine(), and READ_BUFFER_LENGTH.

Here is the call graph for this function:

◆ getLine() [2/2]

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

inlineprotectedinherited

Definition at line 124 of file Fieldmap.h.

References getLine(), and lines_read_m.

Referenced by getLine(), 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:

Here is the caller graph for this function:

◆ getListFieldmapNames()

std::vector< std::string > Fieldmap::getListFieldmapNames ( )

staticinherited

Definition at line 224 of file Fieldmap.cpp.

References FieldmapDictionary, and getListFieldmapNames().

Referenced by getListFieldmapNames().

Here is the call graph for this function:

Here is the caller graph for this function:

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

References getOnaxisEz().

Referenced by getOnaxisEz().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getType()

MapType Fieldmap::getType ( )

inlineinherited

Definition at line 96 of file Fieldmap.h.

References Type.

◆ interpreteEOF()

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

protectedinherited

Definition at line 516 of file Fieldmap.cpp.

References alpha_numeric, buffer_m, exceedingValuesWarning(), interpreteEOF(), 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::FM1DProfile1(), FM1DProfile2::FM1DProfile2(), FM2DDynamic::FM2DDynamic(), FM2DElectroStatic::FM2DElectroStatic(), FM2DMagnetoStatic::FM2DMagnetoStatic(), FM3DDynamic::FM3DDynamic(), FM3DMagnetoStatic::FM3DMagnetoStatic(), FM3DMagnetoStaticExtended::FM3DMagnetoStaticExtended(), and interpreteEOF().

Here is the call graph for this function:

Here is the caller 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(), FM1DDynamic::checkFileData(), FM1DDynamic_fast::checkFileData(), FM1DElectroStatic::checkFileData(), FM1DElectroStatic_fast::checkFileData(), FM1DMagnetoStatic::checkFileData(), FM1DMagnetoStatic_fast::checkFileData(), Astra1D_fast::determineNumSamplingPoints(), FM1DProfile1::FM1DProfile1(), FM1DProfile2::FM1DProfile2(), FM2DDynamic::FM2DDynamic(), FM2DElectroStatic::FM2DElectroStatic(), FM2DMagnetoStatic::FM2DMagnetoStatic(), FM3DDynamic::FM3DDynamic(), FM3DMagnetoStatic::FM3DMagnetoStatic(), FM3DMagnetoStaticExtended::FM3DMagnetoStaticExtended(), Astra1DDynamic::getOnaxisEz(), Astra1DDynamic_fast::getOnaxisEz(), interpretLine(), interpretLine(), interpretLine(), interpretLine(), interpretLine(), 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(), interpretLine(), 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(), interpretLine(), 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(), interpretLine(), 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(), interpretLine(), 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(), interpretLine(), 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 532 of file Fieldmap.cpp.

References Filename_m, interpretWarning(), and lines_read_m.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isInside()

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

inlinevirtual

Reimplemented from Fieldmap.

Definition at line 53 of file FM1DElectroStatic.h.

References isInside(), zBegin_m, and zEnd_m.

Referenced by isInside().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lowResolutionWarning()

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

protectedinherited

Definition at line 583 of file Fieldmap.cpp.

References Filename_m, OpalData::getAuxiliaryOutputDirectory(), OpalData::getInstance(), lowResolutionWarning(), and typeset_msg().

Referenced by checkMap(), and lowResolutionWarning().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ missingValuesWarning()

void Fieldmap::missingValuesWarning ( )

protectedinherited

Definition at line 550 of file Fieldmap.cpp.

References Filename_m, lines_read_m, and missingValuesWarning().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ noFieldmapWarning()

void Fieldmap::noFieldmapWarning ( )

protectedinherited

Definition at line 576 of file Fieldmap.cpp.

References Filename_m, and noFieldmapWarning().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readFileData()

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

private

Definition at line 198 of file FM1DElectroStatic.cpp.

References Fieldmap::interpretLine(), Fieldmap::normalize_m, numberOfGridPoints_m, and readFileData().

Referenced by readFileData(), and readMap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readFileHeader()

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

private

Definition at line 220 of file FM1DElectroStatic.cpp.

References accuracy_m, Fieldmap::interpretLine(), Fieldmap::normalize_m, numberOfGridPoints_m, rBegin_m, readFileHeader(), rEnd_m, Util::toUpper(), zBegin_m, and zEnd_m.

Referenced by FM1DElectroStatic(), and readFileHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readHeader()

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

staticinherited

Definition at line 246 of file Fieldmap.cpp.

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

Referenced by getFieldmap(), and readHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readMap() [1/2]

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

staticinherited

Definition at line 384 of file Fieldmap.cpp.

References FieldmapDictionary, and readMap().

Referenced by readMap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readMap() [2/2]

void FM1DElectroStatic::readMap ( )

privatevirtual

Implements Fieldmap.

Definition at line 40 of file FM1DElectroStatic.cpp.

References computeFourierCoefficients(), Fieldmap::Filename_m, fourierCoefs_m, numberOfGridPoints_m, readFileData(), readMap(), stripFileHeader(), and Fieldmap::typeset_msg().

Referenced by readMap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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.

References setEdgeConstants().

Referenced by setEdgeConstants().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFieldGap()

void Fieldmap::setFieldGap ( double gap )

virtualinherited

Reimplemented in FM1DProfile1.

Definition at line 688 of file Fieldmap.cpp.

References setFieldGap().

Referenced by setFieldGap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFieldLength()

void Fieldmap::setFieldLength ( const double & )

virtualinherited

Definition at line 492 of file Fieldmap.cpp.

References setFieldLength().

Referenced by setFieldLength().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFrequency()

void FM1DElectroStatic::setFrequency ( double freq )

virtual

Implements Fieldmap.

Definition at line 113 of file FM1DElectroStatic.cpp.

References setFrequency().

Referenced by setFrequency().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ stripFileHeader()

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

private

Definition at line 255 of file FM1DElectroStatic.cpp.

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

Referenced by readMap(), and stripFileHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ swap()

void FM1DElectroStatic::swap ( )

virtual

Implements Fieldmap.

Definition at line 101 of file FM1DElectroStatic.cpp.

References swap().

Referenced by swap().

Here is the call graph for this function:

Here is the caller graph for this function:

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

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(), 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(), FM1DProfile1::readMap(), FM1DProfile2::readMap(), FM2DDynamic::readMap(), FM2DElectroStatic::readMap(), FM2DMagnetoStatic::readMap(), FM3DDynamic::readMap(), FM3DH5Block::readMap(), FM3DH5Block_nonscale::readMap(), FM3DMagnetoStatic::readMap(), FM3DMagnetoStaticExtended::readMap(), FM3DMagnetoStaticH5Block::readMap(), and typeset_msg().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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(), Filename_m, OpalData::getAuxiliaryOutputDirectory(), OpalData::getInstance(), and write3DField().

Referenced by FM3DDynamic::readMap(), and write3DField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Fieldmap

friend class Fieldmap

friend

Fourier coefficients derived from field map.

Definition at line 50 of file FM1DElectroStatic.h.

References Fieldmap.

Referenced by Fieldmap, and FM1DElectroStatic().

Member Data Documentation

◆ accuracy_m

int FM1DElectroStatic::accuracy_m

private

Number of grid points in field input file.

Definition at line 47 of file FM1DElectroStatic.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 getLine(), and interpreteEOF().

◆ buffer_m

char Fieldmap::buffer_m

staticprivateinherited

Definition at line 181 of file Fieldmap.h.

Referenced by getLine(), and 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 clearDictionary(), freeMap(), getFieldmap(), getListFieldmapNames(), and readMap().

◆ Filename_m

std::string Fieldmap::Filename_m

protectedinherited

Definition at line 120 of file Fieldmap.h.

◆ fourierCoefs_m

std::vector<double> FM1DElectroStatic::fourierCoefs_m

private

Number of Fourier coefficients to use reconstructing field.

Definition at line 48 of file FM1DElectroStatic.h.

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

◆ length_m

double FM1DElectroStatic::length_m

private

Longitudinal end of field.

Definition at line 44 of file FM1DElectroStatic.h.

Referenced by computeFieldOnAxis(), FM1DElectroStatic(), 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(), exceedingValuesWarning(), Fieldmap(), FM1DProfile2::FM1DProfile2(), FM2DDynamic::FM2DDynamic(), FM2DElectroStatic::FM2DElectroStatic(), FM2DMagnetoStatic::FM2DMagnetoStatic(), FM3DMagnetoStaticExtended::FM3DMagnetoStaticExtended(), getLine(), interpreteEOF(), interpretWarning(), missingValuesWarning(), and 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(), 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().

◆ numberOfGridPoints_m

int FM1DElectroStatic::numberOfGridPoints_m

private

Field length.

Definition at line 45 of file FM1DElectroStatic.h.

Referenced by checkFileData(), computeFourierCoefficients(), FM1DElectroStatic(), readFileData(), readFileHeader(), and readMap().

◆ rBegin_m

double FM1DElectroStatic::rBegin_m

private

Definition at line 40 of file FM1DElectroStatic.h.

Referenced by convertHeaderData(), and readFileHeader().

◆ rEnd_m

double FM1DElectroStatic::rEnd_m

private

Minimum radius of field.

Definition at line 41 of file FM1DElectroStatic.h.

Referenced by convertHeaderData(), and readFileHeader().

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

◆ zBegin_m

double FM1DElectroStatic::zBegin_m

private

Maximum radius of field.

Definition at line 42 of file FM1DElectroStatic.h.

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

◆ zEnd_m

double FM1DElectroStatic::zEnd_m

private

Longitudinal start of field.

Definition at line 43 of file FM1DElectroStatic.h.

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

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

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

Detailed Description

Constructor & Destructor Documentation

◆ FM1DElectroStatic()

◆ ~FM1DElectroStatic()

Member Function Documentation

◆ checkFileData()

◆ checkMap() [1/2]

◆ checkMap() [2/2]

◆ clearDictionary()

◆ computeFieldOffAxis()

◆ computeFieldOnAxis()

◆ computeFourierCoefficients()

◆ convertHeaderData()

◆ deleteFieldmap()

◆ disableFieldmapWarning()

◆ exceedingValuesWarning()

◆ freeMap() [1/2]

◆ freeMap() [2/2]

◆ get1DProfile1EngeCoeffs()

◆ get1DProfile1EntranceParam()

◆ get1DProfile1ExitParam()

◆ getFieldDerivative()

◆ getFieldDimensions() [1/2]

◆ getFieldDimensions() [2/2]

◆ getFieldGap()

◆ getFieldmap()

◆ getFieldstrength()

◆ getFrequency()

◆ getInfo()

◆ getLine() [1/2]

◆ getLine() [2/2]

◆ getListFieldmapNames()

◆ getOnaxisEz()

◆ getType()

◆ interpreteEOF()

◆ interpretLine() [1/6]

◆ interpretLine() [2/6]

◆ interpretLine() [3/6]

◆ interpretLine() [4/6]

◆ interpretLine() [5/6]

◆ interpretLine() [6/6]

◆ interpretWarning()

◆ isInside()

◆ lowResolutionWarning()

◆ missingValuesWarning()

◆ noFieldmapWarning()

◆ readFileData()

◆ readFileHeader()

◆ readHeader()

◆ readMap() [1/2]

◆ readMap() [2/2]

◆ setEdgeConstants()

◆ setFieldGap()

◆ setFieldLength()

◆ setFrequency()

◆ stripFileHeader()

◆ swap()

◆ typeset_msg()

◆ write3DField()

Friends And Related Symbol Documentation

◆ Fieldmap

Member Data Documentation

◆ accuracy_m

◆ alpha_numeric

◆ buffer_m

◆ FieldmapDictionary

◆ Filename_m

◆ fourierCoefs_m

◆ length_m

◆ lines_read_m

◆ normalize_m