NaNInterface Class Reference

Interface class for producing errors, warnings, or just quiet NaNs. More...

#include <NaNInterface.h>

Inheritance diagram for NaNInterface:

Public Member Functions
	NaNInterface (const MooseObject *moose_object)

Static Public Member Functions
static InputParameters	validParams ()

Protected Types
enum	NaNMessage { NAN_MESSAGE_NONE = 0, NAN_MESSAGE_WARNING = 1, NAN_MESSAGE_EXCEPTION = 2, NAN_MESSAGE_ERROR = 3 }

Protected Member Functions
Real	getNaN () const
	Throws an error or returns a NaN with or without a warning, with a default message. More...
std::vector< Real >	getNaNVector (const unsigned int &n) const
	Throws an error or returns NaNs with or without a warning, with a default message. More...
template<typename... Args>
Real	getNaN (Args &&... args) const
	Throws an error or returns a NaN with or without a warning. More...
template<typename... Args>
std::vector< Real >	getNaNVector (const unsigned int &n, Args &&... args) const
	Throws an error or returns NaNs with or without a warning. More...

Protected Attributes
const MooseObject *const	_moose_object
enum NaNMessage	_emit_on_nan
	Raise mooseWarning or mooseError? More...

Detailed Description

Interface class for producing errors, warnings, or just quiet NaNs.

For some objects it is desirable to continue running despite generation of NaN(s). This class provides an interface for choosing whether to throw an error, a warning, or nothing at all, just using a quiet NaN.

Definition at line 22 of file NaNInterface.h.

Member Enumeration Documentation

NaNMessage

enum NaNInterface::NaNMessage

protected

Enumerator
NAN_MESSAGE_NONE
NAN_MESSAGE_WARNING
NAN_MESSAGE_EXCEPTION
NAN_MESSAGE_ERROR

Definition at line 30 of file NaNInterface.h.

  {
    NAN_MESSAGE_NONE = 0,
    NAN_MESSAGE_WARNING = 1,
    NAN_MESSAGE_EXCEPTION = 2,
    NAN_MESSAGE_ERROR = 3
  };

Constructor & Destructor Documentation

NaNInterface()

NaNInterface::NaNInterface

(

const MooseObject *

moose_object

)

Definition at line 35 of file NaNInterface.C.

  : _moose_object(moose_object),
    _emit_on_nan(
        _moose_object->getParam<MooseEnum>("emit_on_nan").getEnum<NaNInterface::NaNMessage>())
{
}

Member Function Documentation

getNaN() [1/2]

Real NaNInterface::getNaN ( ) const

inlineprotected

Throws an error or returns a NaN with or without a warning, with a default message.

Definition at line 46 of file NaNInterface.h.

Referenced by StiffenedGasFluidProperties::c_from_v_e(), CaloricallyImperfectGas::c_from_v_e(), ADNumericalFlux3EqnHLLC::calcFlux(), getNaN(), NaNInterfaceTestFluidProperties::p_from_v_e(), CaloricallyImperfectGas::p_from_v_e(), IdealGasFluidProperties::p_from_v_e(), StiffenedGasFluidProperties::rho_from_p_s(), StiffenedGasFluidProperties::s_from_h_p(), IdealGasFluidProperties::s_from_h_p(), IdealGasFluidProperties::s_from_p_T(), IdealGasFluidProperties::s_from_v_e(), CaloricallyImperfectGas::T_from_v_e(), and IdealRealGasMixtureFluidProperties::xs_prim_from_p_T().

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

getNaN() [2/2]

template<typename... Args>

Real NaNInterface::getNaN ( Args &&...  args ) const

inlineprotected

Throws an error or returns a NaN with or without a warning.

Definition at line 62 of file NaNInterface.h.

  {
    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("");
  }

getNaNVector() [1/2]

std::vector<Real> NaNInterface::getNaNVector ( const unsigned int &  n ) const

inlineprotected

Throws an error or returns NaNs with or without a warning, with a default message.

Parameters

[in]

n

Vector size

Definition at line 53 of file NaNInterface.h.

Referenced by NaNInterfaceTestFluidProperties::returnNaNVector().

  {
    return getNaNVector(n, "A NaN was produced.");
  }

getNaNVector() [2/2]

template<typename... Args>

std::vector<Real> NaNInterface::getNaNVector ( const unsigned int &  n, Args &&...  args  ) const

inlineprotected

Throws an error or returns NaNs with or without a warning.

Parameters

[in]

n

Vector size

Definition at line 88 of file NaNInterface.h.

  {
    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(""));
  }

validParams()

InputParameters NaNInterface::validParams ( )

static

Definition at line 15 of file NaNInterface.C.

Referenced by define_mass_specific_prop_from_p_T(), define_mass_specific_prop_from_T_v(), NaNInterfaceTestFluidProperties::validParams(), StiffenedGasFluidProperties::validParams(), IdealGasFluidProperties::validParams(), CaloricallyImperfectGas::validParams(), ADNumericalFlux3EqnHLLC::validParams(), and StiffenedGasTwoPhaseFluidProperties::validParams().

{
#ifdef NDEBUG
  // in opt mode, getNaN() emits neither a warning nor an error by default
  MooseEnum emit_on_nan("none warning exception error", "none");
#else
  // in dbg mode, getNaN() raises an error by default
  MooseEnum emit_on_nan("none warning exception error", "error");
#endif

  InputParameters params = emptyInputParameters();

  params.addParam<MooseEnum>("emit_on_nan",
                             emit_on_nan,
                             "Whether to raise a warning, an exception (usually triggering a retry "
                             "with a smaller time step) or an error (ending the simulation)");

  return params;
}

Member Data Documentation

_emit_on_nan

enum NaNMessage NaNInterface::_emit_on_nan

protected

Raise mooseWarning or mooseError?

Definition at line 41 of file NaNInterface.h.

Referenced by getNaN(), and getNaNVector().

_moose_object

const MooseObject* const NaNInterface::_moose_object

protected

Definition at line 38 of file NaNInterface.h.

Referenced by getNaN(), and getNaNVector().

---

The documentation for this class was generated from the following files:

• fluid_properties/include/interfaces/NaNInterface.h
• fluid_properties/src/interfaces/NaNInterface.C