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)

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

Protected Member Functions
Real	getNaN () const
	Produces errors, warnings, or just quiet NaNs. More...
template<typename... Args>
Real	getNaN (Args &&... args) const

Protected Attributes
const MooseObject *	_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 27 of file NaNInterface.h.

Member Enumeration Documentation

NaNMessage

enum NaNInterface::NaNMessage

protected

Enumerator
NAN_MESSAGE_NONE
NAN_MESSAGE_WARNING
NAN_MESSAGE_ERROR

Definition at line 33 of file NaNInterface.h.

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

Constructor & Destructor Documentation

NaNInterface()

NaNInterface::NaNInterface

(

const MooseObject *

moose_object

)

Definition at line 33 of file NaNInterface.C.

  : _emit_on_nan(
        moose_object->getParamTempl<MooseEnum>("emit_on_nan").getEnum<NaNInterface::NaNMessage>())
{
  _moose_object = moose_object;
}

Member Function Documentation

getNaN() [1/2]

Real NaNInterface::getNaN ( ) const

inlineprotected

Produces errors, warnings, or just quiet NaNs.

Definition at line 48 of file NaNInterface.h.

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

Referenced by StiffenedGasFluidProperties::c_from_v_e(), getNaN(), NaNInterfaceTestFluidProperties::p_from_v_e(), StiffenedGasFluidProperties::rho_from_p_s(), StiffenedGasFluidProperties::rho_from_p_T(), StiffenedGasFluidProperties::s_from_h_p(), StiffenedGasFluidProperties::s_from_p_T(), StiffenedGasFluidProperties::s_from_v_e(), IdealRealGasMixtureFluidProperties::v_from_p_T(), and IdealRealGasMixtureFluidProperties::xs_prim_from_p_T().

getNaN() [2/2]

template<typename... Args>

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

inlineprotected

Definition at line 51 of file NaNInterface.h.

  {
    switch (_emit_on_nan)
    {
      case (NAN_MESSAGE_WARNING):
        mooseWarning(_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("");
  }

Member Data Documentation

_emit_on_nan

enum NaNMessage NaNInterface::_emit_on_nan

protected

Raise mooseWarning or mooseError?

Definition at line 43 of file NaNInterface.h.

Referenced by getNaN().

_moose_object

const MooseObject* NaNInterface::_moose_object

protected

Definition at line 40 of file NaNInterface.h.

Referenced by getNaN(), and NaNInterface().

---

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

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