Computes Reynolds number as a material property. More...

#include <ReynoldsNumberMaterial.h>

Inheritance diagram for ReynoldsNumberMaterial:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	ReynoldsNumberMaterial (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 void	computeQpProperties ()

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

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

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.

Protected Attributes
const MaterialPropertyName &	_Re_name
	Reynolds number property name.

const MaterialProperty< Real > &	_rho
	Density of the phase.

const MaterialProperty< Real > *const	_drho_dbeta

const MaterialProperty< Real > &	_drho_darhoA

const MaterialProperty< Real > &	_vel
	Velocity of the phase.

const MaterialProperty< Real > &	_dvel_darhoA

const MaterialProperty< Real > &	_dvel_darhouA

const MaterialProperty< Real > &	_D_h
	Hydraulic diameter.

const MaterialProperty< Real > &	_mu
	Dynamic viscosity of the phase.

const MaterialProperty< Real > *const	_dmu_dbeta

const MaterialProperty< Real > &	_dmu_darhoA

const MaterialProperty< Real > &	_dmu_darhouA

const MaterialProperty< Real > &	_dmu_darhoEA

MaterialProperty< Real > &	_Re
	Reynolds.

MaterialProperty< Real > *const	_dRe_dbeta

MaterialProperty< Real > &	_dRe_darhoA

MaterialProperty< Real > &	_dRe_darhouA

MaterialProperty< Real > &	_dRe_darhoEA

Private Member Functions
bool	haveMaterialProperty (const std::string &prop_name)

std::vector< VariableName >	buildVariableVector (const VariableName &c1, const VariableName &c2, const VariableName &c3)

void	validateCouplingHelper (const MaterialPropertyName &base, const std::vector< VariableName > &c, const System &system, std::vector< VariableName > &missing)

bool	isNotObjectVariable (const VariableName &name)

Private Attributes
FEProblemBase &	_dmi_fe_problem

Detailed Description

Computes Reynolds number as a material property.

Definition at line 20 of file ReynoldsNumberMaterial.h.

Constructor & Destructor Documentation

◆ ReynoldsNumberMaterial()

ReynoldsNumberMaterial::ReynoldsNumberMaterial ( const InputParameters & parameters )

Definition at line 38 of file ReynoldsNumberMaterial.C.

  : DerivativeMaterialInterfaceTHM<Material>(parameters),
 
    _Re_name(getParam<MaterialPropertyName>("Re")),
 
    _rho(getMaterialProperty<Real>("rho")),
    _drho_dbeta(isCoupled("beta") ? &getMaterialPropertyDerivativeTHM<Real>("rho", "beta")
                                  : nullptr),
    _drho_darhoA(getMaterialPropertyDerivativeTHM<Real>("rho", "arhoA")),
 
    _vel(getMaterialProperty<Real>("vel")),
    _dvel_darhoA(getMaterialPropertyDerivativeTHM<Real>("vel", "arhoA")),
    _dvel_darhouA(getMaterialPropertyDerivativeTHM<Real>("vel", "arhouA")),
 
    _D_h(getMaterialProperty<Real>("D_h")),
 
    _mu(getMaterialProperty<Real>("mu")),
    _dmu_dbeta(isCoupled("beta") ? &getMaterialPropertyDerivative<Real>("mu", "beta") : nullptr),
    _dmu_darhoA(getMaterialPropertyDerivative<Real>("mu", "arhoA")),
    _dmu_darhouA(getMaterialPropertyDerivative<Real>("mu", "arhouA")),
    _dmu_darhoEA(getMaterialPropertyDerivative<Real>("mu", "arhoEA")),
 
    _Re(declareProperty<Real>(_Re_name)),
    _dRe_dbeta(isCoupled("beta") ? &declarePropertyDerivativeTHM<Real>(_Re_name, "beta") : nullptr),
    _dRe_darhoA(declarePropertyDerivativeTHM<Real>(_Re_name, "arhoA")),
    _dRe_darhouA(declarePropertyDerivativeTHM<Real>(_Re_name, "arhouA")),
    _dRe_darhoEA(declarePropertyDerivativeTHM<Real>(_Re_name, "arhoEA"))
{
}

Member Function Documentation

◆ computeQpProperties()

void ReynoldsNumberMaterial::computeQpProperties ( )

protectedvirtual

Definition at line 69 of file ReynoldsNumberMaterial.C.

{
  _Re[_qp] = THM::Reynolds(1., _rho[_qp], _vel[_qp], _D_h[_qp], _mu[_qp]);
 
  const Real dRe_drho = std::fabs(_vel[_qp]) * _D_h[_qp] / _mu[_qp];
  const Real dRe_dvel = MathUtils::sign(_vel[_qp]) * _rho[_qp] * _D_h[_qp] / _mu[_qp];
  const Real dRe_dmu = -_rho[_qp] * std::fabs(_vel[_qp]) * _D_h[_qp] / std::pow(_mu[_qp], 2);
 
  if (isCoupled("beta"))
    (*_dRe_dbeta)[_qp] = dRe_drho * (*_drho_dbeta)[_qp] + dRe_dmu * (*_dmu_dbeta)[_qp];
  _dRe_darhoA[_qp] =
      dRe_drho * _drho_darhoA[_qp] + dRe_dvel * _dvel_darhoA[_qp] + dRe_dmu * _dmu_darhoA[_qp];
  _dRe_darhouA[_qp] = dRe_dvel * _dvel_darhouA[_qp] + dRe_dmu * _dmu_darhouA[_qp];
  _dRe_darhoEA[_qp] = dRe_dmu * _dmu_darhoEA[_qp];
}

◆ declarePropertyDerivativeTHM()

MaterialProperty< U > & DerivativeMaterialInterfaceTHM< Material >::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 32 of file DerivativeMaterialInterfaceTHM.h.

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

◆ getMaterialPropertyDerivativeTHM()

const MaterialProperty< U > & DerivativeMaterialInterfaceTHM< Material >::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 47 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< Material >::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 71 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 ReynoldsNumberMaterial::validParams ( )

static

Definition at line 18 of file ReynoldsNumberMaterial.C.

{
  InputParameters params = Material::validParams();
 
  params.addCoupledVar("beta", "Remapped volume fraction of liquid");
  params.addRequiredCoupledVar("arhoA", "alpha*rho*A");
  params.addRequiredCoupledVar("arhouA", "alpha*rho*vel*A");
  params.addRequiredCoupledVar("arhoEA", "alpha*rho*E*A");
 
  params.addRequiredParam<MaterialPropertyName>("Re", "Reynolds number property name");
  params.addRequiredParam<MaterialPropertyName>("rho", "Density of the phase");
  params.addRequiredParam<MaterialPropertyName>("vel", "Velocity of the phase");
  params.addRequiredParam<MaterialPropertyName>("D_h", "Hydraulic diameter");
  params.addRequiredParam<MaterialPropertyName>("mu", "Dynamic viscosity of the phase");
 
  params.addClassDescription("Computes Reynolds number as a material property");
 
  return params;
}

Member Data Documentation

◆ _D_h

const MaterialProperty<Real>& ReynoldsNumberMaterial::_D_h

protected

Hydraulic diameter.

Definition at line 42 of file ReynoldsNumberMaterial.h.

Referenced by computeQpProperties().

◆ _dmu_darhoA

const MaterialProperty<Real>& ReynoldsNumberMaterial::_dmu_darhoA

protected

Definition at line 47 of file ReynoldsNumberMaterial.h.

Referenced by computeQpProperties().

◆ _dmu_darhoEA

const MaterialProperty<Real>& ReynoldsNumberMaterial::_dmu_darhoEA

protected

Definition at line 49 of file ReynoldsNumberMaterial.h.

Referenced by computeQpProperties().

◆ _dmu_darhouA

const MaterialProperty<Real>& ReynoldsNumberMaterial::_dmu_darhouA

protected

Definition at line 48 of file ReynoldsNumberMaterial.h.

Referenced by computeQpProperties().

◆ _dmu_dbeta

const MaterialProperty<Real>* const ReynoldsNumberMaterial::_dmu_dbeta

protected

Definition at line 46 of file ReynoldsNumberMaterial.h.

◆ _dRe_darhoA

MaterialProperty<Real>& ReynoldsNumberMaterial::_dRe_darhoA

protected

Definition at line 54 of file ReynoldsNumberMaterial.h.

Referenced by computeQpProperties().

◆ _dRe_darhoEA

MaterialProperty<Real>& ReynoldsNumberMaterial::_dRe_darhoEA

protected

Definition at line 56 of file ReynoldsNumberMaterial.h.

Referenced by computeQpProperties().

◆ _dRe_darhouA

MaterialProperty<Real>& ReynoldsNumberMaterial::_dRe_darhouA

protected

Definition at line 55 of file ReynoldsNumberMaterial.h.

Referenced by computeQpProperties().

◆ _dRe_dbeta

MaterialProperty<Real>* const ReynoldsNumberMaterial::_dRe_dbeta

protected

Definition at line 53 of file ReynoldsNumberMaterial.h.

◆ _drho_darhoA

const MaterialProperty<Real>& ReynoldsNumberMaterial::_drho_darhoA

protected

Definition at line 34 of file ReynoldsNumberMaterial.h.

Referenced by computeQpProperties().

◆ _drho_dbeta

const MaterialProperty<Real>* const ReynoldsNumberMaterial::_drho_dbeta

protected

Definition at line 33 of file ReynoldsNumberMaterial.h.

◆ _dvel_darhoA

const MaterialProperty<Real>& ReynoldsNumberMaterial::_dvel_darhoA

protected

Definition at line 38 of file ReynoldsNumberMaterial.h.

Referenced by computeQpProperties().

◆ _dvel_darhouA

const MaterialProperty<Real>& ReynoldsNumberMaterial::_dvel_darhouA

protected

Definition at line 39 of file ReynoldsNumberMaterial.h.

Referenced by computeQpProperties().

◆ _mu

const MaterialProperty<Real>& ReynoldsNumberMaterial::_mu

protected

Dynamic viscosity of the phase.

Definition at line 45 of file ReynoldsNumberMaterial.h.

Referenced by computeQpProperties().

◆ _Re

MaterialProperty<Real>& ReynoldsNumberMaterial::_Re

protected

Reynolds.

Definition at line 52 of file ReynoldsNumberMaterial.h.

Referenced by computeQpProperties().

◆ _Re_name

const MaterialPropertyName& ReynoldsNumberMaterial::_Re_name

protected

Reynolds number property name.

Definition at line 29 of file ReynoldsNumberMaterial.h.

◆ _rho

const MaterialProperty<Real>& ReynoldsNumberMaterial::_rho

protected

Density of the phase.

Definition at line 32 of file ReynoldsNumberMaterial.h.

Referenced by computeQpProperties().

◆ _vel

const MaterialProperty<Real>& ReynoldsNumberMaterial::_vel

protected

Velocity of the phase.

Definition at line 37 of file ReynoldsNumberMaterial.h.

Referenced by computeQpProperties().

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

thermal_hydraulics/include/materials/ReynoldsNumberMaterial.h
thermal_hydraulics/src/materials/ReynoldsNumberMaterial.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ReynoldsNumberMaterial()

Member Function Documentation

◆ computeQpProperties()

◆ declarePropertyDerivativeTHM()

◆ getMaterialPropertyDerivativeTHM()

◆ getMaterialPropertyDerivativeTHMPhase()

◆ validParams()

Member Data Documentation

◆ _D_h

◆ _dmu_darhoA

◆ _dmu_darhoEA

◆ _dmu_darhouA

◆ _dmu_dbeta

◆ _dRe_darhoA

◆ _dRe_darhoEA

◆ _dRe_darhouA

◆ _dRe_dbeta

◆ _drho_darhoA

◆ _drho_dbeta

◆ _dvel_darhoA

◆ _dvel_darhouA

◆ _mu

◆ _Re

◆ _Re_name

◆ _rho

◆ _vel