OPAL (Object Oriented Parallel Accelerator Library)  2021.1.99
OPAL
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
FM3DDynamic Class Reference

#include <FM3DDynamic.h>

Inheritance diagram for FM3DDynamic:
Inheritance graph
[legend]
Collaboration diagram for FM3DDynamic:
Collaboration graph
[legend]

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 void getOnaxisEz (std::vector< std::pair< double, double > > &F)
 
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 ()
 
template<class T >
bool interpretLine (std::ifstream &in, T &value, const bool &file_length_known)
 

Private Member Functions

 FM3DDynamic (std::string aFilename)
 
 ~FM3DDynamic ()
 
virtual void readMap ()
 
virtual void freeMap ()
 

Private Attributes

double * FieldstrengthEz_m
 
double * FieldstrengthEx_m
 
double * FieldstrengthEy_m
 
double * FieldstrengthBz_m
 
double * FieldstrengthBx_m
 
double * FieldstrengthBy_m
 
double frequency_m
 
double xbegin_m
 
double xend_m
 
double ybegin_m
 
double yend_m
 
double zbegin_m
 
double zend_m
 
double hx_m
 
double hy_m
 
double hz_m
 
unsigned int num_gridpx_m
 
unsigned int num_gridpy_m
 
unsigned int num_gridpz_m
 
bool normalize_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 FM3DDynamic.h.

Constructor & Destructor Documentation

◆ FM3DDynamic()

FM3DDynamic::FM3DDynamic ( std::string  aFilename)
private

Definition at line 14 of file FM3DDynamic.cpp.

References Fieldmap::disableFieldmapWarning(), Physics::e, Fieldmap::Filename_m, frequency_m, hx_m, hy_m, hz_m, Fieldmap::interpreteEOF(), Fieldmap::noFieldmapWarning(), normalize_m, num_gridpx_m, num_gridpy_m, num_gridpz_m, T3DDynamic, Util::toUpper(), Physics::two_pi, Fieldmap::Type, xbegin_m, xend_m, ybegin_m, yend_m, zbegin_m, and zend_m.

Here is the call graph for this function:

◆ ~FM3DDynamic()

FM3DDynamic::~FM3DDynamic ( )
private

Definition at line 104 of file FM3DDynamic.cpp.

References freeMap().

Here is the call graph for this function:

Member Function Documentation

◆ freeMap()

void FM3DDynamic::freeMap ( )
privatevirtual

Implements Fieldmap.

Definition at line 219 of file FM3DDynamic.cpp.

References endl(), FieldstrengthBx_m, FieldstrengthBy_m, FieldstrengthBz_m, FieldstrengthEx_m, FieldstrengthEy_m, FieldstrengthEz_m, Fieldmap::Filename_m, INFOMSG, level3(), and Fieldmap::typeset_msg().

Referenced by ~FM3DDynamic().

Here is the call graph for this function:

◆ getFieldDerivative()

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

Implements Fieldmap.

Definition at line 320 of file FM3DDynamic.cpp.

◆ getFieldDimensions() [1/2]

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

Implements Fieldmap.

Definition at line 328 of file FM3DDynamic.cpp.

◆ getFieldDimensions() [2/2]

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

Implements Fieldmap.

Definition at line 324 of file FM3DDynamic.cpp.

References zbegin_m, and zend_m.

◆ getFieldstrength()

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

Implements Fieldmap.

Definition at line 240 of file FM3DDynamic.cpp.

References FieldstrengthBx_m, FieldstrengthBy_m, FieldstrengthBz_m, FieldstrengthEx_m, FieldstrengthEy_m, FieldstrengthEz_m, floor(), hx_m, hy_m, hz_m, num_gridpx_m, num_gridpy_m, num_gridpz_m, Attrib::Distribution::R, xbegin_m, ybegin_m, and zbegin_m.

Referenced by getOnaxisEz().

Here is the call graph for this function:

◆ getFrequency()

double FM3DDynamic::getFrequency ( ) const
virtual

Implements Fieldmap.

Definition at line 339 of file FM3DDynamic.cpp.

References frequency_m.

◆ getInfo()

void FM3DDynamic::getInfo ( Inform *  msg)
virtual

Implements Fieldmap.

Definition at line 332 of file FM3DDynamic.cpp.

References endl(), Fieldmap::Filename_m, xbegin_m, xend_m, ybegin_m, yend_m, zbegin_m, and zend_m.

Here is the call graph for this function:

◆ getOnaxisEz()

void FM3DDynamic::getOnaxisEz ( std::vector< std::pair< double, double > > &  F)
virtual

Reimplemented from Fieldmap.

Definition at line 347 of file FM3DDynamic.cpp.

References ceil(), Util::combineFilePath(), FieldstrengthEz_m, Fieldmap::Filename_m, getFieldstrength(), OpalData::getInstance(), hx_m, hy_m, hz_m, num_gridpy_m, num_gridpz_m, Attrib::Distribution::R, xbegin_m, ybegin_m, and zbegin_m.

Here is the call graph for this function:

◆ isInside()

bool FM3DDynamic::isInside ( const Vector_t &  r) const
inlinevirtual

Reimplemented from Fieldmap.

Definition at line 56 of file FM3DDynamic.h.

References xbegin_m, xend_m, ybegin_m, yend_m, zbegin_m, and zend_m.

◆ readMap()

void FM3DDynamic::readMap ( )
privatevirtual

Implements Fieldmap.

Definition at line 108 of file FM3DDynamic.cpp.

