DerivativeKernelInterface.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 "DerivativeMaterialInterface.h"

template <class T>
class DerivativeKernelInterface : public DerivativeMaterialInterface<T>
{
public:
  DerivativeKernelInterface(const InputParameters & parameters);

  static InputParameters validParams();

protected:
  unsigned int _nvar;
  std::string _F_name;
};

template <class T>
DerivativeKernelInterface<T>::DerivativeKernelInterface(const InputParameters & parameters)
  : DerivativeMaterialInterface<T>(parameters),
    _nvar(this->_coupled_moose_vars.size()),
    _F_name(this->template getRenamedParam<std::string>("f_name", "property_name"))
{
}

template <class T>
InputParameters
DerivativeKernelInterface<T>::validParams()
{
  InputParameters params = T::validParams();
  params.addDeprecatedParam<std::string>(
      "f_name",
      "Base name of the free energy function F defined in a DerivativeParsedMaterial",
      "Deprecated, use property_name");
  // TODO Make required once deprecation is handled, see #20535
  params.addParam<std::string>(
      "property_name", "Base name of the material property defined in a DerivativeParsedMaterial");
  return params;
}