Interface class ("Veneer") to provide generator methods for derivative material property names, and guarded getMaterialPropertyPointer calls. More...

#include <DerivativeKernelInterface.h>

Inheritance diagram for DerivativeKernelInterface< T >:

[legend]

Public Member Functions
	DerivativeKernelInterface (const InputParameters &parameters)

template<typename U >
const MaterialProperty< U > &	getDefaultMaterialProperty (const std::string &name)
	Fetch a material property if it exists, otherwise return getZeroMaterialProperty. More...

template<typename U >
const MaterialProperty< U > &	getDefaultMaterialPropertyByName (const std::string &name)
	Fetch a material property by name if it exists, otherwise return getZeroMaterialProperty. More...

template<typename U >
void	validateDerivativeMaterialPropertyBase (const std::string &base)
	Check if the material property base exists. More...

const MaterialPropertyName	derivativePropertyName (const MaterialPropertyName &base, const std::vector< VariableName > &c) const
	Helper functions to generate the material property names for the arbitrary derivatives. More...

const MaterialPropertyName	derivativePropertyNameFirst (const MaterialPropertyName &base, const VariableName &c1) const
	Helper functions to generate the material property names for the first derivatives. More...

const MaterialPropertyName	derivativePropertyNameSecond (const MaterialPropertyName &base, const VariableName &c1, const VariableName &c2) const
	Helper functions to generate the material property names for the second derivatives. More...

const MaterialPropertyName	derivativePropertyNameThird (const MaterialPropertyName &base, const VariableName &c1, const VariableName &c2, const VariableName &c3) const
	Helper functions to generate the material property names for the third derivatives. More...


template<typename U >
MaterialProperty< U > &	declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
	Methods for declaring derivative material properties. More...

template<typename U >
MaterialProperty< U > &	declarePropertyDerivative (const std::string &base, const VariableName &c1, const VariableName &c2="", const VariableName &c3="")


template<typename U >
const MaterialProperty< U > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
	Methods for retreiving derivative material properties. More...

template<typename U >
const MaterialProperty< U > &	getMaterialPropertyDerivative (const std::string &base, const VariableName &c1, const VariableName &c2="", const VariableName &c3="")


template<typename U >
const MaterialProperty< U > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)
	Methods for retreiving derivative material properties. More...

template<typename U >
const MaterialProperty< U > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const VariableName &c1, const VariableName &c2="", const VariableName &c3="")


template<typename U >
void	validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)
	check if derivatives of the passed in material property exist w.r.t a variable that is not coupled in to the current object More...

template<typename U >
void	validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

template<typename U >
void	validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")


const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< VariableName > &c) const
	aliases for the deprecated old function names More...

const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const VariableName &c1) const

const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const VariableName &c1, const VariableName &c2) const

const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const VariableName &c1, const VariableName &c2, const VariableName &c3) const

Static Public Member Functions
static InputParameters	validParams ()
	as partial template specialization is not allowed in C++ we have to implement this as a static method More...

Protected Attributes
unsigned int	_nvar

std::string	_F_name

Detailed Description

template<class T>
class DerivativeKernelInterface< T >

Interface class ("Veneer") to provide generator methods for derivative material property names, and guarded getMaterialPropertyPointer calls.

Definition at line 20 of file DerivativeKernelInterface.h.

Constructor & Destructor Documentation

◆ DerivativeKernelInterface()

template<class T >

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

Definition at line 34 of file DerivativeKernelInterface.h.

   : DerivativeMaterialInterface<T>(parameters),
     _nvar(this->_coupled_moose_vars.size()),
     _F_name(this->template getParam<std::string>("f_name"))
 {
 }

Member Function Documentation

◆ declarePropertyDerivative() [1/2]

template<class T >

template<typename U >

MaterialProperty< U > & DerivativeMaterialInterface< T >::declarePropertyDerivative	(	const std::string &	base,
		const std::vector< VariableName > &	c
	)

inherited

Methods for declaring derivative material properties.

Template Parameters

U	The material property type

Parameters

base	The name of the property to take the derivative of
c	The variable(s) to take the derivatives with respect to

