IrregularDomain.h 6.97 KB
Newer Older
1
//
frey_m's avatar
frey_m committed
2 3
// Class IrregularDomain
//   Defines a common abstract interface for different types of boundaries.
4
//
5
// Copyright (c) 2008,        Yves Ineichen, ETH Zürich,
frey_m's avatar
frey_m committed
6
//               2013 - 2015, Tülin Kaman, Paul Scherrer Institut, Villigen PSI, Switzerland
7
//               2017 - 2020, Paul Scherrer Institut, Villigen PSI, Switzerland
frey_m's avatar
frey_m committed
8
// All rights reserved
9
//
10 11 12 13 14
// Implemented as part of the master thesis
// "A Parallel Multigrid Solver for Beam Dynamics"
// and the paper
// "A fast parallel Poisson solver on irregular domains applied to beam dynamics simulations"
// (https://doi.org/10.1016/j.jcp.2010.02.022)
frey_m's avatar
frey_m committed
15 16 17 18 19 20 21 22 23 24
//
// This file is part of OPAL.
//
// OPAL is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// You should have received a copy of the GNU General Public License
// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
25
//
gsell's avatar
gsell committed
26 27 28 29 30
#ifndef IRREGULAR_DOMAIN_H
#define IRREGULAR_DOMAIN_H

#include <vector>
#include <string>
31
#include "Algorithms/PBunchDefs.h"
32 33
#include "Algorithms/Quaternion.h"

gsell's avatar
gsell committed
34 35 36 37 38 39 40
/// enumeration corresponding to different interpolation methods at the boundary
enum {
    CONSTANT,
    LINEAR,
    QUADRATIC
};

41

gsell's avatar
gsell committed
42 43 44 45
class IrregularDomain {

public:

46 47 48 49 50 51 52 53 54 55 56 57 58 59
    template<typename T>
    struct Stencil {
        T center;   // x,   y,   z
        T west;     // x-1, y,   z
        T east;     // x+1, y,   z
        T north;    // x,   y+1, z
        T south;    // x,   y-1, z
        T front;    // x,   y,   z-1
        T back;     // x,   y,   z+1
    };

    typedef Stencil<int>    StencilIndex_t;
    typedef Stencil<double> StencilValue_t;

frey_m's avatar
frey_m committed
60
    IrregularDomain(const Vector_t& nr,
61 62
                    const Vector_t& hr,
                    const std::string& interpl);
frey_m's avatar
frey_m committed
63 64


frey_m's avatar
frey_m committed
65 66
    /** method to compute the intersection points with the boundary geometry
     * (stored in some appropriate data structure)
gsell's avatar
gsell committed
67 68
     * \param hr updated mesh spacings
     */
69
    virtual void compute(Vector_t hr, NDIndex<3> localId) = 0;
gsell's avatar
gsell committed
70 71 72 73 74 75 76 77 78 79
    /** method to get the number of gridpoints in a given z plane
     * \param z coordinate of the z plane
     * \return int number of grid nodes in the given z plane
     */
    virtual int getNumXY(int z) = 0;

    /// method to calculate the stencil at a boundary points
    /// \param x index of the current element in the matrix
    /// \param y index of the current element in the matrix
    /// \param z index of the current element in the matrix
80 81
    /// \param values of stencil element
    /// \param scaleFactor of stencil values
82
    void getBoundaryStencil(int x, int y, int z,
83
                                    StencilValue_t& value,
84
                                    double &scaleFactor);
gsell's avatar
gsell committed
85 86

    /// method to calculate the stencil at a boundary points
87
    /// \param id index of the current element in the matrix
88 89 90
    // \param values of stencil element
    /// \param scaleFactor of stencil values
    void getBoundaryStencil(int id, StencilValue_t& value,
91
                            double &scaleFactor);
gsell's avatar
gsell committed
92 93 94 95 96

    /// method to calculate the neighbours in the matrix of the current index (x,y,z)
    /// \param x index of the current element in the matrix
    /// \param y index of the current element in the matrix
    /// \param z index of the current element in the matrix
97
    /// \param index stencil indices of an element
98
    void getNeighbours(int x, int y, int z, StencilIndex_t& index);
99 100

    void getNeighbours(int idx, StencilIndex_t& index);
101 102 103


    virtual void getCoord(int idx, int &x, int &y, int &z) = 0;
gsell's avatar
gsell committed
104 105 106 107 108 109 110 111

