Computes dynamic viscosity. More...

#include <DynamicViscosityMaterial.h>

Inheritance diagram for DynamicViscosityMaterial:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	DynamicViscosityMaterial (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 () override

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 &	_mu_name
	Dynamic viscosity name.

MaterialProperty< Real > &	_mu

MaterialProperty< Real > *const	_dmu_dbeta

MaterialProperty< Real > &	_dmu_darhoA

MaterialProperty< Real > &	_dmu_darhouA

MaterialProperty< Real > &	_dmu_darhoEA

const MaterialProperty< Real > &	_v
	Specific volume.

const MaterialProperty< Real > *const	_dv_dbeta

const MaterialProperty< Real > &	_dv_darhoA

const MaterialProperty< Real > &	_e
	Specific internal energy.

const MaterialProperty< Real > &	_de_darhoA

const MaterialProperty< Real > &	_de_darhouA

const MaterialProperty< Real > &	_de_darhoEA

const SinglePhaseFluidProperties &	_fp_1phase
	Single-phase fluid properties.

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 dynamic viscosity.

Definition at line 20 of file DynamicViscosityMaterial.h.

Constructor & Destructor Documentation

◆ DynamicViscosityMaterial()

DynamicViscosityMaterial::DynamicViscosityMaterial ( const InputParameters & parameters )

Definition at line 36 of file DynamicViscosityMaterial.C.

  : DerivativeMaterialInterfaceTHM<Material>(parameters),
 
    _mu_name(getParam<MaterialPropertyName>("mu")),
    _mu(declareProperty<Real>(_mu_name)),
    _dmu_dbeta(isParamValid("beta") ? &declarePropertyDerivativeTHM<Real>(_mu_name, "beta")
                                    : nullptr),
    _dmu_darhoA(declarePropertyDerivativeTHM<Real>(_mu_name, "arhoA")),
    _dmu_darhouA(declarePropertyDerivativeTHM<Real>(_mu_name, "arhouA")),
    _dmu_darhoEA(declarePropertyDerivativeTHM<Real>(_mu_name, "arhoEA")),
 
    _v(getMaterialProperty<Real>("v")),
    _dv_dbeta(isParamValid("beta") ? &getMaterialPropertyDerivativeTHM<Real>("v", "beta")
                                   : nullptr),
    _dv_darhoA(getMaterialPropertyDerivativeTHM<Real>("v", "arhoA")),
 
    _e(getMaterialProperty<Real>("e")),
    _de_darhoA(getMaterialPropertyDerivativeTHM<Real>("e", "arhoA")),
    _de_darhouA(getMaterialPropertyDerivativeTHM<Real>("e", "arhouA")),
    _de_darhoEA(getMaterialPropertyDerivativeTHM<Real>("e", "arhoEA")),
 
    _fp_1phase(getUserObject<SinglePhaseFluidProperties>("fp_1phase"))
{
}

Member Function Documentation

◆ computeQpProperties()

void DynamicViscosityMaterial::computeQpProperties ( )

overrideprotectedvirtual

Definition at line 62 of file DynamicViscosityMaterial.C.

{
  Real dmu_dv, dmu_de;
  _fp_1phase.mu_from_v_e(_v[_qp], _e[_qp], _mu[_qp], dmu_dv, dmu_de);
 
  if (isParamValid("beta"))
    (*_dmu_dbeta)[_qp] = dmu_dv * (*_dv_dbeta)[_qp];
  _dmu_darhoA[_qp] = dmu_dv * _dv_darhoA[_qp] + dmu_de * _de_darhoA[_qp];
  _dmu_darhouA[_qp] = dmu_de * _de_darhouA[_qp];
  _dmu_darhoEA[_qp] = dmu_de * _de_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 DynamicViscosityMaterial::validParams ( )

static

Definition at line 16 of file DynamicViscosityMaterial.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>("mu", "Dynamic viscosity property");
  params.addRequiredParam<MaterialPropertyName>("v", "Specific volume property");
  params.addRequiredParam<MaterialPropertyName>("e", "Specific internal energy property");
 
  params.addRequiredParam<UserObjectName>("fp_1phase", "Single-phase fluid properties");
 
  params.addClassDescription("Computes the dynamic viscosity as a material property");
 
  return params;
}

Member Data Documentation

◆ _de_darhoA

const MaterialProperty<Real>& DynamicViscosityMaterial::_de_darhoA

protected

Definition at line 45 of file DynamicViscosityMaterial.h.

Referenced by computeQpProperties().

◆ _de_darhoEA

const MaterialProperty<Real>& DynamicViscosityMaterial::_de_darhoEA

protected

Definition at line 47 of file DynamicViscosityMaterial.h.

Referenced by computeQpProperties().

◆ _de_darhouA

const MaterialProperty<Real>& DynamicViscosityMaterial::_de_darhouA

protected

Definition at line 46 of file DynamicViscosityMaterial.h.

Referenced by computeQpProperties().

◆ _dmu_darhoA

MaterialProperty<Real>& DynamicViscosityMaterial::_dmu_darhoA

protected

Definition at line 34 of file DynamicViscosityMaterial.h.

Referenced by computeQpProperties().

◆ _dmu_darhoEA

MaterialProperty<Real>& DynamicViscosityMaterial::_dmu_darhoEA

protected

Definition at line 36 of file DynamicViscosityMaterial.h.

Referenced by computeQpProperties().

◆ _dmu_darhouA

MaterialProperty<Real>& DynamicViscosityMaterial::_dmu_darhouA

protected

Definition at line 35 of file DynamicViscosityMaterial.h.

Referenced by computeQpProperties().

◆ _dmu_dbeta

MaterialProperty<Real>* const DynamicViscosityMaterial::_dmu_dbeta

protected

Definition at line 33 of file DynamicViscosityMaterial.h.

◆ _dv_darhoA

const MaterialProperty<Real>& DynamicViscosityMaterial::_dv_darhoA

protected

Definition at line 41 of file DynamicViscosityMaterial.h.

Referenced by computeQpProperties().

◆ _dv_dbeta

const MaterialProperty<Real>* const DynamicViscosityMaterial::_dv_dbeta

protected

Definition at line 40 of file DynamicViscosityMaterial.h.

◆ _e

const MaterialProperty<Real>& DynamicViscosityMaterial::_e

protected

Specific internal energy.

Definition at line 44 of file DynamicViscosityMaterial.h.

Referenced by computeQpProperties().

◆ _fp_1phase

const SinglePhaseFluidProperties& DynamicViscosityMaterial::_fp_1phase

protected

Single-phase fluid properties.

Definition at line 50 of file DynamicViscosityMaterial.h.

Referenced by computeQpProperties().

◆ _mu

MaterialProperty<Real>& DynamicViscosityMaterial::_mu

protected

Definition at line 32 of file DynamicViscosityMaterial.h.

Referenced by computeQpProperties().

◆ _mu_name

const MaterialPropertyName& DynamicViscosityMaterial::_mu_name

protected

Dynamic viscosity name.

Definition at line 29 of file DynamicViscosityMaterial.h.

◆ _v

const MaterialProperty<Real>& DynamicViscosityMaterial::_v

protected

Specific volume.

Definition at line 39 of file DynamicViscosityMaterial.h.

Referenced by computeQpProperties().

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

thermal_hydraulics/include/materials/DynamicViscosityMaterial.h
thermal_hydraulics/src/materials/DynamicViscosityMaterial.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

◆ DynamicViscosityMaterial()

Member Function Documentation

◆ computeQpProperties()

◆ declarePropertyDerivativeTHM()

◆ getMaterialPropertyDerivativeTHM()

◆ getMaterialPropertyDerivativeTHMPhase()

◆ validParams()

Member Data Documentation

◆ _de_darhoA

◆ _de_darhoEA

◆ _de_darhouA

◆ _dmu_darhoA

◆ _dmu_darhoEA

◆ _dmu_darhouA

◆ _dmu_dbeta

◆ _dv_darhoA

◆ _dv_dbeta

◆ _e

◆ _fp_1phase

◆ _mu

◆ _mu_name

◆ _v