#include <FM1DElectroStatic.h>

Inheritance diagram for _FM1DElectroStatic:

Collaboration diagram for _FM1DElectroStatic:

Public Member Functions
virtual	~_FM1DElectroStatic ()

virtual bool	getFieldstrength (const Vector_t &R, Vector_t &E, Vector_t &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 &R, Vector_t &E, Vector_t &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 &r) const

Public Member Functions inherited from _Fieldmap
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)

Private Member Functions
	_FM1DElectroStatic (const std::string &filename)

virtual void	readMap ()

virtual void	freeMap ()

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

void	computeFieldOffAxis (const Vector_t &R, Vector_t &E, Vector_t &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)

Static Private Member Functions
static FM1DElectroStatic	create (const std::string &filename)

Private Attributes
double	rBegin_m

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

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

Additional Inherited Members
Static Public Member Functions inherited from _Fieldmap
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 inherited from _Fieldmap
	_Fieldmap ()=delete

	_Fieldmap (const std::string &filename)

virtual	~_Fieldmap ()

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

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

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

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

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

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

bool	interpreteEOF (std::ifstream &in)

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

void	missingValuesWarning ()

void	exceedingValuesWarning ()

void	disableFieldmapWarning ()

void	noFieldmapWarning ()

void	lowResolutionWarning (double squareError, double maxError)

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

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

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

Static Protected Member Functions inherited from _Fieldmap
static void	getLine (std::ifstream &in, int &lines_read, std::string &buffer)

Protected Attributes inherited from _Fieldmap
MapType	Type

std::string	Filename_m

int	lines_read_m

bool	normalize_m

Detailed Description

Definition at line 6 of file FM1DElectroStatic.h.

Constructor & Destructor Documentation

_FM1DElectroStatic::~_FM1DElectroStatic ( )

virtual

Definition at line 40 of file FM1DElectroStatic.cpp.

References freeMap().

Here is the call graph for this function:

_FM1DElectroStatic::_FM1DElectroStatic ( const std::string & filename )

private

Definition at line 13 of file FM1DElectroStatic.cpp.

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

Referenced by create().

Here is the call graph for this function:

Member Function Documentation

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

private

Definition at line 132 of file FM1DElectroStatic.cpp.

References _Fieldmap::interpreteEOF(), and numberOfGridPoints_m.

Referenced by _FM1DElectroStatic().

Here is the call graph for this function:

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

private

Definition at line 144 of file FM1DElectroStatic.cpp.

References pow(), and Attrib::Distribution::R.

Referenced by getFieldstrength().

Here is the call graph for this function:

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

private

Definition at line 159 of file FM1DElectroStatic.cpp.

References accuracy_m, cos(), fourierCoefs_m, length_m, Hypervolume::n, Physics::pi, pow(), sin(), and Physics::two_pi.

Referenced by getFieldstrength().

Here is the call graph for this function:

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

private

Definition at line 192 of file FM1DElectroStatic.cpp.

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

Referenced by readMap().

void _FM1DElectroStatic::convertHeaderData ( )

private

Definition at line 214 of file FM1DElectroStatic.cpp.

References Units::cm2m, rBegin_m, rEnd_m, zBegin_m, and zEnd_m.

Referenced by _FM1DElectroStatic().

FM1DElectroStatic _FM1DElectroStatic::create ( const std::string & filename )

staticprivate

Definition at line 44 of file FM1DElectroStatic.cpp.

References _FM1DElectroStatic().

Referenced by _Fieldmap::getFieldmap().

Here is the call graph for this function:

void _FM1DElectroStatic::freeMap ( )

privatevirtual

Implements _Fieldmap.

Definition at line 67 of file FM1DElectroStatic.cpp.

References fourierCoefs_m.

Referenced by ~_FM1DElectroStatic().

bool _FM1DElectroStatic::getFieldDerivative	(	const Vector_t &	R,
		Vector_t &	E,
		Vector_t &	B,
		const DiffDirection &	dir
	)		const

virtual

Implements _Fieldmap.

Definition at line 84 of file FM1DElectroStatic.cpp.

References accuracy_m, cos(), fourierCoefs_m, length_m, Hypervolume::n, Physics::pi, Attrib::Distribution::R, sin(), Physics::two_pi, and zBegin_m.

Here is the call graph for this function:

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

