ADArrayReaction.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 "ADArrayReaction.h"
#include "FEProblemBase.h"
#include "VariableSizeMaterialPropertiesInterface.h"
 
registerMooseObject("MooseApp", ADArrayReaction);
 
InputParameters
ADArrayReaction::validParams()
{
  InputParameters params = ADArrayKernel::validParams();
  params += ADFunctorInterface::validParams();
  params.addRequiredParam<MaterialPropertyName>(
      "reaction_coefficient",
      "The name of the reaction (can be either a scalar, vector, or matrix) material property.");
  params.addClassDescription(
      "An automatic differentiation kernel for the array reaction operator ($r * u$)");
  return params;
}
 
ADArrayReaction::ADArrayReaction(const InputParameters & parameters)
  : ADArrayKernel(parameters),
    _r(hasADMaterialProperty<Real>("reaction_coefficient")
           ? &getADMaterialProperty<Real>("reaction_coefficient")
           : nullptr),
    _r_array(hasADMaterialProperty<RealEigenVector>("reaction_coefficient")
                 ? &getADMaterialProperty<RealEigenVector>("reaction_coefficient")
                 : nullptr),
    _r_2d_array(hasADMaterialProperty<RealEigenMatrix>("reaction_coefficient")
                    ? &getADMaterialProperty<RealEigenMatrix>("reaction_coefficient")
                    : nullptr)
{
  if (!_r && !_r_array && !_r_2d_array)
  {
    MaterialPropertyName mat = getParam<MaterialPropertyName>("reaction_coefficient");
    mooseError("Property '" + mat + "' is of unsupported type for ADArrayReaction");
  }
}
 
void
ADArrayReaction::initialSetup()
{
  if (_r_array || _r_2d_array)
    Moose::checkArrayMaterialPropertySize(*this,
                                          _fe_problem.getMaterialWarehouse(),
                                          blockRestricted() ? blockIDs() : meshBlockIDs(),
                                          "reaction_coefficient",
                                          _count,
                                          _r_2d_array);
}
 
void
ADArrayReaction::computeQpResidual(ADRealEigenVector & residual)
{
  if (_r)
    residual = (*_r)[_qp] * _u[_qp] * _test[_i][_qp];
  else if (_r_array)
    residual.noalias() = (*_r_array)[_qp].cwiseProduct(_u[_qp]) * _test[_i][_qp];
  else
    residual.noalias() = (*_r_2d_array)[_qp] * _u[_qp] * _test[_i][_qp];
}