CompositeTensorBase computes a simple T type MaterialProperty \( \bar T\) that is summed up from a list of other T objects (tensors) \( T_i \) with associated weights \( w_i \). More...

#include <CompositeTensorBase.h>

Inheritance diagram for CompositeTensorBase< T, U >:

[legend]

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	CompositeTensorBase (const InputParameters &parameters)

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

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

void	validateDerivativeMaterialPropertyBase (const std::string &base)
	Check if the material property base exists. More...

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

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

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

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


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

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)
	Methods for retrieving derivative material properties. More...

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)
	Convenience methods for retrieving derivative material properties based on a mix of variable names `c` and indices `v` into the _coupled_standard_moose_vars vector. More...

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)
	Methods for retrieving derivative material properties. More...

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

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="")


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

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	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
void	initializeDerivativeProperties (const std::string name)
	Output material properties are initialized here so that derived classes can modify the name. More...

virtual void	computeQpTensorProperties (MaterialProperty< T > &M, Real derivative_prefactor=1.0)
	Fill in the. More...

Protected Attributes
std::vector< MaterialPropertyName >	_tensor_names
	component tensor names More...

std::vector< MaterialPropertyName >	_weight_names
	component weight names More...

unsigned int	_num_args
	number of dependent variables More...

unsigned int	_num_comp
	number of compomemt tensors and weights More...


std::vector< MaterialProperty< T > * >	_dM
	Composed tensor and its derivatives. More...

std::vector< std::vector< MaterialProperty< T > * > >	_d2M


std::vector< const MaterialProperty< T > * >	_tensors
	component tensors and their derivatives w.r.t. the args More...

std::vector< std::vector< const MaterialProperty< T > * > >	_dtensors

std::vector< std::vector< std::vector< const MaterialProperty< T > * > > >	_d2tensors


std::vector< const MaterialProperty< Real > * >	_weights
	component weights and their derivatives w.r.t. the args More...

std::vector< std::vector< const MaterialProperty< Real > * > >	_dweights

std::vector< std::vector< std::vector< const MaterialProperty< Real > * > > >	_d2weights

Detailed Description

template<class T, class U>
class CompositeTensorBase< T, U >

CompositeTensorBase computes a simple T type MaterialProperty \( \bar T\) that is summed up from a list of other T objects (tensors) \( T_i \) with associated weights \( w_i \).

\( \bar T = \sum_i T_i\cdot w_i \) Derivatives w.r.t. variables are computed accordingly. This base class is used by the CompositeMobilityTensor and CompositeElasticityTensor classes.

Template Parameters

T	The type of the objects to sum together

Definition at line 27 of file CompositeTensorBase.h.

Member Typedef Documentation

◆ SymbolName

typedef DerivativeMaterialPropertyNameInterface::SymbolName DerivativeMaterialInterface< U >::SymbolName

inherited

Definition at line 35 of file DerivativeMaterialInterface.h.

Constructor & Destructor Documentation

◆ CompositeTensorBase()

template<class T , class U >

CompositeTensorBase< T, U >::CompositeTensorBase ( const InputParameters & parameters )

Definition at line 81 of file CompositeTensorBase.h.

   : DerivativeMaterialInterface<U>(parameters),
     _tensor_names(this->template getParam<std::vector<MaterialPropertyName>>("tensors")),
     _weight_names(this->template getParam<std::vector<MaterialPropertyName>>("weights")),
     _num_args(this->DerivativeMaterialInterface<U>::coupledComponents("coupled_variables")),
     _num_comp(_tensor_names.size()),
     _dM(_num_args),
     _d2M(_num_args),
     _tensors(_num_comp),
     _dtensors(_num_comp),
     _d2tensors(_num_comp),
     _weights(_num_comp),
     _dweights(_num_comp),
     _d2weights(_num_comp)
 {
   if (_num_comp != _weight_names.size())
     mooseError("The number of supplied 'tensors' and 'weights' must match.");
 }

Member Function Documentation

◆ computeQpTensorProperties()

template<class T , class U >

void CompositeTensorBase< T, U >::computeQpTensorProperties	(	MaterialProperty< T > &	M,
		Real	derivative_prefactor = `1.0`
	)

protectedvirtual

Fill in the.

main tensor property given by M
derivatives, set up by initializeDerivativeProperties

The root_property is kept separate from the derivatives to allow the application of this template to the Eigenstrain calculation, which contributes derivatives to a different material property (and uses a derivative_prefactor of -1).

