quicwind/readme.txt

   1 Mass-consistent approximation as in WindNinja or QUIC
   2 implemented by FFT
   3
   4 Jan Mandel, June 2019
   5
   6 Location: wrf-fire/other/Matlab/quic
   7
   8
   9 Given wind field u0, the code minimizes ||u-u0|| subject to div u=0 with
  10 boundary condition u=0 on the ground.
  11
  12 The code uses  staggered grid for wind components at mid sides, similarly
  13 as in WRF. The Lagrange multiplier lambda enforcing div u = 0 is at
  14 cell centers. The method consists of
  15 1. preprocessing u0 and the mesh to set up the Laplace equation for lambda
  16 2. solve the Laplace equation for lamda
  17 3. postprocess lambda to compute u
  18
  19 FFT-based solver - Limited to uniform rectangular grid
  20
  21 The solution time scales as n log n with the size n of each dimension.
  22 The block example on 500x500x50 mesh takes about 5 seconds on macbook pro.
  23 The FFT use is suboptimal due to matlab limitations. The code uses complex
  24 Fourier transform and mirroring in vertical direction. Standard
  25 implementation by calls to appropriate real transforms should be 5 to 10
  26 times faster. Terrain implemented approximately by setting zero input
  27 wind u0 inside obstacles as in block_example.m.
  28
  29 File            Description
  30
  31 startup
  32 all_test
  33 block_example
  34
  35 Function                    Purpose                                                         Test
  36
  37 Amul_v                      Multiply 3d field by a diagonal vector using 1d indexing        mat_mul_v_test
  38 Dmul_v                      Divergence (or transpose) of 3d field using 1d indexing         mat_mul_v_test
  39 Mmul_v                      Multiply wind field to flux matrix and 3d field, 1d indexing    mat_mul_v_test
  40 add_terrain_to_mesh         Modify 3D mesh vertically to follow terrain                     plot_mesh_test
  41 adj_mat_test                Test that the matrices of div3 and grad3z are adjoint
  42 adj_test                    Test if grad3z and div3 are adjoint, without matrices
  43 all_test                    Run all tests
  44 block_example               Compute flow with block obstacle using FFT
  45 cell2vec                    Flatten cell matrix of matrices to a vector
  46 cell_sizes.m
  47 check_mesh.m
  48 div3.m
  49 dstn.m
  50 flat.m
  51 fun2mat.m
  52 fun2mat_sym.m
  53 fun2mat_test.m
  54 grad3z.m
  55 mass_cons_flux              Mass consistent flux, uniform shifted mesh, direct or pcg        mass_cons_flux_test
  56 mass_cons_flux_test         Testing mass_cons_flux, uniform terrain shifted mesh, compare direcrt and pcg
  57 mass_cons_int.m             Mass consistent approximation by FFT
  58 mass_cons_int_test          Testing mass consistent approximation by FFT
  59 masscons.m
  60 mat_div3.m
  61 mat_flux.m
  62 mat_gen_wind_flux_div.m
  63 mat_gen_wind_flux_div_test.m
  64 mat_mul_v_test.m
  65 mat_wind_flux_div.m
  66 mat_wind_flux_div_test.m
  67 mlap3z.m
  68 mlap3z_test.m
  69 multigrid                   Abstract multigrid method with smoothing by pcg                 multigrid_2d_test, multigrid_3d_test
  70 multigrid_2d_test.m         Test of multigrid on 2d Laplace with zero boundary conditions
  71 multigrid_3d_test.m         Test of multigrid on 3d Laplace with zero boundary conditions
  72 plot_mesh.m
  73 plot_mesh_test.m
  74 plot_wind.m
  75 plot_wind_above_terrain.m
  76 poisson_fft3q.m
  77 poisson_fft3z.m
  78 poisson_fft3z_test.m
  79 prolongation_2d.m
  80 prolongation_3d.m
  81 readme.m
  82 regular_mesh.m
  83 restriction_2d.m
  84 restriction_3d.m
  85 skew.m
  86 startup.m                       Run this first to set up the environment.
  87 uniform_mesh.m
  88 vec2cell.m
  89 wind2flux.m
  90 wind2flux_test.m
  91 wind2flux_trans.m