ConvectiveFluxFunction Class Reference

#include <ConvectiveFluxFunction.h>

Inheritance diagram for ConvectiveFluxFunction:

Public Member Functions
	ConvectiveFluxFunction (const InputParameters &parameters)
virtual	~ConvectiveFluxFunction ()

Static Public Member Functions
static InputParameters	validParams ()

Protected Types
enum	CoefFuncType { CoefFuncType::TIME_AND_POSITION, CoefFuncType::TEMPERATURE }
	Enum used to define the type of function used for the heat transfer coefficient. More...

Protected Member Functions
virtual Real	computeQpResidual () override
virtual Real	computeQpJacobian () override

Protected Attributes
const Function &	_T_infinity
	Far-field temperature. More...
const Function &	_coefficient
	Heat transfer coefficient. More...
const CoefFuncType	_coef_func_type
	Type of function used for the heat transfer coefficient. More...
const Function *const	_coef_func
	Heat transfer coefficient function (Deprecated – being replaced by _coefficient) More...

Detailed Description

Definition at line 14 of file ConvectiveFluxFunction.h.

Member Enumeration Documentation

CoefFuncType

enum ConvectiveFluxFunction::CoefFuncType

strongprotected

Enum used to define the type of function used for the heat transfer coefficient.

Enumerator
TIME_AND_POSITION
TEMPERATURE

Definition at line 33 of file ConvectiveFluxFunction.h.

  {
    TIME_AND_POSITION,
    TEMPERATURE
  };

Constructor & Destructor Documentation

ConvectiveFluxFunction()

ConvectiveFluxFunction::ConvectiveFluxFunction

(

const InputParameters &

parameters

)

Definition at line 41 of file ConvectiveFluxFunction.C.

  : IntegratedBC(parameters),
    _T_infinity(getFunction("T_infinity")),
    _coefficient(getFunction("coefficient")),
    _coef_func_type(getParam<MooseEnum>("coefficient_function_type").getEnum<CoefFuncType>()),
    _coef_func(isParamValid("coefficient_function") ? &getFunction("coefficient_function") : NULL)
{
  if (_coef_func_type == CoefFuncType::TEMPERATURE && _coef_func)
    mooseError("Deprecated 'coefficient_function' parameter cannot be used with "
               "'coefficient_function_type=TEMPERATURE'");
}

~ConvectiveFluxFunction()

virtual ConvectiveFluxFunction::~ConvectiveFluxFunction ( )

inlinevirtual

Definition at line 20 of file ConvectiveFluxFunction.h.

{}

Member Function Documentation

computeQpJacobian()

Real ConvectiveFluxFunction::computeQpJacobian ( )

overrideprotectedvirtual

Definition at line 70 of file ConvectiveFluxFunction.C.

{
  if (_coef_func_type == CoefFuncType::TIME_AND_POSITION)
  {
    Real coef = _coefficient.value(_t, _q_point[_qp]);
    if (_coef_func) // Deprecated behavior
      coef *= _coef_func->value(_t, _q_point[_qp]);
    return _test[_i][_qp] * coef * _phi[_j][_qp];
  }
  else
  {
    const Real coef = _coefficient.value(_u[_qp], Point());
    const Real dcoef_dT = _coefficient.timeDerivative(_u[_qp], Point());
    return _test[_i][_qp] * (coef + (_u[_qp] - _T_infinity.value(_t, _q_point[_qp])) * dcoef_dT) *
           _phi[_j][_qp];
  }
}

computeQpResidual()

Real ConvectiveFluxFunction::computeQpResidual ( )

overrideprotectedvirtual

Definition at line 54 of file ConvectiveFluxFunction.C.

{
  Real coef;
  if (_coef_func_type == CoefFuncType::TIME_AND_POSITION)
  {
    coef = _coefficient.value(_t, _q_point[_qp]);
    if (_coef_func) // Deprecated behavior
      coef *= _coef_func->value(_t, _q_point[_qp]);
  }
  else
    coef = _coefficient.value(_u[_qp], Point());
 
  return _test[_i][_qp] * coef * (_u[_qp] - _T_infinity.value(_t, _q_point[_qp]));
}

validParams()

InputParameters ConvectiveFluxFunction::validParams ( )

static

Definition at line 19 of file ConvectiveFluxFunction.C.

{
  InputParameters params = IntegratedBC::validParams();
  params.addRequiredParam<FunctionName>("T_infinity", "Function describing far-field temperature");
  params.addRequiredParam<FunctionName>("coefficient",
                                        "Function describing heat transfer coefficient");
  MooseEnum coef_func_type("TIME_AND_POSITION TEMPERATURE", "TIME_AND_POSITION");
  params.addParam<MooseEnum>(
      "coefficient_function_type",
      coef_func_type,
      "Type of function for heat transfer coefficient provided in 'coefficient' parameter");
  params.addDeprecatedParam<FunctionName>(
      "coefficient_function",
      "Heat transfer coefficient function",
      "'coefficient' should be used instead. 'coefficient_function will be removed on March 1, "
      "2020.");
  params.addClassDescription(
      "Determines boundary value by fluid heat transfer coefficient and far-field temperature");
 
  return params;
}

Member Data Documentation

_coef_func

const Function* const ConvectiveFluxFunction::_coef_func

protected

Heat transfer coefficient function (Deprecated – being replaced by _coefficient)

Definition at line 43 of file ConvectiveFluxFunction.h.

Referenced by computeQpJacobian(), computeQpResidual(), and ConvectiveFluxFunction().

_coef_func_type

const CoefFuncType ConvectiveFluxFunction::_coef_func_type

protected

Type of function used for the heat transfer coefficient.

Definition at line 40 of file ConvectiveFluxFunction.h.

Referenced by computeQpJacobian(), computeQpResidual(), and ConvectiveFluxFunction().

_coefficient

const Function& ConvectiveFluxFunction::_coefficient

protected

Heat transfer coefficient.

Definition at line 30 of file ConvectiveFluxFunction.h.

Referenced by computeQpJacobian(), and computeQpResidual().

_T_infinity

const Function& ConvectiveFluxFunction::_T_infinity

protected

Far-field temperature.

Definition at line 27 of file ConvectiveFluxFunction.h.

Referenced by computeQpJacobian(), and computeQpResidual().

---

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

• heat_conduction/include/bcs/ConvectiveFluxFunction.h
• heat_conduction/src/bcs/ConvectiveFluxFunction.C