1#ifndef AMREX_ML_NODE_LAPLACIAN_H_
2#define AMREX_ML_NODE_LAPLACIAN_H_
3#include <AMReX_Config.H>
17#define AMREX_MLNODELAP_HAS_MKNEWU_HA 1
64 RT a_const_sigma =
RT(0.0));
72 RT a_const_sigma =
RT(0.0));
97 RT a_const_sigma =
RT(0.0));
105 RT a_const_sigma =
RT(0.0));
108 [[nodiscard]] std::string
name ()
const override {
return std::string(
"MLNodeLaplacian"); }
147 m_bndry_divu_corr = on;
157 if (m_normalization_threshold != t) {
158 m_normalization_threshold = t;
159 m_needs_update =
true;
162 sp->setNormalizationThreshold(
static_cast<float>(t)); });
191 const MF& vold,
const MF* rhcc,
204 m_use_gauss_seidel = flag;
213 if (m_use_harmonic_average != flag) {
214 m_use_harmonic_average = flag;
215 m_needs_update =
true;
226 if (m_use_mapped != flag) {
228 m_needs_update =
true;
243 m_needs_update =
true;
254 void restriction (
int amrlev,
int cmglev, MF& crse, MF& fine)
const final;
256 void interpolation (
int amrlev,
int fmglev, MF& fine,
const MF& crse)
const final;
259 const MF& fine_sol,
const MF& fine_rhs)
final;
272 const MF& crse_sol)
const final;
279 MF& res,
const MF& crse_sol,
const MF& crse_rhs,
280 MF& fine_res, MF& fine_sol,
const MF& fine_rhs)
const final;
285 [[nodiscard]]
bool needsUpdate () const final {
return m_needs_update; }
289 void Fapply (
int amrlev,
int mglev, MF& out, const MF& in) const final;
298 void Fsmooth (
int amrlev,
int mglev, MF& sol, const MF& rhs) const final;
300 void normalize (
int amrlev,
int mglev, MF& mf) const final;
316 amrex::Abort(
"MLNodeLaplacian::getFluxes: How did we get here?");
325 MF
const& rhs)
const override;
339 MF& sol,
Location loc)
const final {
341 amrex::Abort(
"MLNodeLaplacian::compGrad: How did we get here?");
350 void compGrad (
int amrlev, MF& grad, MF& sol)
const;
377#if (AMREX_SPACEDIM > 1)
378#if defined(AMREX_USE_HYPRE)
379 void fillIJMatrix (
MFIter const& mfi,
384 Real* mat)
const override;
398 template <
typename AlgInt,
typename AlgG
id>
402 AlgInt* ncols, AlgInt* cols,
Real* mat)
const;
404 template <
typename AlgInt,
typename AlgG
id>
408 AlgInt* ncols, AlgInt* cols,
Real* mat)
const;
410 template <
typename AlgInt,
typename AlgG
id>
414 AlgInt* ncols, AlgInt* cols,
Real* mat)
const;
448 if constexpr (std::is_same_v<MF,MultiFab>) {
459 if constexpr (std::is_same_v<MF,MultiFab>) {
471 bool m_bndry_divu_corr =
false;
473 RT m_const_sigma =
RT(0.0);
474 RT m_sp_sigma_scale =
RT(1.0);
480 RT m_normalization_threshold =
RT(1.e-8);
485 bool m_integral_built =
false;
488 bool m_surface_integral_built =
false;
489 bool m_build_surface_integral =
false;
493 bool m_use_gauss_seidel =
true;
494 bool m_use_harmonic_average =
false;
495 bool m_use_mapped =
false;
496 bool m_needs_update =
true;
498 void checkPoint (std::string
const& file_name)
const final;
501extern template class MLNodeLaplacianT<MultiFab>;
502#ifdef AMREX_MLMG_HAS_FLOAT
503extern template class MLNodeLaplacianT<fMultiFab>;
509 void mlndlap_anchor_sync ();
510 void mlndlap_anchor_sten ();
511 void mlndlap_anchor_misc ();
512 void mlndlap_anchor_matrix ();
514 void mlndlap_anchor_eb ();
516 void mlndlap_link_parts ();
Reference-counted collection of Boxes.
Definition AMReX_BoxArray.H:681
Definition AMReX_EBFabFactory.H:32
const MultiFab & getVolFrac() const noexcept
Volume fraction.
Definition AMReX_EBFabFactory.H:95
Abstract factory interface for creating, aliasing, and destroying FAB objects.
Definition AMReX_FabFactory.H:73
Rectangular problem domain geometry.
Definition AMReX_Geometry.H:87
HYPRE_Int Int
Definition AMReX_HypreNodeLap.H:60
Iterator for looping ever tiles and boxes of amrex::FabArray based containers.
Definition AMReX_MFIter.H:88
Vector< Vector< std::unique_ptr< FabFactory< FAB > > > > m_factory
Definition AMReX_MLLinOp.H:1010
RT m_sp_scale
Definition AMReX_MLLinOp.H:1064
Real m_sp_length_scale
Definition AMReX_MLLinOp.H:1065
void spForward(F const &f)
Definition AMReX_MLLinOp.H:1185
std::unique_ptr< MLLinOpT< fMultiFab > > m_sp_linop
Definition AMReX_MLLinOp.H:1053
Definition AMReX_MLNodeLaplacian.H:34
std::string name() const override
Definition AMReX_MLNodeLaplacian.H:108
typename MLNodeLinOpT< MultiFab >::FAB FAB
Definition AMReX_MLNodeLaplacian.H:39
void fillMatrix_doit(int mglev, MFIter const &mfi, Array4< AlgGid const > const &gid, Array4< int const > const &lid, AlgInt *ncols, AlgInt *cols, Real *mat) const
Definition AMReX_MLNodeLaplacian_matrix.cpp:47
void interpolation(int amrlev, int fmglev, MF &fine, const MF &crse) const final
Add the prolongation of coarse data onto the fine grid (fine += prolong(crse)).
Definition AMReX_MLNodeLaplacian.cpp:686
friend class HypreMLNodeLap
Definition AMReX_MLNodeLaplacian.H:37
void normalize(int amrlev, int mglev, MultiFab &mf) const final
void prepareForSolve() final
Finalize metric terms, sigma averages, and BC caches before solving.
Definition AMReX_MLNodeLaplacian.cpp:529
bool supportsMixedPrecision() const override
Definition AMReX_MLNodeLaplacian.H:110
void compSyncResidualFine(MF &sync_resid, const MF &phi, const MF &vold, const MF *rhcc)
Build fine-level sync residuals for multilevel projections.
Definition AMReX_MLNodeLaplacian_sync.cpp:415
void resizeMultiGrid(int new_size) final
Definition AMReX_MLNodeLaplacian.cpp:152
void compDivergence(const Vector< MF * > &rhs, const Vector< MF * > &vel)
Compute rhs = div(vel) on nodal grids (used for projections).
Definition AMReX_MLNodeLaplacian_misc.cpp:1080
void compRHS(const Vector< MF * > &rhs, const Vector< MF * > &vel, const Vector< const MF * > &rhnd, const Vector< MF * > &rhcc)
Assemble RHS including nodal/cell-centered forcing terms.
Definition AMReX_MLNodeLaplacian_misc.cpp:1087
void compSyncResidualCoarse(MF &sync_resid, const MF &phi, const MF &vold, const MF *rhcc, const BoxArray &fine_grids, const IntVect &ref_ratio)
Build coarse-level sync residuals for multilevel projections.
Definition AMReX_MLNodeLaplacian_sync.cpp:17
void setEBInflowVelocity(int amrlev, const MF &eb_vel)
Definition AMReX_MLNodeLaplacian.cpp:1181
void buildStencil()
Build nodal operator stencils reflecting current sigma and metrics.
Definition AMReX_MLNodeLaplacian_sten.cpp:19
void averageDownSolutionRHS(int camrlev, MF &crse_sol, MF &crse_rhs, const MF &fine_sol, const MF &fine_rhs) final
Average solution/RHS pairs from fine AMR levels onto (camrlev).
Definition AMReX_MLNodeLaplacian.cpp:838
void buildIntegral()
Definition AMReX_MLNodeLaplacian_eb.cpp:16
void fillMatrix_cpu(int mglev, MFIter const &mfi, Array4< AlgGid const > const &gid, Array4< int const > const &lid, AlgInt *ncols, AlgInt *cols, Real *mat) const
Definition AMReX_MLNodeLaplacian_matrix.cpp:206
BottomSolver getDefaultBottomSolver() const final
Definition AMReX_MLNodeLaplacian.H:248
void compGrad(int amrlev, const Array< MF *, 3 > &grad, MF &sol, Location loc) const final
Unsupported flux-style gradient extractor (kept for interface completeness).
Definition AMReX_MLNodeLaplacian.H:338
typename MLNodeLinOpT< MultiFab >::StateMode StateMode
Definition AMReX_MLNodeLaplacian.H:42
MLNodeLaplacianT(const MLNodeLaplacianT &)=delete
void fillMatrix_gpu(int mglev, MFIter const &mfi, Array4< AlgGid const > const &gid, Array4< int const > const &lid, AlgInt *ncols, AlgInt *cols, Real *mat) const
Definition AMReX_MLNodeLaplacian_matrix.cpp:67
void fixSolvabilityByOffset(int amrlev, int mglev, MF &rhs, Vector< RT > const &offset) const override
Subtract solvability offsets from rhs.
Definition AMReX_MLNodeLaplacian.cpp:316
void updateVelocity(const Vector< MF * > &vel, const Vector< MF const * > &sol) const
Update velocities using the Poisson solution (projection correction).
Definition AMReX_MLNodeLaplacian_misc.cpp:743
~MLNodeLaplacianT() override=default
void define(const Vector< Geometry > &a_geom, const Vector< BoxArray > &a_grids, const Vector< DistributionMapping > &a_dmap, const LPInfo &a_info=LPInfo(), const Vector< FabFactory< FAB > const * > &a_factory={}, RT a_const_sigma=RT(0.0))
Bind the nodal operator (no EB data).
Definition AMReX_MLNodeLaplacian.cpp:42
void interpCoarseFineSolution(int famrlev, MF &fine_sol, const MF &crse_sol) const final
Set the coarse/fine nodes of fine AMR level famrlev (Dirichlet mask set, not on a Dirichlet domain fa...
Definition AMReX_MLNodeLaplacian.cpp:855
void compGrad(int amrlev, MF &grad, MF &sol) const
Compute gradients of sol into nodal MultiFab grad on AMR level amrlev.
Definition AMReX_MLNodeLaplacian_misc.cpp:872
void spUpdateScale() noexcept
Definition AMReX_MLNodeLaplacian.H:436
MLNodeLaplacianT(MLNodeLaplacianT &&)=delete
void setHarmonicAverage(bool flag) noexcept
Toggle harmonic averaging when coarsening sigma.
Definition AMReX_MLNodeLaplacian.H:212
void define(const Vector< Geometry > &a_geom, const Vector< BoxArray > &a_grids, const Vector< DistributionMapping > &a_dmap, const LPInfo &a_info, const Vector< EBFArrayBoxFactory const * > &a_factory, RT a_const_sigma=RT(0.0))
Definition AMReX_MLNodeLaplacian.cpp:130
void averageDownCoeffs()
Average conductivity down across all AMR and MG levels.
Definition AMReX_MLNodeLaplacian_misc.cpp:18
void spForwardSigma()
Definition AMReX_MLNodeLaplacian.cpp:443
void fillRHS(int mglev, MFIter const &mfi, Array4< int const > const &lid, Real *rhs, Array4< Real const > const &bfab) const override
Fill the right-hand side of the rows of one box on MG level mglev.
Definition AMReX_MLNodeLaplacian_matrix.cpp:265
void unimposeNeumannBC(int amrlev, MF &rhs) const final
Remove Neumann contributions previously imposed on rhs.
Definition AMReX_MLNodeLaplacian.cpp:177
void setCoarseningStrategy(CoarseningStrategy cs) noexcept
Pick between sigma-weighted or RAP coarsening (ignored if sigma constant).
Definition AMReX_MLNodeLaplacian.H:238
void setRZCorrection(bool rz) noexcept
Enable cylindrical (RZ) metric terms.
Definition AMReX_MLNodeLaplacian.H:119
void setNormalizationThreshold(RT t) noexcept
Threshold for normalization (prevents dividing by tiny averages).
Definition AMReX_MLNodeLaplacian.H:156
MLNodeLaplacianT(const Vector< Geometry > &a_geom, const Vector< BoxArray > &a_grids, const Vector< DistributionMapping > &a_dmap, const LPInfo &a_info, const Vector< EBFArrayBoxFactory const * > &a_factory, RT a_const_sigma=RT(0.0))
Convenience constructor that accepts embedded-boundary factories.
Definition AMReX_MLNodeLaplacian.cpp:29
void getFluxes(const Vector< Array< MultiFab *, 3 > > &a_flux, const Vector< MultiFab * > &a_sol, Location a_loc) const final
Definition AMReX_MLNodeLaplacian.H:312
void fillAlgMatrix(int mglev, MFIter const &mfi, Array4< Long const > const &gid, Array4< int const > const &lid, Long *ncols, Long *cols, Real *mat) const override
Fill the matrix rows of one box for the algebraic solver.
Definition AMReX_MLNodeLaplacian_matrix.cpp:31
MLNodeLaplacianT()=default
Construct an empty operator; call define() before solving.
EBFArrayBoxFactory const * ebFactory(int amrlev) const
Definition AMReX_MLNodeLaplacian.H:446
typename MLNodeLinOpT< MultiFab >::Location Location
Definition AMReX_MLNodeLaplacian.H:43
void Fapply(int amrlev, int mglev, MultiFab &out, const MultiFab &in) const final
void getFluxes(const Vector< MF * > &a_flux, const Vector< MF * > &a_sol) const final
Compute face-centered fluxes given nodal solutions.
Definition AMReX_MLNodeLaplacian_misc.cpp:946
void averageDownCoeffsToCoarseAmrLevel(int flev)
Average coefficients from fine AMR level flev to coarse AMR level flev-1.
Definition AMReX_MLNodeLaplacian_misc.cpp:88
void spCopySettings() override
Definition AMReX_MLNodeLaplacian.H:419
void FillBoundaryCoeff(MF &sigma, const Geometry &geom)
Fill ghost cells of sigma using geom for BC inference.
Definition AMReX_MLNodeLaplacian.cpp:479
void setSigma(int amrlev, const MF &a_sigma)
Provide per-level conductivity (cell-centered MultiFab). A multi-component input also triggers mapped...
Definition AMReX_MLNodeLaplacian.cpp:414
typename MLNodeLinOpT< MultiFab >::BCMode BCMode
Definition AMReX_MLNodeLaplacian.H:41
Vector< RT > getSolvabilityOffset(int amrlev, int mglev, MF const &rhs) const override
Compute component-wise offsets needed for solvability enforcement.
Definition AMReX_MLNodeLaplacian.cpp:200
void update() final
Refresh sigma averages/stencils and clear the dirty flag.
Definition AMReX_MLNodeLaplacian.cpp:558
void averageDownCoeffsSameAmrLevel(int amrlev)
Average coefficients across MG levels within AMR level amrlev.
Definition AMReX_MLNodeLaplacian_misc.cpp:123
MLNodeLaplacianT(const Vector< Geometry > &a_geom, const Vector< BoxArray > &a_grids, const Vector< DistributionMapping > &a_dmap, const LPInfo &a_info=LPInfo(), const Vector< FabFactory< FAB > const * > &a_factory={}, RT a_const_sigma=RT(0.0))
Convenience constructor without EB factories.
Definition AMReX_MLNodeLaplacian.cpp:17
void setGaussSeidel(bool flag) noexcept
Choose red-black Gauss-Seidel instead of Jacobi smoothing.
Definition AMReX_MLNodeLaplacian.H:203
bool needsUpdate() const final
Definition AMReX_MLNodeLaplacian.H:285
void setMapped(bool flag) noexcept
Enable mapped-coordinate metrics (non-orthogonal grids).
Definition AMReX_MLNodeLaplacian.H:225
bool supportsAlgMG() const override
True if makeAlgMG is implemented for this operator.
Definition AMReX_MLNodeLaplacian.H:387
MLNodeLaplacianT & operator=(const MLNodeLaplacianT &)=delete
void restriction(int amrlev, int cmglev, MF &crse, MF &fine) const final
Restrict nodal data from fine grids to coarse MG level cmglev.
Definition AMReX_MLNodeLaplacian.cpp:570
void Fsmooth(int amrlev, int mglev, MultiFab &sol, const MultiFab &rhs) const final
typename MLNodeLinOpT< MultiFab >::RT RT
Definition AMReX_MLNodeLaplacian.H:40
void buildSurfaceIntegral()
Definition AMReX_MLNodeLaplacian_eb.cpp:89
void restrictInteriorNodes(int camrlev, MF &crhs, MF &frhs) const
Restrict interior-node RHS from fine to coarse when syncing.
Definition AMReX_MLNodeLaplacian.cpp:895
void setBoundaryDivuCorrection(bool on) noexcept
Second-order nodal divergence at nodes on Neumann and inflow domain faces.
Definition AMReX_MLNodeLaplacian.H:146
void fixUpResidualMask(int amrlev, iMultiFab &resmsk) final
static MF const * ebVolFrac(EBFArrayBoxFactory const *f)
Volume fraction of EB factory f, or nullptr.
Definition AMReX_MLNodeLaplacian.H:457
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 final
Flux register reflux coupling coarse/fine nodal solves (updates res using the solution and RHS arrays...
Definition AMReX_MLNodeLaplacian_sync.cpp:782
typename MLNodeLinOpT< MultiFab >::CoarseningStrategy CoarseningStrategy
Definition AMReX_MLNodeLaplacian.H:44
MLNodeLinOpT()
Definition AMReX_MLNodeLinOp.cpp:19
CoarseningStrategy m_coarsening_strategy
Definition AMReX_MLNodeLinOp.H:330
void spCopySettings() override
Definition AMReX_MLNodeLinOp.H:300
typename MLLinOpT< MF >::Location Location
Definition AMReX_MLNodeLinOp.H:37
bool m_masks_built
Definition AMReX_MLNodeLinOp.H:335
typename MLLinOpT< MF >::FAB FAB
Definition AMReX_MLNodeLinOp.H:32
typename MLLinOpT< MF >::BCMode BCMode
Definition AMReX_MLNodeLinOp.H:35
typename MLLinOpT< MF >::RT RT
Definition AMReX_MLNodeLinOp.H:33
Vector< MultiFab > m_precond_weight_mask
Definition AMReX_MLNodeLinOp.H:325
MLNodeLinOpCoarseningStrategy CoarseningStrategy
Definition AMReX_MLNodeLinOp.H:39
typename MLLinOpT< MF >::StateMode StateMode
Definition AMReX_MLNodeLinOp.H:36
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:80
amrex_long Long
Definition AMReX_INT.H:30
ArrayND< T, 4, true > Array4
Convenient alias for a 4D ArrayND with three spatial dimensions plus a component dimension.
Definition AMReX_Array4.H:1352
std::array< T, N > Array
Definition AMReX_Array.H:31
Definition AMReX_Amr.cpp:50
__host__ __device__ void ignore_unused(const Ts &...)
No-op helper that marks variables as intentionally unused.
Definition AMReX.H:273
MLNodeLaplacianT< MultiFab > MLNodeLaplacian
Double precision nodal Laplacian.
Definition AMReX_HypreMLNodeLap.H:23
BottomSolver
Definition AMReX_MLLinOp.H:43
@ bicgcg
Definition AMReX_MLLinOp.H:44
@ bicgstab
Definition AMReX_MLLinOp.H:44
IntVectND< 3 > IntVect
IntVect is an alias for amrex::IntVectND instantiated with AMREX_SPACEDIM.
Definition AMReX_BaseFwd.H:38
void Abort(const std::string &msg)
Print a fatal-error message to stderr and abort execution.
Definition AMReX.cpp:239
Configuration knobs for multilevel linear operators (grid agglomeration, metrics, etc....
Definition AMReX_MLLinOp.H:54