OPAL (Object Oriented Parallel Accelerator Library) 2024.2
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 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)
 

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 &filename)
 
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)
 
bool tryMapComponents (const char *name, long long step, FieldArray &x, FieldArray &y, FieldArray &z, std::size_t n)
 
bool anyNonZero (const FieldArray &x, const FieldArray &y, const FieldArray &z) const
 
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 FieldArray &data, const IndexTriplet &idx, unsigned short corner) const
 
Vector_t interpolateTrilinearly (const FieldArray &, const FieldArray &, const FieldArray &, const Vector_t &X) const
 
- Protected Member Functions inherited from _Fieldmap
 _Fieldmap ()=delete
 
 _Fieldmap (const std::string &filename)
 
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
 
FieldArray FieldstrengthEz_m
 
FieldArray FieldstrengthEx_m
 
FieldArray FieldstrengthEy_m
 
bool hasE_m = true
 
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 inv_hx_m
 
double inv_hy_m
 
double inv_hz_m
 
unsigned int num_gridpx_m
 
unsigned int num_gridpy_m
 
unsigned int 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 41 of file FM3DH5BlockBase.h.

Member Enumeration Documentation

◆ anonymous enum

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

Definition at line 264 of file FM3DH5BlockBase.h.

Constructor & Destructor Documentation

◆ _FM3DH5BlockBase()

_FM3DH5BlockBase::_FM3DH5BlockBase ( )
inlineprotected

Definition at line 98 of file FM3DH5BlockBase.h.

◆ ~_FM3DH5BlockBase()

virtual _FM3DH5BlockBase::~_FM3DH5BlockBase ( )
inlineprotectedvirtual

Definition at line 101 of file FM3DH5BlockBase.h.

Member Function Documentation

◆ anyNonZero()

bool _FM3DH5BlockBase::anyNonZero ( const FieldArray &  x,
const FieldArray &  y,
const FieldArray &  z 
) const
protected

Collective over Ippl::getComm(): true if any sample of the three components is nonzero. Each rank scans an equal share, so every sample is read once per job and all ranks get the same answer.

Definition at line 162 of file FM3DH5BlockBase.cpp.

References FieldArray::anyNonZero(), begin(), end(), IpplInfo::getComm(), IpplInfo::getNodes(), IpplInfo::myNode(), and FieldArray::size().

Referenced by _FM3DH5Block::readMap().

Here is the call graph for this function:

◆ closeFile()

void _FM3DH5BlockBase::closeFile ( void  )
protected

◆ freeMap()

virtual void _FM3DH5BlockBase::freeMap ( )
inlinevirtual

Implements _Fieldmap.

Reimplemented in _FM3DH5Block, _FM3DH5Block_nonscale, and _FM3DMagnetoStaticH5Block.

Definition at line 47 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 73 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 60 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 53 of file FM3DH5BlockBase.h.

References zbegin_m, and zend_m.

◆ getFieldInfo()

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

◆ getFieldstrength()

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

◆ getFrequency()

double _FM3DH5BlockBase::getFrequency ( ) const
virtual

Implements _Fieldmap.

Reimplemented in _FM3DMagnetoStaticH5Block.

Definition at line 253 of file FM3DH5BlockBase.cpp.

References frequency_m.

◆ getIndex() [1/2]

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

◆ getIndex() [2/2]

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

Definition at line 178 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 245 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

◆ getOnaxisEz()

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

Reimplemented from _Fieldmap.

Definition at line 261 of file FM3DH5BlockBase.cpp.

References FieldstrengthEz_m, hasE_m, hx_m, hy_m, num_gridpx_m, num_gridpy_m, num_gridpz_m, xbegin_m, ybegin_m, zbegin_m, and zend_m.

◆ getResonanceFrequency()

void _FM3DH5BlockBase::getResonanceFrequency ( void  )
protected

◆ getWeightedData()

double _FM3DH5BlockBase::getWeightedData ( const FieldArray &  data,
const IndexTriplet &  idx,
unsigned short  corner 
) const
protected

◆ interpolateTrilinearly()

Vector_t _FM3DH5BlockBase::interpolateTrilinearly ( const FieldArray &  field_strength_x,
const FieldArray &  field_strength_y,
const FieldArray &  field_strength_z,
const Vector_t &  X 
) const
protected

Definition at line 206 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

◆ openFileMPIOCollective()

void _FM3DH5BlockBase::openFileMPIOCollective ( const std::string &  filename)
protected

◆ readField()

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

◆ readMap()

virtual void _FM3DH5BlockBase::readMap ( )
inlinevirtual

Implements _Fieldmap.

Reimplemented in _FM3DH5Block, _FM3DH5Block_nonscale, and _FM3DMagnetoStaticH5Block.

Definition at line 44 of file FM3DH5BlockBase.h.

◆ setFrequency()

void _FM3DH5BlockBase::setFrequency ( double  freq)
virtual

