OPAL (Object Oriented Parallel Accelerator Library) 2022.1
OPAL
Classes | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
FM3DH5BlockBase Class Referenceabstract

#include <FM3DH5BlockBase.h>

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

Classes

struct  IndexTriplet
 

Public Member Functions

virtual void readMap ()
 
virtual void freeMap ()
 
virtual bool getFieldstrength (const Vector_t &, Vector_t &, Vector_t &) const =0
 
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 &, Vector_t &, Vector_t &, const DiffDirection &) 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)
 
- 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)
 

Protected Types

enum  : unsigned short {
  LX = 0 , LY = 0 , LZ = 0 , HX = 4 ,
  HY = 2 , HZ = 1
}
 

Protected Member Functions

 FM3DH5BlockBase ()
 
virtual ~FM3DH5BlockBase ()
 
void openFileMPIOCollective (const std::string aFilename)
 
long long getNumSteps (void)
 
void setStep (const long long)
 
void getFieldInfo (const char *)
 
void getResonanceFrequency (void)
 
void readField (const char *name, double *x, double *y, double *z)
 
void closeFile (void)
 
virtual bool isInside (const Vector_t &r) const
 
unsigned long getIndex (unsigned int i, unsigned int j, unsigned int k) const
 
IndexTriplet getIndex (const Vector_t &X) const
 
double getWeightedData (const std::vector< double > &data, const IndexTriplet &idx, unsigned short corner) const
 
Vector_t interpolateTrilinearly (const std::vector< double > &, const std::vector< double > &, const std::vector< double > &, const Vector_t &X) const
 
- 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)
 

Protected Attributes

h5_file_t file_m
 
std::vector< double > FieldstrengthEz_m
 
std::vector< double > FieldstrengthEx_m
 
std::vector< double > FieldstrengthEy_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
 
double num_gridpx_m
 
double num_gridpy_m
 
double num_gridpz_m
 
double frequency_m
 
bool swap_m
 
- Protected Attributes inherited from Fieldmap
MapType Type
 
std::string Filename_m
 
int lines_read_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)
 
- Static Protected Member Functions inherited from Fieldmap
static void getLine (std::ifstream &in, int &lines_read, std::string &buffer)
 

Detailed Description

Definition at line 31 of file FM3DH5BlockBase.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : unsigned short
protected
Enumerator
LX 
LY 
LZ 
HX 
HY 
HZ 

Definition at line 185 of file FM3DH5BlockBase.h.

Constructor & Destructor Documentation

◆ FM3DH5BlockBase()

FM3DH5BlockBase::FM3DH5BlockBase ( )
inlineprotected

Definition at line 88 of file FM3DH5BlockBase.h.

◆ ~FM3DH5BlockBase()

virtual FM3DH5BlockBase::~FM3DH5BlockBase ( )
inlineprotectedvirtual

Definition at line 91 of file FM3DH5BlockBase.h.

Member Function Documentation

◆ closeFile()

void FM3DH5BlockBase::closeFile ( void  )
protected

Definition at line 153 of file FM3DH5BlockBase.cpp.

References file_m, and Fieldmap::Filename_m.

Referenced by FM3DH5Block::FM3DH5Block(), FM3DH5Block_nonscale::FM3DH5Block_nonscale(), FM3DMagnetoStaticH5Block::FM3DMagnetoStaticH5Block(), FM3DH5Block::readMap(), FM3DH5Block_nonscale::readMap(), and FM3DMagnetoStaticH5Block::readMap().

◆ freeMap()

virtual void FM3DH5BlockBase::freeMap ( )
inlinevirtual

Implements Fieldmap.

Reimplemented in FM3DH5Block, FM3DH5Block_nonscale, and FM3DMagnetoStaticH5Block.

Definition at line 37 of file FM3DH5BlockBase.h.

◆ getFieldDerivative()

virtual bool FM3DH5BlockBase::getFieldDerivative ( const Vector_t &  ,
Vector_t &  ,
Vector_t &  ,
const DiffDirection &   
) const
inlinevirtual

Implements Fieldmap.

Definition at line 63 of file FM3DH5BlockBase.h.

◆ getFieldDimensions() [1/2]

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

Implements Fieldmap.

Definition at line 50 of file FM3DH5BlockBase.h.

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

◆ getFieldDimensions() [2/2]

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

Implements Fieldmap.

Definition at line 43 of file FM3DH5BlockBase.h.

References zbegin_m, and zend_m.

◆ getFieldInfo()

void FM3DH5BlockBase::getFieldInfo ( const char *  name)
protected

