#include <OneDEnergyWallHeating.h>

Inheritance diagram for OneDEnergyWallHeating:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	OneDEnergyWallHeating (const InputParameters &parameters)

const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialProperty (const std::string &name)

const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialPropertyByName (const std::string &name)

void	validateDerivativeMaterialPropertyBase (const std::string &base)

const MaterialPropertyName	derivativePropertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	derivativePropertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	derivativePropertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	derivativePropertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

void	validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)

void	validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

void	validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)

void	validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

void	validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

void	validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual Real	computeQpResidual ()

virtual Real	computeQpJacobian ()

virtual Real	computeQpOffDiagJacobian (unsigned int jvar)

MaterialProperty< U > &	declarePropertyDerivativeTHM (const std::string &base, const std::string &var_name, const unsigned int i=0)
	Method for declaring derivative material properties. More...

const MaterialProperty< U > &	getMaterialPropertyDerivativeTHM (const std::string &base, const std::string &var_name, const unsigned int i=0)
	Method for retrieving derivative material properties. More...

const MaterialProperty< U > &	getMaterialPropertyDerivativeTHMPhase (const std::string &base, bool property_is_liquid, const std::string &var_name, bool var_is_liquid, const unsigned int i=0)
	Method for retrieving derivative material properties corresponding to phase-dependent derivatives. More...

Protected Attributes
const MaterialProperty< Real > &	_temperature

const MaterialProperty< Real > &	_dT_drhoA

const MaterialProperty< Real > &	_dT_drhouA

const MaterialProperty< Real > &	_dT_drhoEA

const MaterialProperty< Real > &	_Hw

const VariableValue &	_T_wall

const VariableValue &	_P_hf

unsigned	_rhoA_var_number

unsigned	_rhouA_var_number

Detailed Description

Definition at line 16 of file OneDEnergyWallHeating.h.

Constructor & Destructor Documentation

◆ OneDEnergyWallHeating()

OneDEnergyWallHeating::OneDEnergyWallHeating ( const InputParameters & parameters )

Definition at line 31 of file OneDEnergyWallHeating.C.

   : DerivativeMaterialInterfaceTHM<Kernel>(parameters),
     _temperature(getMaterialProperty<Real>("T")),
     _dT_drhoA(getMaterialPropertyDerivativeTHM<Real>("T", "rhoA")),
     _dT_drhouA(getMaterialPropertyDerivativeTHM<Real>("T", "rhouA")),
     _dT_drhoEA(getMaterialPropertyDerivativeTHM<Real>("T", "rhoEA")),
     _Hw(getMaterialProperty<Real>("Hw")),
     _T_wall(coupledValue("T_wall")),
     _P_hf(coupledValue("P_hf")),
     _rhoA_var_number(coupled("rhoA")),
     _rhouA_var_number(coupled("rhouA"))
 {
 }

Member Function Documentation

◆ computeQpJacobian()

Real OneDEnergyWallHeating::computeQpJacobian ( )

protectedvirtual

Definition at line 52 of file OneDEnergyWallHeating.C.

 {
   return _Hw[_qp] * _P_hf[_qp] * _dT_drhoEA[_qp] * _phi[_j][_qp] * _test[_i][_qp];
 }

◆ computeQpOffDiagJacobian()

Real OneDEnergyWallHeating::computeQpOffDiagJacobian ( unsigned int jvar )

protectedvirtual

Definition at line 58 of file OneDEnergyWallHeating.C.

 {
   if (jvar == _rhoA_var_number)
     return _Hw[_qp] * _P_hf[_qp] * _dT_drhoA[_qp] * _phi[_j][_qp] * _test[_i][_qp];
 
   else if (jvar == _rhouA_var_number)
     return _Hw[_qp] * _P_hf[_qp] * _dT_drhouA[_qp] * _phi[_j][_qp] * _test[_i][_qp];
 
   else
     return 0.;
 }

◆ computeQpResidual()

Real OneDEnergyWallHeating::computeQpResidual ( )

protectedvirtual

Definition at line 46 of file OneDEnergyWallHeating.C.

 {
   return _Hw[_qp] * _P_hf[_qp] * (_temperature[_qp] - _T_wall[_qp]) * _test[_i][_qp];
 }

◆ declarePropertyDerivativeTHM()

MaterialProperty< U > & DerivativeMaterialInterfaceTHM< Kernel >::declarePropertyDerivativeTHM	(	const std::string &	base,
		const std::string &	var_name,
		const unsigned int	i = `0`
	)

protectedinherited

Method for declaring derivative material properties.

Template Parameters

U	The material property type

Parameters

base	The name of the property to take the derivative of
var_name	The name of the coupled variable vector containing the variable to take the derivative with respect to
i	The index of the variable to take the derivative with respect to within the coupled variable vector

Definition at line 88 of file DerivativeMaterialInterfaceTHM.h.

 {
   return this->template declarePropertyDerivative<U>(base, this->coupledName(var_name, i));
 }

◆ getMaterialPropertyDerivativeTHM()

const MaterialProperty< U > & DerivativeMaterialInterfaceTHM< Kernel >::getMaterialPropertyDerivativeTHM	(	const std::string &	base,
		const std::string &	var_name,
		const unsigned int	i = `0`
	)

protectedinherited

Method for retrieving derivative material properties.

Template Parameters

U	The material property type

Parameters

base	The name of the property to take the derivative of
var_name	The name of the coupled variable vector containing the variable to take the derivative with respect to
i	The index of the variable to take the derivative with respect to within the coupled variable vector

