LinearFVEnthalpyFunctorMaterial.C

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

#include "LinearFVEnthalpyFunctorMaterial.h"
#include "NS.h" // Variable Term Names
#include "NavierStokesMethods.h"
#include "SinglePhaseFluidProperties.h"

registerMooseObject("NavierStokesApp", LinearFVEnthalpyFunctorMaterial);

InputParameters
LinearFVEnthalpyFunctorMaterial::validParams()
{
  auto params = FunctorMaterial::validParams();
  params.addClassDescription(
      "Creates functors for conversions between specific enthalpy and temperature");

  params.addRequiredParam<MooseFunctorName>(NS::pressure, "Pressure");
  params.addRequiredParam<MooseFunctorName>(NS::T_fluid, "Fluid temperature");
  params.addRequiredParam<MooseFunctorName>(NS::specific_enthalpy, "Specific Enthalpy");

  // Please choose between providing a fluid properties
  params.addParam<UserObjectName>(NS::fluid, "Fluid properties userobject");
  // or the h_from_p_T and T_from_p_h functors.
  params.addParam<MooseFunctorName>("h_from_p_T_functor",
                                    "User specified enthalpy from temperature functor");
  params.addParam<MooseFunctorName>("T_from_p_h_functor",
                                    "User specified temperature from enthalpy functor");

  return params;
}

LinearFVEnthalpyFunctorMaterial::LinearFVEnthalpyFunctorMaterial(const InputParameters & params)
  : FunctorMaterial(params),
    _pressure(getFunctor<Real>(NS::pressure)),
    _T_fluid(getFunctor<Real>(NS::T_fluid)),
    _h(getFunctor<Real>(NS::specific_enthalpy)),
    _fluid(params.isParamValid(NS::fluid)
               ? &UserObjectInterface::getUserObject<SinglePhaseFluidProperties>(NS::fluid)
               : nullptr),
    _h_from_p_T_functor(params.isParamValid("h_from_p_T_functor")
                            ? &getFunctor<Real>("h_from_p_T_functor")
                            : nullptr),
    _T_from_p_h_functor(params.isParamValid("T_from_p_h_functor")
                            ? &getFunctor<Real>("T_from_p_h_functor")
                            : nullptr)
{
  // Check parameters
  if (!((_fluid && !_h_from_p_T_functor && !_T_from_p_h_functor) ||
        (!_fluid && _h_from_p_T_functor && _T_from_p_h_functor)))
  {
    mooseError("An unsupported combination of input parameters was given. Current "
               "supported combinations are either\ni) `fp` and neither `h_from_p_T_functor` nor "
               "`T_from_p_h_functor`, or\nii) "
               "no `fp` and both `h_from_p_T_functor` and `T_from_p_h_functor` are provided.");
  }

  //
  // Set material property functors
  //
  if (_fluid)
  {
    addFunctorProperty<Real>("h_from_p_T",
                             [this](const auto & r, const auto & t) -> Real
                             { return _fluid->h_from_p_T(_pressure(r, t), _T_fluid(r, t)); });
    addFunctorProperty<Real>("T_from_p_h",
                             [this](const auto & r, const auto & t) -> Real
                             { return _fluid->T_from_p_h(_pressure(r, t), _h(r, t)); });
  }
  else
  {
    addFunctorProperty<Real>("h_from_p_T",
                             [this](const auto & r, const auto & t) -> Real
                             { return (*_h_from_p_T_functor)(r, t); });
    addFunctorProperty<Real>("T_from_p_h",
                             [this](const auto & r, const auto & t) -> Real
                             { return (*_T_from_p_h_functor)(r, t); });
  }
}