OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
FM3DMagnetoStatic.h
Go to the documentation of this file.
1#ifndef CLASSIC_FIELDMAP3DMAGNETOSTATIC_HH
2#define CLASSIC_FIELDMAP3DMAGNETOSTATIC_HH
3
4#include "Fields/Fieldmap.h"
5
7
8public:
9 virtual ~_FM3DMagnetoStatic();
10
11 virtual bool getFieldstrength(const Vector_t &R, Vector_t &E, Vector_t &B) const;
12 virtual void getFieldDimensions(double &zBegin, double &zEnd) const;
13 virtual void getFieldDimensions(double &xIni, double &xFinal, double &yIni, double &yFinal, double &zIni, double &zFinal) const;
14 virtual bool getFieldDerivative(const Vector_t &R, Vector_t &E, Vector_t &B, const DiffDirection &dir) const;
15 virtual void swap();
16 virtual void getInfo(Inform *msg);
17 virtual double getFrequency() const;
18 virtual void setFrequency(double freq);
19
20 virtual bool isInside(const Vector_t &r) const;
21private:
22 _FM3DMagnetoStatic(const std::string& filename);
23
24 static FM3DMagnetoStatic create(const std::string& filename);
25
26 virtual void readMap();
27 virtual void freeMap();
28
29 struct IndexTriplet {
30 unsigned int i;
31 unsigned int j;
32 unsigned int k;
35 i(0),
36 j(0),
37 k(0),
38 weight(0.0)
39 { }
40 };
41
42 IndexTriplet getIndex(const Vector_t &X) const;
43 unsigned long getIndex(unsigned int i, unsigned int j, unsigned int k) const;
45 double getWeightedData(double *data, const IndexTriplet &idx, unsigned short corner) const;
46
47 enum { LX = 0, // low X
48 LY = 0, // low Y
49 LZ = 0, // low Z
50 HX = 4, // high X
51 HY = 2, // high Y
52 HZ = 1}; // high Z
53
57
58 double xbegin_m;
59 double xend_m;
60
61 double ybegin_m;
62 double yend_m;
63
64 double zbegin_m;
65 double zend_m;
66
67 double hx_m;
68 double hy_m;
69 double hz_m;
70 unsigned int num_gridpx_m;
71 unsigned int num_gridpy_m;
72 unsigned int num_gridpz_m;
73
74 friend class _Fieldmap;
75};
76
77inline
79{
80 return ((r(0) >= xbegin_m && r(0) < xend_m)
81 && (r(1) >= ybegin_m && r(1) < yend_m)
82 && (r(2) >= zbegin_m && r(2) < zend_m));
83}
84
85inline
87 return 0.0;
88}
89
90inline
91void _FM3DMagnetoStatic::setFrequency(double /*freq*/) { }
92
93inline
94unsigned long _FM3DMagnetoStatic::getIndex(unsigned int i, unsigned int j, unsigned int k) const
95{
96 unsigned long result = i + j * num_gridpx_m;
97 result = k + result * num_gridpz_m;
99 return result;
100}
101
102inline
104 IndexTriplet idx;
105 idx.i = std::floor((X(0) - xbegin_m) / hx_m);
106 idx.j = std::floor((X(1) - ybegin_m) / hy_m);
107 idx.k = std::floor((X(2) - zbegin_m)/ hz_m);
108 PAssert_LT(idx.i, num_gridpx_m - 1);
109 PAssert_LT(idx.j, num_gridpy_m - 1);
110 PAssert_LT(idx.k, num_gridpz_m - 1);
111
112 idx.weight(0) = (X(0) - xbegin_m) / hx_m - idx.i;
113 idx.weight(1) = (X(1) - ybegin_m) / hy_m - idx.j;
114 idx.weight(2) = (X(2) - zbegin_m) / hz_m - idx.k;
115
116 return idx;
117}
118
119using FM3DMagnetoStatic = std::shared_ptr<_FM3DMagnetoStatic>;
120
121#endif
std::shared_ptr< _FM3DMagnetoStatic > FM3DMagnetoStatic
Definition Definitions.h:69
std::shared_ptr< _FM3DMagnetoStatic > FM3DMagnetoStatic
DiffDirection
Definition Fieldmap.h:55
#define X(arg)
Definition fftpack.cpp:106
#define PAssert_LT(a, b)
Definition PAssert.h:106
unsigned int num_gridpx_m
double getWeightedData(double *data, const IndexTriplet &idx, unsigned short corner) const
IndexTriplet getIndex(const Vector_t &X) const
unsigned int num_gridpz_m
virtual void setFrequency(double freq)
unsigned int num_gridpy_m
virtual void getInfo(Inform *msg)
virtual double getFrequency() const
static FM3DMagnetoStatic create(const std::string &filename)
_FM3DMagnetoStatic(const std::string &filename)
virtual bool getFieldstrength(const Vector_t &R, Vector_t &E, Vector_t &B) const
virtual bool isInside(const Vector_t &r) const
virtual void getFieldDimensions(double &zBegin, double &zEnd) const
virtual bool getFieldDerivative(const Vector_t &R, Vector_t &E, Vector_t &B, const DiffDirection &dir) const
Vector_t interpolateTrilinearly(const Vector_t &X) const
Vektor< double, 3 > Vector_t