Block-Structured AMR Software Framework
Loading...
Searching...
No Matches
AMReX_EB2.H
Go to the documentation of this file.
1#ifndef AMREX_EB2_H_
2#define AMREX_EB2_H_
3#include <AMReX_Config.H>
4
5#include <AMReX_Geometry.H>
6#include <AMReX_Vector.H>
8#include <AMReX_EB2_Level.H>
9
10#include <cmath>
11#include <algorithm>
12#include <memory>
13#include <type_traits>
14#include <string>
15
16namespace amrex::EB2 {
17
19extern AMREX_EXPORT int max_grid_size;
21
23void Initialize ();
25void Finalize ();
26
28{
29public:
30 virtual ~IndexSpace ();
31
32 IndexSpace () noexcept = default;
33 IndexSpace (IndexSpace const&) = delete;
34 IndexSpace (IndexSpace &&) = delete;
35 IndexSpace& operator= (IndexSpace const&) = delete;
36 IndexSpace& operator= (IndexSpace &&) = delete;
37
38 // This function will take the ownership of the IndexSpace
39 // pointer, and put it on the top of the stack (i.e., back of the
40 // vector). If the pointer is already in the stack, it will be
41 // moved to the top.
42 static void push (IndexSpace* ispace);
43
44 static void push (std::unique_ptr<IndexSpace> ispace);
45
46 // This erases `ispace` from the stack.
47 static void erase (IndexSpace* ispace);
48
49 static void pop () noexcept { m_instance.pop_back(); }
50 static void clear () noexcept { m_instance.clear(); }
51 static IndexSpace& top () {
53 "Have you forgot to call EB2::build? It's required even if the geometry is all regular.");
54 return *(m_instance.back());
55 }
56 static bool empty () noexcept { return m_instance.empty(); }
57 static int size () noexcept { return static_cast<int>(m_instance.size()); }
58
59 [[nodiscard]] virtual const Level& getLevel (const Geometry & geom) const = 0;
60 [[nodiscard]] virtual const Geometry& getGeometry (const Box& domain) const = 0;
61 [[nodiscard]] virtual const Box& coarsestDomain () const = 0;
62 virtual void addFineLevels (int num_new_fine_levels) = 0;
63 virtual void addRegularCoarseLevels (int num_new_coarse_levels) = 0;
64
65 virtual void setShift (int, int) {
66 amrex::Abort("IndexSpace::setShift: not supported");
67 }
68
70 virtual void buildAllFCData () {
71 amrex::Abort("EB2::BuildFC: face-centered data are not supported for this IndexSpace");
72 }
73
74protected:
76};
77
79const IndexSpace* TopIndexSpaceIfPresent () noexcept;
80//! Return the top IndexSpace if one has been built (nullptr otherwise).
81inline const IndexSpace* TopIndexSpace () noexcept { return TopIndexSpaceIfPresent(); }
82
83template <typename G>
85 : public IndexSpace
86{
87public:
88
89 IndexSpaceImp (const G& gshop, const Geometry& geom,
90 int required_coarsening_level, int max_coarsening_level,
91 int ngrow, bool build_coarse_level_by_coarsening,
92 bool extend_domain_face, int num_coarsen_opt);
93
94 IndexSpaceImp (const G& gshop, const Vector<Geometry>& geom,
95 int ngrow,
96 bool extend_domain_face, int num_coarsen_opt);
97
100 void operator= (IndexSpaceImp<G> const&) = delete;
101 void operator= (IndexSpaceImp<G> &&) = delete;
102
103 ~IndexSpaceImp () override = default;
104
105 [[nodiscard]] const Level& getLevel (const Geometry& geom) const final;
106 [[nodiscard]] const Geometry& getGeometry (const Box& dom) const final;
107 [[nodiscard]] const Box& coarsestDomain () const final {
108 return m_geom.back().Domain();
109 }
110 void addFineLevels (int num_new_fine_levels) final;
111 void addRegularCoarseLevels (int num_new_coarse_levels) final;
112
113 void setShift (int direction, int ncells) override;
114
115 void buildAllFCData () override;
116
117 using F = typename G::FunctionType;
119private:
120
121 G m_gshop;
122 bool m_build_coarse_level_by_coarsening;
123 bool m_extend_domain_face;
124 int m_num_coarsen_opt;
125
126 Vector<GShopLevel<G> > m_gslevel;
127 Vector<Geometry> m_geom;
128 Vector<Box> m_domain;
129 Vector<int> m_ngrow;
130};
131
133
139bool ExtendDomainFace ();
140
149int NumCoarsenOpt ();
150
160
163 * \param extend_domain_face Whether to extrapolate the EB description from the domain face to the outside of the domain (defaults to EB2::ExtendDomainFace / runtime param `eb2.extend_domain_face`).
164 * \param num_coarsen_opt Number of coarse probes to try (defaults to EB2::NumCoarsenOpt /
165 * runtime `eb2.num_coarsen_opt`) before rebuilding at full resolution.
166 */
167template <typename G>
168void
169Build (const G& gshop, const Geometry& geom,
170 int required_coarsening_level, int max_coarsening_level,
171 int ngrow = 4, bool build_coarse_level_by_coarsening = true,
172 bool extend_domain_face = ExtendDomainFace(),
173 int num_coarsen_opt = NumCoarsenOpt())
174{
175 BL_PROFILE("EB2::Initialize()");
176 IndexSpace::push(std::make_unique<IndexSpaceImp<G>>
177 (gshop, geom, required_coarsening_level, max_coarsening_level,
178 ngrow, build_coarse_level_by_coarsening,extend_domain_face,
179 num_coarsen_opt));
180}
181
193template <typename G>
194void
195Build (const G& gshop, Vector<Geometry> geom,
196 int ngrow = 4,
197 bool extend_domain_face = ExtendDomainFace(),
198 int num_coarsen_opt = NumCoarsenOpt())
199{
200 BL_PROFILE("EB2::Initialize()");
201 std::sort(geom.begin(), geom.end(), [] (Geometry const& a, Geometry const& b) { return a.Domain().numPts() > b.Domain().numPts(); });
202 IndexSpace::push(std::make_unique<IndexSpaceImp<G>>
203 (gshop, geom, ngrow, extend_domain_face, num_coarsen_opt));
204}
205
213
216 * \param max_coarsening_level Upper bound on the number of coarsenings we attempt;
217 * it is safe if fewer levels are actually realizable.
218 * \param ngrow Number of EB grow cells to build (default 4).
219 * \param build_coarse_level_by_coarsening When true, coarsen from finer levels; otherwise rebuild.
220 * \param extend_domain_face Whether to extrapolate the EB description beyond the domain by extending from the domain face.
221 * \param num_coarsen_opt Number of coarse probes to try (defaults to EB2::NumCoarsenOpt /
222 * runtime `eb2.num_coarsen_opt`) before rebuilding at full resolution.
223 * \param support_mvmc Whether to build multi-valued multi-cut support. (Only honored when
224 * `eb2.geom_type` is `stl`; other geometries ignore it and emit a warning.
225 * Even for STL, this is not supported yet.)
226 */
227void Build (const Geometry& geom,
228 int required_coarsening_level,
229 int max_coarsening_level,
230 int ngrow = 4,
231 bool build_coarse_level_by_coarsening = true,
232 bool extend_domain_face = ExtendDomainFace(),
233 int num_coarsen_opt = NumCoarsenOpt(),
234 bool support_mvmc = false);
235
242void BuildMultiValuedMultiCut (const Geometry& geom,
243 int required_coarsening_level,
244 int max_coarsening_level,
245 int ngrow = 4,
246 bool build_coarse_level_by_coarsening = true,
247 bool extend_domain_face = ExtendDomainFace(),
248 int num_coarsen_opt = NumCoarsenOpt());
249
262void BuildFromChkptFile (std::string const& fname,
263 const Geometry& geom,
264 int required_coarsening_level,
265 int max_coarsening_level,
266 int ngrow = 4,
267 bool build_coarse_level_by_coarsening = true,
268 bool extend_domain_face = ExtendDomainFace());
269
271int maxCoarseningLevel (const Geometry& geom);
273int maxCoarseningLevel (IndexSpace const* ebis, const Geometry& geom);
274
276void addFineLevels (int num_new_fine_levels);
277
279void addRegularCoarseLevels (int num_new_coarse_levels);
280
291void BuildFC ();
292
293}
294
295#endif
#define BL_PROFILE(a)
Definition AMReX_BLProfiler.H:593
#define AMREX_ALWAYS_ASSERT_WITH_MESSAGE(EX, MSG)
Definition AMReX_BLassert.H:49
#define AMREX_EXPORT
Definition AMReX_Extension.H:222
Problem-domain geometry: maps between index space and physical space.
Definition AMReX_EB2.H:86
typename G::FunctionType F
Definition AMReX_EB2.H:117
const Box & coarsestDomain() const final
Definition AMReX_EB2.H:107
const Level & getLevel(const Geometry &geom) const final
Definition AMReX_EB2.H:107
~IndexSpaceImp() override=default
void addFineLevels(int num_new_fine_levels) final
Definition AMReX_EB2.H:129
IndexSpaceImp(IndexSpaceImp< G > const &)=delete
void addRegularCoarseLevels(int num_new_coarse_levels) final
Definition AMReX_EB2.H:163
const Geometry & getGeometry(const Box &dom) const final
Definition AMReX_EB2.H:118
IndexSpaceImp(IndexSpaceImp< G > &&)=delete
void operator=(IndexSpaceImp< G > const &)=delete
IndexSpaceImp(const G &gshop, const Geometry &geom, int required_coarsening_level, int max_coarsening_level, int ngrow, bool build_coarse_level_by_coarsening, bool extend_domain_face, int num_coarsen_opt)
Definition AMReX_EB2.H:11
void setShift(int direction, int ncells) override
Definition AMReX_EB2.H:216
void buildAllFCData() override
Build face-centered EB data for every face direction.
Definition AMReX_EB2.H:227
Definition AMReX_EB2.H:28
virtual const Geometry & getGeometry(const Box &domain) const =0
virtual const Level & getLevel(const Geometry &geom) const =0
IndexSpace() noexcept=default
virtual void addFineLevels(int num_new_fine_levels)=0
static void pop() noexcept
Definition AMReX_EB2.H:49
static void push(IndexSpace *ispace)
Definition AMReX_EB2.cpp:70
virtual void buildAllFCData()
Build face-centered EB data for every face direction.
Definition AMReX_EB2.H:70
virtual ~IndexSpace()
Definition AMReX_EB2.cpp:64
static bool empty() noexcept
Definition AMReX_EB2.H:56
virtual void addRegularCoarseLevels(int num_new_coarse_levels)=0
static Vector< std::unique_ptr< IndexSpace > > m_instance
Definition AMReX_EB2.H:75
static int size() noexcept
Definition AMReX_EB2.H:57
virtual const Box & coarsestDomain() const =0
static void clear() noexcept
Definition AMReX_EB2.H:50
virtual void setShift(int, int)
Definition AMReX_EB2.H:65
static IndexSpace & top()
Definition AMReX_EB2.H:51
static void erase(IndexSpace *ispace)
Definition AMReX_EB2.cpp:89
Definition AMReX_EB2_Level.H:43
Rectangular problem domain geometry.
Definition AMReX_Geometry.H:87
This class is a thin wrapper around std::vector. Unlike vector, Vector::operator[] provides bound che...
Definition AMReX_Vector.H:29
Definition AMReX_FabArrayBase.H:38
int NumCoarsenOpt()
Definition AMReX_EB2.cpp:59
void addRegularCoarseLevels(int num_new_coarse_levels)
Add num_new_coarse_levels regular levels below the current coarsest level.
Definition AMReX_EB2.cpp:270
bool ExtendDomainFace()
Definition AMReX_EB2.cpp:54
int maxCoarseningLevel(const Geometry &geom)
Return the maximum coarsening level supported for given geom.
Definition AMReX_EB2.cpp:304
void Initialize()
Initialize EB2’s global state (call before constructing geometries by amrex::Initialize).
Definition AMReX_EB2.cpp:36
void BuildMultiValuedMultiCut(const Geometry &geom, int required_coarsening_level, int max_coarsening_level, int ngrow, bool build_coarse_level_by_coarsening, bool a_extend_domain_face, int a_num_coarsen_opt)
Build EB geometry dedicated to multi-valued multi-cut support.
Definition AMReX_EB2.cpp:320
void addFineLevels(int num_new_fine_levels)
Add num_new_fine_levels to the EB hierarchy.
Definition AMReX_EB2.cpp:261
const IndexSpace * TopIndexSpace() noexcept
Return the top IndexSpace if one has been built (nullptr otherwise).
Definition AMReX_EB2.H:81
void Build(const Geometry &geom, int required_coarsening_level, int max_coarsening_level, int ngrow, bool build_coarse_level_by_coarsening, bool a_extend_domain_face, int a_num_coarsen_opt, bool support_mvmc)
Build EB geometry using the runtime-configured EB2 geometry type.
Definition AMReX_EB2.cpp:107
const IndexSpace * TopIndexSpaceIfPresent() noexcept
Return the top IndexSpace if one has been built (nullptr otherwise).
Definition AMReX_EB2.cpp:99
void BuildFC()
Build face-centered EB data for every face direction.
Definition AMReX_EB2.cpp:331
void BuildFromChkptFile(std::string const &fname, const Geometry &geom, int required_coarsening_level, int max_coarsening_level, int ngrow, bool build_coarse_level_by_coarsening, bool a_extend_domain_face)
Rebuild an IndexSpace from a checkpoint file.
Definition AMReX_EB2.cpp:279
void Finalize()
Tear down EB2 global resources (called automatically at shutdown).
Definition AMReX_EB2.cpp:46
BoxND< 3 > Box
Box is an alias for amrex::BoxND instantiated with AMREX_SPACEDIM.
Definition AMReX_BaseFwd.H:35
void Abort(const std::string &msg)
Print a fatal-error message to stderr and abort execution.
Definition AMReX.cpp:239