Definition at line 219 of file DerivativeMaterialInterface.h.

 {
   return this->template declareProperty<U>(derivativePropertyName(base, c));
 }

◆ declarePropertyDerivative() [2/2]

template<class T >

template<typename U >

MaterialProperty< U > & DerivativeMaterialInterface< T >::declarePropertyDerivative	(	const std::string &	base,
		const VariableName &	c1,
		const VariableName &	c2 = `""`,
		const VariableName &	c3 = `""`
	)

inherited

Definition at line 228 of file DerivativeMaterialInterface.h.

 {
   if (c3 != "")
     return this->template declareProperty<U>(derivativePropertyNameThird(base, c1, c2, c3));
   if (c2 != "")
     return this->template declareProperty<U>(derivativePropertyNameSecond(base, c1, c2));
   return this->template declareProperty<U>(derivativePropertyNameFirst(base, c1));
 }

◆ derivativePropertyName()

const MaterialPropertyName DerivativeMaterialPropertyNameInterface::derivativePropertyName	(	const MaterialPropertyName &	base,
		const std::vector< VariableName > &	c
	)		const

inherited

Helper functions to generate the material property names for the arbitrary derivatives.

Definition at line 15 of file DerivativeMaterialPropertyNameInterface.C.

Referenced by DerivativeMaterialPropertyNameInterface::derivativePropertyNameSecond(), DerivativeMaterialPropertyNameInterface::derivativePropertyNameThird(), FunctionMaterialPropertyDescriptor::getPropertyName(), and DerivativeMaterialPropertyNameInterface::propertyName().

 {
   // to obtain well defined names we sort alphabetically
   std::vector<VariableName> a(c);
   std::sort(a.begin(), a.end());
 
   // derivative order
   unsigned int order = a.size();
   if (order == 0)
     return base;
 
   // build the property name as a stringstream
   std::stringstream name;
 
   // build numerator
   name << 'd';
   if (order > 1)
     name << '^' << order;
   name << base << '/';
 
   // build denominator with 'pretty' names using exponents rather than repeat multiplication
   unsigned int exponent = 1;
   for (unsigned i = 1; i <= order; ++i)
   {
     if (i == order || a[i - 1] != a[i])
     {
       name << 'd' << a[i - 1];
       if (exponent > 1)
         name << '^' << exponent;
       exponent = 1;
     }
     else
       exponent++;
   }
 
   return name.str();
 }

◆ derivativePropertyNameFirst()

const MaterialPropertyName DerivativeMaterialPropertyNameInterface::derivativePropertyNameFirst	(	const MaterialPropertyName &	base,
		const VariableName &	c1
	)		const

inherited

Helper functions to generate the material property names for the first derivatives.

Definition at line 55 of file DerivativeMaterialPropertyNameInterface.C.

Referenced by DerivativeFunctionMaterialBase::initialSetup(), and DerivativeMaterialPropertyNameInterface::propertyNameFirst().

 {
   return "d" + base + "/d" + c1;
 }

◆ derivativePropertyNameSecond()

const MaterialPropertyName DerivativeMaterialPropertyNameInterface::derivativePropertyNameSecond	(	const MaterialPropertyName &	base,
		const VariableName &	c1,
		const VariableName &	c2
	)		const

inherited

Helper functions to generate the material property names for the second derivatives.

Definition at line 62 of file DerivativeMaterialPropertyNameInterface.C.

Referenced by DerivativeFunctionMaterialBase::initialSetup(), and DerivativeMaterialPropertyNameInterface::propertyNameSecond().

 {
   return derivativePropertyName(base, {c1, c2});
 }

◆ derivativePropertyNameThird()

const MaterialPropertyName DerivativeMaterialPropertyNameInterface::derivativePropertyNameThird	(	const MaterialPropertyName &	base,
		const VariableName &	c1,
		const VariableName &	c2,
		const VariableName &	c3
	)		const

inherited

Helper functions to generate the material property names for the third derivatives.

Definition at line 69 of file DerivativeMaterialPropertyNameInterface.C.

Referenced by DerivativeFunctionMaterialBase::initialSetup(), and DerivativeMaterialPropertyNameInterface::propertyNameThird().

 {
   return derivativePropertyName(base, {c1, c2, c3});
 }

