CoupledMaterialDerivative.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 "CoupledMaterialDerivative.h"

registerMooseObject("PhaseFieldApp", CoupledMaterialDerivative);

InputParameters
CoupledMaterialDerivative::validParams()
{
  InputParameters params = JvarMapKernelInterface<Kernel>::validParams();
  params.addClassDescription("Kernel that implements the first derivative of a function material "
                             "property with respect to a coupled variable.");
  params.addRequiredCoupledVar("v", "Variable to take the derivative with respect to");
  params.addParam<MaterialPropertyName>("f_name",
                                        "F",
                                        "Function material to take the derivative of (should "
                                        "provide derivative properties - such as a "
                                        "DerivativeParsedMaterial)");
  return params;
}

CoupledMaterialDerivative::CoupledMaterialDerivative(const InputParameters & parameters)
  : DerivativeMaterialInterface<JvarMapKernelInterface<Kernel>>(parameters),
    _v_name(coupledName("v", 0)),
    _v_var(coupled("v")),
    _dFdv(getMaterialPropertyDerivative<Real>("f_name", _v_name)),
    _d2Fdvdu(getMaterialPropertyDerivative<Real>("f_name", _v_name, _var.name())),
    _d2Fdvdarg(_n_args)
{
  // Get material property derivatives for all coupled variables
  for (unsigned int i = 0; i < _n_args; ++i)
    _d2Fdvdarg[i] = &getMaterialPropertyDerivative<Real>("f_name", _v_name, i);
}

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

Real
CoupledMaterialDerivative::computeQpResidual()
{
  return _dFdv[_qp] * _test[_i][_qp];
}

Real
CoupledMaterialDerivative::computeQpJacobian()
{
  return _d2Fdvdu[_qp] * _test[_i][_qp] * _phi[_j][_qp];
}

Real
CoupledMaterialDerivative::computeQpOffDiagJacobian(unsigned int jvar)
{
  const unsigned int cvar = mapJvarToCvar(jvar);
  return (*_d2Fdvdarg[cvar])[_qp] * _test[_i][_qp] * _phi[_j][_qp];
}