MinModLimiter.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

#include "Limiter.h"
#include "MathFVUtils.h"

namespace Moose
{
namespace FV
{
template <typename T>
class MinModLimiter : public Limiter<T>
{
public:
  T limit(const T & phi_upwind,
          const T & phi_downwind,
          const VectorValue<T> * grad_phi_upwind,
          const VectorValue<T> * grad_phi_downwind,
          const RealVectorValue & dCD,
          const Real & /* max_value */,
          const Real & /* min_value */,
          const FaceInfo * /* fi */,
          const bool & /* fi_elem_is_upwind */) const override final
  {
    mooseAssert(grad_phi_upwind, "min-mod limiter requires a gradient");

    // Compute gradient ratio coefficient
    T r_f;
    if (grad_phi_downwind) // compute full slope-reconstruction limiter
      r_f = this->rf_grad(grad_phi_upwind, grad_phi_downwind, dCD);
    else // compute upwind slope reconstruction limiter
      r_f = Moose::FV::rF(phi_upwind, phi_downwind, *grad_phi_upwind, dCD);

    // Return limiter value
    return 0 * r_f + std::max(T(0), std::min(T(1), r_f));
  }

  bool constant() const override final { return false; }

  InterpMethod interpMethod() const override final { return InterpMethod::MinMod; }

  MinModLimiter() = default;
};
}
}