◆ getDefaultMaterialProperty()

template<class T >

template<typename U >

const MaterialProperty< U > & DerivativeMaterialInterface< T >::getDefaultMaterialProperty ( const std::string & name )

inherited

Fetch a material property if it exists, otherwise return getZeroMaterialProperty.

Parameters

name	The input parameter key of type MaterialPropertyName

Definition at line 189 of file DerivativeMaterialInterface.h.

 {
   // get the base property name
   std::string prop_name = this->deducePropertyName(name);
 
   // Check if it's just a constant
   const MaterialProperty<U> * default_property =
       this->template defaultMaterialProperty<U>(prop_name);
   if (default_property)
     return *default_property;
 
   // if found return the requested property
   return getDefaultMaterialPropertyByName<U>(prop_name);
 }

◆ getDefaultMaterialPropertyByName()

template<class T >

template<typename U >

const MaterialProperty< U > & DerivativeMaterialInterface< T >::getDefaultMaterialPropertyByName ( const std::string & name )

inherited

Fetch a material property by name if it exists, otherwise return getZeroMaterialProperty.

Definition at line 207 of file DerivativeMaterialInterface.h.

 {
   // if found return the requested property
   if (haveMaterialProperty<U>(prop_name))
     return this->template getMaterialPropertyByName<U>(prop_name);
 
   return this->template getZeroMaterialProperty<U>(prop_name);
 }

◆ getMaterialPropertyDerivative() [1/2]

template<class T >

template<typename U >

const MaterialProperty< U > & DerivativeMaterialInterface< T >::getMaterialPropertyDerivative	(	const std::string &	base,
		const std::vector< VariableName > &	c
	)

inherited

Methods for retreiving derivative material properties.

Template Parameters

U	The material property type

Parameters

base	The name of the property to take the derivative of
c	The variable(s) to take the derivatives with respect to

Check if base is a default property and shortcut to returning zero, as derivatives of constants are zero.

Definition at line 243 of file DerivativeMaterialInterface.h.

Referenced by FunctionMaterialPropertyDescriptor::value().

 {
   // get the base property name
   std::string prop_name = this->deducePropertyName(base);
 
   if (this->template defaultMaterialProperty<U>(prop_name))
     return this->template getZeroMaterialProperty<U>(prop_name + "_zeroderivative");
 
   return getDefaultMaterialPropertyByName<U>(derivativePropertyName(prop_name, c));
 }

◆ getMaterialPropertyDerivative() [2/2]

template<class T >

template<typename U >

const MaterialProperty< U > & DerivativeMaterialInterface< T >::getMaterialPropertyDerivative	(	const std::string &	base,
		const VariableName &	c1,
		const VariableName &	c2 = `""`,
		const VariableName &	c3 = `""`
	)

inherited

Check if base is a default property and shortcut to returning zero, as derivatives of constants are zero.

Definition at line 262 of file DerivativeMaterialInterface.h.

 {
   // get the base property name
   std::string prop_name = this->deducePropertyName(base);
 
   if (this->template defaultMaterialProperty<U>(prop_name))
     return this->template getZeroMaterialProperty<U>(prop_name + "_zeroderivative");
 
   if (c3 != "")
     return getDefaultMaterialPropertyByName<U>(derivativePropertyNameThird(prop_name, c1, c2, c3));
   if (c2 != "")
     return getDefaultMaterialPropertyByName<U>(derivativePropertyNameSecond(prop_name, c1, c2));
   return getDefaultMaterialPropertyByName<U>(derivativePropertyNameFirst(prop_name, c1));
 }

◆ getMaterialPropertyDerivativeByName() [1/2]

template<class T >

template<typename U >

const MaterialProperty< U > & DerivativeMaterialInterface< T >::getMaterialPropertyDerivativeByName	(	const MaterialPropertyName &	base,
		const std::vector< VariableName > &	c
	)

inherited

Methods for retreiving derivative material properties.

Template Parameters

U	The material property type

Parameters

base	The name of the property to take the derivative of
c	The variable(s) to take the derivatives with respect to