Definition at line 98 of file DerivativeMaterialInterfaceTHM.h.

 {
   // get the base property name
   const std::string prop_name = this->getMaterialPropertyName(base);
 
   // get the name of the variable which derivative is respect to
   const std::string der_var_name = this->coupledName(var_name, i);
 
   return this->template getMaterialPropertyByName<U>(
       this->derivativePropertyNameFirst(prop_name, der_var_name));
 }

◆ getMaterialPropertyDerivativeTHMPhase()

const MaterialProperty< U > & DerivativeMaterialInterfaceTHM< Kernel >::getMaterialPropertyDerivativeTHMPhase	(	const std::string &	base,
		bool	property_is_liquid,
		const std::string &	var_name,
		bool	var_is_liquid,
		const unsigned int	i = `0`
	)

protectedinherited

Method for retrieving derivative material properties corresponding to phase-dependent derivatives.

The intended behavior of this function is as follows. If the material property and derivative variable correspond to the same phase, then the material property is retrieved as usual. Else, a zero-valued material property is returned, as it is assumed that the material property depends only upon the variables corresponding to its phase.

Template Parameters

U	The material property type

Parameters

base	The name of the property to take the derivative of
property_is_liquid	Does the property correspond to the liquid phase?
var_name	The name of the coupled variable vector containing the variable to take the derivative with respect to
var_is_liquid	Does the derivative variable correspond to the liquid phase?
i	The index of the variable to take the derivative with respect to within the coupled variable vector

Definition at line 115 of file DerivativeMaterialInterfaceTHM.h.

 {
   if (property_is_liquid == var_is_liquid)
   {
     return getMaterialPropertyDerivativeTHM<U>(base, var_name, i);
   }
   else
   {
     const std::string prop_name = this->getMaterialPropertyName(base);
     const std::string der_var_name = this->coupledName(var_name, i);
     const std::string der_prop_name = this->derivativePropertyNameFirst(prop_name, der_var_name);
     return this->template getZeroMaterialProperty<U>(der_prop_name);
   }
 }

◆ validParams()

InputParameters OneDEnergyWallHeating::validParams ( )

static

Definition at line 15 of file OneDEnergyWallHeating.C.

 {
   InputParameters params = Kernel::validParams();
   params.addClassDescription("Adds a convective heat flux term from a wall temperature");
   params.addRequiredCoupledVar("rhoA", "");
   params.addRequiredCoupledVar("rhouA", "");
   params.addRequiredCoupledVar("rhoEA", "Energy equation variable");
   params.addRequiredCoupledVar("P_hf", "heat flux perimeter");
   params.addCoupledVar("T_wall", "Wall temperature as a field variable");
   params.addRequiredParam<MaterialPropertyName>("Hw",
                                                 "Convective heat transfer coefficient, W/m^2-K");
   params.addRequiredParam<MaterialPropertyName>("T", "Temperature material property");
 
   return params;
 }

Member Data Documentation

◆ _dT_drhoA

const MaterialProperty<Real>& OneDEnergyWallHeating::_dT_drhoA

protected

Definition at line 27 of file OneDEnergyWallHeating.h.

Referenced by computeQpOffDiagJacobian().

◆ _dT_drhoEA

const MaterialProperty<Real>& OneDEnergyWallHeating::_dT_drhoEA

protected

Definition at line 29 of file OneDEnergyWallHeating.h.

Referenced by computeQpJacobian().

◆ _dT_drhouA

const MaterialProperty<Real>& OneDEnergyWallHeating::_dT_drhouA

protected

Definition at line 28 of file OneDEnergyWallHeating.h.

Referenced by computeQpOffDiagJacobian().

◆ _Hw

const MaterialProperty<Real>& OneDEnergyWallHeating::_Hw

protected

Definition at line 30 of file OneDEnergyWallHeating.h.

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

◆ _P_hf

const VariableValue& OneDEnergyWallHeating::_P_hf

protected

Definition at line 33 of file OneDEnergyWallHeating.h.

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

◆ _rhoA_var_number

unsigned OneDEnergyWallHeating::_rhoA_var_number

protected

Definition at line 36 of file OneDEnergyWallHeating.h.

Referenced by computeQpOffDiagJacobian().

◆ _rhouA_var_number

unsigned OneDEnergyWallHeating::_rhouA_var_number

protected

Definition at line 37 of file OneDEnergyWallHeating.h.

Referenced by computeQpOffDiagJacobian().

◆ _T_wall

const VariableValue& OneDEnergyWallHeating::_T_wall

protected

Definition at line 32 of file OneDEnergyWallHeating.h.

Referenced by computeQpResidual().

◆ _temperature

const MaterialProperty<Real>& OneDEnergyWallHeating::_temperature

protected

Definition at line 26 of file OneDEnergyWallHeating.h.

Referenced by computeQpResidual().

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

thermal_hydraulics/include/kernels/OneDEnergyWallHeating.h
thermal_hydraulics/src/kernels/OneDEnergyWallHeating.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OneDEnergyWallHeating()

Member Function Documentation

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

◆ declarePropertyDerivativeTHM()

◆ getMaterialPropertyDerivativeTHM()

◆ getMaterialPropertyDerivativeTHMPhase()

◆ validParams()

Member Data Documentation

◆ _dT_drhoA

◆ _dT_drhoEA

◆ _dT_drhouA

◆ _Hw

◆ _P_hf

◆ _rhoA_var_number

◆ _rhouA_var_number

◆ _T_wall

◆ _temperature