This class template implements a diffusion kernel with a mobility that can vary spatially and can depend on variables in the simulation. More...

#include <MatDiffusionBase.h>

Inheritance diagram for MatDiffusionBaseTempl< T, is_ad >:

[legend]

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

typedef std::vector< int >	JvarMap

Public Member Functions
	MatDiffusionBaseTempl (const InputParameters &parameters)

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

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

Moose::Kokkos::MaterialProperty< U, dimension >	declareKokkosPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
	Declare a derivative Kokkos material property.

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

virtual void	computeOffDiagJacobian (unsigned int jvar) override

unsigned int	mapJvarToCvar (unsigned int jvar)
	Return index into the _coupled_moose_vars array for a given jvar.

int	mapJvarToCvar (unsigned int jvar, const JvarMap &jvar_map)
	Return an index into a specific coupled variable vector for a given jvar.

bool	mapJvarToCvar (unsigned int jvar, unsigned int &cvar)
	Set the cvar value to the mapped jvar value and return true if the mapping exists.

const JvarMap &	getJvarMap ()
	Obtain the map connecting libmesh variable ID number to its position in the _coupled_moose_vars vector.

const JvarMap &	getParameterJvarMap (std::string parameter_name)
	Make a specific map for a given parameter name representing a couple variable (vector)

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

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

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.

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.


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

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.

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.

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.

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


Moose::Kokkos::MaterialProperty< U, dimension >	getKokkosMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
	Methods for retrieving derivative Kokkos material properties.

Moose::Kokkos::MaterialProperty< U, dimension >	getKokkosMaterialPropertyDerivative (const std::string &base, const SymbolName &c1)

Moose::Kokkos::MaterialProperty< U, dimension >	getKokkosMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)


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

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

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
virtual GenericRealVectorValue< is_ad >	precomputeQpResidual () override

Protected Attributes
const GenericMaterialProperty< T, is_ad > &	_diffusivity
	diffusion coefficient

const GenericVariableGradient< is_ad > &	_grad_v
	Gradient of the concentration.

	usingGenericKernelGradMembers

const unsigned int	_n_args
	number of coupled moose variables

Private Member Functions
bool	haveMaterialProperty (const std::string &prop_name)
	Check if a material property is present with the applicable restrictions.

std::vector< VariableName >	buildVariableVector (const VariableName &c1, const VariableName &c2, const VariableName &c3)
	helper method to combine multiple VariableNames into a vector (if they are != "")

void	validateCouplingHelper (const MaterialPropertyName &base, const std::vector< VariableName > &c, const System &system, std::vector< VariableName > &missing)
	helper method to compile list of missing coupled variables for a given system

bool	isNotObjectVariable (const VariableName &name)

Private Attributes
FEProblemBase &	_dmi_fe_problem
	Reference to FEProblemBase.

const std::size_t	_jvar_max_size
	number of nonlinear variables in the system

JvarMap	_jvar_map
	look-up table to determine the _coupled_moose_vars index for the jvar parameter

std::map< std::string, JvarMap >	_jvar_local_map
	map of local look-up tables for specific parameters

Detailed Description

template<typename T, bool is_ad>
class MatDiffusionBaseTempl< T, is_ad >

This class template implements a diffusion kernel with a mobility that can vary spatially and can depend on variables in the simulation.

Two classes are derived from this template, MatDiffusion for isotropic diffusion and MatAnisoDiffusion for anisotropic diffusion.

Template Parameters

T	Type of the diffusion coefficient parameter. This can be Real for isotropic diffusion or RealTensorValue for the general anisotropic case.

Definition at line 26 of file MatDiffusionBase.h.

Member Typedef Documentation

◆ JvarMap

template<class T >

typedef std::vector<int> JvarMapInterfaceBase< T >::JvarMap

inherited

Definition at line 63 of file JvarMapInterface.h.

◆ SymbolName

typedef DerivativeMaterialPropertyNameInterface::SymbolName DerivativeMaterialInterface< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::SymbolName

inherited

