SwapBackSentinel.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

// MOOSE includes
#include "MooseTypes.h"

// Forward declarations
class FEProblemBase;

class SwapBackSentinel
{
public:
  using SwapBackFunction = void (FEProblemBase::*)(THREAD_ID);

  SwapBackSentinel(FEProblemBase & fe_problem,
                   SwapBackFunction func,
                   THREAD_ID tid,
                   const bool & predicate,
                   const bool store_pred_as_value = true)
    : _fe_problem(fe_problem),
      _func(func),
      _thread_id(tid),
      _predicate(store_pred_as_value ? (predicate ? _always_true : _always_false) : predicate)
  {
  }

  SwapBackSentinel(FEProblemBase & fe_problem, SwapBackFunction func, THREAD_ID tid)
    : _fe_problem(fe_problem), _func(func), _thread_id(tid), _predicate(_always_true)
  {
  }

  ~SwapBackSentinel()
  {
    if (_predicate)
      (_fe_problem.*_func)(_thread_id);
  }

private:
  FEProblemBase & _fe_problem;
  SwapBackFunction _func;
  THREAD_ID _thread_id;
  static constexpr bool _always_true = true;
  static constexpr bool _always_false = false;
  const bool & _predicate;
};