Definition at line 68 of file FM3DH5BlockBase.cpp.

References file_m, Fieldmap::Filename_m, getNumSteps(), hx_m, hy_m, hz_m, name, num_gridpx_m, num_gridpy_m, num_gridpz_m, setStep(), xbegin_m, xend_m, ybegin_m, yend_m, zbegin_m, and zend_m.

Referenced by FM3DH5Block::FM3DH5Block(), FM3DH5Block_nonscale::FM3DH5Block_nonscale(), and FM3DMagnetoStaticH5Block::FM3DMagnetoStaticH5Block().

Here is the call graph for this function:

◆ getFieldstrength()

virtual bool FM3DH5BlockBase::getFieldstrength ( const Vector_t &  ,
Vector_t &  ,
Vector_t &   
) const
pure virtual

Implements Fieldmap.

Implemented in FM3DH5Block, FM3DH5Block_nonscale, and FM3DMagnetoStaticH5Block.

◆ getFrequency()

double FM3DH5BlockBase::getFrequency ( ) const
virtual

Implements Fieldmap.

Reimplemented in FM3DMagnetoStaticH5Block.

Definition at line 225 of file FM3DH5BlockBase.cpp.

References frequency_m.

◆ getIndex() [1/2]

IndexTriplet FM3DH5BlockBase::getIndex ( const Vector_t &  X) const
inlineprotected

Definition at line 158 of file FM3DH5BlockBase.h.

References floor(), hx_m, hy_m, hz_m, FM3DH5BlockBase::IndexTriplet::i, FM3DH5BlockBase::IndexTriplet::j, FM3DH5BlockBase::IndexTriplet::k, num_gridpx_m, num_gridpy_m, num_gridpz_m, PAssert_LT, FM3DH5BlockBase::IndexTriplet::weight, X, xbegin_m, ybegin_m, and zbegin_m.

Here is the call graph for this function:

◆ getIndex() [2/2]

unsigned long FM3DH5BlockBase::getIndex ( unsigned int  i,
unsigned int  j,
unsigned int  k 
) const
inlineprotected

Definition at line 147 of file FM3DH5BlockBase.h.

References num_gridpx_m, and num_gridpy_m.

Referenced by getWeightedData(), and interpolateTrilinearly().

◆ getInfo()

void FM3DH5BlockBase::getInfo ( Inform *  msg)
virtual

Implements Fieldmap.

Definition at line 217 of file FM3DH5BlockBase.cpp.

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

Here is the call graph for this function:

◆ getNumSteps()

long long FM3DH5BlockBase::getNumSteps ( void  )
protected

Definition at line 43 of file FM3DH5BlockBase.cpp.

References file_m, and Fieldmap::Filename_m.

Referenced by getFieldInfo(), FM3DH5Block::readMap(), FM3DH5Block_nonscale::readMap(), and FM3DMagnetoStaticH5Block::readMap().

◆ getOnaxisEz()

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

Reimplemented from Fieldmap.

Definition at line 233 of file FM3DH5BlockBase.cpp.

References abs(), FieldstrengthEz_m, floor(), hx_m, hy_m, num_gridpx_m, num_gridpy_m, num_gridpz_m, xbegin_m, ybegin_m, zbegin_m, and zend_m.

Here is the call graph for this function:

◆ getResonanceFrequency()

void FM3DH5BlockBase::getResonanceFrequency ( void  )
protected

Definition at line 112 of file FM3DH5BlockBase.cpp.

References file_m, Fieldmap::Filename_m, frequency_m, and Physics::two_pi.

Referenced by FM3DH5Block::FM3DH5Block(), FM3DH5Block_nonscale::FM3DH5Block_nonscale(), and FM3DMagnetoStaticH5Block::FM3DMagnetoStaticH5Block().

◆ getWeightedData()

double FM3DH5BlockBase::getWeightedData ( const std::vector< double > &  data,
const IndexTriplet &  idx,
unsigned short  corner 
) const
protected

Definition at line 161 of file FM3DH5BlockBase.cpp.

References getIndex(), HX, HY, HZ, FM3DH5BlockBase::IndexTriplet::i, FM3DH5BlockBase::IndexTriplet::j, FM3DH5BlockBase::IndexTriplet::k, and FM3DH5BlockBase::IndexTriplet::weight.

Referenced by interpolateTrilinearly().

Here is the call graph for this function:

◆ interpolateTrilinearly()

Vector_t FM3DH5BlockBase::interpolateTrilinearly ( const std::vector< double > &  field_strength_x,
const std::vector< double > &  field_strength_y,
const std::vector< double > &  field_strength_z,
const Vector_t &  X 
) const
protected

