Computes gravity term for the energy equation in 1-phase flow. More...

#include <OneD3EqnEnergyGravity.h>

Inheritance diagram for OneD3EqnEnergyGravity:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	OneD3EqnEnergyGravity (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 VariableValue &	_A

const MaterialProperty< Real > &	_rho

const MaterialProperty< Real > &	_drho_darhoA

const MaterialProperty< Real > &	_vel

const MaterialProperty< Real > &	_dvel_darhoA

const MaterialProperty< Real > &	_dvel_darhouA

const MaterialProperty< RealVectorValue > &	_dir
	The direction of the flow channel. More...

const RealVectorValue &	_gravity_vector
	Gravitational acceleration vector. More...

const unsigned int	_arhoA_var_number

const unsigned int	_arhouA_var_number

Detailed Description

Computes gravity term for the energy equation in 1-phase flow.

Definition at line 18 of file OneD3EqnEnergyGravity.h.

Constructor & Destructor Documentation

◆ OneD3EqnEnergyGravity()

OneD3EqnEnergyGravity::OneD3EqnEnergyGravity ( const InputParameters & parameters )

Definition at line 30 of file OneD3EqnEnergyGravity.C.

   : DerivativeMaterialInterfaceTHM<Kernel>(parameters),
     _A(coupledValue("A")),
     _rho(getMaterialProperty<Real>("rho")),
     _drho_darhoA(getMaterialPropertyDerivativeTHM<Real>("rho", "arhoA")),
     _vel(getMaterialProperty<Real>("vel")),
     _dvel_darhoA(getMaterialPropertyDerivativeTHM<Real>("vel", "arhoA")),
     _dvel_darhouA(getMaterialPropertyDerivativeTHM<Real>("vel", "arhouA")),
     _dir(getMaterialProperty<RealVectorValue>("direction")),
     _gravity_vector(getParam<RealVectorValue>("gravity_vector")),
     _arhoA_var_number(coupled("arhoA")),
     _arhouA_var_number(coupled("arhouA"))
 {
 }

Member Function Documentation

◆ computeQpJacobian()

Real OneD3EqnEnergyGravity::computeQpJacobian ( )

protectedvirtual

Definition at line 52 of file OneD3EqnEnergyGravity.C.

 {
   return 0;
 }

◆ computeQpOffDiagJacobian()

Real OneD3EqnEnergyGravity::computeQpOffDiagJacobian ( unsigned int jvar )

protectedvirtual

Definition at line 58 of file OneD3EqnEnergyGravity.C.

 {
   if (jvar == _arhoA_var_number)
   {
     return -(_drho_darhoA[_qp] * _vel[_qp] + _rho[_qp] * _dvel_darhoA[_qp]) * _A[_qp] *
            _gravity_vector * _dir[_qp] * _phi[_j][_qp] * _test[_i][_qp];
   }
   else if (jvar == _arhouA_var_number)
   {
     return -_rho[_qp] * _dvel_darhouA[_qp] * _A[_qp] * _gravity_vector * _dir[_qp] * _phi[_j][_qp] *
            _test[_i][_qp];
   }
   else
     return 0;
 }

◆ computeQpResidual()

Real OneD3EqnEnergyGravity::computeQpResidual ( )

protectedvirtual

Definition at line 46 of file OneD3EqnEnergyGravity.C.

 {
   return -_rho[_qp] * _vel[_qp] * _A[_qp] * _gravity_vector * _dir[_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 OneD3EqnEnergyGravity::validParams ( )

static

Definition at line 15 of file OneD3EqnEnergyGravity.C.

 {
   InputParameters params = Kernel::validParams();
   params.addRequiredCoupledVar("A", "Cross-sectional area");
   params.addRequiredCoupledVar("arhoA", "alpha*rho*A");
   params.addRequiredCoupledVar("arhouA", "alpha*rho*u*A");
   params.addRequiredParam<MaterialPropertyName>(
       "direction", "The direction of the flow channel material property");
   params.addRequiredParam<MaterialPropertyName>("rho", "Density property");
   params.addRequiredParam<MaterialPropertyName>("vel", "Velocity property");
   params.addRequiredParam<RealVectorValue>("gravity_vector", "Gravitational acceleration vector");
   params.addClassDescription("Computes a gravity term for the energy equation in 1-phase flow");
   return params;
 }

Member Data Documentation

◆ _A

const VariableValue& OneD3EqnEnergyGravity::_A

protected

Definition at line 28 of file OneD3EqnEnergyGravity.h.

Referenced by computeQpOffDiagJacobian(), and computeQpResidual().

◆ _arhoA_var_number

const unsigned int OneD3EqnEnergyGravity::_arhoA_var_number

protected

Definition at line 42 of file OneD3EqnEnergyGravity.h.

Referenced by computeQpOffDiagJacobian().

◆ _arhouA_var_number

const unsigned int OneD3EqnEnergyGravity::_arhouA_var_number

protected

Definition at line 43 of file OneD3EqnEnergyGravity.h.

Referenced by computeQpOffDiagJacobian().

◆ _dir

const MaterialProperty<RealVectorValue>& OneD3EqnEnergyGravity::_dir

protected

The direction of the flow channel.

Definition at line 38 of file OneD3EqnEnergyGravity.h.

Referenced by computeQpOffDiagJacobian(), and computeQpResidual().

◆ _drho_darhoA

const MaterialProperty<Real>& OneD3EqnEnergyGravity::_drho_darhoA

protected

Definition at line 31 of file OneD3EqnEnergyGravity.h.

Referenced by computeQpOffDiagJacobian().

◆ _dvel_darhoA

const MaterialProperty<Real>& OneD3EqnEnergyGravity::_dvel_darhoA

protected

Definition at line 34 of file OneD3EqnEnergyGravity.h.

Referenced by computeQpOffDiagJacobian().

◆ _dvel_darhouA

const MaterialProperty<Real>& OneD3EqnEnergyGravity::_dvel_darhouA

protected

Definition at line 35 of file OneD3EqnEnergyGravity.h.

Referenced by computeQpOffDiagJacobian().

◆ _gravity_vector

const RealVectorValue& OneD3EqnEnergyGravity::_gravity_vector

protected

Gravitational acceleration vector.

Definition at line 40 of file OneD3EqnEnergyGravity.h.

Referenced by computeQpOffDiagJacobian(), and computeQpResidual().

◆ _rho

const MaterialProperty<Real>& OneD3EqnEnergyGravity::_rho

protected

Definition at line 30 of file OneD3EqnEnergyGravity.h.

Referenced by computeQpOffDiagJacobian(), and computeQpResidual().

◆ _vel

const MaterialProperty<Real>& OneD3EqnEnergyGravity::_vel

protected

Definition at line 33 of file OneD3EqnEnergyGravity.h.

Referenced by computeQpOffDiagJacobian(), and computeQpResidual().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OneD3EqnEnergyGravity()

Member Function Documentation

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

◆ declarePropertyDerivativeTHM()

◆ getMaterialPropertyDerivativeTHM()

◆ getMaterialPropertyDerivativeTHMPhase()

◆ validParams()

Member Data Documentation

◆ _A

◆ _arhoA_var_number

◆ _arhouA_var_number

◆ _dir

◆ _drho_darhoA

◆ _dvel_darhoA

◆ _dvel_darhouA

◆ _gravity_vector

◆ _rho

◆ _vel