OneD3EqnMomentumAreaGradient Class Reference

Computes the area gradient term in the momentum equation. More...

#include <OneD3EqnMomentumAreaGradient.h>

Inheritance diagram for OneD3EqnMomentumAreaGradient:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	OneD3EqnMomentumAreaGradient (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 VariableGradient &	_area_grad
const MaterialProperty< RealVectorValue > &	_dir
	The direction of the flow channel. More...
const MaterialProperty< Real > &	_pressure
const MaterialProperty< Real > &	_dp_darhoA
const MaterialProperty< Real > &	_dp_darhouA
const MaterialProperty< Real > &	_dp_darhoEA
unsigned int	_arhoA_var_number
unsigned int	_arhoE_var_number

Detailed Description

Computes the area gradient term in the momentum equation.

This kernel computes the following area gradient term in momentum equation:

\[ p_k \frac{\partial A}{\partial x} . \]

Definition at line 23 of file OneD3EqnMomentumAreaGradient.h.

Constructor & Destructor Documentation

OneD3EqnMomentumAreaGradient()

OneD3EqnMomentumAreaGradient::OneD3EqnMomentumAreaGradient

(

const InputParameters &

parameters

)

Definition at line 30 of file OneD3EqnMomentumAreaGradient.C.

  : DerivativeMaterialInterfaceTHM<Kernel>(parameters),
    _area_grad(coupledGradient("A")),
    _dir(getMaterialProperty<RealVectorValue>("direction")),
    _pressure(getMaterialProperty<Real>("p")),
    _dp_darhoA(getMaterialPropertyDerivativeTHM<Real>("p", "arhoA")),
    _dp_darhouA(getMaterialPropertyDerivativeTHM<Real>("p", "arhouA")),
    _dp_darhoEA(getMaterialPropertyDerivativeTHM<Real>("p", "arhoEA")),
    _arhoA_var_number(coupled("arhoA")),
    _arhoE_var_number(coupled("arhoEA"))
{
}

Member Function Documentation

computeQpJacobian()

Real OneD3EqnMomentumAreaGradient::computeQpJacobian ( )

protectedvirtual

Definition at line 50 of file OneD3EqnMomentumAreaGradient.C.

{
  return -_dp_darhouA[_qp] * _area_grad[_qp] * _dir[_qp] * _phi[_j][_qp] * _test[_i][_qp];
}

computeQpOffDiagJacobian()

Real OneD3EqnMomentumAreaGradient::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Definition at line 56 of file OneD3EqnMomentumAreaGradient.C.

{
  if (jvar == _arhoA_var_number)
  {
    return -_dp_darhoA[_qp] * _area_grad[_qp] * _dir[_qp] * _phi[_j][_qp] * _test[_i][_qp];
  }
  else if (jvar == _arhoE_var_number)
  {
    return -_dp_darhoEA[_qp] * _area_grad[_qp] * _dir[_qp] * _phi[_j][_qp] * _test[_i][_qp];
  }
  else
    return 0;
}

computeQpResidual()

Real OneD3EqnMomentumAreaGradient::computeQpResidual ( )

protectedvirtual

Definition at line 44 of file OneD3EqnMomentumAreaGradient.C.

{
  return -_pressure[_qp] * _area_grad[_qp] * _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 OneD3EqnMomentumAreaGradient::validParams ( )

static

Definition at line 15 of file OneD3EqnMomentumAreaGradient.C.

{
  InputParameters params = Kernel::validParams();
  params.addRequiredCoupledVar("arhoA", "The density of the kth phase");
  params.addRequiredCoupledVar("arhouA", "The momentum of the kth phase");
  params.addRequiredCoupledVar("arhoEA", "The total energy of the kth phase");
  params.addRequiredCoupledVar("A", "Cross-sectional area");
  params.addRequiredParam<MaterialPropertyName>(
      "direction", "The direction of the flow channel material property");
  params.addRequiredParam<MaterialPropertyName>("p", "Pressure");
  params.addClassDescription(
      "Computes the area gradient term in the momentum equation for single phase flow.");
  return params;
}

Member Data Documentation

_area_grad

const VariableGradient& OneD3EqnMomentumAreaGradient::_area_grad

protected

Definition at line 33 of file OneD3EqnMomentumAreaGradient.h.

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

_arhoA_var_number

unsigned int OneD3EqnMomentumAreaGradient::_arhoA_var_number

protected

Definition at line 43 of file OneD3EqnMomentumAreaGradient.h.

Referenced by computeQpOffDiagJacobian().

_arhoE_var_number

unsigned int OneD3EqnMomentumAreaGradient::_arhoE_var_number

protected

Definition at line 44 of file OneD3EqnMomentumAreaGradient.h.

Referenced by computeQpOffDiagJacobian().

_dir

const MaterialProperty<RealVectorValue>& OneD3EqnMomentumAreaGradient::_dir

protected

The direction of the flow channel.

Definition at line 36 of file OneD3EqnMomentumAreaGradient.h.

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

_dp_darhoA

const MaterialProperty<Real>& OneD3EqnMomentumAreaGradient::_dp_darhoA

protected

Definition at line 39 of file OneD3EqnMomentumAreaGradient.h.

Referenced by computeQpOffDiagJacobian().

_dp_darhoEA

const MaterialProperty<Real>& OneD3EqnMomentumAreaGradient::_dp_darhoEA

protected

Definition at line 41 of file OneD3EqnMomentumAreaGradient.h.

Referenced by computeQpOffDiagJacobian().

_dp_darhouA

const MaterialProperty<Real>& OneD3EqnMomentumAreaGradient::_dp_darhouA

protected

Definition at line 40 of file OneD3EqnMomentumAreaGradient.h.

Referenced by computeQpJacobian().

_pressure

const MaterialProperty<Real>& OneD3EqnMomentumAreaGradient::_pressure

protected

Definition at line 38 of file OneD3EqnMomentumAreaGradient.h.

Referenced by computeQpResidual().

---

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

• thermal_hydraulics/include/kernels/OneD3EqnMomentumAreaGradient.h
• thermal_hydraulics/src/kernels/OneD3EqnMomentumAreaGradient.C