ideal_gas_mix/MusclHancockPrimMethod.hpp

Go to the documentation of this file.

// Copyright (c) 2020 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_EQUATIONS_IDEAL_GAS_MIX_MUSCL_HANCOCK_PRIM_HPP
#define FUB_EQUATIONS_IDEAL_GAS_MIX_MUSCL_HANCOCK_PRIM_HPP
 
#include "fub/equations/IdealGasMix.hpp"
#include "fub/equations/ideal_gas_mix/HlleMethod.hpp"
 
namespace fub {
namespace ideal_gas {
template <int Rank> struct Primitive {
  double pressure;
  Eigen::Array<double, Rank, 1> velocity;
  double temperature;
  Eigen::Array<double, Eigen::Dynamic, 1> mass_fractions;
};
 
template <int Rank> struct PrimitiveArray {
  Array1d pressure;
  Array<double, Rank> velocity;
  Array1d temperature;
  ArrayXd mass_fractions;
};
 
/// \ingroup FluxMethod
///
/// This is a variation of the Muscl Hancock Method where the reconstruction at
/// the half time level is based on the primitive variables (p, u, T, Y) instead
/// of on conservative variables.
template <int Rank> class MusclHancockPrimitive {
public:
  using Equation = IdealGasMix<Rank>;
  using Complete = ::fub::Complete<Equation>;
  using Conservative = ::fub::Conservative<Equation>;
  using CompleteArray = ::fub::CompleteArray<Equation>;
  using ConservativeArray = ::fub::ConservativeArray<Equation>;
 
  explicit MusclHancockPrimitive(const IdealGasMix<Rank>& equation);
 
  [[nodiscard]] static constexpr int GetStencilWidth() noexcept { return 2; }
 
  /// Returns a stable time step estimate based on HLL signal velocities.
  [[nodiscard]] double ComputeStableDt(span<const Complete, 4> states,
                                       double dx, Direction dir) noexcept;
 
  /// Returns an array of stable time step estimates based on HLL signal
  /// velocities.
  [[nodiscard]] Array1d ComputeStableDt(span<const CompleteArray, 4> states,
                                        Array1d face_fraction,
                                        span<const Array1d, 4> volume_fraction,
                                        double dx, Direction dir) noexcept;
 
  [[nodiscard]] Array1d ComputeStableDt(span<const CompleteArray, 4> states,
                                        double dx, Direction dir) noexcept;
 
  void ComputeNumericFlux(Conservative& flux, span<const Complete, 4> stencil,
                          Duration dt, double dx, Direction dir);
 
  void ComputeNumericFlux(ConservativeArray& flux,
                          span<const CompleteArray, 4> stencil, Duration dt,
                          double dx, Direction dir);
 
  void ComputeNumericFlux(ConservativeArray& flux, Array1d face_fractions,
                          span<const CompleteArray, 4> stencil,
                          span<const Array1d, 4> volume_fractions, Duration dt,
                          double dx, Direction dir);
 
  [[nodiscard]] const Equation& GetEquation() const noexcept {
    return hll_.GetEquation();
  }
  [[nodiscard]] Equation& GetEquation() noexcept { return hll_.GetEquation(); }
 
private:
  using Signals = EinfeldtSignalVelocities<IdealGasMix<Rank>>;
  Hll<IdealGasMix<Rank>, Signals> hll_;
  Primitive<Rank> dpdx;
  Primitive<Rank> dpdt;
  Primitive<Rank> pL;
  Primitive<Rank> pM;
  Primitive<Rank> pR;
  std::array<Complete, 2> stencil_{GetEquation(), GetEquation()};
 
  PrimitiveArray<Rank> dpdx_array_;
  PrimitiveArray<Rank> dpdt_array_;
  PrimitiveArray<Rank> pL_array_;
  PrimitiveArray<Rank> pM_array_;
  PrimitiveArray<Rank> pR_array_;
  std::array<CompleteArray, 2> stencil_array_{GetEquation(), GetEquation()};
};
 
/// \ingroup FluxMethod
template <int Rank>
using MusclHancockPrimMethod = ::fub::FluxMethod<MusclHancockPrimitive<Rank>>;
 
extern template class MusclHancockPrimitive<1>;
extern template class MusclHancockPrimitive<2>;
extern template class MusclHancockPrimitive<3>;
} // namespace ideal_gas
 
extern template class FluxMethod<ideal_gas::MusclHancockPrimitive<1>>;
extern template class FluxMethod<ideal_gas::MusclHancockPrimitive<2>>;
extern template class FluxMethod<ideal_gas::MusclHancockPrimitive<3>>;
 
}
 
#endif