Finite Volume Solver  prototype
A framework to build finite volume solvers for the AG Klein at the Freie Universität Berlin.
AMReX/boundary_condition/ReflectiveBoundary.hpp
Go to the documentation of this file.
1 // Copyright (c) 2019 Maikel Nadolski
2 //
3 // Permission is hereby granted, free of charge, to any person obtaining a copy
4 // of this software and associated documentation files (the "Software"), to deal
5 // in the Software without restriction, including without limitation the rights
6 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7 // copies of the Software, and to permit persons to whom the Software is
8 // furnished to do so, subject to the following conditions:
9 //
10 // The above copyright notice and this permission notice shall be included in
11 // all copies or substantial portions of the Software.
12 //
13 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19 // SOFTWARE.
20 
21 #ifndef FUB_AMREX_BOUNDARY_CONDITION_REFLECTIVE_BOUNDARY_HPP
22 #define FUB_AMREX_BOUNDARY_CONDITION_REFLECTIVE_BOUNDARY_HPP
23 
24 #include "fub/AMReX/ForEachFab.hpp"
27 #include "fub/Execution.hpp"
29 
30 namespace fub::amrex {
31 
32 /// \ingroup BoundaryCondition
33 ///
34 template <typename Tag, typename Equation> class ReflectiveBoundary {
35 public:
36  ReflectiveBoundary(const Equation& equation, Direction dir, int side)
37  : ReflectiveBoundary(Tag(), equation, dir, side) {}
38  ReflectiveBoundary(Tag, const Equation& equation, Direction dir, int side);
39 
40  void FillBoundary(::amrex::MultiFab& mf, const GriddingAlgorithm& gridding,
41  int level);
42 
43  void FillBoundary(::amrex::MultiFab& mf, const GriddingAlgorithm& gridding,
44  int level, Direction dir);
45 
46  void FillBoundary(::amrex::MultiFab& mf, const ::amrex::Geometry& geom);
47 
48 private:
51  int side_;
52 };
53 
54 /// \ingroup BoundaryCondition
55 ///
56 template <typename Equation>
58  ->ReflectiveBoundary<execution::SequentialTag, Equation>;
59 
60 template <typename Tag, typename Equation>
62  const Equation& equation,
63  Direction dir, int side)
64  : implementation_{::fub::ReflectiveBoundary<Equation>(equation)}, dir_{dir},
65  side_{side} {}
66 
67 template <typename Tag, typename Equation>
69  ::amrex::MultiFab& mf, const ::amrex::Geometry& geom) {
70  const int ngrow = mf.nGrow(int(dir_));
71  ::amrex::Box grown_box = geom.growNonPeriodicDomain(ngrow);
72  ::amrex::BoxList boundaries =
73  ::amrex::complementIn(grown_box, ::amrex::BoxList{geom.Domain()});
74  if (boundaries.isEmpty()) {
75  return;
76  }
77  ForEachFab(Tag(), mf, [&](const ::amrex::MFIter& mfi) {
78  ::amrex::FArrayBox& fab = mf[mfi];
79  for (const ::amrex::Box& boundary : boundaries) {
80  ::amrex::Box shifted =
81  ::amrex::shift(boundary, int(dir_), GetSign(side_) * ngrow);
82  if (!geom.Domain().intersects(shifted)) {
83  continue;
84  }
85  ::amrex::Box box_to_fill = mfi.growntilebox() & boundary;
86  if (!box_to_fill.isEmpty()) {
87  auto states = MakeView<Complete<Equation>>(
88  fab, implementation_->GetEquation(), mfi.growntilebox());
89  auto box = AsIndexBox<Equation::Rank()>(box_to_fill);
90  implementation_->FillBoundary(states, box, dir_, side_);
91  }
92  }
93  });
94 }
95 
96 template <typename Tag, typename Equation>
98  ::amrex::MultiFab& mf, const GriddingAlgorithm& gridding, int level) {
99  FillBoundary(mf, gridding.GetPatchHierarchy().GetGeometry(level));
100 }
101 
102 template <typename Tag, typename Equation>
104  ::amrex::MultiFab& mf, const GriddingAlgorithm& gridding, int level,
105  Direction dir) {
106  if (dir == dir_) {
107  FillBoundary(mf, gridding.GetPatchHierarchy().GetGeometry(level));
108  }
109 }
110 
111 template <typename Tag, typename Equation>
113  ->ReflectiveBoundary<Tag, Equation>;
114 
115 } // namespace fub::amrex
116 
117 #endif
This class modifies and initializes a PatchLevel in a PatchHierarchy.
Definition: AMReX/GriddingAlgorithm.hpp:60
PatchHierarchy & GetPatchHierarchy() noexcept
Definition: AMReX/GriddingAlgorithm.hpp:108
const ::amrex::Geometry & GetGeometry(int level) const
Returns a Geometry object for a specified level.
Definition: AMReX/boundary_condition/ReflectiveBoundary.hpp:34
void FillBoundary(::amrex::MultiFab &mf, const GriddingAlgorithm &gridding, int level, Direction dir)
Definition: AMReX/boundary_condition/ReflectiveBoundary.hpp:103
ReflectiveBoundary(const Equation &equation, Direction dir, int side)
Definition: AMReX/boundary_condition/ReflectiveBoundary.hpp:36
Local< Tag, ::fub::ReflectiveBoundary< Equation > > implementation_
Definition: AMReX/boundary_condition/ReflectiveBoundary.hpp:49
ReflectiveBoundary(Tag, const Equation &equation, Direction dir, int side)
Definition: AMReX/boundary_condition/ReflectiveBoundary.hpp:61
Direction dir_
Definition: AMReX/boundary_condition/ReflectiveBoundary.hpp:50
void FillBoundary(::amrex::MultiFab &mf, const ::amrex::Geometry &geom)
Definition: AMReX/boundary_condition/ReflectiveBoundary.hpp:68
void FillBoundary(::amrex::MultiFab &mf, const GriddingAlgorithm &gridding, int level)
Definition: AMReX/boundary_condition/ReflectiveBoundary.hpp:97
int side_
Definition: AMReX/boundary_condition/ReflectiveBoundary.hpp:51
ReflectiveBoundary(const Equation &, Direction, int) -> ReflectiveBoundary< execution::SequentialTag, Equation >
void ForEachFab(Tag, const ::amrex::FabArrayBase &fabarray, F function)
Iterate through all local FArrayBox objects in a MultiFab.
Definition: ForEachFab.hpp:34
The amrex namespace.
Definition: AverageState.hpp:33
std::decay_t< decltype(std::declval< T >().GetEquation())> Equation
A template typedef to detect the member function.
Definition: Meta.hpp:59
The fub namespace.
Definition: AnyBoundaryCondition.hpp:31
int GetSign(int side)
Definition: AnyBoundaryCondition.hpp:104
Direction
This is a type safe type to denote a dimensional split direction.
Definition: Direction.hpp:30
IndexBox< Rank > Box(const BasicView< State, Layout, Rank > &view)
Definition: State.hpp:486
typename detail::LocalType< Tag, T >::type Local
Definition: Execution.hpp:56
Definition: Execution.hpp:30