Definition at line 178 of file FM3DH5BlockBase.cpp.

References getIndex(), getWeightedData(), HX, HY, HZ, LX, LY, LZ, and X.

Referenced by FM3DH5Block::getFieldstrength(), FM3DH5Block_nonscale::getFieldstrength(), and FM3DMagnetoStaticH5Block::getFieldstrength().

Here is the call graph for this function:

◆ isInside()

virtual bool FM3DH5BlockBase::isInside ( const Vector_t &  r) const
inlineprotectedvirtual

Reimplemented from Fieldmap.

Definition at line 119 of file FM3DH5BlockBase.h.

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

Referenced by FM3DH5Block::getFieldstrength(), FM3DH5Block_nonscale::getFieldstrength(), and FM3DMagnetoStaticH5Block::getFieldstrength().

◆ openFileMPIOCollective()

void FM3DH5BlockBase::openFileMPIOCollective ( const std::string  aFilename)
protected

Definition at line 24 of file FM3DH5BlockBase.cpp.

References file_m, and IpplInfo::getComm().

Referenced by FM3DH5Block::FM3DH5Block(), FM3DH5Block_nonscale::FM3DH5Block_nonscale(), FM3DMagnetoStaticH5Block::FM3DMagnetoStaticH5Block(), FM3DH5Block::readMap(), FM3DH5Block_nonscale::readMap(), and FM3DMagnetoStaticH5Block::readMap().

Here is the call graph for this function:

◆ readField()

void FM3DH5BlockBase::readField ( const char *  name,
double *  x,
double *  y,
double *  z 
)
protected

Definition at line 124 of file FM3DH5BlockBase.cpp.

References file_m, Fieldmap::Filename_m, name, num_gridpx_m, num_gridpy_m, and num_gridpz_m.

Referenced by FM3DH5Block::readMap(), FM3DH5Block_nonscale::readMap(), and FM3DMagnetoStaticH5Block::readMap().

◆ readMap()

virtual void FM3DH5BlockBase::readMap ( )
inlinevirtual

Implements Fieldmap.

Reimplemented in FM3DH5Block, FM3DH5Block_nonscale, and FM3DMagnetoStaticH5Block.

Definition at line 34 of file FM3DH5BlockBase.h.

◆ setFrequency()

void FM3DH5BlockBase::setFrequency ( double  freq)
virtual

Implements Fieldmap.

Definition at line 229 of file FM3DH5BlockBase.cpp.

References frequency_m.

◆ setStep()

void FM3DH5BlockBase::setStep ( const long long  step)
protected

Definition at line 59 of file FM3DH5BlockBase.cpp.

References file_m, and Fieldmap::Filename_m.

Referenced by getFieldInfo(), FM3DH5Block::readMap(), FM3DH5Block_nonscale::readMap(), and FM3DMagnetoStaticH5Block::readMap().

◆ swap()

virtual void FM3DH5BlockBase::swap ( )
inlinevirtual

Implements Fieldmap.

Definition at line 72 of file FM3DH5BlockBase.h.

Friends And Related Function Documentation

◆ Fieldmap

friend class Fieldmap
friend

Definition at line 218 of file FM3DH5BlockBase.h.

Member Data Documentation

◆ FieldstrengthEx_m

std::vector<double> FM3DH5BlockBase::FieldstrengthEx_m
protected

3D array with Ex

Definition at line 195 of file FM3DH5BlockBase.h.

Referenced by FM3DH5Block::freeMap(), FM3DH5Block_nonscale::freeMap(), FM3DMagnetoStaticH5Block::freeMap(), FM3DH5Block::getFieldstrength(), FM3DH5Block_nonscale::getFieldstrength(), FM3DMagnetoStaticH5Block::getFieldstrength(), FM3DH5Block::readMap(), FM3DH5Block_nonscale::readMap(), and FM3DMagnetoStaticH5Block::readMap().

◆ FieldstrengthEy_m

std::vector<double> FM3DH5BlockBase::FieldstrengthEy_m
protected

3D array with Ey

Definition at line 196 of file FM3DH5BlockBase.h.

Referenced by FM3DH5Block::freeMap(), FM3DH5Block_nonscale::freeMap(), FM3DMagnetoStaticH5Block::freeMap(), FM3DH5Block::getFieldstrength(), FM3DH5Block_nonscale::getFieldstrength(), FM3DMagnetoStaticH5Block::getFieldstrength(), FM3DH5Block::readMap(), FM3DH5Block_nonscale::readMap(), and FM3DMagnetoStaticH5Block::readMap().

