From 7bbda7ddc6e94ce0a8dafc57bf3b2d24b02e32ed Mon Sep 17 00:00:00 2001 From: Francois Hebert Date: Thu, 28 Feb 2019 14:08:58 -0800 Subject: [PATCH] Split Minmod troubled cell indicator into new file --- .../SlopeLimiters/CMakeLists.txt | 1 + .../SlopeLimiters/Minmod.cpp | 154 +------------ .../SlopeLimiters/Minmod.hpp | 10 - .../SlopeLimiters/MinmodTci.cpp | 215 ++++++++++++++++++ .../SlopeLimiters/MinmodTci.hpp | 50 ++++ 5 files changed, 277 insertions(+), 153 deletions(-) create mode 100644 src/Evolution/DiscontinuousGalerkin/SlopeLimiters/MinmodTci.cpp create mode 100644 src/Evolution/DiscontinuousGalerkin/SlopeLimiters/MinmodTci.hpp diff --git a/src/Evolution/DiscontinuousGalerkin/SlopeLimiters/CMakeLists.txt b/src/Evolution/DiscontinuousGalerkin/SlopeLimiters/CMakeLists.txt index 8b4ccd7284700..c4c3a0d68d2e0 100644 --- a/src/Evolution/DiscontinuousGalerkin/SlopeLimiters/CMakeLists.txt +++ b/src/Evolution/DiscontinuousGalerkin/SlopeLimiters/CMakeLists.txt @@ -5,6 +5,7 @@ set(LIBRARY SlopeLimiters) set(LIBRARY_SOURCES Minmod.cpp + MinmodTci.cpp MinmodType.cpp ) diff --git a/src/Evolution/DiscontinuousGalerkin/SlopeLimiters/Minmod.cpp b/src/Evolution/DiscontinuousGalerkin/SlopeLimiters/Minmod.cpp index b08655b47cede..82aca93dbf31e 100644 --- a/src/Evolution/DiscontinuousGalerkin/SlopeLimiters/Minmod.cpp +++ b/src/Evolution/DiscontinuousGalerkin/SlopeLimiters/Minmod.cpp @@ -3,8 +3,6 @@ #include "Evolution/DiscontinuousGalerkin/SlopeLimiters/Minmod.hpp" -#include -#include #include #include "DataStructures/DataVector.hpp" @@ -12,36 +10,12 @@ #include "Domain/Direction.hpp" #include "Domain/DirectionMap.hpp" #include "Domain/Mesh.hpp" // IWYU pragma: keep -#include "Domain/Side.hpp" -#include "NumericalAlgorithms/LinearOperators/Linearize.hpp" -#include "Utilities/ConstantExpressions.hpp" +#include "Evolution/DiscontinuousGalerkin/SlopeLimiters/MinmodTci.hpp" #include "Utilities/GenerateInstantiations.hpp" -#include "Utilities/MakeArray.hpp" namespace SlopeLimiters { namespace Minmod_detail { -MinmodResult minmod_tvbm(const double a, const double b, const double c, - const double tvbm_scale) noexcept { - if (fabs(a) <= tvbm_scale) { - return {a, false}; - } - if ((std::signbit(a) == std::signbit(b)) and - (std::signbit(a) == std::signbit(c))) { - // The if/else group below could be more simply written as - // std::copysign(std::min({fabs(a), fabs(b), fabs(c)}), a); - // however, by separating different cases, we gain the ability to - // distinguish whether or not the limiter activated. - if (fabs(a) <= fabs(b) and fabs(a) <= fabs(c)) { - return {a, false}; - } else { - return {std::copysign(std::min(fabs(b), fabs(c)), a), true}; - } - } else { - return {0.0, true}; - } -} - // Implements the minmod limiter for one Tensor at a time. template bool limit_one_tensor( @@ -75,19 +49,6 @@ bool limit_one_tensor( const bool using_linear_limiter_on_non_linear_mesh = minmod_type_is_linear and not mesh_is_linear; - const double tvbm_scale = [&tvbm_constant, &element_size ]() noexcept { - const double max_h = - *std::max_element(element_size.begin(), element_size.end()); - return tvbm_constant * square(max_h); - } - (); - - // Results from SpECTRE paper (https://arxiv.org/abs/1609.00098) used a - // max_slope_factor a factor of 2.0 too small, so that LambdaPi1 behaved - // like MUSCL, and MUSCL was even more dissipative. - const double max_slope_factor = - (minmod_type == SlopeLimiters::MinmodType::Muscl) ? 1.0 : 2.0; - // In each direction, average the size of all different neighbors in that // direction. Note that only the component of neighor_size that is normal // to the face is needed (and, therefore, computed). Note that this average @@ -123,10 +84,8 @@ bool limit_one_tensor( bool some_component_was_limited = false; for (auto iter = tensor_begin.get(); iter != tensor_end.get(); ++iter) { - DataVector& u = *iter; - const double u_mean = mean_value(u, mesh); - const auto iter_offset = std::distance(tensor_begin.get(), iter); + // In each direction, average the mean of the `iter` tensor component over // all different neighbors in that direction. This produces one effective // neighbor per direction. @@ -159,105 +118,14 @@ bool limit_one_tensor( } (); - const auto difference_to_neighbor = [ - &u_mean, &element, &element_size, &effective_neighbor_means, & - effective_neighbor_sizes - ](const size_t dim, const Side& side) noexcept { - const auto& externals = element.external_boundaries(); - const auto dir = Direction(dim, side); - const bool has_neighbors = (externals.find(dir) == externals.end()); - if (has_neighbors) { - const double neighbor_size = effective_neighbor_sizes.at(dir); - const double neighbor_mean = effective_neighbor_means.at(dir); - - // Compute an effective element-center-to-neighbor-center distance - // that accounts for the possibility of different refinement levels - // or discontinuous maps (e.g., at Block boundaries). Treated naively, - // these domain features can make a smooth solution appear to be - // non-smooth in the logical coordinates, which could potentially lead - // to the limiter triggering erroneously. This effective distance is - // used to scale the difference in the means, so that a linear function - // at a refinement or Block boundary will still appear smooth to the - // limiter. The factor is normalized to be 1.0 on a uniform grid. - // Note that this is not "by the book" Minmod, but an attempt to - // generalize Minmod to work on non-uniform grids. - const double distance_factor = - 0.5 * (1.0 + neighbor_size / gsl::at(element_size, dim)); - return (side == Side::Lower ? -1.0 : 1.0) * (neighbor_mean - u_mean) / - distance_factor; - } else { - return 0.0; - } - }; - - // The LambdaPiN limiter allows high-order solutions to escape limiting if - // the boundary values are not too different from the mean value: - if (minmod_type == SlopeLimiters::MinmodType::LambdaPiN) { - bool u_needs_limiting = false; - for (size_t d = 0; d < VolumeDim; ++d) { - const double u_lower = - mean_value_on_boundary(&(gsl::at(*boundary_buffer, d)), - gsl::at(volume_and_slice_indices, d).first, - u, mesh, d, Side::Lower); - const double u_upper = - mean_value_on_boundary(&(gsl::at(*boundary_buffer, d)), - gsl::at(volume_and_slice_indices, d).second, - u, mesh, d, Side::Upper); - const double diff_lower = difference_to_neighbor(d, Side::Lower); - const double diff_upper = difference_to_neighbor(d, Side::Upper); - - // Results from SpECTRE paper (https://arxiv.org/abs/1609.00098) used - // minmod_tvbm(..., 0.0), rather than minmod_tvbm(..., tvbm_scale) - const double v_lower = - u_mean - - minmod_tvbm(u_mean - u_lower, diff_lower, diff_upper, tvbm_scale) - .value; - const double v_upper = - u_mean + - minmod_tvbm(u_upper - u_mean, diff_lower, diff_upper, tvbm_scale) - .value; - // Value of epsilon from Hesthaven & Warburton, Chapter 5, in the - // SlopeLimitN.m code sample. - const double eps = 1.e-8; - if (fabs(v_lower - u_lower) > eps or fabs(v_upper - u_upper) > eps) { - u_needs_limiting = true; - break; - } - } - - if (not u_needs_limiting) { - // Skip the limiting step for this tensor component - continue; - } - } - - linearize(u_lin_buffer, u, mesh); - bool reduce_slope = false; - auto u_limited_slopes = make_array(0.0); - - for (size_t d = 0; d < VolumeDim; ++d) { - const double u_lower = - mean_value_on_boundary(&(gsl::at(*boundary_buffer, d)), - gsl::at(volume_and_slice_indices, d).first, - *u_lin_buffer, mesh, d, Side::Lower); - const double u_upper = - mean_value_on_boundary(&(gsl::at(*boundary_buffer, d)), - gsl::at(volume_and_slice_indices, d).second, - *u_lin_buffer, mesh, d, Side::Upper); - - // Divide by element's width (2.0 in logical coordinates) to get a slope - const double local_slope = 0.5 * (u_upper - u_lower); - const double upper_slope = 0.5 * difference_to_neighbor(d, Side::Upper); - const double lower_slope = 0.5 * difference_to_neighbor(d, Side::Lower); - - const MinmodResult& result = - minmod_tvbm(local_slope, max_slope_factor * upper_slope, - max_slope_factor * lower_slope, tvbm_scale); - gsl::at(u_limited_slopes, d) = result.value; - if (result.activated) { - reduce_slope = true; - } - } + DataVector& u = *iter; + double u_mean; + std::array u_limited_slopes{}; + const bool reduce_slope = troubled_cell_indicator( + make_not_null(&u_mean), make_not_null(&u_limited_slopes), u_lin_buffer, + boundary_buffer, minmod_type, tvbm_constant, u, element, mesh, + element_size, effective_neighbor_means, effective_neighbor_sizes, + volume_and_slice_indices); if (reduce_slope or using_linear_limiter_on_non_linear_mesh) { u = u_mean; @@ -266,7 +134,7 @@ bool limit_one_tensor( } some_component_was_limited = true; } - } + } // end for loop over tensor components return some_component_was_limited; } diff --git a/src/Evolution/DiscontinuousGalerkin/SlopeLimiters/Minmod.hpp b/src/Evolution/DiscontinuousGalerkin/SlopeLimiters/Minmod.hpp index dbfc00cef7b52..b3415bf2d8f17 100644 --- a/src/Evolution/DiscontinuousGalerkin/SlopeLimiters/Minmod.hpp +++ b/src/Evolution/DiscontinuousGalerkin/SlopeLimiters/Minmod.hpp @@ -65,16 +65,6 @@ struct SizeOfElement; namespace SlopeLimiters { namespace Minmod_detail { -// Encodes the return status of the minmod_tvbm function. -struct MinmodResult { - const double value; - const bool activated; -}; - -// The TVBM-corrected minmod function, see e.g. Cockburn reference Eq. 2.26. -MinmodResult minmod_tvbm(double a, double b, double c, - double tvbm_scale) noexcept; - // Implements the minmod limiter for one Tensor. // // The interface is designed to erase the tensor structure information, because diff --git a/src/Evolution/DiscontinuousGalerkin/SlopeLimiters/MinmodTci.cpp b/src/Evolution/DiscontinuousGalerkin/SlopeLimiters/MinmodTci.cpp new file mode 100644 index 0000000000000..2afeb70ea6e21 --- /dev/null +++ b/src/Evolution/DiscontinuousGalerkin/SlopeLimiters/MinmodTci.cpp @@ -0,0 +1,215 @@ +// Distributed under the MIT License. +// See LICENSE.txt for details. + +#include "Evolution/DiscontinuousGalerkin/SlopeLimiters/MinmodTci.hpp" + +#include +#include +#include +#include + +#include "DataStructures/DataVector.hpp" // IWYU pragma: keep +#include "Domain/Direction.hpp" +#include "Domain/Element.hpp" // IWYU pragma: keep +#include "Domain/Mesh.hpp" // IWYU pragma: keep +#include "Domain/Side.hpp" +#include "NumericalAlgorithms/LinearOperators/Linearize.hpp" +#include "NumericalAlgorithms/LinearOperators/MeanValue.hpp" +#include "Utilities/ConstantExpressions.hpp" +#include "Utilities/GenerateInstantiations.hpp" +#include "Utilities/Gsl.hpp" + +namespace SlopeLimiters { +namespace Minmod_detail { + +// Encodes the return status of the minmod_tvbm function. +struct MinmodResult { + const double value; + const bool activated; +}; + +// The TVBM-corrected minmod function, see e.g. Cockburn reference Eq. 2.26. +MinmodResult minmod_tvbm(const double a, const double b, const double c, + const double tvbm_scale) noexcept { + if (fabs(a) <= tvbm_scale) { + return {a, false}; + } + if ((std::signbit(a) == std::signbit(b)) and + (std::signbit(a) == std::signbit(c))) { + // The if/else group below could be more simply written as + // std::copysign(std::min({fabs(a), fabs(b), fabs(c)}), a); + // however, by separating different cases, we gain the ability to + // distinguish whether or not the limiter activated. + if (fabs(a) <= fabs(b) and fabs(a) <= fabs(c)) { + return {a, false}; + } else { + return {std::copysign(std::min(fabs(b), fabs(c)), a), true}; + } + } else { + return {0.0, true}; + } +} + +template +bool troubled_cell_indicator( + const gsl::not_null u_mean, + const gsl::not_null*> u_limited_slopes, + const gsl::not_null u_lin_buffer, + const gsl::not_null*> boundary_buffer, + const SlopeLimiters::MinmodType& minmod_type, const double tvbm_constant, + const DataVector& u, const Element& element, + const Mesh& mesh, + const std::array& element_size, + const DirectionMap& effective_neighbor_means, + const DirectionMap& effective_neighbor_sizes, + const std::array>, + gsl::span>>, + VolumeDim>& volume_and_slice_indices) noexcept { + const double tvbm_scale = [&tvbm_constant, &element_size ]() noexcept { + const double max_h = + *std::max_element(element_size.begin(), element_size.end()); + return tvbm_constant * square(max_h); + } + (); + + // Results from SpECTRE paper (https://arxiv.org/abs/1609.00098) used a + // max_slope_factor a factor of 2.0 too small, so that LambdaPi1 behaved + // like MUSCL, and MUSCL was even more dissipative. + const double max_slope_factor = + (minmod_type == SlopeLimiters::MinmodType::Muscl) ? 1.0 : 2.0; + + *u_mean = mean_value(u, mesh); + + const auto difference_to_neighbor = [ + &u_mean, &element, &element_size, &effective_neighbor_means, & + effective_neighbor_sizes + ](const size_t dim, const Side& side) noexcept { + const auto& externals = element.external_boundaries(); + const auto dir = Direction(dim, side); + const bool has_neighbors = (externals.find(dir) == externals.end()); + if (has_neighbors) { + const double neighbor_mean = effective_neighbor_means.at(dir); + const double neighbor_size = effective_neighbor_sizes.at(dir); + + // Compute an effective element-center-to-neighbor-center distance + // that accounts for the possibility of different refinement levels + // or discontinuous maps (e.g., at Block boundaries). Treated naively, + // these domain features can make a smooth solution appear to be + // non-smooth in the logical coordinates, which could potentially lead + // to the limiter triggering erroneously. This effective distance is + // used to scale the difference in the means, so that a linear function + // at a refinement or Block boundary will still appear smooth to the + // limiter. The factor is normalized to be 1.0 on a uniform grid. + // Note that this is not "by the book" Minmod, but an attempt to + // generalize Minmod to work on non-uniform grids. + const double distance_factor = + 0.5 * (1.0 + neighbor_size / gsl::at(element_size, dim)); + return (side == Side::Lower ? -1.0 : 1.0) * (neighbor_mean - *u_mean) / + distance_factor; + } else { + return 0.0; + } + }; + + // The LambdaPiN limiter allows high-order solutions to escape limiting if + // the boundary values are not too different from the mean value: + if (minmod_type == SlopeLimiters::MinmodType::LambdaPiN) { + bool u_needs_limiting = false; + for (size_t d = 0; d < VolumeDim; ++d) { + const double u_lower = mean_value_on_boundary( + &(gsl::at(*boundary_buffer, d)), + gsl::at(volume_and_slice_indices, d).first, u, mesh, d, Side::Lower); + const double u_upper = mean_value_on_boundary( + &(gsl::at(*boundary_buffer, d)), + gsl::at(volume_and_slice_indices, d).second, u, mesh, d, Side::Upper); + const double diff_lower = difference_to_neighbor(d, Side::Lower); + const double diff_upper = difference_to_neighbor(d, Side::Upper); + + // Results from SpECTRE paper (https://arxiv.org/abs/1609.00098) used + // minmod_tvbm(..., 0.0), rather than minmod_tvbm(..., tvbm_scale) + const double v_lower = + *u_mean - + minmod_tvbm(*u_mean - u_lower, diff_lower, diff_upper, tvbm_scale) + .value; + const double v_upper = + *u_mean + + minmod_tvbm(u_upper - *u_mean, diff_lower, diff_upper, tvbm_scale) + .value; + // Value of epsilon from Hesthaven & Warburton, Chapter 5, in the + // SlopeLimitN.m code sample. + const double eps = 1.e-8; + if (fabs(v_lower - u_lower) > eps or fabs(v_upper - u_upper) > eps) { + u_needs_limiting = true; + break; + } + } + + if (not u_needs_limiting) { + // Skip the limiting step for this tensor component + return false; + } + } // end if LambdaPiN + + // If the LambdaPiN check did not skip the limiting, then proceed as normal + // to determine whether the slopes need to be reduced. + // + // Note that we expect the Muscl and LambdaPi1 limiters to linearize the + // solution whether or not the slope needed reduction. To permit this + // linearization, we always return (by reference) the slopes when these + // limiters are in use. In contrast, for LambdaPiN, we only return the slopes + // when they do in fact need to be reduced. + bool slopes_need_reducing = false; + + linearize(u_lin_buffer, u, mesh); + for (size_t d = 0; d < VolumeDim; ++d) { + const double u_lower = + mean_value_on_boundary(&(gsl::at(*boundary_buffer, d)), + gsl::at(volume_and_slice_indices, d).first, + *u_lin_buffer, mesh, d, Side::Lower); + const double u_upper = + mean_value_on_boundary(&(gsl::at(*boundary_buffer, d)), + gsl::at(volume_and_slice_indices, d).second, + *u_lin_buffer, mesh, d, Side::Upper); + + // Divide by element's width (2.0 in logical coordinates) to get a slope + const double local_slope = 0.5 * (u_upper - u_lower); + const double upper_slope = 0.5 * difference_to_neighbor(d, Side::Upper); + const double lower_slope = 0.5 * difference_to_neighbor(d, Side::Lower); + + const MinmodResult& result = + minmod_tvbm(local_slope, max_slope_factor * upper_slope, + max_slope_factor * lower_slope, tvbm_scale); + gsl::at(*u_limited_slopes, d) = result.value; + if (result.activated) { + slopes_need_reducing = true; + } + } + + return slopes_need_reducing; +} + +// Explicit instantiations +#define DIM(data) BOOST_PP_TUPLE_ELEM(0, data) + +#define INSTANTIATE(_, data) \ + template bool troubled_cell_indicator( \ + const gsl::not_null, \ + const gsl::not_null*>, \ + const gsl::not_null, \ + const gsl::not_null*>, \ + const SlopeLimiters::MinmodType&, const double, const DataVector&, \ + const Element&, const Mesh&, \ + const std::array&, \ + const DirectionMap&, \ + const DirectionMap&, \ + const std::array>, \ + gsl::span>>, \ + DIM(data)>&) noexcept; + +GENERATE_INSTANTIATIONS(INSTANTIATE, (1, 2, 3)) + +#undef DIM +#undef INSTANTIATE + +} // namespace Minmod_detail +} // namespace SlopeLimiters diff --git a/src/Evolution/DiscontinuousGalerkin/SlopeLimiters/MinmodTci.hpp b/src/Evolution/DiscontinuousGalerkin/SlopeLimiters/MinmodTci.hpp new file mode 100644 index 0000000000000..55646011cea0e --- /dev/null +++ b/src/Evolution/DiscontinuousGalerkin/SlopeLimiters/MinmodTci.hpp @@ -0,0 +1,50 @@ +// Distributed under the MIT License. +// See LICENSE.txt for details. + +#pragma once + +#include +#include +#include + +#include "Evolution/DiscontinuousGalerkin/SlopeLimiters/MinmodType.hpp" +#include "Utilities/Gsl.hpp" + +/// \cond +class DataVector; +template +class DirectionMap; +template +class Element; +template +class Mesh; +/// \endcond + +namespace SlopeLimiters { +namespace Minmod_detail { + +// Implements the troubled-cell indicator corresponding to the Minmod limiter. +// +// The troubled-cell indicator (TCI) determines whether or not limiting is +// needed. See SlopeLimiters::Minmod for a full description of the Minmod +// limiter. Note that as an optimization, this TCI returns (by reference) some +// additional data that are used by the Minmod limiter in the case where the +// TCI returns true (i.e., the case where limiting is needed). +template +bool troubled_cell_indicator( + gsl::not_null u_mean, + gsl::not_null*> u_limited_slopes, + gsl::not_null u_lin_buffer, + gsl::not_null*> boundary_buffer, + const SlopeLimiters::MinmodType& minmod_type, double tvbm_constant, + const DataVector& u, const Element& element, + const Mesh& mesh, + const std::array& element_size, + const DirectionMap& effective_neighbor_means, + const DirectionMap& effective_neighbor_sizes, + const std::array>, + gsl::span>>, + VolumeDim>& volume_and_slice_indices) noexcept; + +} // namespace Minmod_detail +} // namespace SlopeLimiters