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

#include <FM3DMagnetoStaticH5Block.h>

Inheritance diagram for FM3DMagnetoStaticH5Block:
Inheritance graph
[legend]
Collaboration diagram for FM3DMagnetoStaticH5Block:
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, double &rBegin, double &rEnd) 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 interpreteLine (std::ifstream &in, T &value, const bool &file_length_known)
 

Private Member Functions

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

Private Attributes

std::vector< h5_float64_t > FieldstrengthEz_m
 
std::vector< h5_float64_t > FieldstrengthEx_m
 
std::vector< h5_float64_t > FieldstrengthEy_m
 
std::vector< h5_float64_t > FieldstrengthBz_m
 
std::vector< h5_float64_t > FieldstrengthBx_m
 
std::vector< h5_float64_t > FieldstrengthBy_m
 
h5_float64_t frequency_m
 
h5_float64_t xbegin_m
 
h5_float64_t xend_m
 
h5_float64_t ybegin_m
 
h5_float64_t yend_m
 
h5_float64_t zbegin_m
 
h5_float64_t zend_m
 
h5_float64_t hx_m
 
h5_float64_t hy_m
 
h5_float64_t hz_m
 
h5_int64_t num_gridpx_m
 
h5_int64_t num_gridpy_m
 
h5_int64_t num_gridpz_m
 
bool swap_m
 

Friends

class Fieldmap
 

Additional Inherited Members