Definition at line 35 of file DerivativeMaterialInterface.h.

Constructor & Destructor Documentation

◆ MatDiffusionBaseTempl()

template<typename T , bool is_ad>

MatDiffusionBaseTempl< T, is_ad >::MatDiffusionBaseTempl ( const InputParameters & parameters )

Definition at line 39 of file MatDiffusionBase.C.

  : DerivativeMaterialInterface<JvarMapKernelInterface<GenericKernelGrad<is_ad>>>(parameters),
    _diffusivity(this->template getGenericMaterialProperty<T, is_ad>("diffusivity")),
    _grad_v(isCoupled("v") ? this->template coupledGenericGradient<is_ad>("v") : _grad_u)
{
}

Member Function Documentation

◆ buildVariableVector()

std::vector< VariableName > DerivativeMaterialInterface< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::buildVariableVector	(	const VariableName &	c1,
		const VariableName &	c2,
		const VariableName &	c3
	)

privateinherited

helper method to combine multiple VariableNames into a vector (if they are != "")

Definition at line 226 of file DerivativeMaterialInterface.h.

{
  std::vector<VariableName> c;
  if (c1 != "")
  {
    c.push_back(c1);
    if (c2 != "")
    {
      c.push_back(c2);
      if (c3 != "")
        c.push_back(c3);
    }
  }
  return c;
}

◆ computeOffDiagJacobian()

void JvarMapKernelInterface< GenericKernelGrad< is_ad > >::computeOffDiagJacobian ( unsigned int jvar )

overridevirtualinherited

Definition at line 34 of file JvarMapInterface.h.

{
  // the Kernel is not coupled to the variable; no need to loop over QPs
  if (this->_jvar_map[jvar] < 0)
    return;
 
  // call the underlying class' off-diagonal Jacobian
  T::computeOffDiagJacobian(jvar);
}

◆ declareKokkosPropertyDerivative()

Moose::Kokkos::MaterialProperty< U, dimension > DerivativeMaterialInterface< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::declareKokkosPropertyDerivative	(	const std::string &	base,
		const std::vector< SymbolName > &	c
	)

inlineinherited

Declare a derivative Kokkos material property.

Template Parameters

U	The material property type
dimension	The material property dimension

Parameters

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

Returns: The declared Kokkos material property

Definition at line 180 of file DerivativeMaterialInterface.h.

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

◆ declarePropertyDerivative() [1/3]

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

inherited

Definition at line 63 of file DerivativeMaterialInterface.h.

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

◆ declarePropertyDerivative() [2/3]

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

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

◆ declarePropertyDerivative() [3/3]

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

inherited

Definition at line 67 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.

{
  // 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();
}

Referenced by DerivativeMaterialInterface< T >::declareKokkosPropertyDerivative(), DerivativeMaterialPropertyNameInterface::derivativePropertyNameSecond(), DerivativeMaterialPropertyNameInterface::derivativePropertyNameThird(), and DerivativeMaterialPropertyNameInterface::propertyName().

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

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

Referenced by DerivativeMaterialPropertyNameInterface::propertyNameFirst(), NEML2Action::setupDerivativeMappings(), and NEML2Action::setupParameterDerivativeMappings().

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

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

Referenced by DerivativeMaterialPropertyNameInterface::propertyNameSecond().

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

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

Referenced by DerivativeMaterialPropertyNameInterface::propertyNameThird().

◆ getDefaultMaterialProperty()

const GenericMaterialProperty< U, is_ad > & DerivativeMaterialInterface< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::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 44 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< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::getDefaultMaterialPropertyByName ( const std::string & name )

inherited

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

Definition at line 49 of file DerivativeMaterialInterface.h.

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

◆ getJvarMap()

template<class T >

const JvarMap & JvarMapInterfaceBase< T >::getJvarMap ( )

inlineinherited

Obtain the map connecting libmesh variable ID number to its position in the _coupled_moose_vars vector.

Definition at line 80 of file JvarMapInterface.h.

80{ return _jvar_map; }

