SOULimiter.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 SOULimiter : 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, "SOU limiter requires a gradient");
    using std::abs;
    using std::min;

    T delta_face = abs((*grad_phi_upwind) * dCD);
    T delta_max = abs(max_value - min_value);

    if (delta_face > 1e-10)
      return min(1.0, delta_max / delta_face);
    else
      return T(1.0);
  }

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

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

  SOULimiter() = default;
};
}
}