Definition at line 287 of file DerivativeMaterialInterface.h.

 {
   return getDefaultMaterialPropertyByName<U>(derivativePropertyName(base, c));
 }

◆ getMaterialPropertyDerivativeByName() [2/2]

template<class T >

template<typename U >

const MaterialProperty< U > & DerivativeMaterialInterface< T >::getMaterialPropertyDerivativeByName	(	const MaterialPropertyName &	base,
		const VariableName &	c1,
		const VariableName &	c2 = `""`,
		const VariableName &	c3 = `""`
	)

inherited

Definition at line 296 of file DerivativeMaterialInterface.h.

 {
   if (c3 != "")
     return getDefaultMaterialPropertyByName<U>(derivativePropertyNameThird(base, c1, c2, c3));
   if (c2 != "")
     return getDefaultMaterialPropertyByName<U>(derivativePropertyNameSecond(base, c1, c2));
   return getDefaultMaterialPropertyByName<U>(derivativePropertyNameFirst(base, c1));
 }

◆ propertyName()

const MaterialPropertyName DerivativeMaterialPropertyNameInterface::propertyName	(	const MaterialPropertyName &	base,
		const std::vector< VariableName > &	c
	)		const

inlineinherited

aliases for the deprecated old function names

Definition at line 51 of file DerivativeMaterialPropertyNameInterface.h.

   {
     mooseDeprecated("This function was renamed to 'derivativePropertyName'");
     return derivativePropertyName(base, c);
   }

◆ propertyNameFirst()

const MaterialPropertyName DerivativeMaterialPropertyNameInterface::propertyNameFirst	(	const MaterialPropertyName &	base,
		const VariableName &	c1
	)		const

inlineinherited

Definition at line 57 of file DerivativeMaterialPropertyNameInterface.h.

   {
     mooseDeprecated("This function was renamed to 'derivativePropertyNameFirst'");
     return derivativePropertyNameFirst(base, c1);
   }

◆ propertyNameSecond()

const MaterialPropertyName DerivativeMaterialPropertyNameInterface::propertyNameSecond	(	const MaterialPropertyName &	base,
		const VariableName &	c1,
		const VariableName &	c2
	)		const

inlineinherited

Definition at line 63 of file DerivativeMaterialPropertyNameInterface.h.

   {
     mooseDeprecated("This function was renamed to 'derivativePropertyNameSecond'");
     return derivativePropertyNameSecond(base, c1, c2);
   }

◆ propertyNameThird()

const MaterialPropertyName DerivativeMaterialPropertyNameInterface::propertyNameThird	(	const MaterialPropertyName &	base,
		const VariableName &	c1,
		const VariableName &	c2,
		const VariableName &	c3
	)		const

inlineinherited

Definition at line 70 of file DerivativeMaterialPropertyNameInterface.h.

   {
     mooseDeprecated("This function was renamed to 'derivativePropertyNameThird'");
     return derivativePropertyNameThird(base, c1, c2, c3);
   }

◆ validateCoupling() [1/2]

template<class T >

template<typename U >

void DerivativeMaterialInterface< T >::validateCoupling	(	const MaterialPropertyName &	base,
		const std::vector< VariableName > &	c,
		bool	validate_aux = `true`
	)

inherited

check if derivatives of the passed in material property exist w.r.t a variable that is not coupled in to the current object

Definition at line 352 of file DerivativeMaterialInterface.h.

 {
   // get the base property name
   std::string prop_name = this->deducePropertyName(base);
   // list of potentially missing coupled variables
   std::vector<VariableName> missing;
 
   // iterate over all variables in the both the non-linear and auxiliary system (optional)
   validateCouplingHelper<U>(
       prop_name, c, _dmi_fe_problem.getNonlinearSystemBase().system(), missing);
   if (validate_aux)
     validateCouplingHelper<U>(prop_name, c, _dmi_fe_problem.getAuxiliarySystem().system(), missing);
 
   if (missing.size() > 0)
   {
     // join list of missing variable names
     std::string list = missing[0];
     for (unsigned int i = 1; i < missing.size(); ++i)
       list += ", " + missing[i];
 
     mooseWarning("Missing coupled variables {",
                  list,
                  "} (add them to args parameter of ",
                  this->name(),
                  ")");
   }
 }