◆ FieldstrengthEz_m

std::vector<double> FM3DH5BlockBase::FieldstrengthEz_m
protected

3D array with Ez

Definition at line 194 of file FM3DH5BlockBase.h.

Referenced by FM3DH5Block::freeMap(), FM3DH5Block_nonscale::freeMap(), FM3DMagnetoStaticH5Block::freeMap(), FM3DH5Block::getFieldstrength(), FM3DH5Block_nonscale::getFieldstrength(), FM3DMagnetoStaticH5Block::getFieldstrength(), getOnaxisEz(), FM3DH5Block::readMap(), FM3DH5Block_nonscale::readMap(), and FM3DMagnetoStaticH5Block::readMap().

◆ file_m

h5_file_t FM3DH5BlockBase::file_m
protected

Definition at line 193 of file FM3DH5BlockBase.h.

Referenced by closeFile(), getFieldInfo(), getNumSteps(), getResonanceFrequency(), openFileMPIOCollective(), readField(), and setStep().

◆ frequency_m

double FM3DH5BlockBase::frequency_m
protected

Definition at line 215 of file FM3DH5BlockBase.h.

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

◆ hx_m

double FM3DH5BlockBase::hx_m
protected

length between points in grid, x-direction

Definition at line 207 of file FM3DH5BlockBase.h.

Referenced by getFieldInfo(), getIndex(), getInfo(), and getOnaxisEz().

◆ hy_m

double FM3DH5BlockBase::hy_m
protected

length between points in grid, y-direction

Definition at line 208 of file FM3DH5BlockBase.h.

Referenced by getFieldInfo(), getIndex(), getInfo(), and getOnaxisEz().

◆ hz_m

double FM3DH5BlockBase::hz_m
protected

length between points in grid, z-direction

Definition at line 209 of file FM3DH5BlockBase.h.

Referenced by getFieldInfo(), getIndex(), and getInfo().

◆ num_gridpx_m

double FM3DH5BlockBase::num_gridpx_m
protected

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

Definition at line 211 of file FM3DH5BlockBase.h.

Referenced by getFieldInfo(), getIndex(), getOnaxisEz(), readField(), FM3DH5Block::readMap(), FM3DH5Block_nonscale::readMap(), and FM3DMagnetoStaticH5Block::readMap().

◆ num_gridpy_m

double FM3DH5BlockBase::num_gridpy_m
protected

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

Definition at line 212 of file FM3DH5BlockBase.h.

Referenced by getFieldInfo(), getIndex(), getOnaxisEz(), readField(), FM3DH5Block::readMap(), FM3DH5Block_nonscale::readMap(), and FM3DMagnetoStaticH5Block::readMap().

◆ num_gridpz_m

double FM3DH5BlockBase::num_gridpz_m
protected

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

Definition at line 213 of file FM3DH5BlockBase.h.

Referenced by getFieldInfo(), getIndex(), getOnaxisEz(), readField(), FM3DH5Block::readMap(), FM3DH5Block_nonscale::readMap(), and FM3DMagnetoStaticH5Block::readMap().

◆ swap_m

bool FM3DH5BlockBase::swap_m
protected

Definition at line 217 of file FM3DH5BlockBase.h.

◆ xbegin_m

double FM3DH5BlockBase::xbegin_m
protected

Definition at line 198 of file FM3DH5BlockBase.h.

Referenced by getFieldDimensions(), getFieldInfo(), getIndex(), getInfo(), getOnaxisEz(), and isInside().

◆ xend_m

double FM3DH5BlockBase::xend_m
protected

Definition at line 199 of file FM3DH5BlockBase.h.

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

◆ ybegin_m

double FM3DH5BlockBase::ybegin_m
protected

Definition at line 201 of file FM3DH5BlockBase.h.

Referenced by getFieldDimensions(), getFieldInfo(), getIndex(), getInfo(), getOnaxisEz(), and isInside().

◆ yend_m

double FM3DH5BlockBase::yend_m
protected

Definition at line 202 of file FM3DH5BlockBase.h.

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

◆ zbegin_m

double FM3DH5BlockBase::zbegin_m
protected

Definition at line 204 of file FM3DH5BlockBase.h.

Referenced by getFieldDimensions(), getFieldInfo(), getIndex(), getInfo(), getOnaxisEz(), and isInside().

◆ zend_m

double FM3DH5BlockBase::zend_m
protected

Definition at line 205 of file FM3DH5BlockBase.h.

Referenced by getFieldDimensions(), getFieldInfo(), getInfo(), getOnaxisEz(), and isInside().

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