Definition at line 172 of file CompositeTensorBase.h.

 {
   const unsigned int qp = this->DerivativeMaterialInterface<U>::_qp;
 
   M[qp].zero();
   for (unsigned int i = 0; i < _num_comp; ++i)
   {
     M[qp] += (*_tensors[i])[qp] * (*_weights[i])[qp];
 
     for (unsigned int j = 0; j < _num_args; ++j)
     {
       if (i == 0)
         (*_dM[j])[qp].zero();
 
       (*_dM[j])[qp] += derivative_prefactor * ((*_tensors[i])[qp] * (*_dweights[i][j])[qp] +
                                                (*_dtensors[i][j])[qp] * (*_weights[i])[qp]);
 
       for (unsigned int k = 0; k <= j; ++k)
       {
         if (i == 0)
           (*_d2M[j][k])[qp].zero();
 
         (*_d2M[j][k])[qp] +=
             derivative_prefactor * (2.0 * (*_dtensors[i][j])[qp] * (*_dweights[i][j])[qp] +
                                     (*_tensors[i])[qp] * (*_d2weights[i][j][k])[qp] +
                                     (*_d2tensors[i][j][k])[qp] * (*_weights[i])[qp]);
       }
     }
   }
 }

◆ declarePropertyDerivative() [1/3]

GenericMaterialProperty< U, is_ad > & DerivativeMaterialInterface< U >::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 258 of file DerivativeMaterialInterface.h.

 {
   std::vector<SymbolName> symbol_vector(c.begin(), c.end());
   return declarePropertyDerivative<U, is_ad>(base, symbol_vector);
 }

◆ declarePropertyDerivative() [2/3]

GenericMaterialProperty< U, is_ad > & DerivativeMaterialInterface< U >::declarePropertyDerivative	(	const std::string &	base,
		const std::vector< SymbolName > &	c
	)

inherited

Definition at line 268 of file DerivativeMaterialInterface.h.

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

◆ declarePropertyDerivative() [3/3]

GenericMaterialProperty< U, is_ad > & DerivativeMaterialInterface< U >::declarePropertyDerivative	(	const std::string &	base,
		const SymbolName &	c1,
		const SymbolName &	c2 = `""`,
		const SymbolName &	c3 = `""`
	)

inherited

Definition at line 277 of file DerivativeMaterialInterface.h.

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

◆ derivativePropertyName()

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

inherited

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

Definition at line 16 of file DerivativeMaterialPropertyNameInterface.C.

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

 {
   // to obtain well defined names we sort alphabetically
   std::vector<SymbolName> 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 SymbolName &	c1
	)		const

inherited

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

Definition at line 56 of file DerivativeMaterialPropertyNameInterface.C.

Referenced by DerivativeMaterialPropertyNameInterface::propertyNameFirst().

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

◆ derivativePropertyNameSecond()

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

inherited

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

Definition at line 63 of file DerivativeMaterialPropertyNameInterface.C.

Referenced by DerivativeMaterialPropertyNameInterface::propertyNameSecond().

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

◆ derivativePropertyNameThird()

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

inherited

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

Definition at line 70 of file DerivativeMaterialPropertyNameInterface.C.

Referenced by DerivativeMaterialPropertyNameInterface::propertyNameThird().

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

◆ getDefaultMaterialProperty()

const GenericMaterialProperty< U, is_ad > & DerivativeMaterialInterface< U >::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 231 of file DerivativeMaterialInterface.h.

 {
   // get the base property name
   std::string prop_name = this->getMaterialPropertyName(name);
 
   // Check if it's just a constant
   const auto * default_property =
       this->template defaultGenericMaterialProperty<U, is_ad>(prop_name);
   if (default_property)
     return *default_property;
 
   // if found return the requested property
   return this->template getGenericZeroMaterialPropertyByName<U, is_ad>(prop_name);
 }

◆ getDefaultMaterialPropertyByName()

const GenericMaterialProperty< U, is_ad > & DerivativeMaterialInterface< U >::getDefaultMaterialPropertyByName ( const std::string & name )

inherited

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

Definition at line 249 of file DerivativeMaterialInterface.h.

 {
   // TODO: deprecate this
   return this->template getGenericZeroMaterialPropertyByName<U, is_ad>(prop_name);
 }

◆ getMaterialPropertyDerivative() [1/5]

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

inherited

Methods for retrieving 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 294 of file DerivativeMaterialInterface.h.

 {
   std::vector<SymbolName> symbol_vector(c.begin(), c.end());
   return getMaterialPropertyDerivative(base, symbol_vector);
 }

◆ getMaterialPropertyDerivative() [2/5]

const GenericMaterialProperty< U, is_ad > & DerivativeMaterialInterface< U >::getMaterialPropertyDerivative	(	const std::string &	base,
		const std::vector< SymbolName > &	c
	)

inherited

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

Definition at line 304 of file DerivativeMaterialInterface.h.

 {
   // get the base property name
   std::string prop_name = this->getMaterialPropertyName(base);
 
   if (this->template defaultGenericMaterialProperty<U, is_ad>(prop_name))
     return this->template getGenericZeroMaterialProperty<U, is_ad>();
 
   return this->template getGenericZeroMaterialPropertyByName<U, is_ad>(
       derivativePropertyName(prop_name, c));
 }

◆ getMaterialPropertyDerivative() [3/5]

const GenericMaterialProperty< U, is_ad > & DerivativeMaterialInterface< U >::getMaterialPropertyDerivative	(	const std::string &	base,
		const SymbolName &	c1,
		const SymbolName &	c2 = `""`,
		const SymbolName &	c3 = `""`
	)

inherited

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

Definition at line 324 of file DerivativeMaterialInterface.h.

 {
   // get the base property name
   std::string prop_name = this->getMaterialPropertyName(base);
 
   if (this->template defaultGenericMaterialProperty<Real, is_ad>(prop_name))
     return this->template getGenericZeroMaterialProperty<U, is_ad>();
 
   if (c3 != "")
     return this->template getGenericZeroMaterialPropertyByName<U, is_ad>(
         derivativePropertyNameThird(prop_name, c1, c2, c3));
   if (c2 != "")
     return this->template getGenericZeroMaterialPropertyByName<U, is_ad>(
         derivativePropertyNameSecond(prop_name, c1, c2));
   return this->template getGenericZeroMaterialPropertyByName<U, is_ad>(
       derivativePropertyNameFirst(prop_name, c1));
 }

◆ getMaterialPropertyDerivative() [4/5]

const GenericMaterialProperty< U, is_ad > & DerivativeMaterialInterface< U >::getMaterialPropertyDerivative	(	const std::string &	base,
		const SymbolName &	c1,
		unsigned int	v2,
		unsigned int	v3 = `libMesh::invalid_uint`
	)

inherited

Convenience methods for retrieving derivative material properties based on a mix of variable names c and indices v into the _coupled_standard_moose_vars vector.

Definition at line 352 of file DerivativeMaterialInterface.h.

 {
   return getMaterialPropertyDerivative<U, is_ad>(
       base,
       c1,
       this->_coupled_standard_moose_vars[v2]->name(),
       v3 == libMesh::invalid_uint ? "" : this->_coupled_standard_moose_vars[v3]->name());
 }

◆ getMaterialPropertyDerivative() [5/5]

const GenericMaterialProperty< U, is_ad > & DerivativeMaterialInterface< U >::getMaterialPropertyDerivative	(	const std::string &	base,
		unsigned int	v1,
		unsigned int	v2 = `libMesh::invalid_uint`,
		unsigned int	v3 = `libMesh::invalid_uint`
	)

inherited

Definition at line 367 of file DerivativeMaterialInterface.h.

 {
   return getMaterialPropertyDerivative<U, is_ad>(
       base,
       this->_coupled_standard_moose_vars[v1]->name(),
       v2 == libMesh::invalid_uint ? "" : this->_coupled_standard_moose_vars[v2]->name(),
       v3 == libMesh::invalid_uint ? "" : this->_coupled_standard_moose_vars[v3]->name());
 }

◆ getMaterialPropertyDerivativeByName() [1/3]

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

inherited

Methods for retrieving 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 382 of file DerivativeMaterialInterface.h.

 {
   std::vector<SymbolName> symbol_vector(c.begin(), c.end());
   return getMaterialPropertyDerivativeByName(base, symbol_vector);
 }

◆ getMaterialPropertyDerivativeByName() [2/3]

const GenericMaterialProperty< U, is_ad > & DerivativeMaterialInterface< U >::getMaterialPropertyDerivativeByName	(	const MaterialPropertyName &	base,
		const std::vector< SymbolName > &	c
	)

inherited

Definition at line 392 of file DerivativeMaterialInterface.h.

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

◆ getMaterialPropertyDerivativeByName() [3/3]

const GenericMaterialProperty< U, is_ad > & DerivativeMaterialInterface< U >::getMaterialPropertyDerivativeByName	(	const MaterialPropertyName &	base,
		const SymbolName &	c1,
		const SymbolName &	c2 = `""`,
		const SymbolName &	c3 = `""`
	)

inherited

Definition at line 402 of file DerivativeMaterialInterface.h.

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

◆ initializeDerivativeProperties()

template<class T , class U >

void CompositeTensorBase< T, U >::initializeDerivativeProperties ( const std::string name )

protected

Output material properties are initialized here so that derived classes can modify the name.

Definition at line 113 of file CompositeTensorBase.h.

 {
   // setup output composite tensor and derivatives
   for (unsigned int j = 0; j < _num_args; ++j)
   {
     const VariableName & jname =
         this->DerivativeMaterialInterface<U>::getVar("coupled_variables", j)->name();
     _dM[j] = &this->template declarePropertyDerivative<T>(name, jname);
     _d2M[j].resize(j + 1);
 
     for (unsigned int k = 0; k <= j; ++k)
     {
       const VariableName & kname =
           this->DerivativeMaterialInterface<U>::getVar("coupled_variables", k)->name();
 
       _d2M[j][k] = &this->template declarePropertyDerivative<T>(name, jname, kname);
     }
   }
 
   // setup input components and its derivatives
   for (unsigned int i = 0; i < _num_comp; ++i)
   {
     _tensors[i] = &this->template getMaterialPropertyByName<T>(_tensor_names[i]);
     _weights[i] = &this->template getMaterialPropertyByName<Real>(_weight_names[i]);
 
     _dtensors[i].resize(_num_args);
     _dweights[i].resize(_num_args);
     _d2tensors[i].resize(_num_args);
     _d2weights[i].resize(_num_args);
 
     for (unsigned int j = 0; j < _num_args; ++j)
     {
       const VariableName & jname =
           this->DerivativeMaterialInterface<U>::getVar("coupled_variables", j)->name();
 
       _dtensors[i][j] =
           &this->template getMaterialPropertyDerivativeByName<T>(_tensor_names[i], jname);
       _dweights[i][j] =
           &this->template getMaterialPropertyDerivativeByName<Real>(_weight_names[i], jname);
 
       _d2tensors[i][j].resize(j + 1);
       _d2weights[i][j].resize(j + 1);
 
       for (unsigned int k = 0; k <= j; ++k)
       {
         const VariableName & kname =
             this->DerivativeMaterialInterface<U>::getVar("coupled_variables", k)->name();
 
         _d2tensors[i][j][k] =
             &this->template getMaterialPropertyDerivativeByName<T>(_tensor_names[i], jname, kname);
         _d2weights[i][j][k] = &this->template getMaterialPropertyDerivativeByName<Real>(
             _weight_names[i], jname, kname);
       }
     }
   }
 }

◆ propertyName()

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

inlineinherited

aliases for the deprecated old function names

Definition at line 59 of file DerivativeMaterialPropertyNameInterface.h.

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

◆ propertyNameFirst()

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

inlineinherited

Definition at line 65 of file DerivativeMaterialPropertyNameInterface.h.

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

◆ propertyNameSecond()

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

inlineinherited

Definition at line 71 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 SymbolName &	c1,
		const SymbolName &	c2,
		const SymbolName &	c3
	)		const

inlineinherited

Definition at line 78 of file DerivativeMaterialPropertyNameInterface.h.

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

◆ validateCoupling() [1/2]

void DerivativeMaterialInterface< U >::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 461 of file DerivativeMaterialInterface.h.

 {
   // get the base property name
   std::string prop_name = this->getMaterialPropertyName(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, is_ad>(
       prop_name, c, _dmi_fe_problem.getNonlinearSystemBase(/*nl_sys=*/0).system(), missing);
   if (validate_aux)
     validateCouplingHelper<U, is_ad>(
         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 coupled_variables parameter of ",
                  this->name(),
                  ")");
   }
 }

◆ validateCoupling() [2/2]

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

inherited

Definition at line 515 of file DerivativeMaterialInterface.h.

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

◆ validateDerivativeMaterialPropertyBase()

