REMORA
Regional Modeling of Oceans Refined Adaptively
Loading...
Searching...
No Matches
REMORA_setup_step.cpp
Go to the documentation of this file.
1#include <REMORA.H>
2
3using namespace amrex;
4
5/**
6 * @param[in ] lev level to operate on
7 * @param[in ] time time at start of step
8 * @param[in ] dt_lev time step at level
9 */
10void
12{
13 BL_PROFILE("REMORA::setup_step()");
14
15 MultiFab& S_old = *cons_old[lev];
16 MultiFab& S_new = *cons_new[lev];
17
18 MultiFab& U_old = *xvel_old[lev];
19 MultiFab& V_old = *yvel_old[lev];
20 MultiFab& W_old = *zvel_old[lev];
21
22 MultiFab& U_new = *xvel_new[lev];
23 MultiFab& V_new = *yvel_new[lev];
24 MultiFab& W_new = *zvel_new[lev];
25
26 [[maybe_unused]] int nvars = S_old.nComp();
27
28 // Fill ghost cells/faces at old time
33
34 ////////// //pre_step3d corrections to boundaries
35
36 const BoxArray& ba = S_old.boxArray();
37 const DistributionMapping& dm = S_old.DistributionMap();
38
39 const int nrhs = 0;
40 int nstp = 0;
41
42 //-----------------------------------------------------------------------
43 // Time step momentum equation
44 //-----------------------------------------------------------------------
45
46 //Only used locally, probably should be rearranged into FArrayBox declaration
47
48 MultiFab mf_DC(ba,dm,1,IntVect(NGROW,NGROW,NGROW-1)); //2d missing j coordinate
49 MultiFab mf_logdrg_tmp(ba,dm,1,IntVect(NGROW,NGROW,0));
50 MultiFab mf_rho(ba,dm,1,IntVect(NGROW,NGROW,0));
51
52 MultiFab* mf_z_r = vec_z_r[lev].get();
53 MultiFab* mf_z_w = vec_z_w[lev].get();
54 MultiFab* mf_h = vec_h[lev].get();
55 MultiFab* mf_pm = vec_pm[lev].get();
56 MultiFab* mf_pn = vec_pn[lev].get();
57 MultiFab* mf_fcor = vec_fcor[lev].get();
58
59 MultiFab* mf_gls = vec_gls[lev].get();
60 MultiFab* mf_tke = vec_tke[lev].get();
61
62 //Consider passing these into the advance function or renaming relevant things
63
64 std::unique_ptr<MultiFab>& mf_rhoS = vec_rhoS[lev];
65 std::unique_ptr<MultiFab>& mf_rhoA = vec_rhoA[lev];
66 std::unique_ptr<MultiFab>& mf_bvf = vec_bvf[lev];
67 std::unique_ptr<MultiFab>& mf_ru = vec_ru[lev];
68 std::unique_ptr<MultiFab>& mf_rv = vec_rv[lev];
69 std::unique_ptr<MultiFab>& mf_rufrc = vec_rufrc[lev];
70 std::unique_ptr<MultiFab>& mf_rvfrc = vec_rvfrc[lev];
71 std::unique_ptr<MultiFab>& mf_sustr = vec_sustr[lev];
72 std::unique_ptr<MultiFab>& mf_svstr = vec_svstr[lev];
73 std::unique_ptr<MultiFab>& mf_rdrag = vec_rdrag[lev];
74 std::unique_ptr<MultiFab>& mf_rdrag2 = vec_rdrag2[lev];
75 std::unique_ptr<MultiFab>& mf_ZoBot = vec_ZoBot[lev];
76 std::unique_ptr<MultiFab>& mf_bustr = vec_bustr[lev];
77 std::unique_ptr<MultiFab>& mf_bvstr = vec_bvstr[lev];
78
79 std::unique_ptr<MultiFab>& mf_mskr = vec_mskr[lev];
80 std::unique_ptr<MultiFab>& mf_msku = vec_msku[lev];
81 std::unique_ptr<MultiFab>& mf_mskv = vec_mskv[lev];
82 std::unique_ptr<MultiFab>& mf_mskp = vec_mskp[lev];
83
84 std::unique_ptr<MultiFab>& mf_visc2_p = vec_visc2_p[lev];
85 std::unique_ptr<MultiFab>& mf_visc2_r = vec_visc2_r[lev];
86
87 // We need to set these because otherwise in the first call to remora_advance we may
88 // read uninitialized data on ghost values in setting the bc's on the velocities
89 mf_rho.setVal(zero,IntVect(AMREX_D_DECL(NGROW-1,NGROW-1,0)));
90 mf_rhoS->setVal(zero,IntVect(AMREX_D_DECL(NGROW-1,NGROW-1,0)));
91 mf_rhoA->setVal(zero,IntVect(AMREX_D_DECL(NGROW-1,NGROW-1,0)));
92 mf_DC.setVal(zero);
93
97
98 mf_rufrc->setVal(zero);
99 mf_rvfrc->setVal(zero);
100
101 int iic = istep[lev];
102 int ntfirst = 0;
103 if(iic==ntfirst) {
104 MultiFab::Copy(S_new,S_old,0,0,S_new.nComp(),S_new.nGrowVect());
105 MultiFab::Copy(U_new,U_old,0,0,U_new.nComp(),U_new.nGrowVect());
106 MultiFab::Copy(V_new,V_old,0,0,V_new.nComp(),V_new.nGrowVect());
107 MultiFab::Copy(W_new,W_old,0,0,W_new.nComp(),W_new.nGrowVect());
108 }
109
110 // Refresh the atmospheric forcing fields feeding the bulk-flux path.
111 //
112 // A coupled run needs this too, and used to skip it entirely. The driver
113 // supplies only the lanes its atmosphere can fill and withholds the rest,
114 // expecting those to keep this deck's own forcing - NetCDF series included.
115 // set_surface_state is already per-lane, so the supplied ones are left
116 // alone; skipping it wholesale froze every withheld lane at its
117 // level-creation constant.
118 //
119 // The gate mirrors the bulk_fluxes() call below: in driver flux mode these
120 // fields are never read.
126 set_smflux(lev); // uncoupled, no bulk fluxes: set surface fluxes directly
127 }
128
129 auto N = Geom(lev).Domain().size()[2]-1; // Number of vertical "levs" aka, NZ
130
131 for ( MFIter mfi(S_new, TilingIfNotGPU()); mfi.isValid(); ++mfi )
132 {
133 Array4<Real const> const& h = vec_h[lev]->const_array(mfi);
134 Array4<Real const> const& Hz = vec_Hz[lev]->const_array(mfi);
135 Array4<Real > const& Huon = vec_Huon[lev]->array(mfi);
136 Array4<Real > const& Hvom = vec_Hvom[lev]->array(mfi);
137
138 Array4<Real const> const& z_w = mf_z_w->const_array(mfi);
139 Array4<Real const> const& z_r = mf_z_r->const_array(mfi);
140 Array4<Real const> const& uold = U_old.const_array(mfi);
141 Array4<Real const> const& vold = V_old.const_array(mfi);
142 Array4<Real > const& rho = mf_rho.array(mfi);
143 Array4<Real > const& rhoA = mf_rhoA->array(mfi);
144 Array4<Real > const& rhoS = mf_rhoS->array(mfi);
145 Array4<Real > const& bvf = mf_bvf->array(mfi);
149 ? vec_alpha[lev]->array(mfi) : Array4<Real>();
153 ? vec_beta[lev]->array(mfi) : Array4<Real>();
154
155 Array4<Real const> const& pm = mf_pm->const_array(mfi);
156 Array4<Real const> const& pn = mf_pn->const_array(mfi);
157
158 Array4<Real const> const& mskr = mf_mskr->const_array(mfi);
159
160 Box bx = mfi.tilebox();
161 Box gbx1 = mfi.growntilebox(IntVect(NGROW-1,NGROW-1,0));
162 Box gbx2 = mfi.growntilebox(IntVect(NGROW,NGROW,0));
163 Box ugbx2 = mfi.grownnodaltilebox(0,IntVect(NGROW,NGROW,0));
164 Box vgbx2 = mfi.grownnodaltilebox(1,IntVect(NGROW,NGROW,0));
165
166 Box bxD = bx;
167 bxD.makeSlab(2,0);
168 Box gbx1D = gbx1;
169 gbx1D.makeSlab(2,0);
170 Box gbx2D = gbx2;
171 gbx2D.makeSlab(2,0);
172
173 //
174 //-----------------------------------------------------------------------
175 // Compute horizontal mass fluxes, Hz*u/n and Hz*v/m (set_massflux_3d)
176 //-----------------------------------------------------------------------
177 //
178 ParallelFor(ugbx2, [=] AMREX_GPU_DEVICE (int i, int j, int k)
179 {
180 Real on_u = two / (pn(i-1,j,0)+pn(i,j,0));
181 Huon(i,j,k)=Real(0.5)*(Hz(i,j,k)+Hz(i-1,j,k))*uold(i,j,k)* on_u;
182 });
183
184 ParallelFor(vgbx2, [=] AMREX_GPU_DEVICE (int i, int j, int k)
185 {
186 Real om_v= two / (pm(i,j-1,0)+pm(i,j,0));
187 Hvom(i,j,k)=Real(0.5)*(Hz(i,j,k)+Hz(i,j-1,k))*vold(i,j,k)* om_v;
188 });
189
190 Array4<Real const> const& state_old = S_old.const_array(mfi);
192 }
193
194 const Real Cdb_min = solverChoice.Cdb_min;
195 const Real Cdb_max = solverChoice.Cdb_max;
196
197 MultiFab* lw_ptr = nullptr;
198
201 }
206 vec_Tair[lev].get(),vec_qair[lev].get(),vec_Pair[lev].get(),
207 vec_srflx[lev].get(),
208 lw_ptr,
209 vec_evap[lev].get(),
210 vec_sustr[lev].get(),vec_svstr[lev].get(),vec_stflux[lev].get(),
211 vec_lrflx[lev].get(),vec_lhflx[lev].get(),vec_shflx[lev].get(),N);
212 vec_evap[lev]->FillBoundary(geom[lev].periodicity());
213 }
214
216 for ( MFIter mfi(S_new, TilingIfNotGPU()); mfi.isValid(); ++mfi )
217 {
218 Array4<Real > const& stflx = vec_stflx[lev]->array(mfi);
219 Array4<Real > const& btflx = vec_btflx[lev]->array(mfi);
220 Array4<Real const> const& stflux = vec_stflux[lev]->array(mfi);
221 Array4<Real const> const& btflux = vec_btflux[lev]->array(mfi);
222 Box gbx2 = mfi.growntilebox(IntVect(NGROW,NGROW,0));
223 Box gbx2D = gbx2;
224 gbx2D.makeSlab(2,0);
225 ParallelFor(gbx2D, [=] AMREX_GPU_DEVICE (int i, int j, int ) {
228 });
229 }
230 }
232 for ( MFIter mfi(S_new, TilingIfNotGPU()); mfi.isValid(); ++mfi )
233 {
234 Array4<Real > const& stflx = vec_stflx[lev]->array(mfi);
235 Array4<Real > const& btflx = vec_btflx[lev]->array(mfi);
236 Array4<Real const> const& stflux = vec_stflux[lev]->const_array(mfi);
237 Array4<Real const> const& salt_old = S_old.const_array(mfi,Salt_comp);
238 Box gbx2 = mfi.growntilebox(IntVect(NGROW,NGROW,0));
239 Box gbx2D = gbx2;
240 gbx2D.makeSlab(2,0);
241 ParallelFor(gbx2D, [=] AMREX_GPU_DEVICE (int i, int j, int ) {
243 // The fact that this is btflx on the RHS matches what's in ROMS even though
244 // it's weird -- if it's non-zero, does that mean that it will run away since
245 // it's always getting multiplied by salt?
246 btflx(i,j,0,Salt_comp) = btflx(i,j,0,Salt_comp) * salt_old(i,j,0);
247 });
248 }
249 }
250
251 for ( MFIter mfi(S_new, TilingIfNotGPU()); mfi.isValid(); ++mfi )
252 {
253 Array4<Real > const& bustr = mf_bustr->array(mfi);
254 Array4<Real > const& bvstr = mf_bvstr->array(mfi);
255 Array4<Real const> const& uold = U_old.const_array(mfi);
256 Array4<Real const> const& vold = V_old.const_array(mfi);
258 Array4<Real const> const& z_r = mf_z_r->const_array(mfi);
259 Array4<Real const> const& z_w = mf_z_w->const_array(mfi);
260
261 Box gbx2 = mfi.growntilebox(IntVect(NGROW,NGROW,0));
262 Box gbx2D = gbx2;
263 gbx2D.makeSlab(2,0);
264 Box ubx1 = mfi.grownnodaltilebox(0,IntVect(NGROW-1,NGROW-1,0));
265 Box ubx1D = ubx1;
266 ubx1D.makeSlab(2,0);
267 Box vbx1 = mfi.grownnodaltilebox(1,IntVect(NGROW-1,NGROW-1,0));
268 Box vbx1D = vbx1;
269 vbx1D.makeSlab(2,0);
270 // Set bottom stress as defined in set_vbx.F
272 Array4<Real const> const& rdrag = mf_rdrag->const_array(mfi);
273 ParallelFor(ubx1D, [=] AMREX_GPU_DEVICE (int i, int j, int )
274 {
275 bustr(i,j,0) = Real(0.5) * (rdrag(i-1,j,0)+rdrag(i,j,0))*(uold(i,j,0));
276 });
277 ParallelFor(vbx1D, [=] AMREX_GPU_DEVICE (int i, int j, int )
278 {
279 bvstr(i,j,0) = Real(0.5) * (rdrag(i,j-1,0)+rdrag(i,j,0))*(vold(i,j,0));
280 });
282 Array4<Real const> const& rdrag2 = mf_rdrag2->const_array(mfi);
283 ParallelFor(ubx1D, [=] AMREX_GPU_DEVICE (int i, int j, int )
284 {
285 Real avg_v = Real(0.25) * (vold(i,j,0) + vold(i,j+1,0) + vold(i-1,j,0) + vold(i-1,j+1,0));
286 Real vel_mag = std::sqrt(uold(i,j,0)*uold(i,j,0) + avg_v * avg_v);
287 bustr(i,j,0) = Real(0.5) * (rdrag2(i-1,j,0) + rdrag2(i,j,0)) * uold(i,j,0) * vel_mag;
288 });
289 ParallelFor(vbx1D, [=] AMREX_GPU_DEVICE (int i, int j, int )
290 {
291 Real avg_u = Real(0.25) * (uold(i,j,0) + uold(i+1,j,0) + uold(i,j-1,0) + uold(i+1,j-1,0));
292 Real vel_mag = std::sqrt(avg_u * avg_u + vold(i,j,0) * vold(i,j,0));
293 bvstr(i,j,0) = Real(0.5) * (rdrag2(i,j-1,0) + rdrag2(i,j,0)) * vold(i,j,0) * vel_mag;
294 });
296 Array4<Real const> const& ZoBot = mf_ZoBot->const_array(mfi);
297 ParallelFor(gbx2D, [=] AMREX_GPU_DEVICE (int i, int j, int )
298 {
299 Real logz = one / (std::log((z_r(i,j,0) - z_w(i,j,0)) / ZoBot(i,j,0)));
300 Real cff = vonKar * vonKar * logz * logz;
301 logdrg_tmp(i,j,0) = std::min(Cdb_max,std::max(Cdb_min,cff));
302 });
303 ParallelFor(ubx1D, [=] AMREX_GPU_DEVICE (int i, int j, int )
304 {
305 Real avg_v = Real(0.25) * (vold(i,j,0) + vold(i,j+1,0) + vold(i-1,j,0) + vold(i-1,j+1,0));
306 Real vel_mag = std::sqrt(uold(i,j,0)*uold(i,j,0) + avg_v * avg_v);
307 bustr(i,j,0) = Real(0.5) * (logdrg_tmp(i-1,j,0)+logdrg_tmp(i,j,0)) * uold(i,j,0) * vel_mag;
308 });
309 ParallelFor(vbx1D, [=] AMREX_GPU_DEVICE (int i, int j, int )
310 {
311 Real avg_u = Real(0.25) * (uold(i,j,0) + uold(i+1,j,0) + uold(i,j-1,0) + uold(i+1,j-1,0));
312 Real vel_mag = std::sqrt(avg_u * avg_u + vold(i,j,0) * vold(i,j,0));
313 bvstr(i,j,0) = Real(0.5) * (logdrg_tmp(i,j-1,0) + logdrg_tmp(i,j,0)) * vold(i,j,0) * vel_mag;
314 });
315 }
316 }
319
321 // Update Akv if using analytic mixing
323 }
324
326
327 MultiFab mf_W(convert(ba,IntVect(0,0,1)),dm,1,IntVect(NGROW+1,NGROW+1,0));
328 mf_W.setVal(zero);
329
330
332 const int nnew = 0;
334 mf_ru.get(), mf_rv.get(),
335 S_old, S_new, mf_W,
337 mf_sustr.get(), mf_svstr.get(), mf_bustr.get(), mf_bvstr.get(),
338 mf_msku.get(), mf_mskv.get(),
339 iic, ntfirst, nnew, nstp, nrhs, N, dt_lev);
340 }
341
342 // We use FillBoundary not FillPatch here since mf_W is single-level scratch space
343 mf_W.FillBoundary(geom[lev].periodicity());
344 (*physbcs[lev])(mf_W,*mf_mskr.get(),0,1,mf_W.nGrowVect(),t_new[lev],zvel_bc());
345
346#ifdef REMORA_USE_NETCDF
347 // Get u and v climatology if we're going to do nudging
349 u_clim_data_from_file->update_interpolated_to_time(t_new[lev], lev, xvel_new[lev], geom, ref_ratio);
350 v_clim_data_from_file->update_interpolated_to_time(t_new[lev], lev, yvel_new[lev], geom, ref_ratio);
351 }
352#endif
353
354 for ( MFIter mfi(S_old, TilingIfNotGPU()); mfi.isValid(); ++mfi )
355 {
356 Array4<Real const> const& Hz = vec_Hz[lev]->const_array(mfi);
357 Array4<Real> const& Huon = vec_Huon[lev]->array(mfi);
358 Array4<Real> const& Hvom = vec_Hvom[lev]->array(mfi);
359 Array4<Real> const& z_r = (mf_z_r)->array(mfi);
360 Array4<Real> const& z_w = (mf_z_w)->array(mfi);
361 Array4<Real const> const& uold = U_old.const_array(mfi);
362 Array4<Real const> const& vold = V_old.const_array(mfi);
363 Array4<Real> const& u = U_new.array(mfi);
364 Array4<Real> const& v = V_new.array(mfi);
365 Array4<Real> const& rho = (mf_rho).array(mfi);
366 Array4<Real> const& ru = (mf_ru)->array(mfi);
367 Array4<Real> const& rv = (mf_rv)->array(mfi);
368 Array4<Real> const& rufrc = (mf_rufrc)->array(mfi);
369 Array4<Real> const& rvfrc = (mf_rvfrc)->array(mfi);
370 Array4<Real> const& W = (mf_W).array(mfi);
371 Array4<Real> const& sustr = (mf_sustr)->array(mfi);
372 Array4<Real> const& svstr = (mf_svstr)->array(mfi);
373 Array4<Real> const& bustr = (mf_bustr)->array(mfi);
374 Array4<Real> const& bvstr = (mf_bvstr)->array(mfi);
375 Array4<Real> const& visc2_p = (mf_visc2_p)->array(mfi);
376 Array4<Real> const& visc2_r = (mf_visc2_r)->array(mfi);
377
378 Array4<Real const> const& pm = mf_pm->const_array(mfi);
379 Array4<Real const> const& pn = mf_pn->const_array(mfi);
380 Array4<Real const> const& fcor = mf_fcor->const_array(mfi);
381
382 Array4<Real const> const& msku = mf_msku->const_array(mfi);
383 Array4<Real const> const& mskv = mf_mskv->const_array(mfi);
384 Array4<Real const> const& mskp = mf_mskp->const_array(mfi);
385
386 Box bx = mfi.tilebox();
387
388 Box tbxp1 = bx;
389 Box tbxp2 = bx;
390 Box xbx = mfi.nodaltilebox(0);
391 Box ybx = mfi.nodaltilebox(1);
392
393 Box gbx1 = mfi.growntilebox(IntVect(NGROW-1,NGROW-1,0));
394 Box gbx2 = mfi.growntilebox(IntVect(NGROW,NGROW,0));
395
396 Box utbx = mfi.nodaltilebox(0);
397 Box vtbx = mfi.nodaltilebox(1);
398
399 tbxp1.grow(IntVect(NGROW-1,NGROW-1,0));
400 tbxp2.grow(IntVect(NGROW,NGROW,0));
401
402 Box bxD = bx;
403 bxD.makeSlab(2,0);
404 Box gbx1D = gbx1;
405 gbx1D.makeSlab(2,0);
406 Box gbx2D = gbx2;
407 gbx2D.makeSlab(2,0);
408
409 Box tbxp1D = tbxp1;
410 tbxp1D.makeSlab(2,0);
411 Box tbxp2D = tbxp2;
412 tbxp2D.makeSlab(2,0);
413
414 FArrayBox fab_FC(surroundingNodes(tbxp2,2),1,amrex::The_Async_Arena()); //3D
415 auto FC=fab_FC.array();
416
417 FArrayBox fab_fomn(tbxp2D,1,amrex::The_Async_Arena());
418 auto fomn=fab_fomn.array();
419
421 ParallelFor(tbxp2D, [=] AMREX_GPU_DEVICE (int i, int j, int )
422 {
423 fomn(i,j,0) = fcor(i,j,0)*(one/(pm(i,j,0)*pn(i,j,0)));
424 });
425 }
426
427 ParallelFor(gbx2, [=] AMREX_GPU_DEVICE (int i, int j, int k)
428 {
429 FC(i,j,k)=zero;
430 });
431
433
434 // Apply mixing to temperature and, if use_salt, salt
435 int ncomp = solverChoice.use_salt ? 2 : 1;
436 Array4<Real> const& s_arr = S_new.array(mfi);
437 Array4<Real> const& s_arr_rhs = S_old.array(mfi);
438 Array4<Real> const& diff2_arr = vec_diff2[lev]->array(mfi);
439
441
442 for (int itrac = Tracer_comp; itrac < ncons; ++itrac) {
444 t3dmix2(bx, S_new.array(mfi,itrac), S_old.array(mfi,itrac), diff2_arr_scalar, Hz, z_r, pm, pn, msku, mskv, dt_lev, 1, N);
445 }
446
448 //-----------------------------------------------------------------------
449 // coriolis
450 //-----------------------------------------------------------------------
451 //
452 // ru, rv updated
453 // In ROMS, coriolis is the first (un-ifdefed) thing to happen in rhs3d_tile, which gets called after t3dmix
455 }
456
458 Array4<Real const> const& dndx = vec_dndx[lev]->const_array(mfi);
459 Array4<Real const> const& dmde = vec_dmde[lev]->const_array(mfi);
461 }
462
463#ifdef REMORA_USE_NETCDF
465 Array4<const Real> const& uclim = u_clim_data_from_file->get_interpolated_mf(lev)->const_array(mfi);
466 Array4<const Real> const& vclim = v_clim_data_from_file->get_interpolated_mf(lev)->const_array(mfi);
469 // These boxes are set to match the ROMS loops i=IstrU..Iend, j=JstrV..Jend, which
470 // exclude the u-face on the west/east domain edges and the v-face on south/north
471 const Box xbx_adj = clim_nudg_momentum_box(mfi.nodaltilebox(0), 0,
472 Geom(lev).Domain(), Geom(lev).isPeriodic(0));
473 const Box ybx_adj = clim_nudg_momentum_box(mfi.nodaltilebox(1), 1,
474 Geom(lev).Domain(), Geom(lev).isPeriodic(1));
477 }
478#endif
479
480 ////rufrc from 3d is set to ru, then the wind stress (and bottom stress) is added, then the mixing is added
481 //rufrc=ru+sustr*om_u*on_u
482
484 sustr, svstr, bustr, bvstr, Huon, Hvom,
485 pm, pn, W, FC, nrhs, N);
486
488 const int nnew = 0;
489 uv3dmix(xbx, ybx, u, v, uold, vold, rufrc, rvfrc, visc2_p, visc2_r, Hz, pm, pn, mskp, nrhs, nnew, dt_lev);
490 }
491 } // MFIter
492
493 int nnew = (iic +1)% 2;
494 nstp = iic % 2;
497 nstp, nnew, iic, ntfirst, N, dt_lev);
498 }
499 nstp = 0;
500
501 // Commenting out for now, but not sure it's necessary
502 //FillPatch(lev, time, *cons_old[lev], cons_old, BCVars::cons_bc, BdyVars::t);
503 //FillPatch(lev, time, *cons_new[lev], cons_new, BCVars::cons_bc, BdyVars::t);
505
506 // Don't actually want to apply boundary conditions here
507 vec_Huon[lev]->FillBoundary(geom[lev].periodicity());
508 vec_Hvom[lev]->FillBoundary(geom[lev].periodicity());
509}
constexpr amrex::Real two
constexpr amrex::Real one
constexpr amrex::Real zero
constexpr amrex::Real vonKar
#define NGROW
#define Temp_comp
#define Tracer_comp
#define Salt_comp
mf_h setVal(geomdata.ProbHi(2))
int ncons
Number of conserved scalars in the state (temperature + salt + passive scalars + biology tracers)
Definition REMORA.H:1644
void prsgrd(const amrex::Box &bx, const amrex::Box &gbx, const amrex::Box &utbx, const amrex::Box &vtbx, const amrex::Array4< amrex::Real > &ru, const amrex::Array4< amrex::Real > &rv, const amrex::Array4< amrex::Real const > &pn, const amrex::Array4< amrex::Real const > &pm, const amrex::Array4< amrex::Real const > &rho, const amrex::Array4< amrex::Real > &FC, const amrex::Array4< amrex::Real const > &Hz, const amrex::Array4< amrex::Real const > &z_r, const amrex::Array4< amrex::Real const > &z_w, const amrex::Array4< amrex::Real const > &msku, const amrex::Array4< amrex::Real const > &mskv, const int nrhs, const int N)
Calculate pressure gradient.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_evap
evaporation rate [kg/m^2/s]
Definition REMORA.H:505
int zvel_bc() const noexcept
Definition REMORA.H:1315
bool running_with_coupling_driver
True once REMORA has received forcing through the coupling driver.
Definition REMORA.H:514
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_fcor
coriolis factor (2D)
Definition REMORA.H:577
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_btflux
Bottom tracer flux; input arrays.
Definition REMORA.H:500
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_h
multilevel data container for current step's z velocities (largely unused; W stored separately)
Definition REMORA.H:406
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_pm
horizontal scaling factor: 1 / dx (2D)
Definition REMORA.H:568
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_ZoBot
Bottom roughness length [m], defined at rho points.
Definition REMORA.H:525
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_lrflx
longwave radiation
Definition REMORA.H:485
amrex::Vector< amrex::MultiFab * > cons_new
multilevel data container for current step's scalar data: temperature, salinity, passive tracer
Definition REMORA.H:386
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_vwind
Wind in the v direction, defined at rho-points.
Definition REMORA.H:474
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_mskr
land/sea mask at cell centers (2D)
Definition REMORA.H:557
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_tke
Turbulent kinetic energy.
Definition REMORA.H:632
void rho_eos(const amrex::Box &bx, const amrex::Array4< amrex::Real const > &state, const amrex::Array4< amrex::Real > &rho, const amrex::Array4< amrex::Real > &rhoA, const amrex::Array4< amrex::Real > &rhoS, const amrex::Array4< amrex::Real > &bvf, const amrex::Array4< amrex::Real > &alpha, const amrex::Array4< amrex::Real > &beta, const amrex::Array4< amrex::Real const > &Hz, const amrex::Array4< amrex::Real const > &z_w, const amrex::Array4< amrex::Real const > &z_r, const amrex::Array4< amrex::Real const > &h, const amrex::Array4< amrex::Real const > &mskr, const int N)
Wrapper around equation of state calculation.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_stflx
Surface tracer flux; working arrays.
Definition REMORA.H:494
void t3dmix2(const amrex::Box &bx, const amrex::Array4< amrex::Real > &state, const amrex::Array4< amrex::Real > &state_rhs, const amrex::Array4< amrex::Real const > &diff2, const amrex::Array4< amrex::Real const > &Hz, const amrex::Array4< amrex::Real const > &z_r, const amrex::Array4< amrex::Real const > &pm, const amrex::Array4< amrex::Real const > &pn, const amrex::Array4< amrex::Real const > &msku, const amrex::Array4< amrex::Real const > &mskv, const amrex::Real dt_lev, const int ncomp, const int N)
Wrapper for harmonic diffusivity for tracers.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_gls
Turbulent generic length scale.
Definition REMORA.H:634
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_sustr
Surface stress in the u direction.
Definition REMORA.H:467
amrex::Vector< amrex::MultiFab * > zvel_new
multilevel data container for current step's z velocities (largely unused; W stored separately)
Definition REMORA.H:392
void set_surface_state(int lev)
Initialize or calculate wind speed and other surface state vars from file or analytic.
Definition REMORA.cpp:1190
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_sstore
additional scratch space for calculations on temp, salt, etc
Definition REMORA.H:612
std::unique_ptr< NCTimeSeries > v_clim_data_from_file
Data container for v-velocity climatology data read from file.
Definition REMORA.H:1476
void rhs_uv_3d(int lev, const amrex::Box &xbx, const amrex::Box &ybx, const amrex::Array4< amrex::Real const > &uold, const amrex::Array4< amrex::Real const > &vold, const amrex::Array4< amrex::Real > &ru, const amrex::Array4< amrex::Real > &rv, const amrex::Array4< amrex::Real > &rufrc, const amrex::Array4< amrex::Real > &rvfrc, const amrex::Array4< amrex::Real const > &sustr, const amrex::Array4< amrex::Real const > &svstr, const amrex::Array4< amrex::Real const > &bustr, const amrex::Array4< amrex::Real const > &bvstr, const amrex::Array4< amrex::Real const > &Huon, const amrex::Array4< amrex::Real const > &Hvom, const amrex::Array4< amrex::Real const > &pm, const amrex::Array4< amrex::Real const > &pn, const amrex::Array4< amrex::Real const > &W, const amrex::Array4< amrex::Real > &FC, int nrhs, int N)
RHS terms for 3D momentum.
static amrex::Box clim_nudg_momentum_box(const amrex::Box &nodal_bx, int dir, const amrex::Box &domain, bool is_periodic)
Shrink an x- or y-nodal momentum tilebox to the faces ROMS nudges.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_Hz
Width of cells in the vertical (z-) direction (3D, Hz in ROMS)
Definition REMORA.H:412
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_msku
land/sea mask at x-faces (2D)
Definition REMORA.H:559
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_rvfrc
v velocity RHS, integrated, including advection and bottom/surface stresses (2D)
Definition REMORA.H:428
int v2d_simple_bc() const noexcept
Definition REMORA.H:1323
std::unique_ptr< NCTimeSeries > u_clim_data_from_file
Data container for u-velocity climatology data read from file.
Definition REMORA.H:1474
amrex::Vector< amrex::MultiFab * > xvel_old
multilevel data container for last step's x velocities (u in ROMS)
Definition REMORA.H:379
amrex::Vector< amrex::MultiFab * > yvel_new
multilevel data container for current step's y velocities (v in ROMS)
Definition REMORA.H:390
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_uwind
Wind in the u direction, defined at rho-points.
Definition REMORA.H:472
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_rufrc
u velocity RHS, integrated, including advection and bottom/surface stresses (2D)
Definition REMORA.H:426
DriverAtmosForcingMode driver_atmos_forcing_mode
Active atmosphere-to-ocean forcing contract on the most recent driver apply.
Definition REMORA.H:518
void gls_prestep(int lev, amrex::MultiFab *mf_gls, amrex::MultiFab *mf_tke, amrex::MultiFab &mf_W, amrex::MultiFab *mf_msku, amrex::MultiFab *mf_mskv, const int nstp, const int nnew, const int iic, const int ntfirst, const int N, const amrex::Real dt_lev)
Prestep for GLS calculation.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_shflx
sensible heat flux
Definition REMORA.H:491
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_visc2_p
Harmonic viscosity defined on the psi points (corners of horizontal grid cells)
Definition REMORA.H:434
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_dmde
d(1/m)/d(eta)
Definition REMORA.H:609
amrex::Vector< amrex::MultiFab * > zvel_old
multilevel data container for last step's z velocities (largely unused; W stored separately)
Definition REMORA.H:383
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_z_r
z coordinates at rho points (cell centers)
Definition REMORA.H:441
amrex::Vector< amrex::MultiFab * > xvel_new
multilevel data container for current step's x velocities (u in ROMS)
Definition REMORA.H:388
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_lhflx
latent heat flux
Definition REMORA.H:489
int u2d_simple_bc() const noexcept
Definition REMORA.H:1322
void FillPatchNoBC(int lev, amrex::Real time, amrex::MultiFab &mf_to_be_filled, amrex::Vector< amrex::MultiFab * > const &mfs, const int bdy_var_type=BdyVars::null, const int icomp=0, const bool fill_all=true, const bool fill_set=false)
Fill a new MultiFab by copying in phi from valid region and filling ghost cells without applying boun...
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_mskp
land/sea mask at cell corners (2D)
Definition REMORA.H:563
void prestep(int lev, amrex::MultiFab &mf_uold, amrex::MultiFab &mf_vold, amrex::MultiFab &mf_u, amrex::MultiFab &mf_v, amrex::MultiFab *mf_ru, amrex::MultiFab *mf_rv, amrex::MultiFab &S_old, amrex::MultiFab &S_new, amrex::MultiFab &mf_W, amrex::MultiFab &mf_DC, const amrex::MultiFab *mf_z_r, const amrex::MultiFab *mf_z_w, const amrex::MultiFab *mf_h, const amrex::MultiFab *mf_pm, const amrex::MultiFab *mf_pn, const amrex::MultiFab *mf_sustr, const amrex::MultiFab *mf_svstr, const amrex::MultiFab *mf_bustr, const amrex::MultiFab *mf_bvstr, const amrex::MultiFab *mf_msku, const amrex::MultiFab *mf_mskv, const int iic, const int nfirst, const int nnew, int nstp, int nrhs, int N, const amrex::Real dt_lev)
Wrapper function for prestep.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_bvf
Brunt-Vaisala frequency (3D)
Definition REMORA.H:619
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_mskv
land/sea mask at y-faces (2D)
Definition REMORA.H:561
amrex::Vector< std::unique_ptr< REMORAPhysBCFunct > > physbcs
Vector (over level) of functors to apply physical boundary conditions.
Definition REMORA.H:1566
amrex::Vector< int > istep
which step?
Definition REMORA.H:1552
void uv3dmix(const amrex::Box &xbx, const amrex::Box &ybx, const amrex::Array4< amrex::Real > &u, const amrex::Array4< amrex::Real > &v, const amrex::Array4< amrex::Real const > &uold, const amrex::Array4< amrex::Real const > &vold, const amrex::Array4< amrex::Real > &rufrc, const amrex::Array4< amrex::Real > &rvfrc, const amrex::Array4< amrex::Real const > &visc2_p, const amrex::Array4< amrex::Real const > &visc2_r, const amrex::Array4< amrex::Real const > &Hz, const amrex::Array4< amrex::Real const > &pm, const amrex::Array4< amrex::Real const > &pn, const amrex::Array4< amrex::Real const > &mskp, int nrhs, int nnew, const amrex::Real dt_lev)
Harmonic viscosity.
void set_analytic_vmix(int lev)
Set vertical mixing coefficients from analytic.
Definition REMORA.cpp:842
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_rhoS
density perturbation
Definition REMORA.H:615
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_visc2_r
Harmonic viscosity defined on the rho points (centers)
Definition REMORA.H:436
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_svstr
Surface stress in the v direction.
Definition REMORA.H:469
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_Huon
u-volume flux (3D)
Definition REMORA.H:414
amrex::Vector< amrex::MultiFab * > yvel_old
multilevel data container for last step's y velocities (v in ROMS)
Definition REMORA.H:381
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_rhoA
vertically-averaged density
Definition REMORA.H:617
void apply_clim_nudg(const amrex::Box &bx, int ioff, int joff, const amrex::Array4< amrex::Real > &var, const amrex::Array4< amrex::Real const > &var_old, const amrex::Array4< amrex::Real const > &var_clim, const amrex::Array4< amrex::Real const > &clim_coeff, const amrex::Array4< amrex::Real const > &Hz, const amrex::Array4< amrex::Real const > &pm, const amrex::Array4< amrex::Real const > &pn, const amrex::Real dt_lev=zero)
Apply climatology nudging.
amrex::Vector< amrex::Real > t_new
new time at each level
Definition REMORA.H:1556
static SolverChoice solverChoice
Container for algorithmic choices.
Definition REMORA.H:1717
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_rdrag2
Quadratic drag coefficient [unitless], defined at rho points.
Definition REMORA.H:523
void set_zeta_to_Ztavg(int lev, bool apply_eminusp=true)
Set zeta components to be equal to time-averaged Zt_avg1.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_ru
u velocity RHS (3D, includes horizontal and vertical advection)
Definition REMORA.H:418
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_longwave_down
Downward longwave radiation.
Definition REMORA.H:487
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_alpha
Thermal expansion coefficient (3D)
Definition REMORA.H:621
amrex::Vector< amrex::MultiFab * > cons_old
multilevel data container for last step's scalar data: temperature, salinity, passive tracer
Definition REMORA.H:377
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_bustr
Bottom stress in the u direction.
Definition REMORA.H:528
void FillPatch(int lev, amrex::Real time, amrex::MultiFab &mf_to_be_filled, amrex::Vector< amrex::MultiFab * > const &mfs, const int bccomp, const int bdy_var_type=BdyVars::null, const int icomp=0, const bool fill_all=true, const bool fill_set=false, const int n_not_fill=0, const int icomp_calc=0, const amrex::Real dt=zero, const amrex::MultiFab &mf_calc=amrex::MultiFab())
Fill a new MultiFab by copying in phi from valid region and filling ghost cells.
static constexpr bool DriverUsesStateForcing(DriverAtmosForcingMode mode) noexcept
Definition REMORA.H:98
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_dndx
d(1/n)/d(xi)
Definition REMORA.H:607
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_bvstr
Bottom stress in the v direction.
Definition REMORA.H:530
amrex::Vector< amrex::Vector< std::unique_ptr< amrex::MultiFab > > > vec_nudg_coeff
Climatology nudging coefficients.
Definition REMORA.H:643
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_pn
horizontal scaling factor: 1 / dy (2D)
Definition REMORA.H:570
void curvilinear(const amrex::Box &bx, const amrex::Box &xbx, const amrex::Box &ybx, const amrex::Array4< amrex::Real const > &uold, const amrex::Array4< amrex::Real const > &vold, const amrex::Array4< amrex::Real > &ru, const amrex::Array4< amrex::Real > &rv, const amrex::Array4< amrex::Real const > &Hz, const amrex::Array4< amrex::Real const > &dndx, const amrex::Array4< amrex::Real const > &dmde, int nrhs, int nr)
Calculate curvilinear advection terms.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_stflux
Surface tracer flux; input arrays.
Definition REMORA.H:496
void setup_step(int lev, amrex::Real time, amrex::Real dt_lev)
Set everything up for a step on a level.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_rdrag
Linear drag coefficient [m/s], defined at rho points.
Definition REMORA.H:521
void set_smflux(int lev)
Initialize or calculate surface momentum flux from file or analytic.
Definition REMORA.cpp:1171
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_rv
v velocity RHS (3D, includes horizontal and vertical advection)
Definition REMORA.H:420
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_btflx
Bottom tracer flux; working arrays.
Definition REMORA.H:498
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_beta
Saline contraction coefficient (3D)
Definition REMORA.H:623
void bulk_fluxes(int lev, amrex::MultiFab *mf_cons, amrex::MultiFab *mf_uwind, amrex::MultiFab *mf_vwind, amrex::MultiFab *mf_Tair, amrex::MultiFab *mf_qair, amrex::MultiFab *mf_Pair, amrex::MultiFab *mf_srflx, amrex::MultiFab *mf_longwave_down, amrex::MultiFab *mf_evap, amrex::MultiFab *mf_sustr, amrex::MultiFab *mf_svstr, amrex::MultiFab *mf_stflux, amrex::MultiFab *mf_lrflx, amrex::MultiFab *mf_lhflx, amrex::MultiFab *mf_shflx, const int N)
Calculate bulk temperature, salinity, wind fluxes.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_srflx
Shortwave radiation flux [W/m²], defined at rho-points.
Definition REMORA.H:483
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_Pair
Air pressure [mb], defined at rho-points.
Definition REMORA.H:480
void coriolis(const amrex::Box &xbx, const amrex::Box &ybx, const amrex::Array4< amrex::Real const > &uold, const amrex::Array4< amrex::Real const > &vold, const amrex::Array4< amrex::Real > &ru, const amrex::Array4< amrex::Real > &rv, const amrex::Array4< amrex::Real const > &Hz, const amrex::Array4< amrex::Real const > &fomn, int nrhs, int nr)
Calculate Coriolis terms.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_qair
Specific humidity [kg/kg], defined at rho-points.
Definition REMORA.H:478
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_z_w
z coordinates at w points (faces between z-cells)
Definition REMORA.H:444
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_Tair
Air temperature [°C], defined at rho-points.
Definition REMORA.H:476
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_Hvom
v-volume flux (3D)
Definition REMORA.H:416
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_diff2
Harmonic diffusivity for temperature / salinity.
Definition REMORA.H:438
static constexpr int cons_bc
static constexpr int t
cons component Temp_comp
static constexpr int u
static constexpr int v
static constexpr int null
@ LWrad
longwave radiation [W/m^2]
amrex::Real Cdb_min
BottomStressType bottom_stress_type
VertMixingType vert_mixing_type
std::array< BulkForcingType, BulkFlux::NumTypes > bulk_flux_type
amrex::Real Cdb_max