MaterialDerivativeTestKernelBase.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html
 
#pragma once
 
#include "Kernel.h"
#include "JvarMapInterface.h"
#include "DerivativeMaterialInterface.h"
 
template <typename T>
class MaterialDerivativeTestKernelBase
  : public DerivativeMaterialInterface<JvarMapKernelInterface<Kernel>>
{
public:
  static InputParameters validParams();
 
  MaterialDerivativeTestKernelBase(const InputParameters & parameters);
 
protected:
  const unsigned int _n_vars;
 
  std::vector<SymbolName> _derivative;
 
  const MaterialProperty<T> & _p;
 
  std::vector<const MaterialProperty<T> *> _p_off_diag_derivatives;
 
  const MaterialProperty<T> & _p_diag_derivative;
};
 
template <typename T>
MaterialDerivativeTestKernelBase<T>::MaterialDerivativeTestKernelBase(
    const InputParameters & parameters)
  : DerivativeMaterialInterface<JvarMapKernelInterface<Kernel>>(parameters),
    _n_vars(_coupled_moose_vars.size()),
    _derivative(getParam<std::vector<SymbolName>>("derivative")),
    _p(this->template getMaterialPropertyDerivative<T>("material_property", _derivative)),
    _p_off_diag_derivatives(_n_vars),
    _p_diag_derivative(this->template getMaterialPropertyDerivative<T>(
        "material_property", MooseUtils::concatenate(_derivative, SymbolName(_var.name()))))
{
  for (unsigned int m = 0; m < _n_vars; ++m)
    _p_off_diag_derivatives[m] = &this->template getMaterialPropertyDerivative<T>(
        "material_property",
        MooseUtils::concatenate(_derivative, SymbolName(_coupled_moose_vars[m]->name())));
}
 
template <typename T>
InputParameters
MaterialDerivativeTestKernelBase<T>::validParams()
{
  InputParameters params = Kernel::validParams();
  params.addClassDescription("Class used for testing derivatives of a material property.");
  params.addRequiredParam<MaterialPropertyName>(
      "material_property", "Name of material property for which derivatives are to be tested.");
  params.addRequiredCoupledVar("coupled_variables",
                               "List of variables the material property depends on");
  params.addParam<std::vector<SymbolName>>(
      "derivative",
      {},
      "Select derivative to test derivatives of (leave empty for checking "
      "derivatives of the original material property)");
  return params;
}