References abs(), ceil(), Options::ebDump, endl(), FieldstrengthBx_m, FieldstrengthBy_m, FieldstrengthBz_m, FieldstrengthEx_m, FieldstrengthEy_m, FieldstrengthEz_m, Fieldmap::Filename_m, Fieldmap::getLine(), hx_m, hy_m, INFOMSG, level3(), Physics::mu_0, normalize_m, num_gridpx_m, num_gridpy_m, num_gridpz_m, Fieldmap::typeset_msg(), Fieldmap::write3DField(), xbegin_m, xend_m, ybegin_m, yend_m, zbegin_m, and zend_m.

Here is the call graph for this function:

◆ setFrequency()

void FM3DDynamic::setFrequency ( double  freq)
virtual

Implements Fieldmap.

Definition at line 343 of file FM3DDynamic.cpp.

References frequency_m.

◆ swap()

void FM3DDynamic::swap ( )
virtual

Implements Fieldmap.

Definition at line 330 of file FM3DDynamic.cpp.

Friends And Related Function Documentation

◆ Fieldmap

friend class Fieldmap
friend

Definition at line 53 of file FM3DDynamic.h.

Member Data Documentation

◆ FieldstrengthBx_m

double* FM3DDynamic::FieldstrengthBx_m
private

3D array with Bx

Definition at line 31 of file FM3DDynamic.h.

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

◆ FieldstrengthBy_m

double* FM3DDynamic::FieldstrengthBy_m
private

3D array with By

Definition at line 32 of file FM3DDynamic.h.

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

◆ FieldstrengthBz_m

double* FM3DDynamic::FieldstrengthBz_m
private

3D array with Bz

Definition at line 30 of file FM3DDynamic.h.

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

◆ FieldstrengthEx_m

double* FM3DDynamic::FieldstrengthEx_m
private

3D array with Ex

Definition at line 28 of file FM3DDynamic.h.

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

◆ FieldstrengthEy_m

double* FM3DDynamic::FieldstrengthEy_m
private

3D array with Ey

Definition at line 29 of file FM3DDynamic.h.

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

◆ FieldstrengthEz_m

double* FM3DDynamic::FieldstrengthEz_m
private

3D array with Ez

Definition at line 27 of file FM3DDynamic.h.

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

◆ frequency_m

double FM3DDynamic::frequency_m
private

Definition at line 34 of file FM3DDynamic.h.

Referenced by FM3DDynamic(), getFrequency(), and setFrequency().

◆ hx_m

double FM3DDynamic::hx_m
private

length between points in grid, x-direction

Definition at line 45 of file FM3DDynamic.h.

Referenced by FM3DDynamic(), getFieldstrength(), getOnaxisEz(), and readMap().

◆ hy_m

double FM3DDynamic::hy_m
private

length between points in grid, y-direction

Definition at line 46 of file FM3DDynamic.h.

Referenced by FM3DDynamic(), getFieldstrength(), getOnaxisEz(), and readMap().

◆ hz_m

double FM3DDynamic::hz_m
private

length between points in grid, z-direction

Definition at line 47 of file FM3DDynamic.h.

Referenced by FM3DDynamic(), getFieldstrength(), and getOnaxisEz().

◆ normalize_m

bool FM3DDynamic::normalize_m
private

Definition at line 52 of file FM3DDynamic.h.

Referenced by FM3DDynamic(), and readMap().

◆ num_gridpx_m

unsigned int FM3DDynamic::num_gridpx_m
private

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

Definition at line 48 of file FM3DDynamic.h.

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

◆ num_gridpy_m

unsigned int FM3DDynamic::num_gridpy_m
private

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

Definition at line 49 of file FM3DDynamic.h.

Referenced by FM3DDynamic(), getFieldstrength(), getOnaxisEz(), and readMap().

◆ num_gridpz_m

unsigned int FM3DDynamic::num_gridpz_m
private

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

Definition at line 50 of file FM3DDynamic.h.

Referenced by FM3DDynamic(), getFieldstrength(), getOnaxisEz(), and readMap().

◆ xbegin_m

double FM3DDynamic::xbegin_m
private

Definition at line 36 of file FM3DDynamic.h.

Referenced by FM3DDynamic(), getFieldstrength(), getInfo(), getOnaxisEz(), isInside(), and readMap().

◆ xend_m

double FM3DDynamic::xend_m
private

Definition at line 37 of file FM3DDynamic.h.

Referenced by FM3DDynamic(), getInfo(), isInside(), and readMap().

◆ ybegin_m

double FM3DDynamic::ybegin_m
private

Definition at line 39 of file FM3DDynamic.h.

Referenced by FM3DDynamic(), getFieldstrength(), getInfo(), getOnaxisEz(), isInside(), and readMap().

◆ yend_m

double FM3DDynamic::yend_m
private

Definition at line 40 of file FM3DDynamic.h.

Referenced by FM3DDynamic(), getInfo(), isInside(), and readMap().

◆ zbegin_m

double FM3DDynamic::zbegin_m
private

Definition at line 42 of file FM3DDynamic.h.

Referenced by FM3DDynamic(), getFieldDimensions(), getFieldstrength(), getInfo(), getOnaxisEz(), isInside(), and readMap().

◆ zend_m

double FM3DDynamic::zend_m
private

Definition at line 43 of file FM3DDynamic.h.

Referenced by FM3DDynamic(), getFieldDimensions(), getInfo(), isInside(), and readMap().

The documentation for this class was generated from the following files:
Generated on Wed Aug 25 2021 16:41:11 for OPAL (Object Oriented Parallel Accelerator Library) by doxygen 1.9.1