◆ getKokkosMaterialPropertyDerivative() [1/2]

Moose::Kokkos::MaterialProperty< U, dimension > DerivativeMaterialInterface< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::getKokkosMaterialPropertyDerivative	(	const std::string &	base,
		const std::vector< SymbolName > &	c
	)

inherited

Methods for retrieving derivative Kokkos material properties.

A constant zero property is returned if the base property is a default (constant) property or if the derivative property is not declared.

Template Parameters

U	The material property type
dimension	The material property dimension

Parameters

base	The name of the property to take the derivative of, or the parameter name containing it
c	The variable(s) to take the derivatives with respect to

Definition at line 155 of file DerivativeMaterialInterface.h.

{
  const auto prop_name = this->getMaterialPropertyName(base);
 
  // Derivatives of constants are zero
  if (MooseUtils::parsesToReal(prop_name))
    return Moose::Kokkos::MaterialProperty<U, dimension>(U(0));
 
  return getKokkosMaterialPropertyDerivativeByName<U, dimension>(prop_name, c);
}

◆ getKokkosMaterialPropertyDerivative() [2/2]

Moose::Kokkos::MaterialProperty< U, dimension > DerivativeMaterialInterface< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::getKokkosMaterialPropertyDerivative	(	const std::string &	base,
		const SymbolName &	c1
	)

inlineinherited

Definition at line 159 of file DerivativeMaterialInterface.h.

  {
    return getKokkosMaterialPropertyDerivative<U, dimension>(base, std::vector<SymbolName>{c1});
  }

◆ getKokkosMaterialPropertyDerivativeByName()

Moose::Kokkos::MaterialProperty< U, dimension > DerivativeMaterialInterface< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::getKokkosMaterialPropertyDerivativeByName	(	const MaterialPropertyName &	base,
		const std::vector< SymbolName > &	c
	)

inherited

Definition at line 166 of file DerivativeMaterialInterface.h.

{
  const auto prop_name = derivativePropertyName(base, c);
 
  if (!this->template hasKokkosMaterialPropertyByName<U, dimension>(prop_name))
    return Moose::Kokkos::MaterialProperty<U, dimension>(U(0));
 
  return this->template getKokkosMaterialPropertyByName<U, dimension>(prop_name);
}

◆ getMaterialPropertyDerivative() [1/5]

const GenericMaterialProperty< U, is_ad > & DerivativeMaterialInterface< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::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 86 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() [2/5]

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

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

◆ getMaterialPropertyDerivative() [3/5]

const GenericMaterialProperty< U, is_ad > & DerivativeMaterialInterface< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::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 90 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< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::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 103 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< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::getMaterialPropertyDerivative	(	const std::string &	base,
		unsigned int	v1,
		unsigned int	v2 = `libMesh::invalid_uint`,
		unsigned int	v3 = `libMesh::invalid_uint`
	)

inherited

Definition at line 110 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< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::getMaterialPropertyDerivativeByName	(	const MaterialPropertyName &	base,
		const std::vector< SymbolName > &	c
	)

inherited

Definition at line 130 of file DerivativeMaterialInterface.h.

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

◆ getMaterialPropertyDerivativeByName() [2/3]

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

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

◆ getMaterialPropertyDerivativeByName() [3/3]

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

inherited

Definition at line 135 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));
}

◆ getParameterJvarMap()

template<class T >

const JvarMapInterfaceBase< T >::JvarMap & JvarMapInterfaceBase< T >::getParameterJvarMap ( std::string parameter_name )

inherited

Make a specific map for a given parameter name representing a couple variable (vector)

Definition at line 170 of file JvarMapInterface.h.

{
  auto & jvar_map = _jvar_local_map[parameter_name];
  jvar_map.assign(_jvar_max_size, -1);
 
  // populate local map
  const auto num = this->coupledComponents(parameter_name);
  for (std::size_t i = 0; i < num; ++i)
  {
    const auto & var = *this->getVar(parameter_name, i);
 
    // skip variables from other systems, see the constructor
    if (&var.sys() == &this->_sys)
      jvar_map[var.number()] = i;
  }
 
  return jvar_map;
}