Implements _Fieldmap.

Definition at line 257 of file FM3DH5BlockBase.cpp.

References frequency_m.

◆ setStep()

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

◆ swap()

virtual void _FM3DH5BlockBase::swap ( )
inlinevirtual

Implements _Fieldmap.

Definition at line 82 of file FM3DH5BlockBase.h.

◆ tryMapComponents()

bool _FM3DH5BlockBase::tryMapComponents ( const char *  name,
long long  step,
FieldArray &  x,
FieldArray &  y,
FieldArray &  z,
std::size_t  n 
)
protected

Try to back three components with a read-only mapping of the file instead of reading them. All three succeed or none do. Returns false when the dataset layout is not directly mappable, in which case the caller reads as before.

Definition at line 300 of file FM3DH5BlockBase.cpp.

References endl(), _Fieldmap::Filename_m, INFOMSG, level1(), name, and FieldArray::reset().

Referenced by _FM3DH5Block::readMap(), and _FM3DMagnetoStaticH5Block::readMap().

Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ _Fieldmap

friend class _Fieldmap
friend

Definition at line 308 of file FM3DH5BlockBase.h.

Member Data Documentation

◆ FieldstrengthEx_m

FieldArray _FM3DH5BlockBase::FieldstrengthEx_m
protected

◆ FieldstrengthEy_m

FieldArray _FM3DH5BlockBase::FieldstrengthEy_m
protected

◆ FieldstrengthEz_m

FieldArray _FM3DH5BlockBase::FieldstrengthEz_m
protected

◆ file_m

h5_file_t _FM3DH5BlockBase::file_m
protected

◆ frequency_m

double _FM3DH5BlockBase::frequency_m
protected

Definition at line 305 of file FM3DH5BlockBase.h.

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

◆ hasE_m

bool _FM3DH5BlockBase::hasE_m = true
protected

False once readMap() has found every Efield sample to be exactly zero; the E arrays are then released and never interpolated. Only readMap() implementations that scan clear it.

Definition at line 280 of file FM3DH5BlockBase.h.

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

◆ hx_m

double _FM3DH5BlockBase::hx_m
protected

length between points in grid, x-direction

Definition at line 291 of file FM3DH5BlockBase.h.

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

◆ hy_m

double _FM3DH5BlockBase::hy_m
protected

length between points in grid, y-direction

Definition at line 292 of file FM3DH5BlockBase.h.

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

◆ hz_m

double _FM3DH5BlockBase::hz_m
protected

length between points in grid, z-direction

Definition at line 293 of file FM3DH5BlockBase.h.

Referenced by getFieldInfo(), and getInfo().

◆ inv_hx_m

double _FM3DH5BlockBase::inv_hx_m
protected

Definition at line 297 of file FM3DH5BlockBase.h.

Referenced by getFieldInfo(), and getIndex().

◆ inv_hy_m

double _FM3DH5BlockBase::inv_hy_m
protected

Definition at line 298 of file FM3DH5BlockBase.h.

Referenced by getFieldInfo(), and getIndex().

◆ inv_hz_m

double _FM3DH5BlockBase::inv_hz_m
protected

Definition at line 299 of file FM3DH5BlockBase.h.

Referenced by getFieldInfo(), and getIndex().

◆ num_gridpx_m

unsigned int _FM3DH5BlockBase::num_gridpx_m
protected

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

Definition at line 301 of file FM3DH5BlockBase.h.

Referenced by getFieldInfo(), getIndex(), getIndex(), getOnaxisEz(), readField(), _FM3DH5Block::readMap(), _FM3DH5Block_nonscale::readMap(), and _FM3DMagnetoStaticH5Block::readMap().

◆ num_gridpy_m

unsigned int _FM3DH5BlockBase::num_gridpy_m
protected

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

Definition at line 302 of file FM3DH5BlockBase.h.

Referenced by getFieldInfo(), getIndex(), getIndex(), getOnaxisEz(), readField(), _FM3DH5Block::readMap(), _FM3DH5Block_nonscale::readMap(), and _FM3DMagnetoStaticH5Block::readMap().

◆ num_gridpz_m

unsigned int _FM3DH5BlockBase::num_gridpz_m
protected

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

Definition at line 303 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 307 of file FM3DH5BlockBase.h.

◆ xbegin_m

double _FM3DH5BlockBase::xbegin_m
protected

◆ xend_m

double _FM3DH5BlockBase::xend_m
protected

Definition at line 283 of file FM3DH5BlockBase.h.

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

◆ ybegin_m

double _FM3DH5BlockBase::ybegin_m
protected

◆ yend_m

double _FM3DH5BlockBase::yend_m
protected

Definition at line 286 of file FM3DH5BlockBase.h.

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

◆ zbegin_m

double _FM3DH5BlockBase::zbegin_m
protected

◆ zend_m

double _FM3DH5BlockBase::zend_m
protected

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