src/FDM/YASim/Turbulence.cpp

   1 #include "Turbulence.hpp"
   2 #include "Math.hpp"
   3
   4 namespace yasim {
   5 // Typical velocity spectrum: MIN 0.017 MAX 0.72 AVG 0.30 RMS 0.33
   6
   7 // Maximum conceivable turbulence flow, in m/s.  In practice, most
   8 // generated turbulence fields top out at about 70% of this number.
   9 const float MAX_TURBULENCE = 20;
  10
  11 // How many generations are "meaningful" (i.e., not part of the normal
  12 // wind computation).  Decreasing this number will reallocate
  13 // bandwidth to the higher frequency components.
  14 const int MEANINGFUL_GENS = 9;
  15
  16 static const float FT2M = 0.3048;
  17
  18 // 8 x 32 s-box used by hashrand.  Read out of /dev/random on my Linux
  19 // box; not analyzed for linearity or coverage issues.
  20 static unsigned int SBOX[] = {
  21     0x0a881716, 0x20daa8ee, 0x61eb7d78, 0x46164e74, 0x39ab9d9d, 0x633a33f6,
  22     0x437c821d, 0x60a66f29, 0xc4ae45ab, 0x9a5cb3ce, 0x4a43606a, 0x56802c3c,
  23     0xe40d5e25, 0xa0297f41, 0x0457671e, 0xf167ab77, 0x571276db, 0x8b644e02,
  24     0xd5cfc592, 0x2331bfa2, 0xf9dfe7c1, 0xce9e7583, 0xfb133c29, 0x951c31c9,
  25     0x8e61b24e, 0xddf37570, 0x938c3b72, 0xaf907468, 0x98b77ac7, 0xe6edd515,
  26     0xa01f3600, 0xeafea5ad, 0x83fcce08, 0xe2e9fa9d, 0xd87727bb, 0x1945ea4c,
  27     0x831d295f, 0xa796ed85, 0xaa907b24, 0x69b25f12, 0xd4b27868, 0xdcde40f5,
  28     0x0e9e6def, 0x348a4702, 0x298389c8, 0xce405b63, 0x2e36d5a3, 0xf0569882,
  29     0x3beb3219, 0xf2366b9a, 0x69576cca, 0xd2725b8b, 0x6016d6f3, 0x728142ca,
  30     0x448b9f47, 0xe600cd4e, 0xac45d524, 0x0e32531b, 0x425d7b55, 0xc65cd9dc,
  31     0x58d7f9f1, 0x19f49822, 0x6786f2d3, 0x57844748, 0x523de4a3, 0x01079655,
  32     0x6dccea89, 0xb59278f2, 0x13a27e83, 0x19bcfc69, 0x4cff4bf5, 0xb18a3441,
  33     0x1e235c5e, 0xa1b47a42, 0x3bee8a5a, 0xa0962594, 0xa9b1ce4c, 0xb00399c8,
  34     0x83749847, 0x42c666e7, 0x08b81e57, 0xf7eee24b, 0x66720817, 0x3983f5f8,
  35     0x4999a817, 0x94fabd7a, 0x7aa775ef, 0xf6c1adcb, 0x5f32a695, 0x813ecf7e,
  36     0x66615fd5, 0xc0012e15, 0x051dd97e, 0xe6ee2803, 0x2449663c, 0x4024d59c,
  37     0xcb70a774, 0xacd3db94, 0x1845484e, 0xc803ef3c, 0x0662876f, 0x8794fe30,
  38     0xf0f0d16a, 0x41c065b8, 0xff9d5fc7, 0xa4237394, 0x8656614d, 0x26be5da9,
  39     0xb32bc625, 0xf215cc58, 0xc1e21848, 0xb97fe9fc, 0xbb28ef04, 0xde88eb23,
  40     0xe0623033, 0xa3df9e9c, 0xe9b95887, 0x3a4ab03b, 0x1cba812e, 0x174b4b37,
  41     0x0074d24b, 0xe5668d09, 0xf11a070a, 0x2884252b, 0x911149ea, 0x20dab459,
  42     0x89573d33, 0x68c2711d, 0x2b8e9781, 0xf007567b, 0x9761c8fa, 0x574d3a4e,
  43     0xa2ac28dd, 0x924f2211, 0xb0a91028, 0x83a90487, 0xf22cf6f8, 0x17a5dcfe,
  44     0x10497534, 0x27dd1316, 0x94a34815, 0x276e11ee, 0xead1d779, 0x0bfd4f20,
  45     0x45f2228f, 0x35d21bf8, 0x121336c0, 0x43a6538b, 0x55e950dc, 0x88a80871,
  46     0xfda9f61e, 0x5c76d120, 0x2eb8338f, 0x5193bb8e, 0x30a6995c, 0x500505a8,
  47     0x7b214f6a, 0x6a74558d, 0x040d0716, 0x4452846b, 0xd0a0e838, 0xead282e0,
  48     0x6bc6465c, 0xcb4ab107, 0xab990ed7, 0x72a1fe7b, 0x06901fdf, 0x18f90739,
  49     0x8cd2b861, 0xaea9d40c, 0x2dcf7c18, 0x45979e8a, 0x10393f0d, 0x3209d7c9,
  50     0x2c71378f, 0x908a692a, 0xc0e63b24, 0x05de3118, 0xfc974436, 0x1be44823,
  51     0x03de2f3d, 0x66cfb6e4, 0x52727bfc, 0xa7b93651, 0xd7b9035f, 0xfac28d33,
  52     0x59bb4457, 0xeede4004, 0x175ad747, 0x7808d123, 0xc9c97de8, 0x0c26ca26,
  53     0x75e62e96, 0xc8376e97, 0xf2ee6baa, 0x6a885f88, 0x352f92ab, 0x4143f4a4,
  54     0xb1cca58c, 0xe8fbea94, 0x5c306621, 0xfbe64c32, 0xa1ed285d, 0xca7395cf,
  55     0x4eed31a5, 0x31e39fee, 0x7951c585, 0x23434811, 0xfc103036, 0xef001b3c,
  56     0x499f5f34, 0x5f7f38f4, 0x0206d8c5, 0xcc3ee4f1, 0xbc0b485c, 0x4e4f5829,
  57     0x05ee6e6d, 0xc82d5353, 0x44892bec, 0x22984b53, 0x8a6374d1, 0x0850c3f9,
  58     0x0c06ae88, 0x2dfdc126, 0xd1edacdc, 0x1d8dbd39, 0xdeff2db8, 0xd557278d,
  59     0x7e9e3740, 0x49a1ecb5, 0x43f7b391, 0x50b6b9ef, 0x46b9b8f8, 0xd3f5f6d2,
  60     0x8d453b88, 0xc0ba5333, 0x5ab92e37, 0x6e7620a4, 0x8eb9795a, 0x30355a84,
  61     0xf5e4ad33, 0x7d0b4df2, 0xe0f3e2a1, 0xa466f0e6, 0x39a19c9a, 0x1b284524,
  62     0x854f8b3b, 0x02d10b6c, 0x44fb5d9d, 0x60c29fec, 0xda35244a, 0xb5ce6653,
  63     0xfd8356ad, 0xff88d46b, 0x23fd1d16, 0xdc0be23c };
  64
  65 // Random hash function on 32 bit integers.  Works by XORing the input
  66 // word with s-box values looked up from each input byte.  This is
  67 // pretty much the simplest "good" hash function of this type.  The
  68 // instruction count is very low; depending on cache behavior with the
  69 // 1024 byte s-box table, it may or may not be the fastest.
  70 inline unsigned int Turbulence::hashrand(unsigned int i)
  71 {
  72     i ^= SBOX[(i>> 0) & 0xff];
  73     i ^= SBOX[(i>> 8) & 0xff];
  74     i ^= SBOX[(i>>16) & 0xff];
  75     i ^= SBOX[(i>>24) & 0xff];
  76     return i;
  77 }
  78
  79 // 32 bit integer to [0:1] (safe with 64 bit ints)
  80 static inline float i2fu(unsigned int i) { return (1.0/0xffffffffu) * i; }
  81
  82 // 32 bit integer to [-1:1] (safe with 64 bit ints)
  83 static inline float i2fs(unsigned int i) { return 2 * i2fu(i) - 1; }
  84
  85 // Similar conversions, for 8 bit unsigned bytes
  86 static inline float c2fu(unsigned char c) { return (c+0.5)*(1.0/256); }
  87 static inline unsigned char f2cu(float f) {
  88     int c = (int)(f * 256);
  89     return c == 256 ? 255 : c;
  90 }
  91
  92 inline void Turbulence::turblut(int x, int y, float* out)
  93 {
  94     x = x >= _sz ? x - _sz : x;
  95     y = y >= _sz ? y - _sz : y;
  96
  97     unsigned char* turb = _data + 3*(y*_sz+x);
  98     out[0] = c2fu(turb[0]) * (_x1 - _x0) + _x0;
  99     out[1] = c2fu(turb[1]) * (_y1 - _y0) + _y0;
 100     out[2] = c2fu(turb[2]) * (_z1 - _z0) + _z0;
 101 }
 102
 103 void Turbulence::update(double dt, double rate)
 104 {
 105     // Assume a normal rate is 2 unit/sec.  This will cause the
 106     // highest frequency turbulence component to arrive at 1 Hz.
 107     _currTime += 2 * dt * rate;
 108     if(_currTime > _sz) _currTime -= _sz;
 109 }
 110
 111 void Turbulence::getTurbulence(double* loc, float* turbOut)
 112 {
 113     // Convert to integer 2D coordinates; wrap to [0:_sz].
 114     double a = loc[0] + loc[2];
 115     double b = loc[1] + _currTime;
 116     a -= _sz * Math::floor(a * (1.0/_sz));
 117     b -= _sz * Math::floor(b * (1.0/_sz));
 118     int x = (int)Math::floor(a);
 119     int y = (int)Math::floor(b);
 120
 121     // Convert to fractional interpolation factors
 122     a -= x;
 123     b -= y;
 124
 125     // Do the lookups
 126     float turb00[3], turb10[3], turb01[3], turb11[3];
 127     turblut(x,     y, turb00);
 128     turblut(x+1,   y, turb10);
 129     turblut(x,   y+1, turb01);
 130     turblut(x+1, y+1, turb11);
 131
 132     // Interpolate, add in units
 133     float mag = _mag * _mag * MAX_TURBULENCE;
 134     for(int i=0; i<3; i++) {
 135         float avg0 = (1-a)*turb00[i] + a*turb01[i];
 136         float avg1 = (1-a)*turb10[i] + a*turb11[i];
 137         turbOut[i] = mag * ((1-b)*avg0 + b*avg1);
 138     }
 139 }
 140
 141 // Associates a random number in the range [-1:1] with a given lattice
 142 // point.
 143 float Turbulence::lattice(unsigned int x, unsigned int y)
 144 {
 145     return i2fs(hashrand((((_seed << _gens) | x) << _gens) | y));
 146 }
 147
 148 // Returns a scale for a vector that normalizes it into a sphere (as
 149 // opposed to cube) space.  This prevents the overscaling of the
 150 // "corner" vectors you get from choosing three random turbulence
 151 // components.
 152 float Turbulence::cubenorm(float x, float y, float z)
 153 {
 154     x = x < 0 ? -x : x;
 155     y = y < 0 ? -y : y;
 156     z = z < 0 ? -z : z;
 157     float max = ((x > y) && (x > z)) ? x : ((y > z) ? y : z);
 158     return max/Math::sqrt(x*x + y*y + z*z);
 159 }
 160
 161 Turbulence::~Turbulence()
 162 {
 163     delete[] _data;
 164 }
 165
 166 Turbulence::Turbulence(int gens, int seed)
 167 {
 168     _gens = gens;
 169     _sz = 1 << (_gens - 1);
 170     _seed = seed;
 171     _mag = 1;
 172     _x0 = _x1 = _y0 = _y1 = _z0 = _z1 = 0;
 173     _currTime = 0;
 174
 175     float* xbuf = new float[_sz*_sz];
 176     float* ybuf = new float[_sz*_sz];
 177     float* zbuf = new float[_sz*_sz];
 178
 179     mkimg(xbuf, _sz);
 180     _seed++;
 181     mkimg(ybuf, _sz);
 182     _seed++;
 183     mkimg(zbuf, _sz);
 184
 185     // "Normalize" them to proper spherical magnitudes, and calculate
 186     // range information for the packing.
 187     for(int i=0; i<_sz*_sz; i++) {
 188         float n = cubenorm(xbuf[i], ybuf[i], zbuf[i]);
 189         xbuf[i] *= n;
 190         ybuf[i] *= n;
 191         zbuf[i] *= n;
 192
 193         _x0 = xbuf[i] < _x0 ? xbuf[i] : _x0;
 194         _x1 = xbuf[i] > _x1 ? xbuf[i] : _x1;
 195         _y0 = ybuf[i] < _y0 ? ybuf[i] : _y0;
 196         _y1 = ybuf[i] > _y1 ? ybuf[i] : _y1;
 197         _z0 = zbuf[i] < _z0 ? zbuf[i] : _z0;
 198         _z1 = zbuf[i] > _z1 ? zbuf[i] : _z1;
 199     }
 200
 201     // Pack into 3 byte tuples for storage.
 202     _data = new unsigned char[3*_sz*_sz];
 203     for(int i=0; i<_sz*_sz; i++) {
 204         float x = xbuf[i], y = ybuf[i], z = zbuf[i];
 205         unsigned char* tuple = _data + 3*i;
 206         tuple[0] = f2cu((x - _x0) / (_x1 - _x0));
 207         tuple[1] = f2cu((y - _y0) / (_y1 - _y0));
 208         tuple[2] = f2cu((z - _z0) / (_z1 - _z0));
 209     }
 210
 211     delete[] xbuf;
 212     delete[] ybuf;
 213     delete[] zbuf;
 214 }
 215
 216 // "Integer" turbulence function.  Takes coordinates in the range
 217 // [0:1] expressed as a fraction of 2^32 (works with 64 bit ints too;
 218 // it just doesn't use the whole range). The output range is
 219 // guaranteed to be within [-1:1], with a typical output range of +/-
 220 // 0.6 or so.
 221 float Turbulence::iturb(unsigned int x, unsigned int y)
 222 {
 223     float amplitude = 0.5; // start here, so it all sums to ~1.0
 224     float total = 0;
 225     int wrapmax = 2;
 226     int startgen = _gens - MEANINGFUL_GENS;
 227     for(int g=startgen; g<_gens; g++) {
 228         int xl = x >> (32 - g); // lattice coordinates
 229         int yl = y >> (32 - g);
 230         float xfrac = i2fu(x << g); // interpolation fractions
 231         float yfrac = i2fu(y << g);
 232         xfrac = xfrac*xfrac*(3 - 2*xfrac); // ... as cubics
 233         yfrac = yfrac*yfrac*(3 - 2*yfrac);
 234
 235 #define WRAP(a) (a) >= wrapmax ? 0 : (a)
 236         float p00 = lattice(WRAP(xl),   WRAP(yl)); // lattice values
 237         float p01 = lattice(WRAP(xl),   WRAP(yl+1));
 238         float p10 = lattice(WRAP(xl+1), WRAP(yl));
 239         float p11 = lattice(WRAP(xl+1), WRAP(yl+1));
 240 #undef WRAP
 241
 242         float p0 = p00 * (1-yfrac) + p01 * yfrac;
 243         float p1 = p10 * (1-yfrac) + p11 * yfrac;
 244         float p = p0 * (1-xfrac) + p1 * xfrac;
 245         total += p * amplitude;
 246         amplitude *= 0.5;
 247         wrapmax *= 2;
 248     }
 249     return total;
 250 }
 251
 252 // Converts "real" turbulence coordinates expressed in the range
 253 // [0:_sz] (modulo) to integers and runs them through iturb().
 254 float Turbulence::fturb(double a, double b)
 255 {
 256     a *= 1.0 / _sz;
 257     b *= 1.0 / _sz;
 258     a -= Math::floor(a);
 259     b -= Math::floor(b);
 260     return iturb((unsigned int)(a * 4294967296.0),
 261                  (unsigned int)(b * 4294967296.0));
 262 }
 263
 264 void Turbulence::mkimg(float* buf, int sz)
 265 {
 266     for(int y=0; y<sz; y++)
 267         for(int x=0; x<sz; x++)
 268             buf[y*sz+x] = fturb(x + 0.5, y + 0.5);
 269 }
 270
 271 }; // namespace yasim