#include <FM2DElectroStatic.h>

Inheritance diagram for FM2DElectroStatic:

Collaboration diagram for FM2DElectroStatic:

Public Member Functions
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 *msg)

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
	FM2DElectroStatic (std::string aFilename)

	~FM2DElectroStatic ()

virtual void	readMap ()

virtual void	freeMap ()

Private Attributes
double *	FieldstrengthEz_m

double *	FieldstrengthEr_m

double	rbegin_m

double	rend_m

double	zbegin_m

double	zend_m

double	hz_m

double	hr_m

int	num_gridpr_m

int	num_gridpz_m

bool	swap_m

Friends
class	Fieldmap

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 &aFilename)

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

Constructor & Destructor Documentation

◆ FM2DElectroStatic()

FM2DElectroStatic::FM2DElectroStatic ( std::string aFilename )

private

Definition at line 10 of file FM2DElectroStatic.cpp.

References Fieldmap::disableFieldmapWarning(), Physics::e, endl(), Fieldmap::Filename_m, hr_m, hz_m, Fieldmap::interpreteEOF(), Fieldmap::lines_read_m, Fieldmap::noFieldmapWarning(), Fieldmap::normalize_m, num_gridpr_m, num_gridpz_m, rbegin_m, rend_m, swap_m, T2DElectroStatic, Util::toUpper(), Fieldmap::Type, zbegin_m, and zend_m.

Here is the call graph for this function:

◆ ~FM2DElectroStatic()

FM2DElectroStatic::~FM2DElectroStatic ( )

private

Definition at line 95 of file FM2DElectroStatic.cpp.

References freeMap().

Here is the call graph for this function:

Member Function Documentation

◆ freeMap()

void FM2DElectroStatic::freeMap ( )

privatevirtual

Implements Fieldmap.

Definition at line 155 of file FM2DElectroStatic.cpp.

References endl(), FieldstrengthEr_m, FieldstrengthEz_m, Fieldmap::Filename_m, INFOMSG, and Fieldmap::typeset_msg().

Referenced by ~FM2DElectroStatic().

Here is the call graph for this function:

◆ getFieldDerivative()

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

virtual

Implements Fieldmap.

Definition at line 202 of file FM2DElectroStatic.cpp.

◆ getFieldDimensions() [1/2]

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

virtual

Implements Fieldmap.

Definition at line 210 of file FM2DElectroStatic.cpp.

◆ getFieldDimensions() [2/2]

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

virtual

Implements Fieldmap.

Definition at line 206 of file FM2DElectroStatic.cpp.

References zbegin_m, and zend_m.

◆ getFieldstrength()

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

virtual

Implements Fieldmap.

Definition at line 167 of file FM2DElectroStatic.cpp.

References Physics::e, FieldstrengthEr_m, FieldstrengthEz_m, floor(), hr_m, hz_m, num_gridpr_m, num_gridpz_m, Attrib::Distribution::R, sqrt(), and zbegin_m.

Here is the call graph for this function:

◆ getFrequency()

double FM2DElectroStatic::getFrequency ( ) const

virtual

Implements Fieldmap.

Definition at line 221 of file FM2DElectroStatic.cpp.

◆ getInfo()

void FM2DElectroStatic::getInfo ( Inform * msg )

virtual

Implements Fieldmap.

Definition at line 217 of file FM2DElectroStatic.cpp.

References endl(), Fieldmap::Filename_m, zbegin_m, and zend_m.

Here is the call graph for this function:

◆ isInside()

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

inlinevirtual

Reimplemented from Fieldmap.

Definition at line 42 of file FM2DElectroStatic.h.

References rend_m, sqrt(), zbegin_m, and zend_m.

Here is the call graph for this function:

◆ readMap()

void FM2DElectroStatic::readMap ( )

privatevirtual

Implements Fieldmap.

Definition at line 99 of file FM2DElectroStatic.cpp.

References abs(), endl(), FieldstrengthEr_m, FieldstrengthEz_m, Fieldmap::Filename_m, Fieldmap::getLine(), INFOMSG, Fieldmap::normalize_m, num_gridpr_m, num_gridpz_m, swap_m, and Fieldmap::typeset_msg().

Here is the call graph for this function:

