BoxCornerDomain.h 6.62 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
//
// Class BoxCornerDomain
//   :FIXME: add brief description
//
// Copyright (c) 2008-2020
// Paul Scherrer Institut, Villigen PSI, Switzerland
// All rights reserved.
//
// OPAL is licensed under GNU GPL version 3.
//

gsell's avatar
gsell committed
12
#ifndef BOXCORNER_DOMAIN_H
13
#define BOXCORNER_DOMAIN_H
gsell's avatar
gsell committed
14 15 16 17 18 19 20 21 22 23 24 25 26 27

#include <map>
#include <string>
#include <cmath>
#include <iostream>  // Neeeded for stream I/O
#include <fstream>   // Needed for file I/O
#include "IrregularDomain.h"


/*

    A_m and B_m are the half apperture of the box


kraus's avatar
kraus committed
28
                                     / (A_m,B_m)
gsell's avatar
gsell committed
29 30 31 32
                                    /
                                   /
                                  /
    L1_m                         /
kraus's avatar
kraus committed
33
------------      --------------+ (-A_m,B_m)
gsell's avatar
gsell committed
34
           | L2_m |             |
kraus's avatar
kraus committed
35
        C_m|      |             |
gsell's avatar
gsell committed
36
           |------|             |      /
kraus's avatar
kraus committed
37
         .....                  |     /
gsell's avatar
gsell committed
38 39 40
(0,0)---.......-----------------+    /
         .....                  |   /
   z                            |  /
kraus's avatar
kraus committed
41
   |                            | /
gsell's avatar
gsell committed
42 43
--------------------------------+/ (-A_m,-B_m)

44
            Length_m
gsell's avatar
gsell committed
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59

Test in which of the 3 parts of the geometry we are in.

    if((z < L1_m) || (z > (L1_m + L2_m)))
        b = B_m;
    else
        b = B_m-C_m;

*/

class BoxCornerDomain : public IrregularDomain {

public:

    BoxCornerDomain(Vector_t nr, Vector_t hr);
60
    BoxCornerDomain(double A, double B, double C, double Length, double L1, double L2, Vector_t nr, Vector_t hr,
gsell's avatar
gsell committed
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
                    std::string interpl);
    ~BoxCornerDomain();

    /// returns discretization at (x,y,z)
    void getBoundaryStencil(int x, int y, int z, double &W, double &E, double &S, double &N, double &F, double &B,
                            double &C, double &scaleFactor);

    /// returns discretization at 3D index
    void getBoundaryStencil(int idx, double &W, double &E, double &S, double &N, double &F, double &B, double &C,
                            double &scaleFactor);

    /// returns index of neighbours at (x,y,z)
    void getNeighbours(int x, int y, int z, int &W, int &E, int &S, int &N, int &F, int &B);

    /// returns index of neighbours at 3D index
    void getNeighbours(int idx, int &W, int &E, int &S, int &N, int &F, int &B);

    /// returns type of boundary condition
    std::string getType() {return "BoxCorner";}


    /// we do not need this
83
    int getNumXY(int /*z*/) { return -1;}
gsell's avatar
gsell committed
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106


    /// as a function of z, determine the hight (B) of the geometry
    inline double getB(double z) {
      if((z < L1_m) || (z > (L1_m + L2_m)))
            return B_m;
        else
            return B_m - C_m;
    }

    /// queries if a given (x,y,z) coordinate lies inside the domain
    inline bool isInside(int x, int y, int z) {
        const double xx = (x - (nr[0] - 1) / 2.0) * hr[0];
        const double yy = (y - (nr[1] - 1) / 2.0) * hr[1];
        const double b = getB(z * hr[2]);
        return (xx < A_m && yy < b && z != 0 && z != nr[2] - 1);
    }

    /// set semi-minor
    //void setSemiMinor(double sm) {SemiMinor = sm;}
    /// set semi-major
    //void setSemiMajor(double sm) {SemiMajor = sm;}

107 108
    void compute(Vector_t hr);
    void compute(Vector_t hr, NDIndex<3> localId);
gsell's avatar
gsell committed
109 110 111 112 113