    /// method that checks if a given point lies inside the boundary
    /// \param x index of the current element in the matrix
    /// \param y index of the current element in the matrix
    /// \param z index of the current element in the matrix
    /// \return boolean indicating if the point lies inside the boundary
    virtual bool isInside(int x, int y, int z) = 0;

frey_m's avatar
frey_m committed
112 113 114 115
    Vector_t getNr() { return nr_m; }
    Vector_t getHr() { return hr_m; }
    void setNr(Vector_t nr) { nr_m = nr; }
    void setHr(Vector_t hr) { hr_m = hr; }
gsell's avatar
gsell committed
116 117 118 119 120

    void setMinMaxZ(double minz, double maxz) { zMin_m=minz; zMax_m=maxz; }
    double getMinZ() { return zMin_m; }
    double getMaxZ() { return zMax_m; }

121 122
    void setGlobalMeanR(Vector_t rmean) { rMean_m = rmean;}
    Vector_t getGlobalMeanR() { return rMean_m; }
123

124 125
    void setGlobalToLocalQuaternion(Quaternion_t globalToLocalQuaternion){
        globalToLocalQuaternion_m = globalToLocalQuaternion;}
frey_m's avatar
frey_m committed
126

127
    Quaternion_t getGlobalToLocalQuaternion() { return globalToLocalQuaternion_m;}
128

129 130 131 132 133 134 135 136 137
    double getXRangeMin();
    double getXRangeMax();
    double getYRangeMin();
    double getYRangeMax();
    double getZRangeMin();
    double getZRangeMax();

    void setRangeMin(const Vector_t&);
    void setRangeMax(const Vector_t&);
gsell's avatar
gsell committed
138 139

    virtual int getIdx(int x, int y, int z) = 0;
140 141 142

    bool hasGeometryChanged();

143
    virtual ~IrregularDomain() {};
gsell's avatar
gsell committed
144

145
    virtual void resizeMesh(Vector_t& origin, Vector_t& hr,
frey_m's avatar
frey_m committed
146
                            const Vector_t& /*rmin*/, const Vector_t& /*rmax*/,
147
                            double /*dh*/);
148

gsell's avatar
gsell committed
149 150
protected:

151 152 153 154 155 156 157 158 159 160 161
    /// different interpolation methods for boundary points
    virtual void constantInterpolation(int x, int y, int z, StencilValue_t& value,
                               double &scaleFactor);

    virtual void linearInterpolation(int x, int y, int z, StencilValue_t& value,
                             double &scaleFactor);

    virtual void quadraticInterpolation(int x, int y, int z, StencilValue_t& value,
                                double &scaleFactor);


gsell's avatar
gsell committed
162 163
    // a irregular domain is always defined on a grid
    /// number of mesh points in each direction
frey_m's avatar
frey_m committed
164
    Vector_t nr_m;
gsell's avatar
gsell committed
165
    /// mesh-spacings in each direction
frey_m's avatar
frey_m committed
166
    Vector_t hr_m;
gsell's avatar
gsell committed
167 168 169 170

    /// min/max of bunch in floor coordinates
    double zMin_m;
    double zMax_m;
171

172 173 174
    Vector_t min_m;
    Vector_t max_m;

175 176
    /// mean position of bunch (m)
    Vector_t rMean_m;
177
    Quaternion_t globalToLocalQuaternion_m;
178 179 180 181

    /// flag indicating if geometry has changed for the current time-step
    bool hasGeometryChanged_m;

182 183 184
    /// interpolation type
    int interpolationMethod_m;

gsell's avatar
gsell committed
185 186
};

187 188 189 190 191

inline bool IrregularDomain::hasGeometryChanged() {
    return hasGeometryChanged_m;
}

192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
inline double IrregularDomain::getXRangeMin() {
    return min_m(0);
}

inline double IrregularDomain::getXRangeMax() {
    return max_m(0);
}

inline double IrregularDomain::getYRangeMin() {
    return min_m(1);
}

inline double IrregularDomain::getYRangeMax() {
    return max_m(1);
}

inline double IrregularDomain::getZRangeMin() {
    return min_m(2);
}

inline double IrregularDomain::getZRangeMax() {
    return max_m(2);
}

inline void IrregularDomain::setRangeMin(const Vector_t& min) {
    min_m = min;
}

inline void IrregularDomain::setRangeMax(const Vector_t& max) {
    max_m = max;
}

224 225
#endif

226

227 228 229 230 231 232 233
// vi: set et ts=4 sw=4 sts=4:
// Local Variables:
// mode:c
// c-basic-offset: 4
// indent-tabs-mode: nil
// require-final-newline: nil
// End: