Class for testing objects derived from SmoothTransition. More...

#include <SmoothTransitionTestMaterial.h>

Inheritance diagram for SmoothTransitionTestMaterial:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

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

Real	f1 (const Real &x) const

Real	f2 (const Real &x) const

Real	df1dx (const Real &x) const

Real	df2dx (const Real &x) const

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 MooseEnum &	_transition_type

const VariableValue &	_var

CubicTransition	_cubic_transition

const WeightedTransition	_weighted_transition

MaterialProperty< Real > &	_matprop

MaterialProperty< Real > &	_dmatprop_dvar

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

Class for testing objects derived from SmoothTransition.

Definition at line 19 of file SmoothTransitionTestMaterial.h.

Constructor & Destructor Documentation

◆ SmoothTransitionTestMaterial()

SmoothTransitionTestMaterial::SmoothTransitionTestMaterial ( const InputParameters & parameters )

Definition at line 29 of file SmoothTransitionTestMaterial.C.

  : DerivativeMaterialInterfaceTHM<Material>(parameters),
 
    _transition_type(getParam<MooseEnum>("transition_type")),
 
    _var(coupledValue("var")),
 
    _cubic_transition(0.0, 1.0),
    _weighted_transition(0.0, 1.0),
 
    _matprop(declareProperty<Real>("mymatprop")),
    _dmatprop_dvar(declarePropertyDerivativeTHM<Real>("mymatprop", "var"))
{
  const Real & x1 = _cubic_transition.leftEnd();
  const Real & x2 = _cubic_transition.rightEnd();
  _cubic_transition.initialize(f1(x1), f2(x2), df1dx(x1), df2dx(x2));
}

Member Function Documentation

◆ computeQpProperties()

void SmoothTransitionTestMaterial::computeQpProperties ( )

overrideprotectedvirtual

Definition at line 48 of file SmoothTransitionTestMaterial.C.

{
  const Real & x = _var[_qp];
 
  if (_transition_type == "cubic")
  {
    _matprop[_qp] = _cubic_transition.value(x, f1(x), f2(x));
    _dmatprop_dvar[_qp] = _cubic_transition.derivative(x, df1dx(x), df2dx(x));
  }
  else if (_transition_type == "weighted")
  {
    _matprop[_qp] = _weighted_transition.value(x, f1(x), f2(x));
    _dmatprop_dvar[_qp] = _weighted_transition.derivative(x, f1(x), f2(x), df1dx(x), df2dx(x));
  }
}

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

◆ df1dx()

Real SmoothTransitionTestMaterial::df1dx ( const Real & x ) const

protected

Definition at line 77 of file SmoothTransitionTestMaterial.C.

{
  return 2;
}

Referenced by computeQpProperties(), and SmoothTransitionTestMaterial().

◆ df2dx()

Real SmoothTransitionTestMaterial::df2dx ( const Real & x ) const

protected

Definition at line 83 of file SmoothTransitionTestMaterial.C.

{
  return 1 - x;
}

Referenced by computeQpProperties(), and SmoothTransitionTestMaterial().

◆ f1()

Real SmoothTransitionTestMaterial::f1 ( const Real & x ) const

protected

Definition at line 65 of file SmoothTransitionTestMaterial.C.

{
  return 2 * x + 2;
}

Referenced by computeQpProperties(), and SmoothTransitionTestMaterial().

◆ f2()

Real SmoothTransitionTestMaterial::f2 ( const Real & x ) const

protected

Definition at line 71 of file SmoothTransitionTestMaterial.C.

{
  return -0.5 * std::pow(x - 1, 2) + 1;
}

Referenced by computeQpProperties(), and SmoothTransitionTestMaterial().

◆ 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 SmoothTransitionTestMaterial::validParams ( )

static

Definition at line 15 of file SmoothTransitionTestMaterial.C.

{
  InputParameters params = Material::validParams();
 
  MooseEnum transition_type("cubic weighted");
  params.addRequiredParam<MooseEnum>("transition_type", transition_type, "The transition to test");
 
  params.addRequiredCoupledVar("var", "Variable on which transition depends");
 
  params.addClassDescription("Class for testing objects derived from SmoothTransition");
 
  return params;
}