- Static Public Member Functions inherited from Fieldmap
static FieldmapgetFieldmap (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 (const std::string &aFilename)
 
virtual ~Fieldmap ()
 
void getLine (std::ifstream &in, std::string &buffer)
 
template<class S >
bool interpreteLine (std::ifstream &in, S &value, const bool &file_length_known=true)
 
template<class S , class T >
bool interpreteLine (std::ifstream &in, S &value1, T &value2, const bool &file_length_known=true)
 
template<class S , class T , class U >
bool interpreteLine (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 interpreteLine (std::ifstream &in, S &value1, T &value2, U &value3, V &value4, const bool &file_length_known=true)
 
template<class S >
bool interpreteLine (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 interpreteWarning (const std::string &error_msg, const std::string &expecting, const std::string &found)
 
void interpreteWarning (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 8 of file FM3DMagnetoStaticH5Block.h.

Constructor & Destructor Documentation

FM3DMagnetoStaticH5Block::FM3DMagnetoStaticH5Block ( std::string  aFilename)
private
FM3DMagnetoStaticH5Block::~FM3DMagnetoStaticH5Block ( )
private

Definition at line 80 of file FM3DMagnetoStaticH5Block.cpp.

References freeMap().

Here is the call graph for this function:

Member Function Documentation

void FM3DMagnetoStaticH5Block::freeMap ( )
privatevirtual
bool FM3DMagnetoStaticH5Block::getFieldDerivative ( const Vector_t R,
Vector_t E,
Vector_t B,
const DiffDirection dir 
) const
virtual

Implements Fieldmap.

Definition at line 287 of file FM3DMagnetoStaticH5Block.cpp.

void FM3DMagnetoStaticH5Block::getFieldDimensions ( double &  zBegin,
double &  zEnd,
double &  rBegin,
double &  rEnd 
) const
virtual

Implements Fieldmap.

Definition at line 291 of file FM3DMagnetoStaticH5Block.cpp.

References xbegin_m, xend_m, zbegin_m, and zend_m.

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

Implements Fieldmap.

Definition at line 297 of file FM3DMagnetoStaticH5Block.cpp.

bool FM3DMagnetoStaticH5Block::getFieldstrength ( const Vector_t R,
Vector_t E,
Vector_t B 
) const
virtual
double FM3DMagnetoStaticH5Block::getFrequency ( ) const
virtual

Implements Fieldmap.

Definition at line 305 of file FM3DMagnetoStaticH5Block.cpp.

void FM3DMagnetoStaticH5Block::getInfo ( Inform msg)
virtual

Implements Fieldmap.

Definition at line 301 of file FM3DMagnetoStaticH5Block.cpp.

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

Here is the call graph for this function:

bool FM3DMagnetoStaticH5Block::isInside ( const Vector_t r) const
inlinevirtual

Reimplemented from Fieldmap.

Definition at line 59 of file FM3DMagnetoStaticH5Block.h.

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

void FM3DMagnetoStaticH5Block::readMap ( )
privatevirtual
void FM3DMagnetoStaticH5Block::setFrequency ( double  freq)
virtual

Implements Fieldmap.

Definition at line 309 of file FM3DMagnetoStaticH5Block.cpp.

void FM3DMagnetoStaticH5Block::swap ( )
virtual

Implements Fieldmap.

Definition at line 299 of file FM3DMagnetoStaticH5Block.cpp.

Friends And Related Function Documentation

friend class Fieldmap
friend

Definition at line 56 of file FM3DMagnetoStaticH5Block.h.

Member Data Documentation

std::vector<h5_float64_t> FM3DMagnetoStaticH5Block::FieldstrengthBx_m
private

3D array with Bx

Definition at line 32 of file FM3DMagnetoStaticH5Block.h.

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

std::vector<h5_float64_t> FM3DMagnetoStaticH5Block::FieldstrengthBy_m
private

3D array with By

Definition at line 33 of file FM3DMagnetoStaticH5Block.h.

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

std::vector<h5_float64_t> FM3DMagnetoStaticH5Block::FieldstrengthBz_m
private

3D array with Bz

Definition at line 31 of file FM3DMagnetoStaticH5Block.h.

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

std::vector<h5_float64_t> FM3DMagnetoStaticH5Block::FieldstrengthEx_m
private

3D array with Ex

Definition at line 29 of file FM3DMagnetoStaticH5Block.h.

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

std::vector<h5_float64_t> FM3DMagnetoStaticH5Block::FieldstrengthEy_m
private

3D array with Ey

Definition at line 30 of file FM3DMagnetoStaticH5Block.h.

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

std::vector<h5_float64_t> FM3DMagnetoStaticH5Block::FieldstrengthEz_m
private

3D array with Ez

Definition at line 28 of file FM3DMagnetoStaticH5Block.h.

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

h5_float64_t FM3DMagnetoStaticH5Block::frequency_m
private

Definition at line 35 of file FM3DMagnetoStaticH5Block.h.

Referenced by FM3DMagnetoStaticH5Block().

h5_float64_t FM3DMagnetoStaticH5Block::hx_m
private

length between points in grid, x-direction

Definition at line 48 of file FM3DMagnetoStaticH5Block.h.

Referenced by FM3DMagnetoStaticH5Block(), and getFieldstrength().

h5_float64_t FM3DMagnetoStaticH5Block::hy_m
private

length between points in grid, y-direction

Definition at line 49 of file FM3DMagnetoStaticH5Block.h.

Referenced by FM3DMagnetoStaticH5Block(), and getFieldstrength().

h5_float64_t FM3DMagnetoStaticH5Block::hz_m
private

length between points in grid, z-direction

Definition at line 50 of file FM3DMagnetoStaticH5Block.h.

Referenced by FM3DMagnetoStaticH5Block(), and getFieldstrength().

h5_int64_t FM3DMagnetoStaticH5Block::num_gridpx_m
private

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

Definition at line 51 of file FM3DMagnetoStaticH5Block.h.

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

h5_int64_t FM3DMagnetoStaticH5Block::num_gridpy_m
private

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

Definition at line 52 of file FM3DMagnetoStaticH5Block.h.

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

h5_int64_t FM3DMagnetoStaticH5Block::num_gridpz_m
private

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

Definition at line 53 of file FM3DMagnetoStaticH5Block.h.

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

bool FM3DMagnetoStaticH5Block::swap_m
private

Definition at line 55 of file FM3DMagnetoStaticH5Block.h.

h5_float64_t FM3DMagnetoStaticH5Block::xbegin_m
private
h5_float64_t FM3DMagnetoStaticH5Block::xend_m
private
h5_float64_t FM3DMagnetoStaticH5Block::ybegin_m
private

Definition at line 41 of file FM3DMagnetoStaticH5Block.h.

Referenced by FM3DMagnetoStaticH5Block(), getFieldstrength(), and isInside().

h5_float64_t FM3DMagnetoStaticH5Block::yend_m
private

Definition at line 42 of file FM3DMagnetoStaticH5Block.h.

Referenced by FM3DMagnetoStaticH5Block(), and isInside().

h5_float64_t FM3DMagnetoStaticH5Block::zbegin_m
private
h5_float64_t FM3DMagnetoStaticH5Block::zend_m
private

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