1#ifndef AMREX_MultiFabUtil_H_
2#define AMREX_MultiFabUtil_H_
3#include <AMReX_Config.H>
12#include <AMReX_MultiFabUtil_C.H>
20 const MultiFab& nd,
int scomp,
21 int ncomp,
int ngrow = 0);
23 const MultiFab& nd,
int scomp,
24 int ncomp,
IntVect const& ng_vect);
33 const Vector<const MultiFab*>& edge,
36 const Vector<const MultiFab*>& edge,
46 const Vector<const MultiFab*>& fc,
49 const Vector<const MultiFab*>& fc,
53 template <FabArrayType CMF, FabArrayType FMF>
55 const Array<const FMF*,AMREX_SPACEDIM>& fc,
58 template <FabArrayType CMF, FabArrayType FMF>
60 const Array<const FMF*,AMREX_SPACEDIM>& fc,
65 const Vector<const MultiFab*>& fc,
66 const Geometry& geom);
69 const Array<const MultiFab*,AMREX_SPACEDIM>& fc,
70 const Geometry& geom);
83 bool use_harmonic_averaging =
false,
90 bool use_harmonic_averaging =
false,
97 bool use_harmonic_averaging,
98 const Array<IntVect, AMREX_SPACEDIM>& ng_vects);
101 template <FabArrayType MF>
103 const Vector<MF*>&
crse,
107 template <FabArrayType MF>
109 const Vector<MF*>&
crse,
113 template <FabArrayType MF>
115 const Array<MF*,AMREX_SPACEDIM>&
crse,
119 template <FabArrayType MF>
121 const Array<MF*,AMREX_SPACEDIM>&
crse,
130 template <BaseFabType FAB>
132 const IntVect& ratio,
int ngcrse=0);
135 template <FabArrayType MF>
137 const Array<MF*,AMREX_SPACEDIM>&
crse,
138 const IntVect& ratio,
const Geometry& crse_geom);
140 template <BaseFabType FAB>
142 const IntVect& ratio,
const Geometry& crse_geom);
146 const Vector<MultiFab*>&
crse,
150 const Array<MultiFab*,AMREX_SPACEDIM>&
crse,
157 const IntVect& ratio,
int ngcrse=0);
160 template <BaseFabType FAB>
162 FabArray<FAB>& S_crse,
165 bool mfiter_is_definitely_safe=
false);
173 void average_down (
const MultiFab& S_fine, MultiFab& S_crse,
174 const Geometry& fgeom,
const Geometry& cgeom,
175 int scomp,
int ncomp,
const IntVect& ratio);
176 void average_down (
const MultiFab& S_fine, MultiFab& S_crse,
177 const Geometry& fgeom,
const Geometry& cgeom,
178 int scomp,
int ncomp,
int rr);
183 template <BaseFabType FAB>
184 void average_down (
const FabArray<FAB>& S_fine, FabArray<FAB>& S_crse,
185 int scomp,
int ncomp,
const IntVect& ratio);
186 template <BaseFabType FAB>
187 void average_down (
const FabArray<FAB>& S_fine, FabArray<FAB>& S_crse,
188 int scomp,
int ncomp,
int rr);
193 int scomp,
int ncomp,
195 const Geometry& cgeom,
const Geometry& fgeom);
202 void writeFabs (
const MultiFab& mf,
const std::string& name);
203 void writeFabs (
const MultiFab& mf,
int comp,
int ncomp,
const std::string& name);
209 const Geometry& geom,
int start_comp,
int ncomp,
210 bool interpolate=
false,
211 RealBox
const& bnd_rbx = RealBox());
220 template <FabArrayType MF>
229 template <FabArrayType MF>
235 template <BaseFabType FAB>
236 iMultiFab
makeFineMask (
const FabArray<FAB>& cmf,
const BoxArray& fba,
const IntVect& ratio,
237 int crse_value = 0,
int fine_value = 1,
238 MFInfo
const& info = MFInfo());
239 iMultiFab
makeFineMask (
const BoxArray& cba,
const DistributionMapping& cdm,
240 const BoxArray& fba,
const IntVect& ratio,
241 int crse_value = 0,
int fine_value = 1,
242 MFInfo
const& info = MFInfo());
243 template <BaseFabType FAB>
244 iMultiFab
makeFineMask (
const FabArray<FAB>& cmf,
const BoxArray& fba,
const IntVect& ratio,
245 Periodicity
const& period,
int crse_value,
int fine_value,
246 MFInfo
const& info = MFInfo());
247 iMultiFab
makeFineMask (
const BoxArray& cba,
const DistributionMapping& cdm,
248 const IntVect& cnghost,
const BoxArray& fba,
const IntVect& ratio,
249 Periodicity
const& period,
int crse_value,
int fine_value,
250 MFInfo
const& info = MFInfo());
251 template <BaseFabType FAB>
252 iMultiFab
makeFineMask (
const FabArray<FAB>& cmf,
const FabArray<FAB>& fmf,
254 Periodicity
const& period,
int crse_value,
int fine_value,
255 MFInfo
const& info = MFInfo());
256 template <BaseFabType FAB>
257 iMultiFab
makeFineMask (
const FabArray<FAB>& cmf,
const FabArray<FAB>& fmf,
259 Periodicity
const& period,
int crse_value,
int fine_value,
260 LayoutData<int>& has_cf,
261 MFInfo
const& info = MFInfo());
263 MultiFab
makeFineMask (
const BoxArray& cba,
const DistributionMapping& cdm,
264 const BoxArray& fba,
const IntVect& ratio,
266 MFInfo
const& info = MFInfo());
269 void computeDivergence (MultiFab& divu,
const Array<MultiFab const*,AMREX_SPACEDIM>& umac,
270 const Geometry& geom);
273 void computeGradient (MultiFab& grad,
const Array<MultiFab const*,AMREX_SPACEDIM>& umac,
274 const Geometry& geom);
283 Periodicity
const& period);
286 template <
typename T,
typename U>
289 T mf_out(mf_in.boxArray(), mf_in.DistributionMap(), mf_in.nComp(), mf_in.nGrowVect());
292#pragma omp parallel if (Gpu::notInLaunchRegion())
296 const Long n = mfi.fabbox().numPts() * mf_in.nComp();
297 auto *
pdst = mf_out[mfi].dataPtr();
298 auto const* psrc = mf_in [mfi].dataPtr();
301 pdst[i] =
static_cast<typename T::value_type
>(psrc[i]);
367 template <
typename Op,
typename T, BaseFabType FAB,
typename F>
368#ifndef AMREX_USE_CUDA
369 requires (IsCallableR<T,F,int,int,int,int>::value)
372 ReduceToPlane (
int direction,
Box const& domain, FabArray<FAB>
const& mf,
F const& f);
418 template <
typename Op, MultiFabLike FA,
typename F>
419#ifndef AMREX_USE_CUDA
420 requires (IsCallableR<
typename FA::value_type,
467 template <
typename Op, MultiFabLike FA,
typename F>
468#ifndef AMREX_USE_CUDA
469 requires (IsCallableR<
typename FA::value_type,
502 template <
typename Op, MultiFabLike FA,
typename F>
503#ifndef AMREX_USE_CUDA
504 requires (IsCallableR<
typename FA::value_type,
509 IntVect const& plane_max_grid_size,
F const& f);
526 Gpu::HostVector<Real>
sumToLine (MultiFab
const& mf,
int icomp,
int ncomp,
527 Box const& domain,
int direction,
bool local =
false);
537 Vector<Geometry>
const& geom,
538 Vector<IntVect>
const& ratio,
568 void FillRandom (MultiFab& mf,
int scomp,
int ncomp);
594 [[nodiscard]] Vector<MultiFab>
convexify (Vector<MultiFab const*>
const& mf,
595 Vector<IntVect>
const& refinement_ratio);
600template <BaseFabType FAB>
603 int crse_value,
int fine_value,
MFInfo const& info)
610template <BaseFabType FAB>
613 Periodicity const& period,
int crse_value,
int fine_value,
617 fba, ratio, period, crse_value, fine_value, info);
620template <BaseFabType FAB>
624 Periodicity const& period,
int crse_value,
int fine_value,
628 mask.setVal(crse_value);
631 1, 0,
MFInfo().SetAlloc(
false));
633 mask.setVal(fine_value, cpc, 0, 1);
638template <BaseFabType FAB>
642 Periodicity const& period,
int crse_value,
int fine_value,
646 mask.setVal(crse_value);
649 1, 0,
MFInfo().SetAlloc(
false));
651 mask.setVal(fine_value, cpc, 0, 1);
653 has_cf =
mask.RecvLayoutMask(cpc);
660template <BaseFabType FAB>
662 const IntVect& ratio,
int ngcrse,
bool mfiter_is_definitely_safe)
668 int ncomp =
crse.nComp();
669 using value_type =
typename FAB::value_type;
674#pragma omp parallel if (Gpu::notInLaunchRegion())
678 const Box& bx = mfi.growntilebox(ngcrse);
684 amrex_avgdown_nodes(tbx,crsearr,finearr,0,0,ncomp,ratio);
693 crse.ParallelCopy(ctmp,0,0,ncomp,ngcrse,ngcrse);
702template <BaseFabType FAB>
708template <BaseFabType FAB>
710 int scomp,
int ncomp,
const IntVect& ratio)
717 using value_type =
typename FAB::value_type;
730 auto const& crsema = S_crse.
arrays();
732 if (is_cell_centered) {
736 amrex_avgdown(i,j,k,n,crsema[box_no],finema[box_no],scomp,scomp,ratio);
742 amrex_avgdown_nodes(i,j,k,n,crsema[box_no],finema[box_no],scomp,scomp,ratio);
752#pragma omp parallel if (Gpu::notInLaunchRegion())
757 const Box& bx = mfi.tilebox();
761 if (is_cell_centered) {
764 amrex_avgdown(i,j,k,n,crsearr,finearr,scomp,scomp,ratio);
769 amrex_avgdown_nodes(i,j,k,n,crsearr,finearr,scomp,scomp,ratio);
781 auto const& crsema = crse_S_fine.
arrays();
783 if (is_cell_centered) {
787 amrex_avgdown(i,j,k,n,crsema[box_no],finema[box_no],0,scomp,ratio);
793 amrex_avgdown_nodes(i,j,k,n,crsema[box_no],finema[box_no],0,scomp,ratio);
803#pragma omp parallel if (Gpu::notInLaunchRegion())
808 const Box& bx = mfi.tilebox();
816 if (is_cell_centered) {
819 amrex_avgdown(i,j,k,n,crsearr,finearr,0,scomp,ratio);
824 amrex_avgdown_nodes(i,j,k,n,crsearr,finearr,0,scomp,ratio);
850 int numcomp,
IntVect nghost,
bool local)
853 BL_ASSERT(
x.DistributionMap() ==
y.DistributionMap());
854 BL_ASSERT(
x.nGrowVect().allGE(nghost) &&
y.nGrowVect().allGE(nghost));
859 auto const& xma =
x.const_arrays();
860 auto const& yma =
y.const_arrays();
865 auto const& xfab = xma[box_no];
866 auto const& yfab = yma[box_no];
867 for (
int n = 0; n < numcomp; ++n) {
868 t += f(xfab(i,j,k,xcomp+n) , yfab(i,j,k,ycomp+n));
876#pragma omp parallel if (!system::regtest_reduction) reduction(+:sm)
880 Box const& bx = mfi.growntilebox(nghost);
885 sm += f(xfab(i,j,k,xcomp+n) , yfab(i,j,k,ycomp+n));
905template <
typename MMF,
typename Pred,
typename F>
912 int numcomp,
IntVect nghost,
bool local)
916 BL_ASSERT(
x.DistributionMap() ==
y.DistributionMap());
918 BL_ASSERT(
x.nGrowVect().allGE(nghost) &&
y.nGrowVect().allGE(nghost));
924 auto const& xma =
x.const_arrays();
925 auto const& yma =
y.const_arrays();
926 auto const& mma =
mask.const_arrays();
931 if (pf(mma[box_no](i,j,k))) {
932 auto const& xfab = xma[box_no];
933 auto const& yfab = yma[box_no];
934 for (
int n = 0; n < numcomp; ++n) {
935 t += f(xfab(i,j,k,xcomp+n) , yfab(i,j,k,ycomp+n));
944#pragma omp parallel if (!system::regtest_reduction) reduction(+:sm)
948 Box const& bx = mfi.growntilebox(nghost);
951 auto const& mfab =
mask.const_array(mfi);
954 if (pf(mfab(i,j,k))) {
955 sm += f(xfab(i,j,k,xcomp+n) , yfab(i,j,k,ycomp+n));
968template <FabArrayType CMF, FabArrayType FMF>
977template <FabArrayType CMF, FabArrayType FMF>
987 auto const& ccma = cc.arrays();
989 auto const& fyma = fc[1]->const_arrays();,
990 auto const& fzma = fc[2]->const_arrays(););
994#if (AMREX_SPACEDIM == 1)
998 amrex_avg_fc_to_cc(i,j,k, ccma[box_no],
AMREX_D_DECL(fxma[box_no],
1002#
if (AMREX_SPACEDIM == 1)
1014#pragma omp parallel if (Gpu::notInLaunchRegion())
1018 const Box bx = mfi.growntilebox(ng_vect);
1019 auto const& ccarr = cc.array(mfi);
1020 AMREX_D_TERM(
auto const& fxarr = fc[0]->const_array(mfi);,
1021 auto const& fyarr = fc[1]->const_array(mfi);,
1022 auto const& fzarr = fc[2]->const_array(mfi););
1024#if (AMREX_SPACEDIM == 1)
1029 amrex_avg_fc_to_cc(i,j,k, ccarr, fxarr, dcomp, gd);
1034 amrex_avg_fc_to_cc(i,j,k, ccarr,
AMREX_D_DECL(fxarr,fyarr,fzarr), dcomp);
1041template <FabArrayType MF>
1044 const IntVect& ratio,
int ngcrse)
1054template <FabArrayType MF>
1061template <FabArrayType MF>
1064 int ratio,
int ngcrse)
1069template <FabArrayType MF>
1072 const IntVect& ratio,
int ngcrse)
1074 for (
int idim = 0; idim < AMREX_SPACEDIM; ++idim) {
1079template <BaseFabType FAB>
1081 const IntVect& ratio,
int ngcrse)
1087 const auto type =
fine.ixType();
1089 for (dir = 0; dir < AMREX_SPACEDIM; ++dir) {
1090 if (type.nodeCentered(dir)) {
break; }
1092 auto tmptype = type;
1094 if (dir >= AMREX_SPACEDIM || !tmptype.cellCentered()) {
1095 amrex::Abort(
"average_down_faces: not face index type");
1097 const int ncomp =
crse.nComp();
1102 auto const& crsema =
crse.arrays();
1103 auto const& finema =
fine.const_arrays();
1107 amrex_avgdown_faces(i,j,k,n, crsema[box_no], finema[box_no], 0, 0, ratio, dir);
1116#pragma omp parallel if (Gpu::notInLaunchRegion())
1120 const Box& bx = mfi.growntilebox(ngcrse);
1121 auto const& crsearr =
crse.array(mfi);
1122 auto const& finearr =
fine.const_array(mfi);
1125 amrex_avgdown_faces(i,j,k,n, crsearr, finearr, 0, 0, ratio, dir);
1135 crse.ParallelCopy(ctmp,0,0,ncomp,ngcrse,ngcrse);
1139template <FabArrayType MF>
1144 for (
int idim = 0; idim < AMREX_SPACEDIM; ++idim) {
1149template <BaseFabType FAB>
1159template <FabArrayType MF>
1162 using T =
typename MF::value_type;
1163 const int ncomp = mf.nComp();
1165 auto* dp = dv.
data();
1167 auto loc = cell.
dim3();
1170 Box const& box = mfi.validbox();
1173 auto const& fab = mf.const_array(mfi);
1176 for (
int n = 0; n < ncomp; ++n) {
1177 dp[n] = fab(loc.x,loc.y,loc.z,n);
1190template <FabArrayType MF>
1193 bool do_bnd = (!bnd_bx.
isEmpty());
1195 BoxArray const& ba = mf.boxArray();
1197 const auto nboxes =
static_cast<int>(ba.
size());
1203 for (
int i = 0; i < nboxes; ++i) {
1204 Box const& b = ba[i];
1212 procmap.push_back(dm[i]);
1213 index_map.push_back(i);
1217 for (
int i = 0; i < nboxes; ++i) {
1218 Box const& b = ba[i];
1219 Box const& b1d = bnd_bx & b;
1222 procmap.push_back(dm[i]);
1223 index_map.push_back(i);
1233 MF rmf(rba, rdm, mf.nComp(),
IntVect(0),
1234 MFInfo().SetArena(mf.arena()));
1236#pragma omp parallel if (Gpu::notInLaunchRegion())
1239 Box const& b = mfi.validbox();
1240 auto const& dfab = rmf.array(mfi);
1241 auto const& sfab = mf.const_array(index_map[mfi.index()]);
1245 dfab(i,j,k,n) = sfab(i,j,k,n);
1254template <
typename Op,
typename T,
typename F>
1255void reduce_to_plane (Array4<T>
const& ar,
int direction,
Box const& bx,
int box_no,
1258#if defined(AMREX_USE_GPU)
1263 constexpr int nthreads = 128;
1264 auto nblocks =
static_cast<int>(b2d.numPts());
1265#ifdef AMREX_USE_SYCL
1267 amrex::launch<nthreads>(nblocks, shared_mem_bytes,
Gpu::gpuStream(),
1270 int bid = h.blockIdx();
1271 int tid = h.threadIdx();
1276 int bid = blockIdx.x;
1277 int tid = threadIdx.x;
1282 if (direction == 0) {
1283 int k = bid / len.y;
1284 int j = bid - k*len.y;
1287 for (
int i = blo.x + tid; i < blo.x+len.x; i += nthreads) {
1288 Op().local_update(tmp, f(box_no,i,j,k));
1291 }
else if (direction == 1) {
1292 int k = bid / len.x;
1293 int i = bid - k*len.x;
1296 for (
int j = blo.y + tid; j < blo.y+len.y; j += nthreads) {
1297 Op().local_update(tmp, f(box_no,i,j,k));
1301 int j = bid / len.x;
1302 int i = bid - j*len.x;
1305 for (
int k = blo.z + tid; k < blo.z+len.z; k += nthreads) {
1306 Op().local_update(tmp, f(box_no,i,j,k));
1310#ifdef AMREX_USE_SYCL
1311 Op().template parallel_update<T>(*p, tmp, h);
1313 Op().template parallel_update<T,nthreads>(*p, tmp);
1318 if (direction == 0) {
1321 Op().local_update(ar(0,j,k), f(box_no,i,j,k));
1323 }
else if (direction == 1) {
1326 Op().local_update(ar(i,0,k), f(box_no,i,j,k));
1331 Op().local_update(ar(i,j,0), f(box_no,i,j,k));
1339template <
typename Op,
typename T, BaseFabType FAB,
typename F>
1340#ifndef AMREX_USE_CUDA
1341requires (IsCallableR<T,F,int,int,int,int>::value)
1348 Box domain2d = domain;
1355 r.template setVal<RunOn::Device>(initval);
1356 auto const& ar = r.
array();
1358 for (
MFIter mfi(mf,
MFItInfo().UseDefaultStream().DisableDeviceSync());
1361 Box bx = mfi.validbox() & domain;
1363 int box_no = mfi.LocalIndex();
1364 detail::reduce_to_plane<Op, T>(ar, direction, bx, box_no, f);
1376template <
typename Op, MultiFabLike FA,
typename F>
1377FA reduce_to_plane (
int direction, Box
const& domain, FA
const& mf, F
const& f)
1379 using T =
typename FA::value_type;
1385 amrex::Abort(
"ReduceToPlaneMF: mf's BoxArray must have a rectangular domain.");
1391 BoxList bl = mf.boxArray().boxList();
1392 for (
auto& b : bl) {
1393 b.setRange(direction, 0);
1395 BoxArray ba(std::move(bl));
1396 FA tmpfa(ba, mf.DistributionMap(), 1, 0);
1397 tmpfa.setVal(initval);
1399 for (MFIter mfi(mf); mfi.isValid(); ++mfi)
1401 Box bx = mfi.validbox() & ndomain;
1403 int box_no = mfi.LocalIndex();
1404 detail::reduce_to_plane<Op, T>(tmpfa.array(mfi), direction, bx, box_no, f);
1414template <
typename Op, MultiFabLike FA,
typename F>
1415#ifndef AMREX_USE_CUDA
1416requires (IsCallableR<
typename FA::value_type,
1421 auto [fa3, fa2] = ReduceToPlaneMF2<Op>(direction, domain, mf, f);
1422 fa3.ParallelCopy(fa2);
1423 return std::move(fa3);
1426template <
typename Op, MultiFabLike FA,
typename F>
1427#ifndef AMREX_USE_CUDA
1428requires (IsCallableR<
typename FA::value_type,
1434 using T =
typename FA::value_type;
1439 auto tmpmf = detail::reduce_to_plane<Op>(direction, domain, mf, f);
1443 auto const& ba3d = mf.boxArray();
1444 auto const& dm3d = mf.DistributionMap();
1445 int dlo = domain.
smallEnd(direction);
1446 for (
int i = 0, N = mf.size(); i < N; ++i) {
1448 if (b.
smallEnd(direction) <= dlo && dlo <= b.
bigEnd(direction)) {
1451 procmap2d.push_back(dm3d[i]);
1458 FA mf2d(ba2d, dm2d, 1, 0);
1459 mf2d.setVal(initval);
1461 static_assert(std::is_same_v<Op, ReduceOpSum>,
"Currently only ReduceOpSum is supported.");
1462 mf2d.ParallelAdd(tmpmf);
1464 return std::make_pair(std::move(tmpmf), std::move(mf2d));
1467template <
typename Op, MultiFabLike FA,
typename F>
1468#ifndef AMREX_USE_CUDA
1469requires (IsCallableR<
typename FA::value_type,
1474 IntVect const& plane_max_grid_size,
F const& f)
1477 "ReduceToPlaneMF2Patchy: only cell-centered data is supported.");
1481 "ReduceToPlaneMF2Patchy: subdomains are not supported; domain must cover the full extent of mf.boxArray().");
1483 using T =
typename FA::value_type;
1487 BoxList bl_patch2d = mf.boxArray().boxList();
1488 for (
auto& b : bl_patch2d) {
1489 b.setRange(direction, 0);
1491 BoxArray ba_patch2d(std::move(bl_patch2d));
1492 FA tmpmf(ba_patch2d, mf.DistributionMap(), 1, 0);
1493 tmpmf.setVal(initval);
1497 Box bx = mfi.validbox() & ndomain;
1499 int box_no = mfi.LocalIndex();
1500 detail::reduce_to_plane<Op, T>(tmpmf.array(mfi), direction, bx, box_no, f);
1506 BoxArray ba2d(std::move(bl_unique));
1510 "ReduceToPlaneMF2Patchy: plane_max_grid_size must be >= 1 in every direction.");
1511 IntVect mgs2d = plane_max_grid_size;
1512 mgs2d[direction] = 1;
1517 FA mf2d(ba2d, dm2d, 1, 0);
1518 mf2d.setVal(initval);
1520 static_assert(std::is_same_v<Op, ReduceOpSum>,
"Currently only ReduceOpSum is supported.");
1521 mf2d.ParallelAdd(tmpmf);
1523 return std::make_pair(std::move(tmpmf), std::move(mf2d));
#define BL_PROFILE(a)
Definition AMReX_BLProfiler.H:551
#define AMREX_ALWAYS_ASSERT_WITH_MESSAGE(EX, MSG)
Definition AMReX_BLassert.H:49
#define BL_ASSERT(EX)
Definition AMReX_BLassert.H:39
#define AMREX_ASSERT(EX)
Definition AMReX_BLassert.H:38
#define AMREX_HOST_DEVICE_PARALLEL_FOR_1D(...)
Definition AMReX_GpuLaunchMacrosC.nolint.H:109
#define AMREX_HOST_DEVICE_PARALLEL_FOR_3D(...)
Definition AMReX_GpuLaunchMacrosC.nolint.H:110
#define AMREX_HOST_DEVICE_PARALLEL_FOR_4D(...)
Definition AMReX_GpuLaunchMacrosC.nolint.H:111
#define AMREX_LAUNCH_HOST_DEVICE_LAMBDA(...)
Definition AMReX_GpuLaunch.nolint.H:16
#define AMREX_GPU_DEVICE
Definition AMReX_GpuQualifiers.H:18
Array4< int const > offset
Definition AMReX_HypreMLABecLap.cpp:1139
Real * pdst
Definition AMReX_HypreMLABecLap.cpp:1140
Array4< Real > fine
Definition AMReX_InterpFaceRegister.cpp:90
Array4< int const > mask
Definition AMReX_InterpFaceRegister.cpp:93
Array4< Real const > crse
Definition AMReX_InterpFaceRegister.cpp:92
#define AMREX_LOOP_3D(bx, i, j, k, block)
Definition AMReX_Loop.nolint.H:4
#define AMREX_LOOP_4D(bx, ncomp, i, j, k, n, block)
Definition AMReX_Loop.nolint.H:16
#define AMREX_D_TERM(a, b, c)
Definition AMReX_SPACE.H:172
#define AMREX_D_DECL(a, b, c)
Definition AMReX_SPACE.H:171
A FortranArrayBox(FAB)-like object.
Definition AMReX_BaseFab.H:194
Array4< T const > array() const noexcept
Definition AMReX_BaseFab.H:387
A collection of Boxes stored in an Array.
Definition AMReX_BoxArray.H:564
IndexType ixType() const noexcept
Return index type of this BoxArray.
Definition AMReX_BoxArray.H:854
BoxList boxList() const
Create a BoxList from this BoxArray.
Definition AMReX_BoxArray.cpp:949
void removeOverlap(bool simplify=true)
Change the BoxArray to one with no overlap and then simplify it (see the simplify function in BoxList...
Definition AMReX_BoxArray.cpp:1456
BoxArray & coarsen(int refinement_ratio)
Coarsen each Box in the BoxArray to the specified ratio.
Definition AMReX_BoxArray.cpp:672
Long size() const noexcept
Return the number of boxes in the BoxArray.
Definition AMReX_BoxArray.H:611
BoxArray & maxSize(int block_size)
Forces each Box in BoxArray to have sides <= block_size.
Definition AMReX_BoxArray.cpp:553
A class for managing a List of Boxes that share a common IndexType. This class implements operations ...
Definition AMReX_BoxList.H:52
bool isEmpty() const noexcept
Is this BoxList empty?
Definition AMReX_BoxList.H:135
int simplify(bool best=false)
Merge adjacent Boxes in this BoxList. Return the number of Boxes merged. If "best" is specified we do...
Definition AMReX_BoxList.cpp:654
void push_back(const Box &bn)
Append a Box to this BoxList.
Definition AMReX_BoxList.H:93
__host__ __device__ const IntVectND< dim > & bigEnd() const &noexcept
Return the inclusive upper bound of the box.
Definition AMReX_Box.H:124
__host__ __device__ bool isEmpty() const noexcept
Checks if it is an empty BoxND.
Definition AMReX_Box.H:208
__host__ __device__ bool contains(const IntVectND< dim > &p) const noexcept
Return true if argument is contained within BoxND.
Definition AMReX_Box.H:216
__host__ __device__ IndexTypeND< dim > ixType() const noexcept
Return the indexing type.
Definition AMReX_Box.H:136
__host__ __device__ BoxND & setRange(int dir, int sm_index, int n_cells=1) noexcept
Set the entire range in a given direction, starting at sm_index with length n_cells....
Definition AMReX_Box.H:1117
__host__ __device__ bool ok() const noexcept
Checks if it is a proper BoxND (including a valid type).
Definition AMReX_Box.H:212
__host__ __device__ const IntVectND< dim > & smallEnd() const &noexcept
Return the inclusive lower bound of the box.
Definition AMReX_Box.H:112
Definition AMReX_FabFactory.H:76
Calculates the distribution of FABs to MPI processes.
Definition AMReX_DistributionMapping.H:43
IntVect nGrowVect() const noexcept
Definition AMReX_FabArrayBase.H:80
bool isFusingCandidate() const noexcept
Is this a good candidate for kernel fusing?
Definition AMReX_FabArrayBase.cpp:2705
bool is_cell_centered() const noexcept
This tests on whether the FabArray is cell-centered.
Definition AMReX_FabArrayBase.cpp:2699
bool is_nodal() const noexcept
This tests on whether the FabArray is fully nodal.
Definition AMReX_FabArrayBase.cpp:2687
IndexType ixType() const noexcept
Return index type.
Definition AMReX_FabArrayBase.H:86
const DistributionMapping & DistributionMap() const noexcept
Return constant reference to associated DistributionMapping.
Definition AMReX_FabArrayBase.H:131
int nComp() const noexcept
Return number of variables (aka components) associated with each point.
Definition AMReX_FabArrayBase.H:83
const BoxArray & boxArray() const noexcept
Return a constant reference to the BoxArray that defines the valid region associated with this FabArr...
Definition AMReX_FabArrayBase.H:95
An Array of FortranArrayBox(FAB)-like Objects.
Definition AMReX_FabArray.H:344
void ParallelCopy(const FabArray< FAB > &src, const Periodicity &period=Periodicity::NonPeriodic(), CpOp op=FabArrayBase::COPY)
Definition AMReX_FabArray.H:873
MultiArray4< typename FabArray< FAB >::value_type > arrays() noexcept
Definition AMReX_FabArray.H:633
MultiArray4< typename FabArray< FAB >::value_type const > const_arrays() const noexcept
Definition AMReX_FabArray.H:647
Array4< typename FabArray< FAB >::value_type const > array(const MFIter &mfi) const noexcept
Definition AMReX_FabArray.H:561
Array4< typename FabArray< FAB >::value_type const > const_array(const MFIter &mfi) const noexcept
Definition AMReX_FabArray.H:585
Rectangular problem domain geometry.
Definition AMReX_Geometry.H:75
Periodicity periodicity() const noexcept
Definition AMReX_Geometry.H:361
GPU-compatible tuple.
Definition AMReX_Tuple.H:98
static constexpr int warp_size
Definition AMReX_GpuDevice.H:236
__host__ __device__ constexpr Dim3 dim3() const noexcept
Definition AMReX_IntVect.H:262
__host__ static __device__ constexpr IntVectND< dim > TheUnitVector() noexcept
This static member function returns a reference to a constant IntVectND object, all of whose dim argu...
Definition AMReX_IntVect.H:781
__host__ __device__ constexpr bool allGE(const IntVectND< dim > &rhs) const noexcept
Returns true if this is greater than or equal to argument for all components. NOTE: This is NOT a str...
Definition AMReX_IntVect.H:542
__host__ static __device__ constexpr IntVectND< dim > TheZeroVector() noexcept
This static member function returns a reference to a constant IntVectND object, all of whose dim argu...
Definition AMReX_IntVect.H:771
a one-thingy-per-box distributed object
Definition AMReX_LayoutData.H:13
Iterator for looping ever tiles and boxes of amrex::FabArray based containers.
Definition AMReX_MFIter.H:88
bool isValid() const noexcept
Is the iterator valid i.e. is it associated with a FAB?
Definition AMReX_MFIter.H:172
A collection (stored as an array) of FArrayBox objects.
Definition AMReX_MultiFab.H:40
Dynamically allocated vector for trivially copyable data.
Definition AMReX_PODVector.H:308
iterator begin() noexcept
Definition AMReX_PODVector.H:674
iterator end() noexcept
Definition AMReX_PODVector.H:678
T * data() noexcept
Definition AMReX_PODVector.H:666
This provides length of period for periodic domains. 0 means it is not periodic in that direction....
Definition AMReX_Periodicity.H:17
static const Periodicity & NonPeriodic() noexcept
Definition AMReX_Periodicity.cpp:52
This class is a thin wrapper around std::vector. Unlike vector, Vector::operator[] provides bound che...
Definition AMReX_Vector.H:29
A Collection of IArrayBoxes.
Definition AMReX_iMultiFab.H:34
amrex_real Real
Floating Point Type for Fields.
Definition AMReX_REAL.H:79
amrex_long Long
Definition AMReX_INT.H:30
__host__ __device__ Dim3 length(Array4< T > const &a) noexcept
Return the spatial extents of an Array4 in Dim3 form.
Definition AMReX_Array4.H:1373
__host__ __device__ Dim3 lbound(Array4< T > const &a) noexcept
Return the inclusive lower bounds of an Array4 in Dim3 form.
Definition AMReX_Array4.H:1345
__host__ __device__ BoxND< dim > coarsen(const BoxND< dim > &b, int ref_ratio) noexcept
Coarsen BoxND by given (positive) coarsening ratio.
Definition AMReX_Box.H:1418
std::array< T, N > Array
Definition AMReX_Array.H:26
void Sum(T &v, MPI_Comm comm)
Definition AMReX_ParallelReduce.H:221
void copy(HostToDevice, InIter begin, InIter end, OutIter result) noexcept
A host-to-device copy routine. Note this is just a wrapper around memcpy, so it assumes contiguous st...
Definition AMReX_GpuContainers.H:128
static constexpr DeviceToHost deviceToHost
Definition AMReX_GpuContainers.H:106
void streamSynchronize() noexcept
Definition AMReX_GpuDevice.H:310
bool inLaunchRegion() noexcept
Definition AMReX_GpuControl.H:88
bool inNoSyncRegion() noexcept
Definition AMReX_GpuControl.H:148
gpuStream_t gpuStream() noexcept
Definition AMReX_GpuDevice.H:291
MPI_Comm CommunicatorSub() noexcept
sub-communicator for current frame
Definition AMReX_ParallelContext.H:70
Definition AMReX_Amr.cpp:50
std::pair< FA, FA > ReduceToPlaneMF2Patchy(int direction, Box const &domain, FA const &mf, IntVect const &plane_max_grid_size, F const &f)
Reduce FabArray/MultiFab data to plane FabArray for patchy BoxArrays.
Definition AMReX_MultiFabUtil.H:1473
__host__ __device__ BoxND< dim > convert(const BoxND< dim > &b, const IntVectND< dim > &typ) noexcept
Return a BoxND with different type.
Definition AMReX_Box.H:1567
void FillRandomNormal(MultiFab &mf, int scomp, int ncomp, Real mean, Real stddev)
Fill MultiFab with random numbers from normal distribution.
Definition AMReX_MultiFabUtil.cpp:1261
int nComp(FabArrayBase const &fa)
Definition AMReX_FabArrayBase.cpp:2852
void FillRandom(MultiFab &mf, int scomp, int ncomp)
Fill MultiFab with random numbers from uniform distribution.
Definition AMReX_MultiFabUtil.cpp:1248
ReduceData< Ts... >::Type ParReduce(TypeList< Ops... > operation_list, TypeList< Ts... > type_list, FabArray< FAB > const &fa, IntVect const &nghost, F &&f)
Parallel reduce for MultiFab/FabArray. The reduce result is local and it's the user's responsibility ...
Definition AMReX_ParReduce.H:48
void average_down(const MultiFab &S_fine, MultiFab &S_crse, const Geometry &fgeom, const Geometry &cgeom, int scomp, int ncomp, int rr)
Definition AMReX_MultiFabUtil.cpp:359
__host__ __device__ void cast(BaseFab< Tto > &tofab, BaseFab< Tfrom > const &fromfab, Box const &bx, SrcComp scomp, DestComp dcomp, NumComps ncomp) noexcept
Definition AMReX_BaseFabUtility.H:13
std::unique_ptr< MultiFab > get_slice_data(int dir, Real coord, const MultiFab &cc, const Geometry &geom, int start_comp, int ncomp, bool interpolate, RealBox const &bnd_rbx)
Definition AMReX_MultiFabUtil.cpp:597
void average_face_to_cellcenter(MultiFab &cc, int dcomp, const Vector< const MultiFab * > &fc, IntVect const &ng_vect)
Definition AMReX_MultiFabUtil.cpp:156
iMultiFab makeFineMask(const BoxArray &cba, const DistributionMapping &cdm, const BoxArray &fba, const IntVect &ratio, int crse_value, int fine_value, MFInfo const &info)
Definition AMReX_MultiFabUtil.cpp:652
Vector< MultiFab > convexify(Vector< MultiFab const * > const &mf, Vector< IntVect > const &refinement_ratio)
Convexify AMR data.
Definition AMReX_MultiFabUtil.cpp:1274
MF get_line_data(MF const &mf, int dir, IntVect const &cell, Box const &bnd_bx=Box())
Get data in a line of MultiFab/FabArray.
Definition AMReX_MultiFabUtil.H:1191
FA ReduceToPlaneMF(int direction, Box const &domain, FA const &mf, F const &f)
Reduce FabArray/MultiFab data to plane FabArray.
Definition AMReX_MultiFabUtil.H:1419
MultiFab periodicShift(MultiFab const &mf, IntVect const &offset, Periodicity const &period)
Periodic shift MultiFab.
Definition AMReX_MultiFabUtil.cpp:841
BaseFab< T > ReduceToPlane(int direction, Box const &domain, FabArray< FAB > const &mf, F const &f)
Reduce FabArray/MultiFab data to a plane Fab.
Definition AMReX_MultiFabUtil.H:1344
void ParallelFor(TypeList< CTOs... > ctos, std::array< int, sizeof...(CTOs)> const &runtime_options, T N, F &&f)
Definition AMReX_CTOParallelForImpl.H:202
std::pair< FA, FA > ReduceToPlaneMF2(int direction, Box const &domain, FA const &mf, F const &f)
Reduce FabArray/MultiFab data to plane FabArray.
Definition AMReX_MultiFabUtil.H:1432
Real volumeWeightedSum(Vector< MultiFab const * > const &mf, int icomp, Vector< Geometry > const &geom, Vector< IntVect > const &ratio, bool local)
Volume weighted sum for a vector of MultiFabs.
Definition AMReX_MultiFabUtil.cpp:1007
BoxND< 3 > Box
Box is an alias for amrex::BoxND instantiated with AMREX_SPACEDIM.
Definition AMReX_BaseFwd.H:30
void average_down_faces(const Vector< const MF * > &fine, const Vector< MF * > &crse, const IntVect &ratio, int ngcrse=0)
Average fine face-based FabArray onto crse face-based FabArray.
Definition AMReX_MultiFabUtil.H:1042
bool isMFIterSafe(const FabArrayBase &x, const FabArrayBase &y)
Definition AMReX_MFIter.H:252
MultiFab ToMultiFab(const iMultiFab &imf)
Convert iMultiFab to MultiFab.
Definition AMReX_MultiFabUtil.cpp:587
Vector< typename MF::value_type > get_cell_data(MF const &mf, IntVect const &cell)
Get data in a cell of MultiFab/FabArray.
Definition AMReX_MultiFabUtil.H:1160
void writeFabs(const MultiFab &mf, const std::string &name)
Write each fab individually.
Definition AMReX_MultiFabUtil.cpp:574
Real NormHelper(const MultiFab &x, int xcomp, const MultiFab &y, int ycomp, F const &f, int numcomp, IntVect nghost, bool local)
Returns part of a norm based on two MultiFabs.
Definition AMReX_MultiFabUtil.H:847
void computeDivergence(MultiFab &divu, const Array< MultiFab const *, 3 > &umac, const Geometry &geom)
Computes divergence of face-data stored in the umac MultiFab.
Definition AMReX_MultiFabUtil.cpp:740
void average_down_edges(const Vector< const MultiFab * > &fine, const Vector< MultiFab * > &crse, const IntVect &ratio, int ngcrse)
Average fine edge-based MultiFab onto crse edge-based MultiFab.
Definition AMReX_MultiFabUtil.cpp:492
Gpu::HostVector< Real > sumToLine(MultiFab const &mf, int icomp, int ncomp, Box const &domain, int direction, bool local)
Sum MultiFab data to line.
Definition AMReX_MultiFabUtil.cpp:865
IntVectND< 3 > IntVect
IntVect is an alias for amrex::IntVectND instantiated with AMREX_SPACEDIM.
Definition AMReX_BaseFwd.H:33
void print_state(const MultiFab &mf, const IntVect &cell, const int n, const IntVect &ng)
Output state data for a single zone.
Definition AMReX_MultiFabUtil.cpp:569
bool TilingIfNotGPU() noexcept
Definition AMReX_MFIter.H:12
void sum_fine_to_coarse(const MultiFab &S_fine, MultiFab &S_crse, int scomp, int ncomp, const IntVect &ratio, const Geometry &cgeom, const Geometry &)
Definition AMReX_MultiFabUtil.cpp:438
void Abort(const std::string &msg)
Print out message to cerr and exit via abort().
Definition AMReX.cpp:241
const int[]
Definition AMReX_BLProfiler.cpp:1664
void average_node_to_cellcenter(MultiFab &cc, int dcomp, const MultiFab &nd, int scomp, int ncomp, int ngrow)
Average nodal-based MultiFab onto cell-centered MultiFab.
Definition AMReX_MultiFabUtil.cpp:63
void FourthOrderInterpFromFineToCoarse(MultiFab &cmf, int scomp, int ncomp, MultiFab const &fmf, IntVect const &ratio)
Fourth-order interpolation from fine to coarse level.
Definition AMReX_MultiFabUtil.cpp:1161
void average_cellcenter_to_face(const Vector< MultiFab * > &fc, const MultiFab &cc, const Geometry &geom, int ncomp, bool use_harmonic_averaging, int ngrow)
Average cell-centered MultiFab onto face-based MultiFab with geometric weighting.
Definition AMReX_MultiFabUtil.cpp:241
FabArray< BaseFab< Long > > ToLongMultiFab(const iMultiFab &imf)
Convert iMultiFab to Long.
Definition AMReX_MultiFabUtil.cpp:592
void computeGradient(MultiFab &grad, const Array< MultiFab const *, 3 > &umac, const Geometry &geom)
Computes gradient of face-data stored in the umac MultiFab.
Definition AMReX_MultiFabUtil.cpp:792
void average_edge_to_cellcenter(MultiFab &cc, int dcomp, const Vector< const MultiFab * > &edge, int ngrow)
Average edge-based MultiFab onto cell-centered MultiFab.
Definition AMReX_MultiFabUtil.cpp:105
void average_down_nodal(const FabArray< FAB > &S_fine, FabArray< FAB > &S_crse, const IntVect &ratio, int ngcrse=0, bool mfiter_is_definitely_safe=false)
Average fine node-based MultiFab onto crse node-centered MultiFab.
Definition AMReX_MultiFabUtil.H:661
A multidimensional array accessor.
Definition AMReX_Array4.H:285
parallel copy or add
Definition AMReX_FabArrayBase.H:538
Definition AMReX_Geometry.H:26
int coord
Definition AMReX_Geometry.H:60
FabArray memory allocation information.
Definition AMReX_FabArray.H:68
Definition AMReX_MFIter.H:20
Struct for holding types.
Definition AMReX_TypeList.H:13