    double getXRangeMin() { return -A_m; }
    double getXRangeMax() { return  A_m; }
    double getYRangeMin() { return  -B_m;} // actBMin_m; }
    double getYRangeMax() { return  B_m; } // actBMax_m; }
114
    double getZRangeMin() { return  L1_m;}
kraus's avatar
kraus committed
115
    double getZRangeMax() { return  L1_m+L2_m; }
116

gsell's avatar
gsell committed
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149

    //TODO: ?
    int getStartIdx() {return 0;}

    bool hasGeometryChanged() { return hasGeometryChanged_m; }

private:

    //XXX: since the Y coorindate is dependent on the Z value we need (int,
    //int) -> intersection. To simplify things (for now) we use the same
    //structure for X...
    /// Map from a ([(x or y], z) to a list of intersection values with
    /// boundary.
    typedef std::multimap< std::pair<int, int>, double > BoxCornerPointList;

    /// all intersection points with grid lines in X direction
    BoxCornerPointList IntersectXDir;

    /// all intersection points with grid lines in Y direction
    BoxCornerPointList IntersectYDir;

    /// mapping (x,y,z) -> idx
    std::map<int, int> IdxMap;

    /// mapping idx -> (x,y,z)
    std::map<int, int> CoordMap;

    /// depth of the box
    double A_m;

    /// the maximal hight of the box
    double B_m;

kraus's avatar
kraus committed
150

gsell's avatar
gsell committed
151 152 153 154 155 156 157 158 159
    /// because the geometry can change in the y direction
    double actBMin_m;

    double actBMax_m;

    /// hight of the corner
    double C_m;

    /// lenght of the structure
160
    double Length_m;
gsell's avatar
gsell committed
161 162 163 164 165 166 167 168

    /// lenght of the first part of the structure
    double L1_m;

    /// lenght of the corner
    double L2_m;

    /// semi-major of the ellipse
169 170
    // :FIXME: unused
    //double SemiMajor;
gsell's avatar
gsell committed
171
    /// semi-minor of the ellipse
172 173
    // :FIXME: unused
    //double SemiMinor;
gsell's avatar
gsell committed
174 175 176 177 178 179 180 181 182 183 184 185 186

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

    /// for debug reasons
   std::ofstream os_m;





187
    inline double getXIntersection(double cx, int /*z*/) {
gsell's avatar
gsell committed
188 189 190 191 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 224 225 226 227 228
        if(cx < 0)
            return -A_m;
        else
            return  A_m;
    }

    inline double getYIntersection(double cy, int z) {
        if(cy < 0)
            return -B_m;
        else
            return getB(z * hr[2]);
    }

    /// conversion from (x,y,z) to index in xyz plane
    inline int toCoordIdx(int x, int y, int z) {
        return (z * nr[1] + y) * nr[0] + x;
    }

    /// conversion from (x,y,z) to index on the 3D grid
    /*inline*/
    inline int getIdx(int x, int y, int z) {
        if(isInside(x, y, z) && x >= 0 && y >= 0 && z >= 0)
            return IdxMap[toCoordIdx(x, y, z)];
        else
            return -1;
    }

    /// conversion from a 3D index to (x,y,z)
    inline void getCoord(int idx, int &x, int &y, int &z) {

        int idxx = CoordMap[idx];

        x = idxx % (int)nr[0];
        idxx /= nr[0];
        y = idxx % (int)nr[1];
        idxx /= nr[1];
        z = idxx;

    }

    /// different interpolation methods for boundary points
229 230 231
    void constantInterpolation(int x, int y, int z, double &W, double &E, double &S, double &N, double &F, double &B, double &C, double &scaleFactor);
    void linearInterpolation(int x, int y, int z, double &W, double &E, double &S, double &N, double &F, double &B, double &C, double &scaleFactor);
    void quadraticInterpolation(int x, int y, int z, double &W, double &E, double &S, double &N, double &F, double &B, double &C, double &scaleFactor);
gsell's avatar
gsell committed
232 233 234

};

235 236 237 238 239 240 241 242 243
#endif

// 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: