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

#include <FM1DMagnetoStatic.h>

Inheritance diagram for FM1DMagnetoStatic:
Inheritance graph
[legend]
Collaboration diagram for FM1DMagnetoStatic:
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 *)
 
virtual double getFrequency () const
 
virtual void setFrequency (double freq)
 
virtual bool isInside (const Vector_t &r) const
 
- Public Member Functions inherited from Fieldmap
virtual bool getFieldstrength (const Vector_t &R, Vector_t &E, Vector_t &B) const =0
 
virtual bool getFieldDerivative (const Vector_t &R, Vector_t &E, Vector_t &B, const DiffDirection &dir) const =0
 
virtual void getFieldDimensions (double &zBegin, double &zEnd) const =0
 
virtual void getFieldDimensions (double &xIni, double &xFinal, double &yIni, double &yFinal, double &zIni, double &zFinal) const =0
 
virtual void swap ()=0
 
virtual void getInfo (Inform *msg)=0
 
virtual double getFrequency () const =0
 
virtual void setFrequency (double freq)=0
 
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)
 
virtual bool isInside (const Vector_t &) const
 
virtual void readMap ()=0
 
virtual void freeMap ()=0
 
template<class T >
bool interpretLine (std::ifstream &in, T &value, const bool &file_length_known)
 

Private Member Functions

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

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 &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 FM1DMagnetoStatic.h.

Constructor & Destructor Documentation

◆ FM1DMagnetoStatic()

FM1DMagnetoStatic::FM1DMagnetoStatic ( std::string  aFilename)
private

Definition at line 13 of file FM1DMagnetoStatic.cpp.

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

Here is the call graph for this function:

◆ ~FM1DMagnetoStatic()

FM1DMagnetoStatic::~FM1DMagnetoStatic ( )
private

Definition at line 40 of file FM1DMagnetoStatic.cpp.

References freeMap().

Here is the call graph for this function:

Member Function Documentation

◆ checkFileData()

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

Definition at line 131 of file FM1DMagnetoStatic.cpp.

References Fieldmap::interpreteEOF(), and numberOfGridPoints_m.

Referenced by FM1DMagnetoStatic().

Here is the call graph for this function:

◆ computeFieldOffAxis()

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

Definition at line 143 of file FM1DMagnetoStatic.cpp.

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

Referenced by getFieldstrength().

Here is the call graph for this function:

◆ computeFieldOnAxis()

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

Definition at line 158 of file FM1DMagnetoStatic.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:

◆ computeFourierCoefficients()

void FM1DMagnetoStatic::computeFourierCoefficients ( double  maxEz,
double  fieldData[] 
)
private

Definition at line 191 of file FM1DMagnetoStatic.cpp.

References accuracy_m, fourierCoefs_m, and numberOfGridPoints_m.

Referenced by readMap().

◆ convertHeaderData()

void FM1DMagnetoStatic::convertHeaderData ( )
private

Definition at line 213 of file FM1DMagnetoStatic.cpp.

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

Referenced by FM1DMagnetoStatic().

◆ freeMap()

void FM1DMagnetoStatic::freeMap ( )
privatevirtual

Implements Fieldmap.

Definition at line 62 of file FM1DMagnetoStatic.cpp.

References endl(), Fieldmap::Filename_m, fourierCoefs_m, INFOMSG, level3(), and Fieldmap::typeset_msg().

Referenced by ~FM1DMagnetoStatic().

Here is the call graph for this function:

◆ getFieldDerivative()

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

Implements Fieldmap.

Definition at line 82 of file FM1DMagnetoStatic.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:

◆ getFieldDimensions() [1/2]

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

Implements Fieldmap.

Definition at line 109 of file FM1DMagnetoStatic.cpp.

◆ getFieldDimensions() [2/2]

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

Implements Fieldmap.

Definition at line 105 of file FM1DMagnetoStatic.cpp.

References zBegin_m, and zEnd_m.

◆ getFieldstrength()

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

Implements Fieldmap.

Definition at line 72 of file FM1DMagnetoStatic.cpp.

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

Here is the call graph for this function:

◆ getFrequency()

double FM1DMagnetoStatic::getFrequency ( ) const
virtual

Implements Fieldmap.

Definition at line 124 of file FM1DMagnetoStatic.cpp.

◆ getInfo()

void FM1DMagnetoStatic::getInfo ( Inform *  msg)
virtual

Implements Fieldmap.

Definition at line 117 of file FM1DMagnetoStatic.cpp.

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

Here is the call graph for this function:

◆ isInside()

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

Reimplemented from Fieldmap.

Definition at line 53 of file FM1DMagnetoStatic.h.

References zBegin_m, and zEnd_m.

◆ readFileData()

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

Definition at line 222 of file FM1DMagnetoStatic.cpp.

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

Referenced by readMap().

Here is the call graph for this function:

◆ readFileHeader()

bool FM1DMagnetoStatic::readFileHeader ( std::ifstream &  fieldFile)
private

Definition at line 247 of file FM1DMagnetoStatic.cpp.

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

Referenced by FM1DMagnetoStatic().

Here is the call graph for this function:

◆ readMap()

void FM1DMagnetoStatic::readMap ( )
privatevirtual

Implements Fieldmap.

Definition at line 44 of file FM1DMagnetoStatic.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:

◆ setFrequency()

void FM1DMagnetoStatic::setFrequency ( double  freq)
virtual

Implements Fieldmap.

Definition at line 128 of file FM1DMagnetoStatic.cpp.

◆ stripFileHeader()

void FM1DMagnetoStatic::stripFileHeader ( std::ifstream &  fieldFile)
private

Definition at line 288 of file FM1DMagnetoStatic.cpp.

References Fieldmap::getLine().

Referenced by readMap().

Here is the call graph for this function:

◆ swap()

void FM1DMagnetoStatic::swap ( )
virtual

Implements Fieldmap.

Definition at line 114 of file FM1DMagnetoStatic.cpp.

Friends And Related Function Documentation

◆ Fieldmap

friend class Fieldmap
friend

Fourier coefficients derived from field map.

Definition at line 50 of file FM1DMagnetoStatic.h.

Member Data Documentation

◆ accuracy_m

int FM1DMagnetoStatic::accuracy_m
private

Number of grid points in field input file.

Definition at line 47 of file FM1DMagnetoStatic.h.

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

◆ fourierCoefs_m

std::vector<double> FM1DMagnetoStatic::fourierCoefs_m
private

Number of Fourier coefficients to use reconstructing field.

Definition at line 48 of file FM1DMagnetoStatic.h.

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

◆ length_m

double FM1DMagnetoStatic::length_m
private

Longitudinal end of field.

Definition at line 44 of file FM1DMagnetoStatic.h.

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

◆ numberOfGridPoints_m

int FM1DMagnetoStatic::numberOfGridPoints_m
private

Field length.

Definition at line 45 of file FM1DMagnetoStatic.h.

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

◆ rBegin_m

double FM1DMagnetoStatic::rBegin_m
private

Definition at line 40 of file FM1DMagnetoStatic.h.

Referenced by convertHeaderData(), and readFileHeader().

◆ rEnd_m

double FM1DMagnetoStatic::rEnd_m
private

Minimum radius of field.

Definition at line 41 of file FM1DMagnetoStatic.h.

Referenced by convertHeaderData(), and readFileHeader().

◆ zBegin_m

double FM1DMagnetoStatic::zBegin_m
private

Maximum radius of field.

Definition at line 42 of file FM1DMagnetoStatic.h.

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

◆ zEnd_m

double FM1DMagnetoStatic::zEnd_m
private

Longitudinal start of field.

Definition at line 43 of file FM1DMagnetoStatic.h.

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

The documentation for this class was generated from the following files:
Generated on Thu Oct 20 2022 17:40:17 for OPAL (Object Oriented Parallel Accelerator Library) by doxygen 1.9.3