MultiBlockBoundary.hpp

Go to the documentation of this file.

// Copyright (c) 2019 Maikel Nadolski
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
 
#ifndef FUB_AMREX_MULTI_BLOCK_BOUNDARY_HPP
#define FUB_AMREX_MULTI_BLOCK_BOUNDARY_HPP
 
#include "fub/AMReX/boundary_condition/PressureValveBoundary.hpp"
#include "fub/Direction.hpp"
#include "fub/Duration.hpp"
#include "fub/PatchDataView.hpp"
#include "fub/equations/IdealGasMix.hpp"
 
#include <AMReX.H>
#include <AMReX_MultiFab.H>
 
#include <boost/log/sources/severity_channel_logger.hpp>
#include <boost/log/trivial.hpp>
 
#include <vector>
 
namespace fub::amrex {
 
class MultiBlockGriddingAlgorithm;
class PatchHierarchy;
class GriddingAlgorithm;
 
namespace cutcell {
class PatchHierarchy;
class GriddingAlgorithm;
} // namespace cutcell
 
struct BlockEntry {
  std::size_t id;
  ::amrex::Box mirror_box;
};
 
struct BlockConnection {
  BlockEntry tube;
  BlockEntry plenum;
  Direction direction;
  int side;
  int ghost_cell_width;
};
 
/// \ingroup BoundaryCondition
///
class MultiBlockBoundary {
public:
  static constexpr int Plenum_Rank = AMREX_SPACEDIM;
  static constexpr int Tube_Rank = 1;
 
  /// Constructs coupled boundary states by pre computing mirror and ghost
  /// states for each of the specified domains.
  ///
  /// This function might grow the specified mirror boxes to an extent which is
  /// required to fulfill the specified ghost cell width requirements.
  MultiBlockBoundary(const std::string& name,
                     const MultiBlockGriddingAlgorithm& gridding,
                     const BlockConnection& connection, int gcw,
                     const FlameMasterReactor& reactor, int level);
 
  MultiBlockBoundary(const std::string& name,
                     const MultiBlockGriddingAlgorithm& gridding,
                     const BlockConnection& connection, int gcw,
                     const FlameMasterReactor& reactor, int level,
                     std::shared_ptr<PressureValve> valve);
 
  /// Constructs coupled boundary states by pre computing mirror and ghost
  /// states for each of the specified domains.
  ///
  /// This function might grow the specified mirror boxes to an extent which is
  /// required to fulfill the specified ghost cell width requirements.
  MultiBlockBoundary(const MultiBlockGriddingAlgorithm& gridding,
                     const BlockConnection& connection, int gcw,
                     const FlameMasterReactor& reactor, int level);
 
  MultiBlockBoundary(const MultiBlockBoundary& other);
  MultiBlockBoundary& operator=(const MultiBlockBoundary& other);
 
  MultiBlockBoundary(MultiBlockBoundary&& other) = default;
  MultiBlockBoundary& operator=(MultiBlockBoundary&& other) = default;
 
  /// Precompute Boundary states for each domain.
  ///
  /// Subsequent calls to FillBoundary will use these computed boundary states.
  ///
  /// \param[in] plenum  The higher dimensional patch hierarchy with geometry
  /// information. States here will be conservatively averaged and projected
  /// onto a one-dimesnional space.
  ///
  /// \param[in] tube The low dimensional tube data.
  void ComputeBoundaryData(const cutcell::PatchHierarchy& plenum,
                           const PatchHierarchy& tube);
 
  /// Assuming that mf represents a MultiFab living in the higher dimensional
  /// plenum simulation its ghost layer will be filled with data from the tube
  /// simulation.
  void FillBoundary(::amrex::MultiFab& mf,
                    const cutcell::GriddingAlgorithm& gridding, int level);
 
  void FillBoundary(::amrex::MultiFab& mf,
                    const cutcell::GriddingAlgorithm& gridding, int level,
                    Direction dir) {
    if (dir == dir_) {
      FillBoundary(mf, gridding, level);
    }
  }
 
  /// Assuming that mf represents a MultiFab living in the one dimensional tube
  /// simulation its ghost layer will be filled with data from the plenum
  /// simulation.
  void FillBoundary(::amrex::MultiFab& mf, const GriddingAlgorithm& gridding,
                    int level);
 
  void FillBoundary(::amrex::MultiFab& mf, const GriddingAlgorithm& gridding,
                    int level, Direction dir) {
    if (dir == dir_) {
      FillBoundary(mf, gridding, level);
    }
  }
 
  const std::shared_ptr<PressureValve>& GetValve() const noexcept;
 
private:
  using logger_type = boost::log::sources::severity_channel_logger<
      boost::log::trivial::severity_level>;
  logger_type log_;
 
  std::shared_ptr<PressureValve> valve_{};
 
  IdealGasMix<Plenum_Rank> plenum_equation_;
  IdealGasMix<Tube_Rank> tube_equation_;
 
  ::amrex::Box plenum_mirror_box_{};
  ::amrex::Box tube_mirror_box_{};
 
  std::unique_ptr<::amrex::FArrayBox> plenum_mirror_data_{};
  std::unique_ptr<::amrex::FArrayBox> tube_ghost_data_{};
 
  std::unique_ptr<::amrex::FArrayBox> tube_mirror_data_{};
  std::unique_ptr<::amrex::FArrayBox> plenum_ghost_data_{};
 
  Direction dir_{};
  int side_{};
  int level_{};
  int gcw_{};
};
 
} // namespace fub::amrex
 
#endif