◆ haveMaterialProperty()

bool DerivativeMaterialInterface< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::haveMaterialProperty ( const std::string & prop_name )

privateinherited

Check if a material property is present with the applicable restrictions.

Definition at line 222 of file DerivativeMaterialInterface.h.

{
  // Call the correct method to test for material property declarations
  BlockRestrictable * blk = dynamic_cast<BlockRestrictable *>(this);
  BoundaryRestrictable * bnd = dynamic_cast<BoundaryRestrictable *>(this);
  return ((bnd && bnd->boundaryRestricted() &&
           bnd->template hasBoundaryMaterialProperty<U, is_ad>(prop_name)) ||
          (blk && blk->template hasBlockMaterialProperty<U, is_ad>(prop_name)) ||
          (this->template hasGenericMaterialProperty<U, is_ad>(prop_name)));
}

◆ isNotObjectVariable()

bool DerivativeMaterialInterface< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::isNotObjectVariable ( const VariableName & name )

inlineprivateinherited

Definition at line 237 of file DerivativeMaterialInterface.h.

{
  // try to cast this to a Kernel pointer
  KernelBase * kernel_ptr = dynamic_cast<KernelBase *>(this);
  if (kernel_ptr != nullptr)
    return kernel_ptr->variable().name() != name;
 
  // try to cast this to a BoundaryCondition pointer
  BoundaryCondition * bc_ptr = dynamic_cast<BoundaryCondition *>(this);
  if (bc_ptr != nullptr)
    return bc_ptr->variable().name() != name;
 
  // This interface is not templated on a class derived from either Kernel or BC
  return true;
}

◆ mapJvarToCvar() [1/3]

template<class T >

unsigned int JvarMapInterfaceBase< T >::mapJvarToCvar ( unsigned int jvar )

inherited

Return index into the _coupled_moose_vars array for a given jvar.

Definition at line 149 of file JvarMapInterface.h.

{
  mooseAssert(jvar < _jvar_max_size,
              "Calling mapJvarToCvar for an invalid Moose variable number. Maybe an AuxVariable?");
  int cit = _jvar_map[jvar];
 
  mooseAssert(cit >= 0, "Calling mapJvarToCvar for a variable not coupled to this kernel.");
  return cit;
}

Referenced by MatReaction::computeQpOffDiagJacobian().

◆ mapJvarToCvar() [2/3]

template<class T >

int JvarMapInterfaceBase< T >::mapJvarToCvar	(	unsigned int	jvar,
		const JvarMap &	jvar_map
	)

inherited

Return an index into a specific coupled variable vector for a given jvar.

A negative return value indicates that the jvar value does not point to a variable in the couple variable vector corresponding to the mapped parameter.

Definition at line 161 of file JvarMapInterface.h.

{
  mooseAssert(jvar < _jvar_max_size,
              "Calling mapJvarToCvar for an invalid Moose variable number. Maybe an AuxVariable?");
  return jvar_map[jvar];
}

◆ mapJvarToCvar() [3/3]

template<class T >

bool JvarMapInterfaceBase< T >::mapJvarToCvar	(	unsigned int	jvar,
		unsigned int &	cvar
	)

inherited

Set the cvar value to the mapped jvar value and return true if the mapping exists.

Otherwise return false.

Parameters

[in]	jvar	Variable number passed as argument to computeQpOffDiagJacobian
[out]	cvar	Corresponding index into the _coupled_moose_vars array

Returns: true if the requested variable is coupled, false otherwise

◆ precomputeQpResidual()

template<typename T , bool is_ad>

GenericRealVectorValue< is_ad > MatDiffusionBaseTempl< T, is_ad >::precomputeQpResidual ( )

overrideprotectedvirtual

Definition at line 62 of file MatDiffusionBase.C.

{
  return _diffusivity[_qp] * _grad_v[_qp];
}

