Block-Structured AMR Software Framework
Loading...
Searching...
No Matches
AMReX_HypreNodeLap.H
Go to the documentation of this file.
1#ifndef AMREX_HYPRE_NODE_LAP_H_
2#define AMREX_HYPRE_NODE_LAP_H_
3#include <AMReX_Config.H>
4
5#include <AMReX_Geometry.H>
6#include <AMReX_MultiFab.H>
7#include <AMReX_iMultiFab.H>
8#include <AMReX_LayoutData.H>
9#include <AMReX_BndryData.H>
10#include <AMReX_MultiFabUtil.H>
11#include <AMReX_HypreIJIface.H>
12
13#include <algorithm>
14#include <memory>
15#include <type_traits>
16
22
23namespace amrex {
24
25template <typename MF> class MLNodeLinOpT;
27
32{
33public:
48 HypreNodeLap (const BoxArray& grids_, const DistributionMapping& dmap_,
49 const Geometry& geom_, const FabFactory<FArrayBox>& factory_,
50 const iMultiFab& owner_mask_, const iMultiFab& dirichlet_mask_,
51 MPI_Comm comm_, MLNodeLinOp const* linop_, int verbose_,
52 std::string options_namespace_);
54
55 HypreNodeLap (HypreNodeLap const&) = delete;
59
60 using Int = HYPRE_Int;
61 // To generate global ids for HYPRE, we need to remove duplicates on
62 // nodes shared by multiple Boxes. So we need to use a type that
63 // supports atomicAdd. HYPRE_Int is either int or long long. The
64 // latter does not have native atomicAdd support in CUDA/HIP.
65 using AtomicInt = std::conditional_t<sizeof(Int) == 4, unsigned int, unsigned long long>;
66
76 void solve (MultiFab& soln, const MultiFab& rhs,
77 Real rel_tol, Real abs_tol, int max_iter);
78
80 void setHypreOptionsNamespace(const std::string& ns)
81 { options_namespace = ns; }
82
85 void setThrowException (bool t) noexcept { throw_exception = t; }
86
87private:
88
89 BoxArray grids;
91 Geometry geom;
92 FabFactory<FArrayBox> const* factory = nullptr;
93 iMultiFab const* owner_mask = nullptr;
94 iMultiFab const* dirichlet_mask = nullptr;
96 MLNodeLinOp const* linop = nullptr;
97 int verbose = 0;
98 bool throw_exception = false;
99
100 std::unique_ptr<HypreIJIface> hypre_ij;
101
102 // Non-owning references to HYPRE matrix, rhs, and solution data
103 HYPRE_IJMatrix A = nullptr;
104 HYPRE_IJVector b = nullptr;
105 HYPRE_IJVector x = nullptr;
106
107 LayoutData<Int> nnodes_grid;
110 iMultiFab local_node_id;
111 LayoutData<Int> id_offset;
112 MultiFab tmpsoln;
113
114 std::string options_namespace{"hypre"};
115
116public: // for CUDA
123#ifdef AMREX_USE_GPU
126#endif
130 void fill_global_node_id ();
139 static void adjust_singular_matrix (Int const* ncols, Int const* cols, Int const* rows, Real* mat);
141 void loadVectors (MultiFab& soln, const MultiFab& rhs);
143 void getSolution (MultiFab& soln);
144};
145
146}
147
148#endif
Boundary data container that owns masks, boundary values, and metadata.
Problem-domain geometry: maps between index space and physical space.
Reference-counted collection of Boxes.
Definition AMReX_BoxArray.H:681
Calculates the distribution of FABs to MPI processes.
Definition AMReX_DistributionMapping.H:55
An Array of FortranArrayBox(FAB)-like Objects.
Definition AMReX_FabArray.H:383
Abstract factory interface for creating, aliasing, and destroying FAB objects.
Definition AMReX_FabFactory.H:73
Rectangular problem domain geometry.
Definition AMReX_Geometry.H:87
std::conditional_t< sizeof(Int)==4, unsigned int, unsigned long long > AtomicInt
Definition AMReX_HypreNodeLap.H:65
Int fill_local_node_id()
Assign local ids to each owned node.
Definition AMReX_HypreNodeLap.cpp:156
void fill_global_node_id()
Convert local ids to globally unique ids recognized by HYPRE.
Definition AMReX_HypreNodeLap.cpp:253
HypreNodeLap(HypreNodeLap &&)=delete
HypreNodeLap & operator=(HypreNodeLap const &)=delete
HypreNodeLap(const BoxArray &grids_, const DistributionMapping &dmap_, const Geometry &geom_, const FabFactory< FArrayBox > &factory_, const iMultiFab &owner_mask_, const iMultiFab &dirichlet_mask_, MPI_Comm comm_, MLNodeLinOp const *linop_, int verbose_, std::string options_namespace_)
Construct an IJ-based nodal Laplacian mirroring MLNodeLinOp.
Definition AMReX_HypreNodeLap.cpp:12
Int fill_local_node_id_cpu()
CPU fallback local-id fill routine; returns the owned-node count.
Definition AMReX_HypreNodeLap.cpp:215
HYPRE_Int Int
Definition AMReX_HypreNodeLap.H:60
void getSolution(MultiFab &soln)
Copy the solved data soln out of HYPRE and back into AMReX storage.
Definition AMReX_HypreNodeLap.cpp:337
void solve(MultiFab &soln, const MultiFab &rhs, Real rel_tol, Real abs_tol, int max_iter)
Solve the nodal Laplacian using HYPRE's IJ interface.
Definition AMReX_HypreNodeLap.cpp:136
void loadVectors(MultiFab &soln, const MultiFab &rhs)
Copy AMReX solution guess soln and RHS rhs into HYPRE's IJ vectors prior to solving.
Definition AMReX_HypreNodeLap.cpp:294
void setHypreOptionsNamespace(const std::string &ns)
Override the ParmParse namespace used when configuring HYPRE (ns).
Definition AMReX_HypreNodeLap.H:80
Int fill_local_node_id_gpu()
GPU-specific local-id fill routine; returns the owned-node count.
Definition AMReX_HypreNodeLap.cpp:171
void setThrowException(bool t) noexcept
Definition AMReX_HypreNodeLap.H:85
HypreNodeLap(HypreNodeLap const &)=delete
static void adjust_singular_matrix(Int const *ncols, Int const *cols, Int const *rows, Real *mat)
Apply the fix-up HYPRE expects for singular matrices (Dirichlet pinning).
Definition AMReX_HypreNodeLap.cpp:281
a one-thingy-per-box distributed object
Definition AMReX_LayoutData.H:13
Definition AMReX_MLNodeLinOp.H:27
A collection (stored as an array) of FArrayBox objects.
Definition AMReX_MultiFab.H:40
A Collection of IArrayBoxes.
Definition AMReX_iMultiFab.H:34
amrex_real Real
Floating Point Type for Fields.
Definition AMReX_REAL.H:80
int MPI_Comm
Definition AMReX_ccse-mpi.H:51
static constexpr int MPI_COMM_NULL
Definition AMReX_ccse-mpi.H:59
Definition AMReX_Amr.cpp:50
MLNodeLinOpT< MultiFab > MLNodeLinOp
Double precision base class for nodal linear operators.
Definition AMReX_HypreNodeLap.H:26