Block-Structured AMR Software Framework
Loading...
Searching...
No Matches
AMReX_MLNodeLinOp.H
Go to the documentation of this file.
1#ifndef AMREX_ML_NODE_LINOP_H_H
2#define AMREX_ML_NODE_LINOP_H_H
3#include <AMReX_Config.H>
4
5#include <AMReX_MLLinOp.H>
6#include <AMReX_iMultiFab.H>
7#include <AMReX_MultiFab.H>
8
9#if defined(AMREX_USE_HYPRE) && (AMREX_SPACEDIM > 1)
10#include <AMReX_HypreNodeLap.H>
11#endif
12
13namespace amrex {
14
20
23
24template <typename MF>
26 : public MLLinOpT<MF>
27{
28public:
29
30 friend class HypreMLNodeLap;
31
32 using FAB = typename MLLinOpT<MF>::FAB;
33 using RT = typename MLLinOpT<MF>::RT;
34 using BCType = typename MLLinOpT<MF>::BCType;
35 using BCMode = typename MLLinOpT<MF>::BCMode;
38
40
42 ~MLNodeLinOpT () override = default;
43
44 MLNodeLinOpT (const MLNodeLinOpT&) = delete;
48
60 void define (const Vector<Geometry>& a_geom,
61 const Vector<BoxArray>& a_grids,
62 const Vector<DistributionMapping>& a_dmap,
63 const LPInfo& a_info = LPInfo(),
64 const Vector<FabFactory<FAB> const*>& a_factory = {},
65 int a_eb_limit_coarsening = -1);
66
76 void setSmoothNumSweeps (int nsweeps) noexcept {
77 m_smooth_num_sweeps = nsweeps;
78 this->template spForward<MLNodeLinOpT>([&] (auto* sp) { sp->setSmoothNumSweeps(nsweeps); });
79 }
80
81 void setLevelBC (int /*amrlev*/, const MF* /*levelbcdata*/,
82 const MF* = nullptr, const MF* = nullptr,
83 const MF* = nullptr) final {}
84
96 void apply (int amrlev, int mglev, MF& out, MF& in, BCMode bc_mode,
97 StateMode s_mode, const MLMGBndryT<MF>* bndry=nullptr) const final;
98
109 void smooth (int amrlev, int mglev, MF& sol, const MF& rhs,
110 bool skip_fillboundary, int niter) const override;
111
113 void solutionResidual (int amrlev, MF& resid, MF& x, const MF& b,
114 const MF* crse_bcdata=nullptr) override;
116 void correctionResidual (int amrlev, int mglev, MF& resid, MF& x, const MF& b,
117 BCMode bc_mode, const MF* crse_bcdata=nullptr) override;
118
120 Vector<RT> getSolvabilityOffset (int amrlev, int mglev,
121 MF const& rhs) const override;
123 void fixSolvabilityByOffset (int amrlev, int mglev, MF& rhs,
124 Vector<RT> const& offset) const override;
125
127 void prepareForSolve () override;
128
130 void preparePrecond () override;
131
133 void setDirichletNodesToZero (int amrlev, int mglev, MF& mf) const override;
134
135 bool isSingular (int amrlev) const override
136 { return (amrlev == 0) ? m_is_singular : false; }
137 bool isBottomSingular () const override { return m_is_bottom_singular; }
138
140 RT xdoty (int amrlev, int mglev, const MF& x, const MF& y, bool local) const final;
141
144 Vector<MF const*> const& y) const final;
145
147 RT norm2Precond (Vector<MF const*> const& x) const final;
148
159 virtual void applyBC (int amrlev, int mglev, MF& phi, BCMode bc_mode, StateMode state_mode,
160 bool skip_fillboundary=false) const;
161
170 virtual void Fapply (int amrlev, int mglev, MF& out, const MF& in) const = 0;
179 virtual void Fsmooth (int amrlev, int mglev, MF& sol, const MF& rhs) const = 0;
180
182 void nodalSync (int amrlev, int mglev, MF& mf) const;
183
191 static std::unique_ptr<iMultiFab> makeOwnerMask (const BoxArray& ba,
192 const DistributionMapping& dm,
193 const Geometry& geom);
194
196 void buildMasks ();
197
198 // omask is either 0 or 1. 1 means the node is an unknown. 0 means it's known.
205 void setOversetMask (int amrlev, const iMultiFab& a_dmask);
206
208 void applyOverset (int amrlev, MF& mf) const override;
209
210 virtual void fixUpResidualMask (int /*amrlev*/, iMultiFab& /*resmsk*/) { }
211
213 RT normInf (int amrlev, MF const& mf, bool local) const override;
214
216 void avgDownResAmr (int, MF&, MF const&) const final { }
217
226 void interpolationAmr (int famrlev, MF& fine, const MF& crse,
227 IntVect const& nghost) const override;
228
234 void averageDownAndSync (Vector<MF>& sol) const override;
235
245 void interpAssign (int amrlev, int fmglev, MF& fine, MF& crse) const override;
246
247#if (AMREX_SPACEDIM > 1)
248 [[nodiscard]] std::unique_ptr<MLAlgMG> makeAlgMG (int mglev) const override;
249#endif
250
251#if defined(AMREX_USE_HYPRE) && (AMREX_SPACEDIM > 1)
258 [[nodiscard]] std::unique_ptr<HypreNodeLap> makeHypreNodeLap(
259 int bottom_verbose,
260 const std::string& options_namespace) const override;
261
262 virtual void fillIJMatrix (MFIter const& /*mfi*/,
264 Array4<int const> const& /*lid*/,
265 HypreNodeLap::Int* /*ncols*/,
266 HypreNodeLap::Int* /*cols*/,
267 Real* /*mat*/) const
268 {
269 amrex::Abort("MLNodeLinOp::fillIJMatrix: how did we get here?");
270 }
271#endif
272
281 virtual void fillAlgMatrix (int /*mglev*/, MFIter const& /*mfi*/,
282 Array4<Long const> const& /*gid*/,
283 Array4<int const> const& /*lid*/,
284 Long* /*ncols*/, Long* /*cols*/, Real* /*mat*/) const
285 {
286 amrex::Abort("MLNodeLinOp::fillAlgMatrix: not supported by this operator");
287 }
288
290 virtual void fillRHS (int /*mglev*/, MFIter const& /*mfi*/,
291 Array4<int const> const& /*lid*/,
292 Real* /*rhs*/,
293 Array4<Real const> const& /*bfab*/) const
294 {
295 amrex::Abort("MLNodeLinOp:fillRHS: how did we get here?");
296 }
297
298protected:
299
305
307 [[nodiscard]] static GpuArray<RT,AMREX_SPACEDIM>
309 {
310 return {AMREX_D_DECL(static_cast<RT>(a[0]), static_cast<RT>(a[1]), static_cast<RT>(a[2]))};
311 }
312
313 void resizeMultiGrid (int new_size) override;
314
315 void buildMGHierarchy () override;
316
317 std::unique_ptr<iMultiFab> m_owner_mask_top; // ownership of nodes
318 std::unique_ptr<iMultiFab> m_owner_mask_bottom;
320 Vector<std::unique_ptr<iMultiFab> > m_cc_fine_mask; // cell-centered mask for cells covered by fine
321 Vector<std::unique_ptr<iMultiFab> > m_nd_fine_mask; // nodal mask: 0: this level node, 1: c/f boundary, 2: fine node
322 Vector<std::unique_ptr<LayoutData<int> > > m_has_fine_bndry; // does this fab contain c/f boundary?
326
328
329#ifdef AMREX_USE_EB
330 CoarseningStrategy m_coarsening_strategy = CoarseningStrategy::RAP;
331#else
332 CoarseningStrategy m_coarsening_strategy = CoarseningStrategy::Sigma;
333#endif
334
335 bool m_masks_built = false;
338 mutable bool m_in_solution_mode = true;
339
340private:
341 bool m_is_singular = false;
342 bool m_is_bottom_singular = false; // also when coarsening dropped all overset nodes
343};
344
345extern template class MLNodeLinOpT<MultiFab>;
346#ifdef AMREX_MLMG_HAS_FLOAT
347extern template class MLNodeLinOpT<fMultiFab>;
348#endif
349
352
353}
354
355#endif
#define AMREX_D_DECL(a, b, c)
Definition AMReX_SPACE.H:171
Reference-counted collection of Boxes.
Definition AMReX_BoxArray.H:681
Calculates the distribution of FABs to MPI processes.
Definition AMReX_DistributionMapping.H:55
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
LinOpEnumType::StateMode StateMode
Definition AMReX_MLLinOp.H:173
virtual void spCopySettings()
Definition AMReX_MLLinOp.H:1165
typename FabDataType< MF >::fab_type FAB
Definition AMReX_MLLinOp.H:168
LinOpBCType BCType
Definition AMReX_MLLinOp.H:171
typename FabDataType< MF >::value_type RT
Definition AMReX_MLLinOp.H:169
LinOpEnumType::Location Location
Definition AMReX_MLLinOp.H:174
LinOpEnumType::BCMode BCMode
Definition AMReX_MLLinOp.H:172
void spForward(F const &f)
Definition AMReX_MLLinOp.H:1185
friend class MLLinOpT
Definition AMReX_MLLinOp.H:159
Boundary helper for MLMG that manages coarse/fine and physical BC metadata.
Definition AMReX_MLMGBndry.H:20
Definition AMReX_MLNodeLinOp.H:27
friend class HypreMLNodeLap
Definition AMReX_MLNodeLinOp.H:30
void setLevelBC(int, const MF *, const MF *=nullptr, const MF *=nullptr, const MF *=nullptr) final
Set boundary conditions for given level. For cell-centered solves only.
Definition AMReX_MLNodeLinOp.H:81
virtual void fillRHS(int, MFIter const &, Array4< int const > const &, Real *, Array4< Real const > const &) const
Fill the right-hand side of the rows of one box on MG level mglev.
Definition AMReX_MLNodeLinOp.H:290
virtual void applyBC(int amrlev, int mglev, MF &phi, BCMode bc_mode, StateMode state_mode, bool skip_fillboundary=false) const
Apply physical BCs prior to smoothing/apply.
Definition AMReX_MLNodeLinOp.cpp:563
void smooth(int amrlev, int mglev, MultiFab &sol, const MultiFab &rhs, bool skip_fillboundary, int niter) const override
MultiFab m_coarse_dot_mask
Definition AMReX_MLNodeLinOp.H:324
RT normInf(int amrlev, MF const &mf, bool local) const override
Infinity norm helper operating on level amrlev (set local to true to skip MPI reduction).
Definition AMReX_MLNodeLinOp.cpp:658
void resizeMultiGrid(int new_size) override
Definition AMReX_MLNodeLinOp.cpp:594
void fixSolvabilityByOffset(int amrlev, int mglev, MultiFab &rhs, Vector< RT > const &offset) const override
void solutionResidual(int amrlev, MultiFab &resid, MultiFab &x, const MultiFab &b, const MultiFab *crse_bcdata=nullptr) override
bool isSingular(int amrlev) const override
Definition AMReX_MLNodeLinOp.H:135
void correctionResidual(int amrlev, int mglev, MultiFab &resid, MultiFab &x, const MultiFab &b, BCMode bc_mode, const MultiFab *crse_bcdata=nullptr) override
bool m_in_solution_mode
Definition AMReX_MLNodeLinOp.H:338
void setDirichletNodesToZero(int amrlev, int mglev, MultiFab &mf) const override
Vector< RT > getSolvabilityOffset(int amrlev, int mglev, MultiFab const &rhs) const override
bool m_overset_dirichlet_mask
Definition AMReX_MLNodeLinOp.H:336
virtual void fixUpResidualMask(int, iMultiFab &)
Definition AMReX_MLNodeLinOp.H:210
MLNodeLinOpT()
Definition AMReX_MLNodeLinOp.cpp:19
CoarseningStrategy m_coarsening_strategy
Definition AMReX_MLNodeLinOp.H:330
MLNodeLinOpT & operator=(const MLNodeLinOpT &)=delete
void applyOverset(int amrlev, MF &mf) const override
Zero mf at the known nodes of the overset mask.
Definition AMReX_MLNodeLinOp.cpp:543
void setOversetMask(int amrlev, const iMultiFab &a_dmask)
Mark nodes that belong to overset (known) regions.
Definition AMReX_MLNodeLinOp.cpp:522
RT norm2Precond(Vector< MF const * > const &x) const final
L2 norm used when the operator acts as a preconditioner.
Definition AMReX_MLNodeLinOp.cpp:230
std::unique_ptr< iMultiFab > m_owner_mask_bottom
Definition AMReX_MLNodeLinOp.H:318
void buildMGHierarchy() override
Build the MG levels of AMR level 0 below the finest one.
Definition AMReX_MLNodeLinOp.cpp:632
void interpAssign(int amrlev, int fmglev, MF &fine, MF &crse) const override
Overwrite fine data with the prolongation of coarse data (fine = prolong(crse)).
Definition AMReX_MLNodeLinOp.cpp:769
MultiFab m_bottom_dot_mask
Definition AMReX_MLNodeLinOp.H:323
Vector< std::unique_ptr< iMultiFab > > m_nd_fine_mask
Definition AMReX_MLNodeLinOp.H:321
Vector< std::unique_ptr< LayoutData< int > > > m_has_fine_bndry
Definition AMReX_MLNodeLinOp.H:322
virtual void fillAlgMatrix(int, MFIter const &, Array4< Long const > const &, Array4< int const > const &, Long *, Long *, Real *) const
Fill the matrix rows of one box for the algebraic solver.
Definition AMReX_MLNodeLinOp.H:281
std::unique_ptr< MLAlgMG > makeAlgMG(int mglev) const override
Build the algebraic system of MG level mglev of AMR level 0 for the AlgMG solver. Operators that hypr...
Definition AMReX_MLNodeLinOp.cpp:813
void spCopySettings() override
Definition AMReX_MLNodeLinOp.H:300
virtual void Fapply(int amrlev, int mglev, MF &out, const MF &in) const =0
Low-level apply invoked by the base class.
typename MLLinOpT< MultiFab >::Location Location
Definition AMReX_MLNodeLinOp.H:37
bool isBottomSingular() const override
Is the bottom of the multigrid hierarchy singular?
Definition AMReX_MLNodeLinOp.H:137
void buildMasks()
Build Dirichlet/dot-product masks and determine bottom singularity.
Definition AMReX_MLNodeLinOp.cpp:309
void apply(int amrlev, int mglev, MF &out, MF &in, BCMode bc_mode, StateMode s_mode, const MLMGBndryT< MF > *bndry=nullptr) const final
Apply the nodal operator with the requested BC/state modes.
Definition AMReX_MLNodeLinOp.cpp:175
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={}, int a_eb_limit_coarsening=-1)
Bind the nodal operator to an AMR hierarchy.
Definition AMReX_MLNodeLinOp.cpp:26
void setSmoothNumSweeps(int nsweeps) noexcept
Control how many smoother passes are executed inside each Fsmooth call.
Definition AMReX_MLNodeLinOp.H:76
MLNodeLinOpT(const MLNodeLinOpT &)=delete
bool m_masks_built
Definition AMReX_MLNodeLinOp.H:335
void avgDownResAmr(int, MF &, MF const &) const final
Nodal average-down for residuals between AMR levels (no-op here).
Definition AMReX_MLNodeLinOp.H:216
typename MLLinOpT< MultiFab >::FAB FAB
Definition AMReX_MLNodeLinOp.H:32
Vector< Vector< std::unique_ptr< iMultiFab > > > m_dirichlet_mask
Definition AMReX_MLNodeLinOp.H:319
typename MLLinOpT< MultiFab >::BCMode BCMode
Definition AMReX_MLNodeLinOp.H:35
RT dotProductPrecond(Vector< MF const * > const &x, Vector< MF const * > const &y) const final
Dot product used when the operator acts as a preconditioner.
Definition AMReX_MLNodeLinOp.cpp:215
typename MLLinOpT< MultiFab >::RT RT
Definition AMReX_MLNodeLinOp.H:33
void nodalSync(int amrlev, int mglev, MF &mf) const
Synchronize nodal values across box/partition boundaries on (amrlev,mglev).
Definition AMReX_MLNodeLinOp.cpp:128
virtual void Fsmooth(int amrlev, int mglev, MF &sol, const MF &rhs) const =0
Low-level smoother invoked by the base class.
static GpuArray< RT, 3 > toRT(GpuArray< Real, 3 > const &a) noexcept
Convert a geometry array to RT.
Definition AMReX_MLNodeLinOp.H:308
Vector< MultiFab > m_precond_weight_mask
Definition AMReX_MLNodeLinOp.H:325
Vector< std::unique_ptr< iMultiFab > > m_norm_fine_mask
Definition AMReX_MLNodeLinOp.H:327
MLNodeLinOpT(MLNodeLinOpT &&)=delete
int m_smooth_num_sweeps
Definition AMReX_MLNodeLinOp.H:337
std::unique_ptr< iMultiFab > m_owner_mask_top
Definition AMReX_MLNodeLinOp.H:317
static std::unique_ptr< iMultiFab > makeOwnerMask(const BoxArray &ba, const DistributionMapping &dm, const Geometry &geom)
Build a nodal mask that marks points owned by this rank (used for sync).
Definition AMReX_MLNodeLinOp.cpp:118
void averageDownAndSync(Vector< MF > &sol) const override
Average nodal solutions down the AMR hierarchy and synchronize overlaps.
Definition AMReX_MLNodeLinOp.cpp:746
typename MLLinOpT< MultiFab >::BCType BCType
Definition AMReX_MLNodeLinOp.H:34
~MLNodeLinOpT() override=default
Vector< std::unique_ptr< iMultiFab > > m_cc_fine_mask
Definition AMReX_MLNodeLinOp.H:320
MLNodeLinOpCoarseningStrategy CoarseningStrategy
Definition AMReX_MLNodeLinOp.H:39
void interpolationAmr(int famrlev, MF &fine, const MF &crse, IntVect const &nghost) const override
Prolong AMR-level data during FMG initialization.
Definition AMReX_MLNodeLinOp.cpp:713
RT xdoty(int amrlev, int mglev, const MF &x, const MF &y, bool local) const final
Dot-product helper.
Definition AMReX_MLNodeLinOp.cpp:198
typename MLLinOpT< MultiFab >::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
Definition AMReX_Amr.cpp:50
MLNodeLinOpCoarseningStrategy
Coarsening strategy of nodal operators.
Definition AMReX_MLNodeLinOp.H:22
@ Sigma
Definition AMReX_MLNodeLinOp.H:22
@ y
Definition AMReX_Orientation.H:14
@ x
Definition AMReX_Orientation.H:14
MLNodeLinOpT< MultiFab > MLNodeLinOp
Double precision base class for nodal linear operators.
Definition AMReX_HypreNodeLap.H:26
SpMatrix< T, Allocator > RAP(SpMatrix< T, Allocator > const &R, SpMatrix< T, Allocator > const &A, SpMatrix< T, Allocator > const &P, AlgPartition const &col_partition)
Galerkin product R (A P), with the result of SpGEMM(R, SpGEMM(A, P, col_partition),...
Definition AMReX_SpGEMM.H:1368
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
Fixed-size array that can be used on GPU.
Definition AMReX_Array.H:52
Configuration knobs for multilevel linear operators (grid agglomeration, metrics, etc....
Definition AMReX_MLLinOp.H:54