NaNInterface.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 "InputParameters.h"
#include "MooseObject.h"

class NaNInterface
{
public:
  static InputParameters validParams();

  NaNInterface(const MooseObject * moose_object);

protected:
  enum NaNMessage
  {
    NAN_MESSAGE_NONE = 0,
    NAN_MESSAGE_WARNING = 1,
    NAN_MESSAGE_EXCEPTION = 2,
    NAN_MESSAGE_ERROR = 3
  };

  const MooseObject * const _moose_object;

  const enum NaNMessage _emit_on_nan;

  Real getNaN() const { return getNaN("A NaN was produced."); }

  std::vector<Real> getNaNVector(const unsigned int & n) const
  {
    return getNaNVector(n, "A NaN was produced.");
  }

  template <typename... Args>
  Real getNaN(Args &&... args) const
  {
    switch (_emit_on_nan)
    {
      case (NAN_MESSAGE_WARNING):
        mooseWarning(_moose_object->name(), ": ", std::forward<Args>(args)...);
        break;
      case (NAN_MESSAGE_EXCEPTION):
        mooseException(_moose_object->name(), ": ", std::forward<Args>(args)...);
        break;
      case (NAN_MESSAGE_ERROR):
        mooseError(_moose_object->name(), ": ", std::forward<Args>(args)...);
        break;
      default:
        break;
    }
    // return a quiet NaN
    return std::nan("");
  }

  template <typename... Args>
  std::vector<Real> getNaNVector(const unsigned int & n, Args &&... args) const
  {
    switch (_emit_on_nan)
    {
      case (NAN_MESSAGE_WARNING):
        mooseWarning(_moose_object->name(), ": ", std::forward<Args>(args)...);
        break;
      case (NAN_MESSAGE_EXCEPTION):
        mooseException(_moose_object->name(), ": ", std::forward<Args>(args)...);
        break;
      case (NAN_MESSAGE_ERROR):
        mooseError(_moose_object->name(), ": ", std::forward<Args>(args)...);
        break;
      default:
        break;
    }
    // return quiet NaNs
    return std::vector<Real>(n, std::nan(""));
  }
};