#include <DerivativeMaterialInterfaceTHM.h>

Inheritance diagram for DerivativeMaterialInterfaceTHM< T >:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	DerivativeMaterialInterfaceTHM (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

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

template<typename U >
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...

template<typename U >
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...

Detailed Description

template<class T>
class DerivativeMaterialInterfaceTHM< T >

Definition at line 15 of file DerivativeMaterialInterfaceTHM.h.

Constructor & Destructor Documentation

◆ DerivativeMaterialInterfaceTHM()

template<class T >

DerivativeMaterialInterfaceTHM< T >::DerivativeMaterialInterfaceTHM ( const InputParameters & parameters )

Definition at line 79 of file DerivativeMaterialInterfaceTHM.h.

   : DerivativeMaterialInterface<T>(parameters)
 {
 }

Member Function Documentation

◆ declarePropertyDerivativeTHM()

template<class T >

template<typename U >

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

protected

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()

template<class T >

template<typename U >

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

protected

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()

template<class T >

template<typename U >

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

protected

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);
   }
 }

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

thermal_hydraulics/include/materials/DerivativeMaterialInterfaceTHM.h

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

template<class T> class DerivativeMaterialInterfaceTHM< T >

Constructor & Destructor Documentation

◆ DerivativeMaterialInterfaceTHM()

Member Function Documentation

◆ declarePropertyDerivativeTHM()

◆ getMaterialPropertyDerivativeTHM()

◆ getMaterialPropertyDerivativeTHMPhase()

template<class T>
class DerivativeMaterialInterfaceTHM< T >