SusceptibilityTimeDerivative.C

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

#include "SusceptibilityTimeDerivative.h"

registerMooseObject("PhaseFieldApp", SusceptibilityTimeDerivative);
registerMooseObject("PhaseFieldApp", ADSusceptibilityTimeDerivative);

template <bool is_ad>
InputParameters
SusceptibilityTimeDerivativeTempl<is_ad>::validParams()
{
  InputParameters params = SusceptibilityTimeDerivativeBase<is_ad>::validParams();
  params.addClassDescription(
      "A modified time derivative Kernel that multiplies the time derivative "
      "of a variable by a generalized susceptibility");
  params.addRequiredParam<MaterialPropertyName>(
      "f_name", "Susceptibility function F defined in a FunctionMaterial");
  params.addCoupledVar("args", "Vector of variable arguments of the susceptibility");
  params.deprecateCoupledVar("args", "coupled_variables", "02/27/2024");
  return params;
}

template <bool is_ad>
SusceptibilityTimeDerivativeTempl<is_ad>::SusceptibilityTimeDerivativeTempl(
    const InputParameters & parameters)
  : DerivativeMaterialInterface<JvarMapKernelInterface<SusceptibilityTimeDerivativeBase<is_ad>>>(
        parameters),
    _Chi(this->template getGenericMaterialProperty<Real, is_ad>("f_name"))
{
}

SusceptibilityTimeDerivative::SusceptibilityTimeDerivative(const InputParameters & parameters)
  : SusceptibilityTimeDerivativeTempl<false>(parameters),
    _dChidu(getMaterialPropertyDerivative<Real>("f_name", _var.name())),
    _dChidarg(_n_args)
{
  // fetch derivatives
  for (unsigned int i = 0; i < _n_args; ++i)
    _dChidarg[i] = &getMaterialPropertyDerivative<Real>("f_name", i);
}

void
SusceptibilityTimeDerivative::initialSetup()
{
  validateNonlinearCoupling<Real>("f_name");
}

Real
SusceptibilityTimeDerivative::computeQpResidual()
{
  return TimeDerivative::computeQpResidual() * _Chi[_qp];
}

ADReal
ADSusceptibilityTimeDerivative::precomputeQpResidual()
{
  return _u_dot[_qp] * _Chi[_qp];
}

Real
SusceptibilityTimeDerivative::computeQpJacobian()
{
  return TimeDerivative::computeQpJacobian() * _Chi[_qp] +
         TimeDerivative::computeQpResidual() * _dChidu[_qp] * _phi[_j][_qp];
}

Real
SusceptibilityTimeDerivative::computeQpOffDiagJacobian(unsigned int jvar)
{
  // get the coupled variable jvar is referring to
  const unsigned int cvar = mapJvarToCvar(jvar);

  return TimeDerivative::computeQpResidual() * (*_dChidarg[cvar])[_qp] * _phi[_j][_qp];
}