void DerivativeMaterialInterface< U >::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 537 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, is_ad>(prop_name) &&
       this->template defaultGenericMaterialProperty<U, is_ad>(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()

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

inherited

Definition at line 526 of file DerivativeMaterialInterface.h.

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

◆ validParams()

template<class T , class U >

InputParameters CompositeTensorBase< T, U >::validParams ( )

static

Definition at line 102 of file CompositeTensorBase.h.

 {
   InputParameters params = U::validParams();
   params.addRequiredParam<std::vector<MaterialPropertyName>>("tensors", "Component tensors");
   params.addRequiredParam<std::vector<MaterialPropertyName>>("weights", "Component weights");
   params.addRequiredCoupledVar("coupled_variables", "variable dependencies for the prefactor");
   return params;
 }

Member Data Documentation

◆ _d2M

template<class T , class U >

std::vector<std::vector<MaterialProperty<T> *> > CompositeTensorBase< T, U >::_d2M

protected

Definition at line 64 of file CompositeTensorBase.h.

◆ _d2tensors

template<class T , class U >

std::vector<std::vector<std::vector<const MaterialProperty<T> *> > > CompositeTensorBase< T, U >::_d2tensors

protected

Definition at line 70 of file CompositeTensorBase.h.

◆ _d2weights

template<class T , class U >

std::vector<std::vector<std::vector<const MaterialProperty<Real> *> > > CompositeTensorBase< T, U >::_d2weights

protected

Definition at line 76 of file CompositeTensorBase.h.

◆ _dM

template<class T , class U >

std::vector<MaterialProperty<T> *> CompositeTensorBase< T, U >::_dM

protected

Composed tensor and its derivatives.

Definition at line 63 of file CompositeTensorBase.h.

◆ _dtensors

template<class T , class U >

std::vector<std::vector<const MaterialProperty<T> *> > CompositeTensorBase< T, U >::_dtensors

protected

Definition at line 69 of file CompositeTensorBase.h.

◆ _dweights

template<class T , class U >

std::vector<std::vector<const MaterialProperty<Real> *> > CompositeTensorBase< T, U >::_dweights

protected

Definition at line 75 of file CompositeTensorBase.h.

◆ _num_args

template<class T , class U >

unsigned int CompositeTensorBase< T, U >::_num_args

protected

number of dependent variables

Definition at line 58 of file CompositeTensorBase.h.

◆ _num_comp

template<class T , class U >

unsigned int CompositeTensorBase< T, U >::_num_comp

protected

number of compomemt tensors and weights

Definition at line 60 of file CompositeTensorBase.h.

Referenced by CompositeTensorBase< T, U >::CompositeTensorBase().

◆ _tensor_names

template<class T , class U >

std::vector<MaterialPropertyName> CompositeTensorBase< T, U >::_tensor_names

protected

component tensor names

Definition at line 53 of file CompositeTensorBase.h.

◆ _tensors

template<class T , class U >

std::vector<const MaterialProperty<T> *> CompositeTensorBase< T, U >::_tensors

protected

component tensors and their derivatives w.r.t. the args

Definition at line 68 of file CompositeTensorBase.h.

◆ _weight_names

template<class T , class U >

std::vector<MaterialPropertyName> CompositeTensorBase< T, U >::_weight_names

protected

component weight names

Definition at line 55 of file CompositeTensorBase.h.

Referenced by CompositeTensorBase< T, U >::CompositeTensorBase().

◆ _weights

template<class T , class U >

std::vector<const MaterialProperty<Real> *> CompositeTensorBase< T, U >::_weights

protected

component weights and their derivatives w.r.t. the args

Definition at line 74 of file CompositeTensorBase.h.

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

include/materials/CompositeTensorBase.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<class T, class U> class CompositeTensorBase< T, U >

Member Typedef Documentation

◆ SymbolName

Constructor & Destructor Documentation

◆ CompositeTensorBase()

Member Function Documentation

◆ computeQpTensorProperties()

◆ declarePropertyDerivative() [1/3]

◆ declarePropertyDerivative() [2/3]

◆ declarePropertyDerivative() [3/3]

◆ derivativePropertyName()

◆ derivativePropertyNameFirst()

◆ derivativePropertyNameSecond()

◆ derivativePropertyNameThird()

◆ getDefaultMaterialProperty()

◆ getDefaultMaterialPropertyByName()

◆ getMaterialPropertyDerivative() [1/5]

◆ getMaterialPropertyDerivative() [2/5]

◆ getMaterialPropertyDerivative() [3/5]

◆ getMaterialPropertyDerivative() [4/5]

◆ getMaterialPropertyDerivative() [5/5]

◆ getMaterialPropertyDerivativeByName() [1/3]

◆ getMaterialPropertyDerivativeByName() [2/3]

◆ getMaterialPropertyDerivativeByName() [3/3]

◆ initializeDerivativeProperties()

◆ propertyName()

◆ propertyNameFirst()

◆ propertyNameSecond()

◆ propertyNameThird()

◆ validateCoupling() [1/2]

◆ validateCoupling() [2/2]

◆ validateDerivativeMaterialPropertyBase()

◆ validateNonlinearCoupling()

◆ validParams()

Member Data Documentation

◆ _d2M

◆ _d2tensors

◆ _d2weights

◆ _dM

◆ _dtensors

◆ _dweights

◆ _num_args

◆ _num_comp

◆ _tensor_names

◆ _tensors

◆ _weight_names

◆ _weights

template<class T, class U>
class CompositeTensorBase< T, U >