◆ validateCoupling() [2/2]

template<class T >

template<typename U >

void DerivativeMaterialInterface< T >::validateCoupling	(	const MaterialPropertyName &	base,
		const VariableName &	c1 = `""`,
		const VariableName &	c2 = `""`,
		const VariableName &	c3 = `""`
	)

inherited

Definition at line 405 of file DerivativeMaterialInterface.h.

 {
   validateCoupling<U>(base, buildVariableVector(c1, c2, c3), true);
 }

◆ validateDerivativeMaterialPropertyBase()

template<class T >

template<typename U >

void DerivativeMaterialInterface< T >::validateDerivativeMaterialPropertyBase ( const std::string & base )

inherited

Check if the material property base exists.

Print a warning if it doesn't. This is useful in materials that pull in only derivative properties, which are optional. If the base property name has a typo all derivatives will be set to zero without the user ever knowing.

Definition at line 427 of file DerivativeMaterialInterface.h.

 {
   // resolve the input parameter name base to the actual material property name
   const MaterialPropertyName prop_name = this->template getParam<MaterialPropertyName>(base);
 
   // check if the material property does not exist on the blocks of the current object,
   // and check if it is not a plain number in the input file
   if (!haveMaterialProperty<U>(prop_name) &&
       this->template defaultMaterialProperty<U>(prop_name) == 0)
     mooseWarning("The material property '",
                  prop_name,
                  "' does not exist. The kernel '",
                  this->name(),
                  "' only needs its derivatives, but this may indicate a typo in the input file.");
 }

◆ validateNonlinearCoupling()

template<class T >

template<typename U >

void DerivativeMaterialInterface< T >::validateNonlinearCoupling	(	const MaterialPropertyName &	base,
		const VariableName &	c1 = `""`,
		const VariableName &	c2 = `""`,
		const VariableName &	c3 = `""`
	)

inherited

Definition at line 416 of file DerivativeMaterialInterface.h.

 {
   validateCoupling<U>(base, buildVariableVector(c1, c2, c3), false);
 }

◆ validParams()

template<class T >

InputParameters DerivativeKernelInterface< T >::validParams ( )

static

as partial template specialization is not allowed in C++ we have to implement this as a static method

Definition at line 43 of file DerivativeKernelInterface.h.

 {
   InputParameters params = ::validParams<T>();
   params.addRequiredParam<std::string>(
       "f_name", "Base name of the free energy function F defined in a DerivativeParsedMaterial");
   return params;
 }

Member Data Documentation

◆ _F_name

template<class T >

std::string DerivativeKernelInterface< T >::_F_name

protected

Definition at line 30 of file DerivativeKernelInterface.h.

◆ _nvar

template<class T >

unsigned int DerivativeKernelInterface< T >::_nvar

protected

Definition at line 29 of file DerivativeKernelInterface.h.

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

include/utils/DerivativeKernelInterface.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

template<class T> class DerivativeKernelInterface< T >

Constructor & Destructor Documentation

◆ DerivativeKernelInterface()

Member Function Documentation

◆ declarePropertyDerivative() [1/2]

◆ declarePropertyDerivative() [2/2]

◆ derivativePropertyName()

◆ derivativePropertyNameFirst()

◆ derivativePropertyNameSecond()

◆ derivativePropertyNameThird()

◆ getDefaultMaterialProperty()

◆ getDefaultMaterialPropertyByName()

◆ getMaterialPropertyDerivative() [1/2]

◆ getMaterialPropertyDerivative() [2/2]

◆ getMaterialPropertyDerivativeByName() [1/2]

◆ getMaterialPropertyDerivativeByName() [2/2]

◆ propertyName()

◆ propertyNameFirst()

◆ propertyNameSecond()

◆ propertyNameThird()

◆ validateCoupling() [1/2]

◆ validateCoupling() [2/2]

◆ validateDerivativeMaterialPropertyBase()

◆ validateNonlinearCoupling()

◆ validParams()

Member Data Documentation

◆ _F_name

◆ _nvar

template<class T>
class DerivativeKernelInterface< T >