SpECTRE Documentation Coverage Report
Current view: top level - Parallel/Actions - TerminatePhase.hpp Hit Total Coverage
Commit: b1342d46f40e2d46bbd11d0cef68fd973031a24b Lines: 1 4 25.0 %
Date: 2020-09-24 20:24:42
Legend: Lines: hit not hit

          Line data    Source code
       1           0 : // Distributed under the MIT License.
       2             : // See LICENSE.txt for details.
       3             : 
       4             : #pragma once
       5             : 
       6             : #include <tuple>
       7             : 
       8             : /// \cond
       9             : namespace tuples {
      10             : template <typename... InboxTags>
      11             : struct TaggedTuple;
      12             : }  // namespace tuples
      13             : namespace Parallel {
      14             : template <typename Metavariables>
      15             : class GlobalCache;
      16             : }  // namespace Parallel
      17             : /// \endcond
      18             : 
      19             : namespace Parallel {
      20           0 : namespace Actions {
      21             : 
      22             : /*!
      23             :  * \ingroup ActionsGroup
      24             :  * \brief Terminate the algorithm to proceed to the next phase.
      25             :  */
      26           1 : struct TerminatePhase {
      27             :   template <typename DataBox, typename... InboxTags, typename Metavariables,
      28             :             typename ArrayIndex, typename ActionList,
      29             :             typename ParallelComponent>
      30           0 :   static std::tuple<DataBox&&, bool> apply(
      31             :       DataBox& box, const tuples::TaggedTuple<InboxTags...>& /*inboxes*/,
      32             :       const Parallel::GlobalCache<Metavariables>& /*cache*/,
      33             :       const ArrayIndex& /*array_index*/,
      34             :       // NOLINTNEXTLINE(readability-avoid-const-params-in-decls)
      35             :       const ActionList /*meta*/,
      36             :       // NOLINTNEXTLINE(readability-avoid-const-params-in-decls)
      37             :       const ParallelComponent* const /*meta*/) noexcept {
      38             :     return {std::move(box), true};
      39             :   }
      40             : };
      41             : 
      42             : }  // namespace Actions
      43             : }  // namespace Parallel

Generated by: LCOV version 1.14