ADFluxFromGradientMaterial.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 "ADFluxFromGradientMaterial.h"
 
registerMooseObject("MooseApp", ADFluxFromGradientMaterial);
 
InputParameters
ADFluxFromGradientMaterial::validParams()
{
  InputParameters params = Material::validParams();
 
  params.addClassDescription("Computes a flux vector material property based on the gradient of a "
                             "coupled variable and a scalar diffusivity.");
 
  // Required name for the output flux property
  params.addRequiredParam<MaterialPropertyName>("flux", "Name of the flux material property");
 
  // Coupled variable whose gradient is used
  params.addRequiredCoupledVar("u", "Variable used to compute the flux");
 
  // Optional name for the diffusivity material property (default: 'diffusivity')
  params.addParam<MaterialPropertyName>(
      "diffusivity", "diffusivity", "The diffusivity material property name");
 
  return params;
}
 
ADFluxFromGradientMaterial::ADFluxFromGradientMaterial(const InputParameters & parameters)
  : Material(parameters),
    _grad_u(adCoupledGradient("u")),
    _diffusivity(getADMaterialProperty<Real>("diffusivity")),
    _flux(declareADProperty<RealVectorValue>("flux"))
{
}
 
void
ADFluxFromGradientMaterial::computeQpProperties()
{
  _flux[_qp] = -_diffusivity[_qp] * _grad_u[_qp];
}