INSFEFluidEnergyDirichletBC.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 "INSFEFluidEnergyDirichletBC.h"

registerMooseObject("NavierStokesApp", INSFEFluidEnergyDirichletBC);
registerMooseObjectRenamed("NavierStokesApp",
                           MDFluidEnergyDirichletBC,
                           "02/01/2024 00:00",
                           INSFEFluidEnergyDirichletBC);

InputParameters
INSFEFluidEnergyDirichletBC::validParams()
{
  InputParameters params = NodalBC::validParams();

  params.addClassDescription(
      "Imposes a Dirichlet condition on temperature at inlets. Is not applied at outlets");
  params.addRequiredCoupledVar("u", "velocity in x-direction");
  params.addCoupledVar("v", "velocity in y-direction"); // required in 2D/3D
  params.addCoupledVar("w", "velocity in z-direction"); // required in 3D

  params.addParam<FunctionName>("v_fn", "Velocity function with time at the boundary");

  params.addParam<Real>("T_scale", 1.0, "Coefficient to multiply the temperature with");
  params.addParam<FunctionName>("T_fn", "A function that describes the temperature");
  params.addCoupledVar("T_scalar", "A scalar value is multiplied by the temperature");

  params.addRequiredParam<VectorValue<Real>>("out_norm", "out norm of the boundary");

  return params;
}

INSFEFluidEnergyDirichletBC::INSFEFluidEnergyDirichletBC(const InputParameters & parameters)
  : NodalBC(parameters),
    _out_norm(getParam<VectorValue<Real>>("out_norm")),
    _u_vel(coupledValueOld("u")),
    _v_vel(_mesh.dimension() >= 2 ? coupledValueOld("v") : _zero),
    _w_vel(_mesh.dimension() == 3 ? coupledValueOld("w") : _zero),
    _T_scale(getParam<Real>("T_scale")),
    _T_scalar(isParamValid("T_scalar") ? coupledScalarValue("T_scalar") : _zero),
    _has_vbc(isParamValid("v_fn")),
    _velocity_fn(_has_vbc ? &getFunction("v_fn") : NULL),
    _T_fn(isParamValid("T_fn") ? &getFunction("T_fn") : NULL)
{
  if (isParamValid("T_scalar") == isParamValid("T_fn"))
    mooseError("Please provide one and only one of 'T_scalar' and 'T_fn'");
}

bool
INSFEFluidEnergyDirichletBC::isInlet() const
{
  RealVectorValue vec_vel(_u_vel[0], _v_vel[0], _w_vel[0]);

  Real v_bc = 0.0;
  if (_has_vbc)
    v_bc = -_velocity_fn->value(_t, *_current_node);
  else
    v_bc = vec_vel * _out_norm;

  if (v_bc < 0.) // Inlet
    return true;
  else
    return false;
}

bool
INSFEFluidEnergyDirichletBC::shouldApply() const
{
  return isInlet();
}

Real
INSFEFluidEnergyDirichletBC::computeQpResidual()
{
  if (isInlet())
  {
    Real T_bc = isParamValid("T_scalar") ? _T_scalar[0] : _T_fn->value(_t, *_current_node);
    return _u[_qp] - _T_scale * T_bc;
  }
  else
    return 0.0;
}

Real
INSFEFluidEnergyDirichletBC::computeQpJacobian()
{
  return isInlet() ? 1.0 : 0.0;
}

Real
INSFEFluidEnergyDirichletBC::computeQpOffDiagJacobian(unsigned int /*jvar*/)
{
  return 0.0;
}