◆ setFrequency()

void FM2DElectroStatic::setFrequency ( double freq )

virtual

Implements Fieldmap.

Definition at line 225 of file FM2DElectroStatic.cpp.

◆ swap()

void FM2DElectroStatic::swap ( )

virtual

Implements Fieldmap.

Definition at line 212 of file FM2DElectroStatic.cpp.

References swap_m.

Friends And Related Function Documentation

◆ Fieldmap

friend class Fieldmap

friend

Definition at line 39 of file FM2DElectroStatic.h.

Member Data Documentation

◆ FieldstrengthEr_m

double* FM2DElectroStatic::FieldstrengthEr_m

private

2D array with Er, read in like Ez

Definition at line 27 of file FM2DElectroStatic.h.

Referenced by freeMap(), getFieldstrength(), and readMap().

◆ FieldstrengthEz_m

double* FM2DElectroStatic::FieldstrengthEz_m

private

2D array with Ez, read in first along z0 - r0 to rN then z1 - r0 to rN until zN - r0 to rN

Definition at line 26 of file FM2DElectroStatic.h.

Referenced by freeMap(), getFieldstrength(), and readMap().

◆ hr_m

double FM2DElectroStatic::hr_m

private

length between points in grid, r-direction, m

Definition at line 34 of file FM2DElectroStatic.h.

Referenced by FM2DElectroStatic(), and getFieldstrength().

◆ hz_m

double FM2DElectroStatic::hz_m

private

length between points in grid, z-direction, m

Definition at line 33 of file FM2DElectroStatic.h.

Referenced by FM2DElectroStatic(), and getFieldstrength().

◆ num_gridpr_m

int FM2DElectroStatic::num_gridpr_m

private

Read in number of points after 0(not counted here) in grid, r-direction

Definition at line 35 of file FM2DElectroStatic.h.

Referenced by FM2DElectroStatic(), getFieldstrength(), and readMap().

◆ num_gridpz_m

int FM2DElectroStatic::num_gridpz_m

private

Read in number of points after 0(not counted here) in grid, z-direction

Definition at line 36 of file FM2DElectroStatic.h.

Referenced by FM2DElectroStatic(), getFieldstrength(), and readMap().

◆ rbegin_m

double FM2DElectroStatic::rbegin_m

private

Definition at line 29 of file FM2DElectroStatic.h.

Referenced by FM2DElectroStatic().

◆ rend_m

double FM2DElectroStatic::rend_m

private

Definition at line 30 of file FM2DElectroStatic.h.

Referenced by FM2DElectroStatic(), and isInside().

◆ swap_m

bool FM2DElectroStatic::swap_m

private

Definition at line 38 of file FM2DElectroStatic.h.

Referenced by FM2DElectroStatic(), readMap(), and swap().

◆ zbegin_m

double FM2DElectroStatic::zbegin_m

private

Definition at line 31 of file FM2DElectroStatic.h.

Referenced by FM2DElectroStatic(), getFieldDimensions(), getFieldstrength(), getInfo(), and isInside().

◆ zend_m

double FM2DElectroStatic::zend_m

private

Definition at line 32 of file FM2DElectroStatic.h.

Referenced by FM2DElectroStatic(), getFieldDimensions(), getInfo(), and isInside().

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

/Users/gsell/src/OPAL/src/src/Classic/Fields/FM2DElectroStatic.h
/Users/gsell/src/OPAL/src/src/Classic/Fields/FM2DElectroStatic.cpp

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FM2DElectroStatic()

◆ ~FM2DElectroStatic()

Member Function Documentation

◆ freeMap()

◆ getFieldDerivative()

◆ getFieldDimensions() [1/2]

◆ getFieldDimensions() [2/2]

◆ getFieldstrength()

◆ getFrequency()

◆ getInfo()

◆ isInside()

◆ readMap()

◆ setFrequency()

◆ swap()

Friends And Related Function Documentation

◆ Fieldmap

Member Data Documentation

◆ FieldstrengthEr_m

◆ FieldstrengthEz_m

◆ hr_m

◆ hz_m

◆ num_gridpr_m

◆ num_gridpz_m

◆ rbegin_m

◆ rend_m

◆ swap_m

◆ zbegin_m

◆ zend_m