◆ 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 58 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 64 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 70 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 77 of file DerivativeMaterialPropertyNameInterface.h.

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

◆ validateCoupling() [1/2]

void DerivativeMaterialInterface< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::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 193 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< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::validateCoupling	(	const MaterialPropertyName &	base,
		const VariableName &	c1 = `""`,
		const VariableName &	c2 = `""`,
		const VariableName &	c3 = `""`
	)

inherited

Definition at line 198 of file DerivativeMaterialInterface.h.

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

◆ validateCouplingHelper()

void DerivativeMaterialInterface< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::validateCouplingHelper	(	const MaterialPropertyName &	base,
		const std::vector< VariableName > &	c,
		const System &	system,
		std::vector< VariableName > &	missing
	)

privateinherited

helper method to compile list of missing coupled variables for a given system

Definition at line 230 of file DerivativeMaterialInterface.h.

{
  unsigned int ncoupled = this->_coupled_standard_moose_vars.size();
 
  // iterate over all variables in the current system (in groups)
  for (unsigned int i = 0; i < system.n_variable_groups(); ++i)
  {
    const libMesh::VariableGroup & vg = system.variable_group(i);
    for (unsigned int j = 0; j < vg.n_variables(); ++j)
    {
      std::vector<SymbolName> cj(c.begin(), c.end());
      SymbolName jname = vg.name(j);
      cj.push_back(jname);
 
      // if the derivative exists make sure the variable is coupled
      if (haveMaterialProperty<U, is_ad>(derivativePropertyName(base, cj)))
      {
        // kernels and BCs to not have the variable they are acting on in coupled_moose_vars
        bool is_missing = isNotObjectVariable(jname);
 
        for (unsigned int k = 0; k < ncoupled; ++k)
          if (this->_coupled_standard_moose_vars[k]->name() == jname)
          {
            is_missing = false;
            break;
          }
 
        if (is_missing)
          missing.push_back(jname);
      }
    }
  }
}

◆ validateDerivativeMaterialPropertyBase()

void DerivativeMaterialInterface< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::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 217 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< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::validateNonlinearCoupling	(	const MaterialPropertyName &	base,
		const VariableName &	c1 = `""`,
		const VariableName &	c2 = `""`,
		const VariableName &	c3 = `""`
	)

inherited

Definition at line 204 of file DerivativeMaterialInterface.h.

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

◆ validParams()

template<typename T , bool is_ad>

InputParameters MatDiffusionBaseTempl< T, is_ad >::validParams ( )

static

Definition at line 14 of file MatDiffusionBase.C.

{
  InputParameters params = GenericKernelGrad<is_ad>::validParams();
  params.addParam<MaterialPropertyName>(
      "diffusivity", "D", "The diffusivity value or material property");
  params.addCoupledVar("v",
                       "Coupled concentration variable for kernel to operate on; if this "
                       "is not specified, the kernel's nonlinear variable will be used as "
                       "usual");
  return params;
}

Member Data Documentation

◆ _diffusivity

template<typename T , bool is_ad>

const GenericMaterialProperty<T, is_ad>& MatDiffusionBaseTempl< T, is_ad >::_diffusivity

protected

diffusion coefficient

Definition at line 38 of file MatDiffusionBase.h.

◆ _dmi_fe_problem

FEProblemBase& DerivativeMaterialInterface< JvarMapKernelInterface< GenericKernelGrad< is_ad > > >::_dmi_fe_problem

privateinherited

Reference to FEProblemBase.

Definition at line 240 of file DerivativeMaterialInterface.h.

◆ _grad_v

template<typename T , bool is_ad>

const GenericVariableGradient<is_ad>& MatDiffusionBaseTempl< T, is_ad >::_grad_v

protected

Gradient of the concentration.

Definition at line 41 of file MatDiffusionBase.h.

◆ _jvar_local_map

template<class T >

std::map<std::string, JvarMap> JvarMapInterfaceBase< T >::_jvar_local_map

privateinherited

map of local look-up tables for specific parameters

Definition at line 107 of file JvarMapInterface.h.