virtual

Implements _Fieldmap.

Definition at line 107 of file FM1DElectroStatic.cpp.

References zBegin_m, and zEnd_m.

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

virtual

Implements _Fieldmap.

Definition at line 111 of file FM1DElectroStatic.cpp.

bool _FM1DElectroStatic::getFieldstrength	(	const Vector_t &	R,
		Vector_t &	E,
		Vector_t &	B
	)		const

virtual

Implements _Fieldmap.

Definition at line 74 of file FM1DElectroStatic.cpp.

References computeFieldOffAxis(), computeFieldOnAxis(), Attrib::Distribution::R, and zBegin_m.

Here is the call graph for this function:

double _FM1DElectroStatic::getFrequency ( ) const

virtual

Implements _Fieldmap.

Definition at line 125 of file FM1DElectroStatic.cpp.

void _FM1DElectroStatic::getInfo ( Inform * msg )

virtual

Implements _Fieldmap.

Definition at line 118 of file FM1DElectroStatic.cpp.

References endl(), _Fieldmap::Filename_m, zBegin_m, and zEnd_m.

Here is the call graph for this function:

bool _FM1DElectroStatic::isInside ( const Vector_t & r ) const

inlinevirtual

Reimplemented from _Fieldmap.

Definition at line 56 of file FM1DElectroStatic.h.

References zBegin_m, and zEnd_m.

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

private

Definition at line 223 of file FM1DElectroStatic.cpp.

References abs(), _Fieldmap::normalize_m, and numberOfGridPoints_m.

Referenced by readMap().

Here is the call graph for this function:

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

private

Definition at line 248 of file FM1DElectroStatic.cpp.

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

Referenced by _FM1DElectroStatic().

Here is the call graph for this function:

void _FM1DElectroStatic::readMap ( )

privatevirtual

Implements _Fieldmap.

Definition at line 49 of file FM1DElectroStatic.cpp.

References computeFourierCoefficients(), endl(), _Fieldmap::Filename_m, fourierCoefs_m, INFOMSG, level3(), numberOfGridPoints_m, readFileData(), stripFileHeader(), and _Fieldmap::typeset_msg().

Here is the call graph for this function:

void _FM1DElectroStatic::setFrequency ( double freq )

virtual

Implements _Fieldmap.

Definition at line 129 of file FM1DElectroStatic.cpp.

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

private

Definition at line 291 of file FM1DElectroStatic.cpp.

References _Fieldmap::getLine().

Referenced by readMap().

Here is the call graph for this function:

void _FM1DElectroStatic::swap ( )

virtual

Implements _Fieldmap.

Definition at line 115 of file FM1DElectroStatic.cpp.

Friends And Related Function Documentation

friend class _Fieldmap

friend

Fourier coefficients derived from field map.

Definition at line 53 of file FM1DElectroStatic.h.

Member Data Documentation

int _FM1DElectroStatic::accuracy_m

private

Number of grid points in field input file.

Definition at line 50 of file FM1DElectroStatic.h.

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

std::vector<double> _FM1DElectroStatic::fourierCoefs_m

private

Number of Fourier coefficients to use reconstructing field.

Definition at line 51 of file FM1DElectroStatic.h.

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

double _FM1DElectroStatic::length_m

private

Longitudinal end of field.

Definition at line 47 of file FM1DElectroStatic.h.

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

int _FM1DElectroStatic::numberOfGridPoints_m

private

Field length.

Definition at line 48 of file FM1DElectroStatic.h.

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

double _FM1DElectroStatic::rBegin_m

private

Definition at line 43 of file FM1DElectroStatic.h.

Referenced by convertHeaderData(), and readFileHeader().

double _FM1DElectroStatic::rEnd_m

private

Minimum radius of field.

Definition at line 44 of file FM1DElectroStatic.h.

Referenced by convertHeaderData(), and readFileHeader().

double _FM1DElectroStatic::zBegin_m

private

Maximum radius of field.

Definition at line 45 of file FM1DElectroStatic.h.

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

double _FM1DElectroStatic::zEnd_m

private

Longitudinal start of field.

Definition at line 46 of file FM1DElectroStatic.h.

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

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

src/Classic/Fields/FM1DElectroStatic.h
src/Classic/Fields/FM1DElectroStatic.cpp

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation