1#ifndef AMREX_ML_LINOP_H_
2#define AMREX_ML_LINOP_H_
3#include <AMReX_Config.H>
5#if defined(AMREX_USE_HYPRE) && (AMREX_SPACEDIM > 1)
10#if defined(AMREX_USE_PETSC) && (AMREX_SPACEDIM > 1)
130template <
typename T>
class MLMGT;
131template <
typename T>
class MLCGSolverT;
132template <
typename T>
class MLPoissonT;
133template <
typename T>
class MLABecLaplacianT;
134template <
typename T>
class GMRESMLMGT;
141#if !defined(AMREX_USE_FLOAT) && !(defined(AMREX_USE_CUDA) && defined(_WIN32) && defined(AMREX_USE_EB))
142#define AMREX_MLMG_HAS_FLOAT 1
154template <
typename MF>
160 template <
typename T>
friend class MLMGT;
200 bool eb_limit_coarsening =
true);
202 [[nodiscard]]
virtual std::string
name ()
const {
return std::string(
"Unspecified"); }
278 template <
typename AMF>
279 requires (!std::same_as<MF,AMF>)
283 template <
typename AMF>
284 requires (!std::same_as<MF,AMF>)
310 const MF* =
nullptr) = 0;
312 template <MultiFabLike AMF>
313 requires (!std::same_as<MF,AMF>)
315 const AMF* robinbc_a =
nullptr,
316 const AMF* robinbc_b =
nullptr,
317 const AMF* robinbc_f =
nullptr);
378 RT eps_rel,
RT eps_abs,
int maxiter)
385 [[nodiscard]]
virtual int getNComp ()
const {
return 1; }
387 [[nodiscard]]
virtual int getNGrow (
int = 0,
int = 0)
const {
return 0; }
403 virtual void restriction (
int amrlev,
int cmglev, MF& crse, MF& fine)
const = 0;
413 virtual void interpolation (
int amrlev,
int fmglev, MF& fine,
const MF& crse)
const = 0;
423 virtual void interpAssign (
int amrlev,
int fmglev, MF& fine, MF& crse)
const
426 amrex::Abort(
"MLLinOpT::interpAssign: Must be implemented for FMG cycle");
441 amrex::Abort(
"MLLinOpT::interpolationAmr: Must be implemented for composite solves across multiple AMR levels");
470 const MF& fine_sol,
const MF& fine_rhs)
473 amrex::Abort(
"MLLinOpT::averageDownSolutionRHS: Must be implemented for composite solves across multiple AMR levels");
487 virtual void apply (
int amrlev,
int mglev, MF& out, MF& in,
BCMode bc_mode,
500 virtual void smooth (
int amrlev,
int mglev, MF& sol,
const MF& rhs,
501 bool skip_fillboundary,
int niter)
const = 0;
510 virtual void normalize (
int amrlev,
int mglev, MF& mf)
const {
524 const MF* crse_bcdata=
nullptr) = 0;
548 BCMode bc_mode,
const MF* crse_bcdata=
nullptr) = 0;
562 MF& res,
const MF& crse_sol,
const MF& crse_rhs,
563 MF& fine_res, MF& fine_sol,
const MF& fine_rhs)
const
567 amrex::Abort(
"MLLinOpT::reflux: Must be implemented for composite solves across multiple AMR levels");
582 amrex::Abort(
"AMReX_MLLinOp::compFlux::How did we get here?");
597 amrex::Abort(
"AMReX_MLLinOp::compGrad::How did we get here?");
658 [[nodiscard]]
virtual bool scaleRHS (
int amrlev, MF* rhs)
const {
672 MF
const& rhs)
const {
713 amrex::Warning(
"This function might need to be implemented for GMRES to work with this LinOp.");
717 [[nodiscard]]
virtual bool isSingular (
int amrlev)
const = 0;
730 virtual RT xdoty (
int amrlev,
int mglev,
const MF&
x,
const MF&
y,
bool local)
const = 0;
756 virtual std::unique_ptr<MLLinOpT<MF>>
makeNLinOp (
int grid_size)
const
759 amrex::Abort(
"MLLinOp::makeNLinOp: NSolve not supported");
774 amrex::Abort(
"MLLinOp::getFluxes: How did we get here?");
785 amrex::Abort(
"MLLinOp::getFluxes: How did we get here?");
798 amrex::Abort(
"MLLinOp::getEBFluxes: How did we get here?");
806 [[nodiscard]]
virtual std::unique_ptr<MLAlgMG>
makeAlgMG (
int mglev)
const {
808 amrex::Abort(
"MLLinOp::makeAlgMG: not supported by this operator");
833#if defined(AMREX_USE_HYPRE) && (AMREX_SPACEDIM > 1)
841 amrex::Abort(
"MLLinOp::makeHypre: How did we get here?");
850 [[nodiscard]]
virtual std::unique_ptr<HypreNodeLap> makeHypreNodeLap(
852 const std::string& options_namespace)
const
855 amrex::Abort(
"MLLinOp::makeHypreNodeLap: How did we get here?");
860#if defined(AMREX_USE_PETSC) && (AMREX_SPACEDIM > 1)
864 [[nodiscard]]
virtual std::unique_ptr<PETScABecLap> makePETSc ()
const {
865 amrex::Abort(
"MLLinOp::makePETSc: How did we get here?");
908 [[nodiscard]]
virtual RT normInf (
int amrlev, MF
const& mf,
bool local)
const = 0;
920 amrex::Abort(
"MLLinOpT::avgDownResAmr: Must be implemented for composite solves across multiple AMR levels");
948 [[nodiscard]]
bool isMFIterSafe (
int amrlev,
int mglev1,
int mglev2)
const;
962 [[nodiscard]]
const Geometry&
Geom (
int amr_lev,
int mglev=0) const noexcept {
return m_geom[amr_lev][mglev]; }
1016 struct CommContainer {
1018 CommContainer (
MPI_Comm m) noexcept : comm(m) {}
1019 CommContainer (
const CommContainer&) =
delete;
1020 CommContainer (CommContainer&&) =
delete;
1021 void operator= (
const CommContainer&) =
delete;
1022 void operator= (CommContainer&&) =
delete;
1048 std::is_same_v<MF,MultiFab>
1049#ifndef AMREX_MLMG_HAS_FLOAT
1070 if (
x >
RT(0.0) && std::isfinite(
x)) { std::frexp(
x, &e); }
1071 return std::ldexp(
RT(1.0), -e);
1078 RT dmin = std::numeric_limits<RT>::max();
1080 for (
auto d : diag) {
1082 dmin = std::min(dmin, d);
1083 dmax = std::max(dmax, d);
1086 return (dmin < dmax) ? std::sqrt(dmin)*std::sqrt(dmax) : dmax;
1092 if (!
m_geom[0][0].IsCartesian() &&
info.has_metric_term) {
1093 return (AMREX_SPACEDIM == 1) ? 2 : 1;
1104 Real dxmin = std::numeric_limits<Real>::max();
1105 for (
int idim = 0; idim < AMREX_SPACEDIM; ++idim) {
1106 if (idim !=
info.hidden_direction) {
1107 dxmin = std::min(dxmin, a_geom.back().CellSize(idim));
1114 sp_geom.reserve(a_geom.
size());
1115 for (
auto const& g : a_geom) {
1117 for (
int idim = 0; idim < AMREX_SPACEDIM; ++idim) {
1121 sp_geom.emplace_back(g.Domain(),
RealBox(lo, hi), g.Coord(), g.isPeriodic());
1144 template <
typename F>
1176 sp->setCoarseFineBC(
static_cast<fMultiFab const*
>(
nullptr),
1184 template <
template <
typename>
class Op,
typename F>
1189 f(
static_cast<Op<fMultiFab>*
>(
m_sp_linop.get()));
1205 if (
info.hasHiddenDimension()) { rr[
info.hidden_direction] = 1; }
1256 [[nodiscard]]
virtual MF
make (
int amrlev,
int mglev,
IntVect const& ng)
const;
1259 [[nodiscard]]
virtual MF
make (
int amrlev,
int mglev,
IntVect const& ng,
1260 MFInfo const& mf_info)
const;
1269 MFInfo const& mf_info)
const;
1276 MFInfo const& mf_info)
const;
1278 [[nodiscard]]
virtual std::unique_ptr<FabFactory<FAB> >
makeFactory (
int ,
int )
const {
1279 return std::make_unique<DefaultFabFactory<FAB>>();
1290 defineCoarseMGLevels();
1297 template <
typename T>
1300 if (
info.hidden_direction == 0) {
1301 return Array4<T>(a.dataPtr(), {a.begin[1],a.begin[2],0}, {a.end[1],a.end[2],1}, a.nComp());
1302 }
else if (
info.hidden_direction == 1) {
1303 return Array4<T>(a.dataPtr(), {a.begin[0],a.begin[2],0}, {a.end[0],a.end[2],1}, a.nComp());
1304 }
else if (
info.hidden_direction == 2) {
1305 return Array4<T>(a.dataPtr(), {a.begin[0],a.begin[1],0}, {a.end[0],a.end[1],1}, a.nComp());
1311 template <
typename T>
1312 [[nodiscard]] T
get_d0 (T
const& dx, T
const& dy, T
const&)
const noexcept
1314 if (
info.hidden_direction == 0) {
1321 template <
typename T>
1322 [[nodiscard]] T
get_d1 (T
const&, T
const& dy, T
const& dz)
const noexcept
1324 if (
info.hidden_direction == 0 ||
info.hidden_direction == 1) {
1338 void defineCoarseMGLevels ();
1341 int ratio,
int strategy);
1344 virtual void checkPoint (std::string
const& )
const {
1348 Vector<std::unique_ptr<MF>> levelbc_raii;
1349 Vector<std::unique_ptr<MF>> robin_a_raii;
1350 Vector<std::unique_ptr<MF>> robin_b_raii;
1351 Vector<std::unique_ptr<MF>> robin_f_raii;
1354template <
typename MF>
1361 [[maybe_unused]]
bool eb_limit_coarsening)
1380 if (!a_factory.empty() && eb_limit_coarsening) {
1383 info.max_coarsening_level = std::min(
info.max_coarsening_level,
1384 f->maxCoarseningLevel());
1388 if (
info.mixed_precision) {
1394 "MLLinOp: this operator does not support mixed precision");
1396 for (
auto const* f : a_factory) {
1399 "MLLinOp: mixed precision does not support EB");
1403 info.mixed_precision =
false;
1408 defineGrids(a_geom, a_grids, a_dmap, a_factory);
1412template <
typename MF>
1422 if ( ! a_factory.empty() ) {
1424 if (ebf && !(ebf->isAllRegular())) {
1425 mg_domain_min_width = 4;
1430 m_num_amr_levels = 0;
1431 for (
int amrlev = 0; amrlev < std::ssize(a_geom); amrlev++) {
1432 if (!a_grids[amrlev].empty()) {
1437 m_amr_ref_ratio.resize(m_num_amr_levels);
1438 m_num_mg_levels.resize(m_num_amr_levels);
1444 m_domain_covered.clear();
1445 mg_coarsen_ratio_vec.clear();
1447 m_geom.resize(m_num_amr_levels);
1448 m_grids.resize(m_num_amr_levels);
1449 m_dmap.resize(m_num_amr_levels);
1450 m_factory.resize(m_num_amr_levels);
1454 const RealBox& rb = a_geom[0].ProbDomain();
1455 const int coord = a_geom[0].Coord();
1458 IntVect mg_coarsen_ratio_v(mg_coarsen_ratio);
1459 if (hasHiddenDimension()) {
1461 "Hidden direction only supported for 3d");
1462 mg_coarsen_ratio_v[info.hidden_direction] = 1;
1466 for (
int amrlev = m_num_amr_levels-1; amrlev > 0; --amrlev)
1468 m_num_mg_levels[amrlev] = 1;
1469 m_geom[amrlev].push_back(a_geom[amrlev]);
1470 m_grids[amrlev].push_back(a_grids[amrlev]);
1471 m_dmap[amrlev].push_back(a_dmap[amrlev]);
1472 if (amrlev < std::ssize(a_factory)) {
1473 m_factory[amrlev].emplace_back(a_factory[amrlev]->clone());
1478 IntVect rr = mg_coarsen_ratio_v;
1479 const Box& dom = a_geom[amrlev].Domain();
1480 for (
int i = 0; i < 2; ++i)
1482 if (!dom.coarsenable(rr)) {
amrex::Abort(
"MLLinOp: Uncoarsenable domain"); }
1485 if (cdom == a_geom[amrlev-1].Domain()) {
break; }
1487 ++(m_num_mg_levels[amrlev]);
1489 m_geom[amrlev].emplace_back(cdom, rb, coord, is_per);
1491 m_grids[amrlev].push_back(a_grids[amrlev]);
1493 m_grids[amrlev].back().coarsen(rr);
1495 m_dmap[amrlev].push_back(a_dmap[amrlev]);
1497 rr *= mg_coarsen_ratio_v;
1500#if (AMREX_SPACEDIM > 1)
1501 if (hasHiddenDimension()) {
1502 m_amr_ref_ratio[amrlev-1] = rr[(info.hidden_direction+1) % AMREX_SPACEDIM];
1506 m_amr_ref_ratio[amrlev-1] = rr[0];
1511 m_num_mg_levels[0] = 1;
1512 m_geom[0].push_back(a_geom[0]);
1513 m_grids[0].push_back(a_grids[0]);
1514 m_dmap[0].push_back(a_dmap[0]);
1515 if (!a_factory.empty()) {
1516 m_factory[0].emplace_back(a_factory[0]->clone());
1521 m_domain_covered.resize(m_num_amr_levels,
false);
1522 auto npts0 = m_grids[0][0].numPts();
1523 m_domain_covered[0] = (npts0 == compactify(m_geom[0][0].Domain()).numPts());
1524 for (
int amrlev = 1; amrlev < m_num_amr_levels; ++amrlev)
1526 if (!m_domain_covered[amrlev-1]) {
break; }
1527 m_domain_covered[amrlev] = (m_grids[amrlev][0].numPts() ==
1528 compactify(m_geom[amrlev][0].Domain()).numPts());
1531 if (m_mg_deferred) {
1533 m_bottom_comm = m_default_comm;
1534 m_do_agglomeration =
false;
1535 m_do_consolidation =
false;
1537 defineCoarseMGLevels();
1540 for (
int amrlev = 1; amrlev < m_num_amr_levels; ++amrlev)
1542 for (
int mglev = 1; mglev < m_num_mg_levels[amrlev]; ++mglev)
1544 m_factory[amrlev].emplace_back(makeFactory(amrlev,mglev));
1548 for (
int amrlev = 1; amrlev < m_num_amr_levels; ++amrlev)
1551 "MLLinOp: grids not coarsenable between AMR levels");
1555template <
typename MF>
1557MLLinOpT<MF>::defineCoarseMGLevels ()
1559 BL_PROFILE(
"MLLinOp::defineCoarseMGLevels()");
1561 AMREX_ASSERT(m_grids[0].size() == 1 && mg_coarsen_ratio_vec.empty());
1564 Geometry const geom0 = m_geom[0][0];
1565 BoxArray const ba0 = m_grids[0][0];
1568 const RealBox& rb = geom0.ProbDomain();
1569 const int coord = geom0.Coord();
1571 auto const npts0 = ba0.numPts();
1573 IntVect mg_coarsen_ratio_v(mg_coarsen_ratio);
1574 IntVect mg_box_min_width_v(mg_box_min_width);
1575 IntVect mg_domain_min_width_v(mg_domain_min_width);
1576 if (hasHiddenDimension()) {
1577 mg_coarsen_ratio_v[info.hidden_direction] = 1;
1578 mg_box_min_width_v[info.hidden_direction] = 0;
1579 mg_domain_min_width_v[info.hidden_direction] = 0;
1583 bool aggable =
false;
1585 if (ba0.size() > 1 && info.do_agglomeration)
1587 if (m_domain_covered[0])
1589 aggbox = geom0.Domain();
1590 if (hasHiddenDimension()) {
1591 aggbox.makeSlab(hiddenDirection(), ba0[0].smallEnd(hiddenDirection()));
1597 aggbox = ba0.minimalBox();
1598 aggable = (aggbox.numPts() == npts0);
1604 int agg_lev = 0, con_lev = 0;
1607 && (info.semicoarsening_direction == -1 ||
1608 info.semicoarsening_direction == info.hidden_direction))
1609 && info.semicoarsening_direction >= -1
1610 && info.semicoarsening_direction < AMREX_SPACEDIM );
1614 bool const aniso_coarsening = supportsAnisotropicCoarsening() && !hasHiddenDimension()
1615 && !(info.do_semicoarsening && info.semicoarsening_direction != -1);
1616 auto const dx0 = anisotropicCoarseningCellSize(geom0);
1619 IntVect rr = mg_coarsen_ratio_v;
1620 if (aniso_coarsening) {
1621 Real dxmin = std::numeric_limits<Real>::max();
1622 for (
int idim = 0; idim < AMREX_SPACEDIM; ++idim) {
1623 dxmin = std::min(dxmin, dx0[idim]*
Real(accum[idim]));
1625 for (
int idim = 0; idim < AMREX_SPACEDIM; ++idim) {
1626 if (dx0[idim]*
Real(accum[idim]) >=
Real(1.5)*dxmin) { rr[idim] = 1; }
1632 if (info.do_agglomeration && aggable)
1634 Box dbx = geom0.Domain();
1636 Real const nbxs =
static_cast<Real>(ba0.size());
1638 *info.agg_grid_size,
1639 *info.agg_grid_size);
1646 for (
int lev = 0; lev < info.max_coarsening_level; ++lev)
1648 IntVect const rr_base = base_ratio(accum_coarsen_ratio.back());
1650 bool const do_semicoarsening_level = info.do_semicoarsening
1651 && numsclevs < info.max_semicoarsening_level;
1652 if (do_semicoarsening_level
1653 && info.semicoarsening_direction != -1)
1655 rr_level[info.semicoarsening_direction] = 1;
1658 for (
int idim = 0; idim < AMREX_SPACEDIM; ++idim) {
1660 rr_dir[idim] = rr_level[idim];
1662 bool const fit_ba0 = mg_odd_coarsening && lev == 0;
1663 is_coarsenable[idim] = dbx.coarsenable(rr_dir, mg_domain_min_width_v)
1664 && bbx.coarsenable(rr_dir, mg_box_min_width_v)
1665 && (!fit_ba0 || ba0.coarsenable(rr_dir, mg_box_min_width_v));
1666 for (
int r : {3, 5}) {
1667 if (is_coarsenable[idim] || !mg_odd_coarsening || rr_level[idim] != 2) {
1671 if (dbx.coarsenable(rr_dir, mg_domain_min_width_v)
1672 && bbx.coarsenable(rr_dir, mg_box_min_width_v)
1673 && (!fit_ba0 || ba0.coarsenable(rr_dir, mg_box_min_width_v)))
1675 is_coarsenable[idim] =
true;
1679 if (!is_coarsenable[idim] && do_semicoarsening_level
1680 && info.semicoarsening_direction == -1)
1682 is_coarsenable[idim] =
true;
1686 if (mg_independent_coarsening) {
1689 Real hmin = std::numeric_limits<Real>::max();
1690 for (
int idim = 0; idim < AMREX_SPACEDIM; ++idim) {
1691 if (is_coarsenable[idim] && rr_level[idim] > 1) {
1692 hmin = std::min(hmin, dx0[idim]*
Real(accum_coarsen_ratio.back()[idim]));
1695 for (
int idim = 0; idim < AMREX_SPACEDIM; ++idim) {
1696 if (!is_coarsenable[idim] || dx0[idim]*
Real(accum_coarsen_ratio.back()[idim]) >=
Real(1.5)*hmin) {
1697 is_coarsenable[idim] =
true;
1705 if (do_semicoarsening_level && info.semicoarsening_direction == -1) {
1707 int n_ones =
AMREX_D_TERM(
static_cast<int>(rr_level[0] == 1),
1708 +
static_cast<int>(rr_level[1] == 1),
1709 +
static_cast<int>(rr_level[2] == 1));
1710 if (n_ones > 1 && !aniso_coarsening) {
break; }
1712 bool semi_level =
false;
1713 for (
int idim = 0; idim < AMREX_SPACEDIM; ++idim) {
1714 semi_level = semi_level || (rr_level[idim] == 1 && rr_base[idim] != 1);
1720 accum_coarsen_ratio.push_back(accum_coarsen_ratio.back()*rr_level);
1721 domainboxes.push_back(dbx.coarsen(rr_level));
1722 boundboxes.push_back(bbx.coarsen(rr_level));
1723 bool to_agg = (bbx.d_numPts() / nbxs)
1724 <
Real(0.999)*
static_cast<Real>(threshold_npts);
1725 agg_flag.push_back(to_agg);
1728 for (
int lev = 1, nlevs =
static_cast<int>(domainboxes.size()); lev < nlevs; ++lev) {
1729 if (!agged && !agg_flag[lev] &&
1730 ba0.coarsenable(accum_coarsen_ratio[lev], mg_box_min_width_v))
1732 m_grids[0].push_back(
amrex::coarsen(ba0, accum_coarsen_ratio[lev]));
1733 m_dmap[0].push_back(dm0);
1735 IntVect cr = domainboxes[lev-1].length() / domainboxes[lev].length();
1736 if (!agged && lev > 1 && !m_grids[0].back().coarsenable(cr)) {
1739 m_grids[0].pop_back();
1740 m_dmap[0].pop_back();
1741 m_geom[0].pop_back();
1743 cr = domainboxes[lev-1].length() / domainboxes[lev].length();
1745 if (!m_grids[0].back().coarsenable(cr)) {
1748 m_grids[0].emplace_back(boundboxes[lev]);
1750 if (cell_box.numPts() > threshold_npts) {
1751 IntVect max_grid_size(info.agg_grid_size);
1752 if (info.do_semicoarsening && info.max_semicoarsening_level >= lev
1753 && info.semicoarsening_direction != -1)
1755 IntVect blen = cell_box.size();
1756 AMREX_D_TERM(
int mgs_0 = (max_grid_size[0]+blen[0]-1) / blen[0];,
1757 int mgs_1 = (max_grid_size[1]+blen[1]-1) / blen[1];,
1758 int mgs_2 = (max_grid_size[2]+blen[2]-1) / blen[2]);
1759 max_grid_size[info.semicoarsening_direction]
1762 if (mg_agg_no_split_direction >= 0 &&
1763 mg_agg_no_split_direction < AMREX_SPACEDIM)
1765 int const d = mg_agg_no_split_direction;
1766 max_grid_size[d] = std::max(max_grid_size[d], cell_box.length(d));
1770 IntVect const rn = (lev+1 < nlevs)
1771 ? domainboxes[lev].
length() / domainboxes[lev+1].length() :
IntVect(1);
1774 cba.
maxSize((max_grid_size+rn-1)/rn);
1783 m_geom[0].emplace_back(domainboxes[lev],rb,coord,is_per);
1788 Long consolidation_threshold = 0;
1789 Real avg_npts = 0.0;
1790 if (info.do_consolidation) {
1793 *info.con_grid_size,
1794 *info.con_grid_size);
1797 Box const& dom0 = geom0.Domain();
1800 for (
int lev = 0; lev < info.max_coarsening_level; ++lev)
1802 IntVect const rr_base = base_ratio(rr_vec);
1804 bool do_semicoarsening_level = info.do_semicoarsening
1805 && numsclevs < info.max_semicoarsening_level;
1806 if (do_semicoarsening_level
1807 && info.semicoarsening_direction != -1)
1809 rr_level[info.semicoarsening_direction] = 1;
1812 for (
int idim = 0; idim < AMREX_SPACEDIM; ++idim) {
1814 rr_dir[idim] = rr_vec[idim] * rr_level[idim];
1815 is_coarsenable[idim] = dom0.coarsenable(rr_dir, mg_domain_min_width_v)
1816 && ba0.coarsenable(rr_dir, mg_box_min_width_v);
1817 for (
int r : {3, 5}) {
1818 if (is_coarsenable[idim] || !mg_odd_coarsening || rr_level[idim] != 2) {
1821 rr_dir[idim] = rr_vec[idim] * r;
1822 if (dom0.coarsenable(rr_dir, mg_domain_min_width_v)
1823 && ba0.coarsenable(rr_dir, mg_box_min_width_v))
1825 is_coarsenable[idim] =
true;
1829 if (!is_coarsenable[idim] && do_semicoarsening_level
1830 && info.semicoarsening_direction == -1)
1832 is_coarsenable[idim] =
true;
1836 if (mg_independent_coarsening) {
1839 Real hmin = std::numeric_limits<Real>::max();
1840 for (
int idim = 0; idim < AMREX_SPACEDIM; ++idim) {
1841 if (is_coarsenable[idim] && rr_level[idim] > 1) {
1842 hmin = std::min(hmin, dx0[idim]*
Real(rr_vec[idim]));
1845 for (
int idim = 0; idim < AMREX_SPACEDIM; ++idim) {
1846 if (!is_coarsenable[idim] || dx0[idim]*
Real(rr_vec[idim]) >=
Real(1.5)*hmin) {
1847 is_coarsenable[idim] =
true;
1855 if (do_semicoarsening_level && info.semicoarsening_direction == -1) {
1857 int n_ones =
AMREX_D_TERM(
static_cast<int>(rr_level[0] == 1),
1858 +
static_cast<int>(rr_level[1] == 1),
1859 +
static_cast<int>(rr_level[2] == 1));
1860 if (n_ones > 1 && !aniso_coarsening) {
break; }
1862 bool semi_level =
false;
1863 for (
int idim = 0; idim < AMREX_SPACEDIM; ++idim) {
1864 semi_level = semi_level || (rr_level[idim] == 1 && rr_base[idim] != 1);
1871 m_geom[0].emplace_back(
amrex::coarsen(dom0, rr_vec), rb, coord, is_per);
1874 if (info.do_consolidation)
1876 if (avg_npts/
static_cast<Real>(
AMREX_D_TERM(rr_vec[0], *rr_vec[1], *rr_vec[2]))
1877 <
Real(0.999)*
static_cast<Real>(consolidation_threshold))
1880 con_lev = m_dmap[0].size();
1885 m_dmap[0].push_back(m_dmap[0].back());
1890 m_dmap[0].push_back(dm0);
1895 m_num_mg_levels[0] = m_grids[0].size();
1897 for (
int mglev = 0; mglev < m_num_mg_levels[0] - 1; mglev++){
1898 const Box& fine_domain = m_geom[0][mglev].Domain();
1899 const Box& crse_domain = m_geom[0][mglev+1].Domain();
1900 mg_coarsen_ratio_vec.push_back(fine_domain.length()/crse_domain.length());
1903 for (
int amrlev = 0; amrlev < m_num_amr_levels; ++amrlev) {
1904 if (AMRRefRatio(amrlev) == 4 && mg_coarsen_ratio_vec.empty()) {
1905 mg_coarsen_ratio_vec.push_back(
IntVect(2));
1911 makeAgglomeratedDMap(m_grids[0], m_dmap[0]);
1915 makeConsolidatedDMap(m_grids[0], m_dmap[0], info.con_ratio, info.con_strategy);
1920 m_bottom_comm = makeSubCommunicator(m_dmap[0].back());
1924 m_bottom_comm = m_default_comm;
1927 m_do_agglomeration = agged;
1928 m_do_consolidation = coned;
1932 Print() <<
"MLLinOp::defineGrids(): agglomerated AMR level 0 starting at MG level "
1933 << agg_lev <<
" of " << m_num_mg_levels[0] <<
"\n";
1935 Print() <<
"MLLinOp::defineGrids(): consolidated AMR level 0 starting at MG level "
1936 << con_lev <<
" of " << m_num_mg_levels[0]
1937 <<
" (ratio = " << info.con_ratio <<
")" <<
"\n";
1939 Print() <<
"MLLinOp::defineGrids(): no agglomeration or consolidation of AMR level 0\n";
1943 for (
int mglev = 1; mglev < m_num_mg_levels[0]; ++mglev)
1945 m_factory[0].emplace_back(makeFactory(0,mglev));
1949template <
typename MF>
1961template <
typename MF>
1963MLLinOpT<MF>::defineBC ()
1965 m_needs_coarse_data_for_bc = !m_domain_covered[0];
1967 levelbc_raii.resize(m_num_amr_levels);
1968 robin_a_raii.resize(m_num_amr_levels);
1969 robin_b_raii.resize(m_num_amr_levels);
1970 robin_f_raii.resize(m_num_amr_levels);
1973template <
typename MF>
1983template <
typename MF>
1990 "MLLinOp::setDomainBC: wrong size");
1995 for (
int icomp = 0; icomp < ncomp; ++icomp) {
1996 for (
int idim = 0; idim < AMREX_SPACEDIM; ++idim) {
1997 if (
m_geom[0][0].isPeriodic(idim)) {
1999 m_hibc[icomp][idim] == BCType::Periodic);
2002 m_hibc[icomp][idim] != BCType::Periodic);
2021 for (
int n = 0; n < ncomp; ++n) {
2028 amrex::Abort(
"Inhomogeneous Neumann BC not supported");
2037template <
typename MF>
2042 for (
int n = 0; n < ncomp; ++n) {
2043 for (
int idim = 0; idim <AMREX_SPACEDIM; ++idim) {
2052template <
typename MF>
2056 return hasBC(BCType::inhomogNeumann);
2059template <
typename MF>
2063 return hasBC(BCType::Robin);
2066template <
typename MF>
2070#if (AMREX_SPACEDIM == 3)
2071 if (
info.hasHiddenDimension()) {
2072 const auto& lo = b.smallEnd();
2073 const auto& hi = b.bigEnd();
2074 if (
info.hidden_direction == 0) {
2076 }
else if (
info.hidden_direction == 1) {
2088template <
typename MF>
2096 for (
int i = 1, N=
static_cast<int>(ba.
size()); i < N; ++i)
2106 for (
int iproc = 0; iproc < nprocs; ++iproc) {
2108 for (
int ibox : sfc[iproc]) {
2112 dm[i].define(std::move(pmap));
2117template <
typename MF>
2121 int ratio,
int strategy)
2123 BL_PROFILE(
"MLLinOp::makeConsolidatedDMap()");
2127 for (
int i = 1, N=
static_cast<int>(ba.size()); i < N; ++i)
2134 const auto& pmap_fine = dm[i-1].ProcessorMap();
2137 if (strategy == 1) {
2138 for (
auto&
x: pmap) {
2141 }
else if (strategy == 2) {
2142 int nprocs_con =
static_cast<int>(std::ceil(
static_cast<Real>(nprocs)
2143 /
static_cast<Real>(factor)));
2144 for (
auto&
x: pmap) {
2145 auto d = std::div(
x,nprocs_con);
2148 }
else if (strategy == 3) {
2149 if (factor == ratio) {
2151 for (
int iproc = 0; iproc < nprocs; ++iproc) {
2152 for (
int ibox : sfc[iproc]) {
2157 for (
auto&
x: pmap) {
2163 dm[i].define(std::move(pmap));
2167 dm[i].define(std::move(pmap_g));
2173template <
typename MF>
2177 BL_PROFILE(
"MLLinOp::makeSubCommunicator()");
2182 std::ranges::sort(newgrp_ranks);
2183 auto last = std::unique(newgrp_ranks.begin(), newgrp_ranks.end());
2184 newgrp_ranks.erase(last, newgrp_ranks.end());
2188 MPI_Comm_group(m_default_comm, &defgrp);
2190 MPI_Group_incl(defgrp,
static_cast<int>(newgrp_ranks.size()), newgrp_ranks.data(), &newgrp);
2192 Vector<int> local_newgrp_ranks(newgrp_ranks.size());
2194 newgrp_ranks.data(),
static_cast<int>(newgrp_ranks.size()));
2195 MPI_Group_incl(defgrp,
static_cast<int>(local_newgrp_ranks.size()), local_newgrp_ranks.data(), &newgrp);
2198 MPI_Comm_create(m_default_comm, newgrp, &newcomm);
2200 m_raii_comm = std::make_unique<CommContainer>(newcomm);
2202 MPI_Group_free(&defgrp);
2203 MPI_Group_free(&newgrp);
2208 return m_default_comm;
2212template <
typename MF>
2228template <
typename MF>
2236template <
typename MF>
2249template <
typename MF>
2250template <
typename AMF>
2251requires (!std::same_as<MF,AMF>)
2259template <
typename MF>
2260template <
typename AMF>
2261requires (!std::same_as<MF,AMF>)
2268 crse->nComp(), crse->nGrowVect());
2282template <
typename MF>
2291 mf[alev][mlev] =
make(alev, mlev, ng);
2296template <
typename MF>
2303template <
typename MF>
2318template <
typename MF>
2326 amrex::Abort(
"MLLinOpT::makeAlias: how did we get here?");
2331template <
typename MF>
2338template <
typename MF>
2341 MFInfo const& mf_info)
const
2352 amrex::Abort(
"MLLinOpT::makeCoarseMG: how did we get here?");
2357template <
typename MF>
2364template <
typename MF>
2376 amrex::Abort(
"MLLinOpT::makeCoarseAmr: how did we get here?");
2381template <
typename MF>
2389 m_geom[0].resize(new_size);
2391 m_dmap[0].resize(new_size);
2399template <
typename MF>
2405 const int ncomp = this->
getNComp();
2407 if (!fres.isAllRegular()) {
2408 if constexpr (std::is_same<MF,MultiFab>()) {
2412 amrex::Abort(
"EB_average_down only works with MultiFab");
2420 amrex::Abort(
"For non-FabArray, MLLinOpT<MF>::avgDownResMG should be overridden.");
2424template <
typename MF>
2428 return m_dmap[amrlev][mglev1] ==
m_dmap[amrlev][mglev2]
2432template <
typename MF>
2433template <MultiFabLike AMF>
2434requires (!std::same_as<MF,AMF>)
2437 const AMF* robinbc_a,
const AMF* robinbc_b,
2438 const AMF* robinbc_f)
2440 const int ncomp = this->
getNComp();
2442 levelbc_raii[amrlev] = std::make_unique<MF>(levelbcdata->boxArray(),
2443 levelbcdata->DistributionMap(),
2444 ncomp, levelbcdata->nGrowVect());
2445 levelbc_raii[amrlev]->LocalCopy(*levelbcdata, 0, 0, ncomp,
2446 levelbcdata->nGrowVect());
2448 levelbc_raii[amrlev].reset();
2452 robin_a_raii[amrlev] = std::make_unique<MF>(robinbc_a->boxArray(),
2453 robinbc_a->DistributionMap(),
2454 ncomp, robinbc_a->nGrowVect());
2455 robin_a_raii[amrlev]->LocalCopy(*robinbc_a, 0, 0, ncomp,
2456 robinbc_a->nGrowVect());
2458 robin_a_raii[amrlev].reset();
2462 robin_b_raii[amrlev] = std::make_unique<MF>(robinbc_b->boxArray(),
2463 robinbc_b->DistributionMap(),
2464 ncomp, robinbc_b->nGrowVect());
2465 robin_b_raii[amrlev]->LocalCopy(*robinbc_b, 0, 0, ncomp,
2466 robinbc_b->nGrowVect());
2468 robin_b_raii[amrlev].reset();
2472 robin_f_raii[amrlev] = std::make_unique<MF>(robinbc_f->boxArray(),
2473 robinbc_f->DistributionMap(),
2474 ncomp, robinbc_f->nGrowVect());
2475 robin_f_raii[amrlev]->LocalCopy(*robinbc_f, 0, 0, ncomp,
2476 robinbc_f->nGrowVect());
2478 robin_f_raii[amrlev].reset();
2481 this->
setLevelBC(amrlev, levelbc_raii[amrlev].
get(), robin_a_raii[amrlev].
get(),
2482 robin_b_raii[amrlev].
get(), robin_f_raii[amrlev].
get());
2485template <
typename MF>
2490 return xdoty(0,0,*
x[0],*
y[0],
false);
2493template <
typename MF>
2498 auto r =
xdoty(0,0,*
x[0],*
x[0],
false);
2499 return std::sqrt(r);
2503#ifdef AMREX_MLMG_HAS_FLOAT
Type-erased container that supports move-only types.
#define BL_PROFILE(a)
Definition AMReX_BLProfiler.H:593
#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_WITH_MESSAGE(EX, MSG)
Definition AMReX_BLassert.H:37
#define AMREX_ASSERT(EX)
Definition AMReX_BLassert.H:38
#define AMREX_ALWAYS_ASSERT(EX)
Definition AMReX_BLassert.H:50
Infrastructure for storing per-face boundary data in FabSets.
Type trait that exposes the FAB and value types of MultiFab-like containers.
#define AMREX_D_TERM(a, b, c)
Definition AMReX_SPACE.H:172
#define AMREX_D_PICK(a, b, c)
Definition AMReX_SPACE.H:173
#define AMREX_D_DECL(a, b, c)
Definition AMReX_SPACE.H:171
Reference-counted collection of Boxes.
Definition AMReX_BoxArray.H:681
BoxArray & refine(int refinement_ratio)
Refine each Box in the BoxArray by refinement_ratio.
Definition AMReX_BoxArray.cpp:606
static bool SameRefs(const BoxArray &lhs, const BoxArray &rhs)
whether two BoxArrays share the same data
Definition AMReX_BoxArray.H:1252
BoxArray & coarsen(int refinement_ratio)
Coarsen each Box in the BoxArray by refinement_ratio.
Definition AMReX_BoxArray.cpp:685
BoxArray & convert(IndexType typ)
Set the IndexType of the BoxArray.
Definition AMReX_BoxArray.cpp:829
BoxArray & maxSize(int block_size)
Split any Box whose side length exceeds block_size.
Definition AMReX_BoxArray.cpp:553
GpuArray< Real, 3 > CellSizeArray() const noexcept
Returns the cell sizes as a GpuArray for use on host or device.
Definition AMReX_CoordSys.H:85
Default FabFactory that calls new / delete on the FAB type directly.
Definition AMReX_FabFactory.H:124
Calculates the distribution of FABs to MPI processes.
Definition AMReX_DistributionMapping.H:55
static DistributionMapping makeSFC(const MultiFab &weight, bool sort=true)
Build an SFC map weighted by the sum of component 0 over each valid box of weight; sort enables load-...
Definition AMReX_DistributionMapping.cpp:1778
Definition AMReX_EBFabFactory.H:32
Abstract factory interface for creating, aliasing, and destroying FAB objects.
Definition AMReX_FabFactory.H:73
Rectangular problem domain geometry.
Definition AMReX_Geometry.H:87
Interface
HYPRE interface modes supported.
Definition AMReX_Hypre.H:70
Definition AMReX_MLLinOp.H:156
virtual void copyNSolveSolution(MF &dst, MF const &src) const
Copy an NSolve solution from src to dst.
Definition AMReX_MLLinOp.H:888
const MultiFab * m_coarse_data_for_bc
Definition AMReX_MLLinOp.H:1039
bool mg_odd_coarsening
Definition AMReX_MLLinOp.H:978
virtual void postSolve(Vector< MF * > const &sol) const
Optional hook invoked after the main solve completes.
Definition AMReX_MLLinOp.H:897
Vector< Vector< std::unique_ptr< FabFactory< FAB > > > > m_factory
Definition AMReX_MLLinOp.H:1010
virtual bool scaleRHS(int amrlev, MF *rhs) const
Optionally scale the RHS to fix solvability.
Definition AMReX_MLLinOp.H:658
bool m_mg_deferred
Definition AMReX_MLLinOp.H:989
virtual void avgDownResMG(int clev, MF &cres, MF const &fres) const
Average residuals from fine to coarse MG levels (FMG helper).
Definition AMReX_MLLinOp.H:2401
int NAMRLevels() const noexcept
Return the number of AMR levels.
Definition AMReX_MLLinOp.H:951
friend class HypreMLNodeLap
Definition AMReX_MLLinOp.H:165
bool m_do_consolidation
Definition AMReX_MLLinOp.H:1001
bool isCellCentered() const noexcept
Definition AMReX_MLLinOp.H:1248
IntVect m_ixtype
Definition AMReX_MLLinOp.H:998
void setVerbose(int v) noexcept
Set verbosity.
Definition AMReX_MLLinOp.H:324
bool isMFIterSafe(int amrlev, int mglev1, int mglev2) const
Check whether mixing MFIter loops for different MG levels is safe.
Definition AMReX_MLLinOp.H:2426
RealVect m_coarse_bc_loc
Definition AMReX_MLLinOp.H:1038
virtual bool needsUpdate() const
Does it need update if it's reused?
Definition AMReX_MLLinOp.H:390
virtual void interpolation(int amrlev, int fmglev, MF &fine, const MF &crse) const =0
Add interpolated coarse MG level data to fine MG level data.
virtual void setLevelBC(int, const MF *, const MF *=nullptr, const MF *=nullptr, const MF *=nullptr)=0
Set boundary conditions for given level. For cell-centered solves only.
virtual MF make(int amrlev, int mglev, IntVect const &ng) const
Definition AMReX_MLLinOp.H:2298
virtual void applyOverset(int amrlev, MF &rhs) const
Overset-only hook for zeroing regions covered by masks.
Definition AMReX_MLLinOp.H:647
FabFactory< FAB > const * Factory(int amr_lev, int mglev=0) const noexcept
Definition AMReX_MLLinOp.H:1209
LinOpEnumType::StateMode StateMode
Definition AMReX_MLLinOp.H:173
int spMetricExponent() const noexcept
Definition AMReX_MLLinOp.H:1091
void setDomainBC(const Vector< Array< BCType, 3 > > &lobc, const Vector< Array< BCType, 3 > > &hibc)
Boundary of the whole domain.
Definition AMReX_MLLinOp.H:1985
Array< Real, 3 > m_domain_bloc_hi
Definition AMReX_MLLinOp.H:1033
T get_d0(T const &dx, T const &dy, T const &) const noexcept
Definition AMReX_MLLinOp.H:1312
MPI_Comm BottomCommunicator() const noexcept
Definition AMReX_MLLinOp.H:1236
void setEnforceSingularSolvable(bool o) noexcept
Control whether the solver should try to make singular problems solvable.
Definition AMReX_MLLinOp.H:353
MPI_Comm Communicator() const noexcept
Definition AMReX_MLLinOp.H:1237
friend class GMRESMLMGT
Definition AMReX_MLLinOp.H:164
void setPrintIndentation(std::string s)
Prefix printed messages (e.g., to indent per level).
Definition AMReX_MLLinOp.H:334
int mg_domain_min_width
Definition AMReX_MLLinOp.H:976
void setMaxOrder(int o) noexcept
Set order of interpolation at coarse/fine boundary.
Definition AMReX_MLLinOp.H:341
virtual void compGrad(int amrlev, const Array< MF *, 3 > &grad, MF &sol, Location loc) const
Compute gradients of the solution.
Definition AMReX_MLLinOp.H:593
virtual void interpAssign(int amrlev, int fmglev, MF &fine, MF &crse) const
Overwrite fine MG level data with interpolated coarse data.
Definition AMReX_MLLinOp.H:423
virtual std::string name() const
Definition AMReX_MLLinOp.H:202
GpuArray< BCType, 3 > LoBC(int icomp=0) const noexcept
Definition AMReX_MLLinOp.H:1213
virtual void getEBFluxes(const Vector< MF * > &a_flux, const Vector< MF * > &a_sol) const
Extract embedded-boundary fluxes.
Definition AMReX_MLLinOp.H:795
bool doAgglomeration() const noexcept
Definition AMReX_MLLinOp.H:1244
virtual void spCopySettings()
Definition AMReX_MLLinOp.H:1165
virtual bool supportCustomBottomSolver() const
Does this operator provide its own bottom solver (BottomSolver::custom)?
Definition AMReX_MLLinOp.H:364
virtual MF makeCoarseAmr(int famrlev, IntVect const &ng, MFInfo const &mf_info) const
As above, with caller-selected allocation metadata for temporary storage.
Definition AMReX_MLLinOp.H:2366
MultiFab m_coarse_data_for_bc_raii
Definition AMReX_MLLinOp.H:1040
Vector< Geometry > spGeom(const Vector< Geometry > &a_geom)
Definition AMReX_MLLinOp.H:1102
MLLinOpT< MF > & operator=(const MLLinOpT< MF > &)=delete
int mg_box_min_width
Definition AMReX_MLLinOp.H:975
std::unique_ptr< CommContainer > m_raii_comm
Definition AMReX_MLLinOp.H:1030
bool m_do_semicoarsening
Definition AMReX_MLLinOp.H:1003
bool hasRobinBC() const noexcept
virtual std::unique_ptr< MLLinOpT< MF > > makeNLinOp(int grid_size) const
Create the NSolve counterpart of this operator with the requested grid size.
Definition AMReX_MLLinOp.H:756
friend class MLPoissonT
Definition AMReX_MLLinOp.H:162
Vector< Array< BCType, 3 > > m_hibc
Definition AMReX_MLLinOp.H:966
virtual void resizeMultiGrid(int new_size)
Definition AMReX_MLLinOp.H:2383
Vector< Vector< BoxArray > > m_grids
Definition AMReX_MLLinOp.H:1008
virtual MF makeCoarseAmr(int famrlev, IntVect const &ng) const
Allocate an MF on the next coarser AMR level (famrlev-1) with grow cells ng.
Definition AMReX_MLLinOp.H:2359
bool m_do_agglomeration
Definition AMReX_MLLinOp.H:1000
virtual MF makeAlias(MF const &mf) const
Definition AMReX_MLLinOp.H:2320
virtual bool supportsMixedPrecision() const
Definition AMReX_MLLinOp.H:877
int m_sp_linop_count
Definition AMReX_MLLinOp.H:1056
Array4< T > compactify(Array4< T > const &a) const noexcept
Definition AMReX_MLLinOp.H:1298
static constexpr int mg_coarsen_ratio
Definition AMReX_MLLinOp.H:974
virtual void solutionResidual(int amrlev, MF &resid, MF &x, const MF &b, const MF *crse_bcdata=nullptr)=0
Compute residual for solution.
int getMaxOrder() const noexcept
Get order of interpolation at coarse/fine boundary.
Definition AMReX_MLLinOp.H:346
virtual int getNComp() const
Return number of components.
Definition AMReX_MLLinOp.H:385
void setCoarseFineBCLocation(const RealVect &cloc) noexcept
Definition AMReX_MLLinOp.H:1239
Vector< int > m_amr_ref_ratio
Definition AMReX_MLLinOp.H:993
MPI_Comm m_default_comm
Definition AMReX_MLLinOp.H:1013
virtual void unapplyMetricTerm(int amrlev, int mglev, MF &rhs) const
Remove metric scaling previously applied via applyMetricTerm().
Definition AMReX_MLLinOp.H:617
virtual void setDirichletNodesToZero(int amrlev, int mglev, MF &mf) const
Optional hook for masking out Dirichlet nodes or cells prior to GMRES solves; the default is a no-op ...
Definition AMReX_MLLinOp.H:709
bool isBottomActive() const noexcept
Definition AMReX_MLLinOp.H:1234
virtual void applyInhomogNeumannTerm(int amrlev, MF &rhs) const
Add extra terms introduced when treating inhomogeneous Neumann BC as homogeneous.
Definition AMReX_MLLinOp.H:637
virtual BottomSolver getDefaultBottomSolver() const
Definition AMReX_MLLinOp.H:361
virtual void prepareForFluxes(int amrlev, const MF *crse_bcdata=nullptr)
Ensure BC caches are populated before flux extraction.
Definition AMReX_MLLinOp.H:532
typename FabDataType< MF >::fab_type FAB
Definition AMReX_MLLinOp.H:168
virtual RT normInf(int amrlev, MF const &mf, bool local) const =0
Infinity norm helper used by residual reductions.
Vector< int > m_num_mg_levels
Definition AMReX_MLLinOp.H:995
bool hasBC(BCType bct) const noexcept
Definition AMReX_MLLinOp.H:2039
Vector< Vector< DistributionMapping > > m_dmap
Definition AMReX_MLLinOp.H:1009
int verbose
Definition AMReX_MLLinOp.H:983
virtual MF make(int amrlev, int mglev, IntVect const &ng, MFInfo const &mf_info) const
As above, with caller-selected allocation metadata for temporary storage.
Definition AMReX_MLLinOp.H:2305
IntVect m_coarse_data_crse_ratio
Definition AMReX_MLLinOp.H:1037
LinOpBCType BCType
Definition AMReX_MLLinOp.H:171
virtual void correctionResidual(int amrlev, int mglev, MF &resid, MF &x, const MF &b, BCMode bc_mode, const MF *crse_bcdata=nullptr)=0
Compute residual for the residual-correction form, resid = b - L(x).
virtual void customBottomSolve(MLMGT< MF > *mlmg, MF &x, const MF &b, RT eps_rel, RT eps_abs, int maxiter)
Bottom solve provided by the operator itself.
Definition AMReX_MLLinOp.H:377
const Vector< int > & AMRRefRatio() const noexcept
Return AMR refinement ratios.
Definition AMReX_MLLinOp.H:1197
MLLinOpT(MLLinOpT< MF > &&)=delete
Vector< Array< BCType, 3 > > m_hibc_orig
Definition AMReX_MLLinOp.H:970
RT m_sp_scale
Definition AMReX_MLLinOp.H:1064
virtual void unimposeNeumannBC(int amrlev, MF &rhs) const
Undo Neumann contributions stored on the RHS.
Definition AMReX_MLLinOp.H:627
void setCoarseFineBC(const MF *crse, int crse_ratio, LinOpBCType bc_type=LinOpBCType::Dirichlet) noexcept
Set coarse/fine boundary conditions. For cell-centered solves only.
Definition AMReX_MLLinOp.H:2230
virtual void apply(int amrlev, int mglev, MF &out, MF &in, BCMode bc_mode, StateMode s_mode, const MLMGBndryT< MF > *bndry=nullptr) const =0
Apply the linear operator, out = L(in).
int mg_agg_no_split_direction
Definition AMReX_MLLinOp.H:977
friend class MLCGSolverT
Definition AMReX_MLLinOp.H:161
std::string print_ident
Definition AMReX_MLLinOp.H:984
virtual void interpCoarseFineSolution(int famrlev, MF &fine_sol, const MF &crse_sol) const
Before a composite solve, set the solution at the nodes that fine AMR level famrlev takes from the co...
Definition AMReX_MLLinOp.H:455
bool needsCoarseDataForBC() const noexcept
Needs coarse data for bc?
Definition AMReX_MLLinOp.H:249
static RT spScaleFor(RT x) noexcept
The power of two p with p*x in [0.5,1), or 1 if x is zero or not finite.
Definition AMReX_MLLinOp.H:1068
typename FabDataType< MF >::value_type RT
Definition AMReX_MLLinOp.H:169
virtual void update()
Update for reuse.
Definition AMReX_MLLinOp.H:392
Vector< Array< BCType, 3 > > m_lobc_orig
Definition AMReX_MLLinOp.H:969
bool m_precond_mode
Definition AMReX_MLLinOp.H:1042
virtual std::unique_ptr< FabFactory< FAB > > makeFactory(int, int) const
Definition AMReX_MLLinOp.H:1278
bool hasHiddenDimension() const noexcept
Definition AMReX_MLLinOp.H:1293
virtual bool isBottomSingular() const =0
Is the bottom of the multigrid hierarchy singular?
virtual void reflux(int crse_amrlev, MF &res, const MF &crse_sol, const MF &crse_rhs, MF &fine_res, MF &fine_sol, const MF &fine_rhs) const
Reflux at AMR coarse/fine boundary.
Definition AMReX_MLLinOp.H:561
virtual IntVect getNGrowVectRestriction() const
Definition AMReX_MLLinOp.H:1250
virtual std::unique_ptr< MLAlgMG > makeAlgMG(int mglev) const
Build the algebraic system of MG level mglev of AMR level 0 for the AlgMG solver. Operators that hypr...
Definition AMReX_MLLinOp.H:806
virtual bool supportsAnisotropicCoarsening() const
True if the operator supports MG levels coarsened in any subset of directions. Then MLMG coarsens str...
Definition AMReX_MLLinOp.H:823
virtual void compFlux(int amrlev, const Array< MF *, 3 > &fluxes, MF &sol, Location loc) const
Compute fluxes.
Definition AMReX_MLLinOp.H:578
virtual RT dotProductPrecond(Vector< MF const * > const &x, Vector< MF const * > const &y) const
Dot product over the composite AMR hierarchy, excluding cells covered by finer levels....
Definition AMReX_MLLinOp.H:2487
virtual MF makeCoarseMG(int amrlev, int mglev, IntVect const &ng) const
Allocate an MF on the next coarser MG level (mglev+1) with grow cells ng.
Definition AMReX_MLLinOp.H:2333
const Geometry & Geom(int amr_lev, int mglev=0) const noexcept
Geometry accessor for (amr_lev,mglev).
Definition AMReX_MLLinOp.H:962
virtual void endPrecondBC()
Called when the operator stops being used as a preconditioner.
Definition AMReX_MLLinOp.H:939
bool isMixedPrecision() const noexcept
True if this operator has a single precision copy for mixed precision.
Definition AMReX_MLLinOp.H:880
int hiddenDirection() const noexcept
Definition AMReX_MLLinOp.H:1294
void setDomainBCLoc(const Array< Real, 3 > &lo_bcloc, const Array< Real, 3 > &hi_bcloc) noexcept
Set location offsets for the physical domain boundaries.
Definition AMReX_MLLinOp.H:2214
Vector< Array< BCType, 3 > > m_lobc
Definition AMReX_MLLinOp.H:965
Vector< int > m_domain_covered
Definition AMReX_MLLinOp.H:1011
void prepareMGHierarchy()
Build the deferred MG levels of AMR level 0 once. See supportsAnisotropicCoarsening.
Definition AMReX_MLLinOp.H:1951
const MLLinOpT< MultiFab > * m_parent
Definition AMReX_MLLinOp.H:996
bool doSemicoarsening() const noexcept
Definition AMReX_MLLinOp.H:1246
virtual bool supportNSolve() const
Whether this operator supports NSolve.
Definition AMReX_MLLinOp.H:873
virtual bool supportRobinBC() const noexcept
Definition AMReX_MLLinOp.H:1228
virtual void normalize(int amrlev, int mglev, MF &mf) const
Divide mf by the diagonal component of the operator. Used by the bottom solvers.
Definition AMReX_MLLinOp.H:510
virtual void avgDownResAmr(int clev, MF &cres, MF const &fres) const
Definition AMReX_MLLinOp.H:917
Vector< Vector< Geometry > > m_geom
Definition AMReX_MLLinOp.H:1007
virtual RT norm2Precond(Vector< MF const * > const &x) const
L2 norm over the composite AMR hierarchy, excluding cells covered by finer levels....
Definition AMReX_MLLinOp.H:2495
MLLinOpT(const MLLinOpT< MF > &)=delete
friend class MLABecLaplacianT
Definition AMReX_MLLinOp.H:163
virtual void averageDownAndSync(Vector< MF > &sol) const =0
Average the solution hierarchy down (fine to coarse) and synchronize interfaces.
void setCoarseFineBC(const MF *crse, IntVect const &crse_ratio, LinOpBCType bc_type=LinOpBCType::Dirichlet) noexcept
Definition AMReX_MLLinOp.H:2238
LPInfo dpInfo(LPInfo const &a_info) const
Definition AMReX_MLLinOp.H:1128
virtual void getFluxes(const Vector< MF * > &a_flux, const Vector< MF * > &a_sol) const
Extract fluxes when the operator stores them in single MultiFabs per level.
Definition AMReX_MLLinOp.H:782
Box compactify(Box const &b) const noexcept
Definition AMReX_MLLinOp.H:2068
bool m_needs_coarse_data_for_bc
Definition AMReX_MLLinOp.H:1035
virtual void fixSolvabilityByOffset(int amrlev, int mglev, MF &rhs, Vector< RT > const &offset) const
Subtract previously computed offsets from the RHS.
Definition AMReX_MLLinOp.H:685
GpuArray< BCType, 3 > HiBC(int icomp=0) const noexcept
Definition AMReX_MLLinOp.H:1218
Real m_sp_length_scale
Definition AMReX_MLLinOp.H:1065
int maxorder
Definition AMReX_MLLinOp.H:986
void define(const Vector< Geometry > &a_geom, const Vector< BoxArray > &a_grids, const Vector< DistributionMapping > &a_dmap, const LPInfo &a_info, const Vector< FabFactory< FAB > const * > &a_factory, bool eb_limit_coarsening=true)
Initialize the operator hierarchy on a set of AMR levels.
Definition AMReX_MLLinOp.H:1356
Vector< IntVect > mg_coarsen_ratio_vec
Definition AMReX_MLLinOp.H:1004
virtual MF makeCoarseMG(int amrlev, int mglev, IntVect const &ng, MFInfo const &mf_info) const
As above, with caller-selected allocation metadata for temporary storage.
Definition AMReX_MLLinOp.H:2340
LinOpEnumType::Location Location
Definition AMReX_MLLinOp.H:174
MF MFType
Definition AMReX_MLLinOp.H:167
virtual void preparePrecond()
Prepare auxiliary data used when the operator acts as a preconditioner.
Definition AMReX_MLLinOp.H:699
virtual ~MLLinOpT()=default
virtual void averageDownSolutionRHS(int camrlev, MF &crse_sol, MF &crse_rhs, const MF &fine_sol, const MF &fine_rhs)
Average-down data from fine AMR level to coarse AMR level.
Definition AMReX_MLLinOp.H:469
LPInfo info
Definition AMReX_MLLinOp.H:981
void makeSPLinOp(LPInfo const &a_info, F const &f)
Definition AMReX_MLLinOp.H:1145
friend class MLMGT
Definition AMReX_MLLinOp.H:160
int NMGLevels(int amrlev) const noexcept
Return the number of MG levels at given AMR level.
Definition AMReX_MLLinOp.H:959
LinOpEnumType::BCMode BCMode
Definition AMReX_MLLinOp.H:172
virtual Vector< RT > getSolvabilityOffset(int amrlev, int mglev, MF const &rhs) const
Compute offsets used to enforce solvability (per component).
Definition AMReX_MLLinOp.H:671
T get_d1(T const &, T const &dy, T const &dz) const noexcept
Definition AMReX_MLLinOp.H:1322
bool enforceSingularSolvable
Definition AMReX_MLLinOp.H:988
virtual RT xdoty(int amrlev, int mglev, const MF &x, const MF &y, bool local) const =0
Dot-product helper used by bottom solvers.
virtual void interpolationAmr(int famrlev, MF &fine, const MF &crse, IntVect const &nghost) const
Interpolation between AMR levels.
Definition AMReX_MLLinOp.H:437
bool doConsolidation() const noexcept
Definition AMReX_MLLinOp.H:1245
static constexpr bool mixed_precision_capable
Definition AMReX_MLLinOp.H:1047
virtual bool supportInhomogNeumannBC() const noexcept
Definition AMReX_MLLinOp.H:1229
void spForward(F const &f)
Definition AMReX_MLLinOp.H:1185
LinOpBCType m_coarse_fine_bc_type
Definition AMReX_MLLinOp.H:1036
Array< Real, 3 > m_domain_bloc_lo
Definition AMReX_MLLinOp.H:1032
std::unique_ptr< MLLinOpT< fMultiFab > > m_sp_linop
Definition AMReX_MLLinOp.H:1053
virtual bool supportsAlgMG() const
True if makeAlgMG is implemented for this operator.
Definition AMReX_MLLinOp.H:813
bool m_mg_built
Definition AMReX_MLLinOp.H:990
virtual void buildMGHierarchy()
Build the MG levels of AMR level 0 below the finest one.
Definition AMReX_MLLinOp.H:1288
virtual bool isSingular(int amrlev) const =0
Is it singular on AMR level amrlev?
int AMRRefRatio(int amr_lev) const noexcept
Return AMR refinement ratio at given AMR level.
Definition AMReX_MLLinOp.H:1200
MPI_Comm m_bottom_comm
Definition AMReX_MLLinOp.H:1014
virtual void restriction(int amrlev, int cmglev, MF &crse, MF &fine) const =0
Restriction onto coarse MG level.
friend class MLLinOpT
Definition AMReX_MLLinOp.H:159
virtual void getFluxes(const Vector< Array< MF *, 3 > > &a_flux, const Vector< MF * > &a_sol, Location a_loc) const
Extract per-direction fluxes for each AMR level.
Definition AMReX_MLLinOp.H:770
virtual void beginPrecondBC()
Called when the operator starts being used as a preconditioner.
Definition AMReX_MLLinOp.H:935
virtual void applyMetricTerm(int amrlev, int mglev, MF &rhs) const
Apply metric scaling to the RHS on (amrlev,mglev).
Definition AMReX_MLLinOp.H:607
bool mg_independent_coarsening
Definition AMReX_MLLinOp.H:979
bool getEnforceSingularSolvable() const noexcept
Definition AMReX_MLLinOp.H:359
virtual void prepareForSolve()=0
Finalize coefficients, masks, and BC data before iterative solves.
IntVect AMRRefRatioVect(int amr_lev) const noexcept
Return AMR refinement ratio as IntVect (1 in hidden direction).
Definition AMReX_MLLinOp.H:1203
virtual void smooth(int amrlev, int mglev, MF &sol, const MF &rhs, bool skip_fillboundary, int niter) const =0
Smooth.
static RT spDiagForScale(Vector< RT > const &diag) noexcept
Definition AMReX_MLLinOp.H:1077
virtual GpuArray< Real, 3 > anisotropicCoarseningCellSize(Geometry const &geom) const
Cell size used to pick the directions to coarsen when supportsAnisotropicCoarsening() is true....
Definition AMReX_MLLinOp.H:831
virtual void make(Vector< Vector< MF > > &mf, IntVect const &ng) const
Definition AMReX_MLLinOp.H:2284
bool hasInhomogNeumannBC() const noexcept
Definition AMReX_MLLinOp.H:2054
void setDomainBC(const Array< BCType, 3 > &lobc, const Array< BCType, 3 > &hibc) noexcept
Boundary of the whole domain.
Definition AMReX_MLLinOp.H:1975
virtual int getNGrow(int=0, int=0) const
Definition AMReX_MLLinOp.H:387
int m_num_amr_levels
Definition AMReX_MLLinOp.H:992
Boundary helper for MLMG that manages coarse/fine and physical BC metadata.
Definition AMReX_MLMGBndry.H:20
This class provides the user with a few print options.
Definition AMReX_Print.H:35
A Box with real dimensions.
Definition AMReX_RealBox.H:28
This class is a thin wrapper around std::vector. Unlike vector, Vector::operator[] provides bound che...
Definition AMReX_Vector.H:29
Long size() const noexcept
Definition AMReX_Vector.H:54
amrex_real Real
Floating Point Type for Fields.
Definition AMReX_REAL.H:80
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:1391
ArrayND< T, 4, true > Array4
Convenient alias for a 4D ArrayND with three spatial dimensions plus a component dimension.
Definition AMReX_Array4.H:1352
__host__ __device__ BoxND< dim > convert(const BoxND< dim > &b, const IntVectND< dim > &typ) noexcept
Return a copy of b converted to the nodal flags typ.
Definition AMReX_Box.H:1632
__host__ __device__ BoxND< dim > coarsen(const BoxND< dim > &b, int ref_ratio) noexcept
Return a copy of b coarsened by the isotropic ratio ref_ratio.
Definition AMReX_Box.H:1471
__host__ __device__ BoxND< dim > enclosedCells(const BoxND< dim > &b, int dir) noexcept
Return a BoxND with CELL based coordinates in direction dir that is enclosed by b.
Definition AMReX_Box.H:1666
std::array< T, N > Array
Definition AMReX_Array.H:31
MLLinOpT< MultiFab > MLLinOp
Definition AMReX_MLLinOp.H:2508
bool notInLaunchRegion() noexcept
Definition AMReX_GpuControl.H:89
void push(MPI_Comm c)
Definition AMReX_ParallelContext.H:105
MPI_Comm CommunicatorSub() noexcept
sub-communicator for current frame
Definition AMReX_ParallelContext.H:70
void pop()
Note that it's the user's responsibility to free the MPI_Comm.
Definition AMReX_ParallelContext.H:111
int local_to_global_rank(int rank) noexcept
translate between local rank and global rank
Definition AMReX_ParallelContext.H:98
int global_to_local_rank(int rank) noexcept
Definition AMReX_ParallelContext.H:101
int NProcsSub() noexcept
number of ranks in current frame
Definition AMReX_ParallelContext.H:74
MPI_Comm Communicator() noexcept
Definition AMReX_ParallelDescriptor.H:223
int MPI_Comm
Definition AMReX_ccse-mpi.H:51
static constexpr int MPI_COMM_NULL
Definition AMReX_ccse-mpi.H:59
int MPI_Group
Definition AMReX_ccse-mpi.H:52
__host__ __device__ T hmin(T const &v)
Definition AMReX_SIMD.H:168
Definition AMReX_Amr.cpp:50
@ make_alias
Definition AMReX_MakeType.H:7
__host__ __device__ void ignore_unused(const Ts &...)
No-op helper that marks variables as intentionally unused.
Definition AMReX.H:273
@ F
Definition AMReX_Order.H:7
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:360
constexpr bool IsMultiFabLike_v
Definition AMReX_TypeTraits.H:44
@ bicgstab
Definition AMReX_AlgMG.H:200
BoxND< 3 > Box
Box is an alias for amrex::BoxND instantiated with AMREX_SPACEDIM.
Definition AMReX_BaseFwd.H:35
LinOpBCType
Definition AMReX_LO_BCTYPES.H:27
@ Robin
Definition AMReX_LO_BCTYPES.H:36
@ Neumann
Definition AMReX_LO_BCTYPES.H:30
@ Dirichlet
Definition AMReX_LO_BCTYPES.H:29
@ inhomogNeumann
Definition AMReX_LO_BCTYPES.H:35
void EB_average_down(const MultiFab &S_fine, MultiFab &S_crse, const MultiFab &vol_fine, const MultiFab &vfrac_fine, int scomp, int ncomp, const IntVect &ratio)
Volume-weighted average-down from fine to coarse using EB volume fractions.
Definition AMReX_EBMultiFabUtil.cpp:336
@ y
Definition AMReX_Orientation.H:14
@ x
Definition AMReX_Orientation.H:14
BottomSolver
Definition AMReX_MLLinOp.H:43
@ algmg
Definition AMReX_MLLinOp.H:44
@ bicgcg
Definition AMReX_MLLinOp.H:44
@ petsc
Definition AMReX_MLLinOp.H:44
@ cg
Definition AMReX_MLLinOp.H:44
@ Default
Definition AMReX_MLLinOp.H:44
@ custom
Definition AMReX_MLLinOp.H:44
@ cgbicg
Definition AMReX_MLLinOp.H:44
@ hypre
Definition AMReX_MLLinOp.H:44
@ smoother
Definition AMReX_MLLinOp.H:44
@ bicgstab
Definition AMReX_MLLinOp.H:44
FabArray< BaseFab< float > > fMultiFab
Definition AMReX_MultiFab.H:19
std::unique_ptr< Hypre > makeHypre(const BoxArray &grids, const DistributionMapping &dmap, const Geometry &geom, MPI_Comm comm_, Hypre::Interface interface, const iMultiFab *overset_mask)
Factory that instantiates the requested HYPRE interface.
Definition AMReX_Hypre.cpp:12
IntVectND< 3 > IntVect
IntVect is an alias for amrex::IntVectND instantiated with AMREX_SPACEDIM.
Definition AMReX_BaseFwd.H:38
void Warning(const std::string &msg)
Print a warning message to the diagnostic stream and keep running.
Definition AMReX.cpp:245
void Abort(const std::string &msg)
Print a fatal-error message to stderr and abort execution.
Definition AMReX.cpp:239
RealVectND< 3 > RealVect
Definition AMReX_ParmParse.H:40
__host__ __device__ constexpr int get(IntVectND< dim > const &iv) noexcept
Get the Idx-th element of IntVectND<dim>.
Definition AMReX_IntVect.H:1367
Type trait specialized for MultiFab-like types and their containers.
Definition AMReX_FabDataType.H:16
Fixed-size array that can be used on GPU.
Definition AMReX_Array.H:52
Definition AMReX_TypeTraits.H:27
Configuration knobs for multilevel linear operators (grid agglomeration, metrics, etc....
Definition AMReX_MLLinOp.H:54
LPInfo & setConsolidationRatio(int x) noexcept
Set the refinement ratio x between consolidated levels.
Definition AMReX_MLLinOp.H:81
int con_strategy
Definition AMReX_MLLinOp.H:61
bool do_semicoarsening
Definition AMReX_MLLinOp.H:57
bool has_metric_term
Definition AMReX_MLLinOp.H:62
LPInfo & setConsolidationGridSize(int x) noexcept
Override the consolidation grid cutoff x (cells per MPI task) used to trigger grouping.
Definition AMReX_MLLinOp.H:79
int max_semicoarsening_level
Definition AMReX_MLLinOp.H:64
bool hasHiddenDimension() const noexcept
True if a hidden dimension was configured via setHiddenDirection().
Definition AMReX_MLLinOp.H:102
int con_ratio
Definition AMReX_MLLinOp.H:60
bool do_consolidation
Definition AMReX_MLLinOp.H:56
int con_grid_size
Definition AMReX_MLLinOp.H:59
LPInfo & setSemicoarsening(bool x) noexcept
Toggle plane-wise semicoarsening instead of full coarsening (x = true selects semicoarsening).
Definition AMReX_MLLinOp.H:75
LPInfo & setHiddenDirection(int n) noexcept
Specify a dimension n that should be treated as “hidden” (e.g., for thin domains).
Definition AMReX_MLLinOp.H:93
LPInfo & setConsolidation(bool x) noexcept
Enable or disable consolidation (MPI rank grouping) on coarse levels (x toggles the feature).
Definition AMReX_MLLinOp.H:73
LPInfo & setSemicoarseningDirection(int n) noexcept
Lock the direction n used for semicoarsening (-1 restores the default heuristic).
Definition AMReX_MLLinOp.H:91
LPInfo & setMaxSemicoarseningLevel(int n) noexcept
Cap the number of semicoarsening steps (when enabled) via n.
Definition AMReX_MLLinOp.H:89
bool do_agglomeration
Definition AMReX_MLLinOp.H:55
LPInfo & setMetricTerm(bool x) noexcept
Indicate whether metric terms are present so downstream code can skip metric work when absent.
Definition AMReX_MLLinOp.H:85
bool deterministic
Enable deterministic mode for GPU operations.
Definition AMReX_MLLinOp.H:67
static constexpr int getDefaultConsolidationGridSize()
Definition AMReX_MLLinOp.H:114
LPInfo & setConsolidationStrategy(int x) noexcept
Select the heuristic x used when forming consolidated grids.
Definition AMReX_MLLinOp.H:83
int max_coarsening_level
Definition AMReX_MLLinOp.H:63
int agg_grid_size
Definition AMReX_MLLinOp.H:58
static constexpr int getDefaultAgglomerationGridSize()
Definition AMReX_MLLinOp.H:106
int hidden_direction
Definition AMReX_MLLinOp.H:66
LPInfo & setAgglomerationGridSize(int x) noexcept
Override the target grid size x used when agglomerating patches.
Definition AMReX_MLLinOp.H:77
LPInfo & setMixedPrecision(bool x) noexcept
Definition AMReX_MLLinOp.H:99
LPInfo & setMaxCoarseningLevel(int n) noexcept
Cap how many coarsening steps (standard or semi-) MLMG may perform by setting n.
Definition AMReX_MLLinOp.H:87
LPInfo & setDeterministic(bool x) noexcept
Definition AMReX_MLLinOp.H:96
LPInfo & setAgglomeration(bool x) noexcept
Enable or disable grid agglomeration on the coarsest MLMG levels (x = true enables it).
Definition AMReX_MLLinOp.H:71
bool mixed_precision
Run the multigrid cycles in single precision.
Definition AMReX_MLLinOp.H:68
int semicoarsening_direction
Definition AMReX_MLLinOp.H:65
Definition AMReX_MLLinOp.H:124
StateMode
Definition AMReX_MLLinOp.H:126
@ Solution
Definition AMReX_MLLinOp.H:126
@ Correction
Definition AMReX_MLLinOp.H:126
BCMode
Definition AMReX_MLLinOp.H:125
@ Homogeneous
Definition AMReX_MLLinOp.H:125
@ Inhomogeneous
Definition AMReX_MLLinOp.H:125
Location
Definition AMReX_MLLinOp.H:127
@ CellCentroid
Definition AMReX_MLLinOp.H:127
@ FaceCentroid
Definition AMReX_MLLinOp.H:127
@ FaceCenter
Definition AMReX_MLLinOp.H:127
@ CellCenter
Definition AMReX_MLLinOp.H:127
FabArray memory allocation information.
Definition AMReX_FabArray.H:73