Referenced by JvarMapInterfaceBase< T >::getParameterJvarMap().

◆ _jvar_map

template<class T >

JvarMap JvarMapInterfaceBase< T >::_jvar_map

privateinherited

look-up table to determine the _coupled_moose_vars index for the jvar parameter

Definition at line 104 of file JvarMapInterface.h.

Referenced by JvarMapKernelInterface< T >::computeOffDiagJacobian(), JvarMapIntegratedBCInterface< T >::computeOffDiagJacobian(), JvarMapInterfaceBase< T >::getJvarMap(), JvarMapInterfaceBase< T >::JvarMapInterfaceBase(), and JvarMapInterfaceBase< T >::mapJvarToCvar().

◆ _jvar_max_size

template<class T >

const std::size_t JvarMapInterfaceBase< T >::_jvar_max_size

privateinherited

number of nonlinear variables in the system

Definition at line 101 of file JvarMapInterface.h.

Referenced by JvarMapInterfaceBase< T >::getParameterJvarMap(), JvarMapInterfaceBase< T >::mapJvarToCvar(), and JvarMapInterfaceBase< T >::mapJvarToCvar().

◆ _n_args

template<class T >

const unsigned int JvarMapInterfaceBase< T >::_n_args

protectedinherited

number of coupled moose variables

Definition at line 97 of file JvarMapInterface.h.

Referenced by MatReaction::MatReaction().

◆ usingGenericKernelGradMembers

template<typename T , bool is_ad>

MatDiffusionBaseTempl< T, is_ad >::usingGenericKernelGradMembers

protected

Definition at line 43 of file MatDiffusionBase.h.

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

include/kernels/MatDiffusionBase.h
src/kernels/MatDiffusionBase.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ JvarMap

◆ SymbolName

Constructor & Destructor Documentation

◆ MatDiffusionBaseTempl()

Member Function Documentation

◆ buildVariableVector()

◆ computeOffDiagJacobian()

◆ declareKokkosPropertyDerivative()

◆ declarePropertyDerivative() [1/3]

◆ declarePropertyDerivative() [2/3]

◆ declarePropertyDerivative() [3/3]

◆ derivativePropertyName()

◆ derivativePropertyNameFirst()

◆ derivativePropertyNameSecond()

◆ derivativePropertyNameThird()

◆ getDefaultMaterialProperty()

◆ getDefaultMaterialPropertyByName()

◆ getJvarMap()

◆ getKokkosMaterialPropertyDerivative() [1/2]

◆ getKokkosMaterialPropertyDerivative() [2/2]

◆ getKokkosMaterialPropertyDerivativeByName()

◆ getMaterialPropertyDerivative() [1/5]

◆ getMaterialPropertyDerivative() [2/5]

◆ getMaterialPropertyDerivative() [3/5]

◆ getMaterialPropertyDerivative() [4/5]

◆ getMaterialPropertyDerivative() [5/5]

◆ getMaterialPropertyDerivativeByName() [1/3]

◆ getMaterialPropertyDerivativeByName() [2/3]

◆ getMaterialPropertyDerivativeByName() [3/3]

◆ getParameterJvarMap()

◆ haveMaterialProperty()

◆ isNotObjectVariable()

◆ mapJvarToCvar() [1/3]

◆ mapJvarToCvar() [2/3]

◆ mapJvarToCvar() [3/3]

◆ precomputeQpResidual()

◆ propertyName()

◆ propertyNameFirst()

◆ propertyNameSecond()

◆ propertyNameThird()

◆ validateCoupling() [1/2]

◆ validateCoupling() [2/2]

◆ validateCouplingHelper()

◆ validateDerivativeMaterialPropertyBase()

◆ validateNonlinearCoupling()

◆ validParams()

Member Data Documentation

◆ _diffusivity

◆ _dmi_fe_problem

◆ _grad_v

◆ _jvar_local_map

◆ _jvar_map

◆ _jvar_max_size

◆ _n_args

◆ usingGenericKernelGradMembers