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

// MOOSE includes
#include "Assembly.h"
#include "SubProblem.h"
#include "SystemBase.h"
#include "MooseVariableFE.h"
#include "MooseVariableScalar.h"
#include "ADUtils.h"

#include "libmesh/quadrature.h"

template <typename T>
InputParameters
ADIntegratedBCTempl<T>::validParams()
{
  InputParameters params = IntegratedBCBase::validParams();
  params += ADFunctorInterface::validParams();
  return params;
}

template <typename T>
ADIntegratedBCTempl<T>::ADIntegratedBCTempl(const InputParameters & parameters)
  : IntegratedBCBase(parameters),
    MooseVariableInterface<T>(this,
                              false,
                              "variable",
                              Moose::VarKindType::VAR_SOLVER,
                              std::is_same<T, Real>::value ? Moose::VarFieldType::VAR_FIELD_STANDARD
                                                           : Moose::VarFieldType::VAR_FIELD_VECTOR),
    ADFunctorInterface(this),
    _var(*this->mooseVariable()),
    _normals(_assembly.adNormals()),
    _ad_q_points(_assembly.adQPointsFace()),
    _test(_var.phiFace()),
    _grad_test(_var.adGradPhiFace()),
    _u(_var.adSln()),
    _grad_u(_var.adGradSln()),
    _ad_JxW(_assembly.adJxWFace()),
    _ad_coord(_assembly.adCoordTransformation()),
    _phi(_assembly.phi(_var)),
    _use_displaced_mesh(getParam<bool>("use_displaced_mesh"))
{
  _subproblem.haveADObjects(true);

  addMooseVariableDependency(this->mooseVariable());

  _save_in.resize(_save_in_strings.size());
  _diag_save_in.resize(_diag_save_in_strings.size());

  for (unsigned int i = 0; i < _save_in_strings.size(); i++)
  {
    MooseVariable * var = &_subproblem.getStandardVariable(_tid, _save_in_strings[i]);

    if (var->feType() != _var.feType())
      paramError(
          "save_in",
          "saved-in auxiliary variable is incompatible with the object's nonlinear variable: ",
          moose::internal::incompatVarMsg(*var, _var));
    _save_in[i] = var;
    var->sys().addVariableToZeroOnResidual(_save_in_strings[i]);
    addMooseVariableDependency(var);
  }

  _has_save_in = _save_in.size() > 0;

  for (unsigned int i = 0; i < _diag_save_in_strings.size(); i++)
  {
    MooseVariable * var = &_subproblem.getStandardVariable(_tid, _diag_save_in_strings[i]);

    if (var->feType() != _var.feType())
      paramError(
          "diag_save_in",
          "saved-in auxiliary variable is incompatible with the object's nonlinear variable: ",
          moose::internal::incompatVarMsg(*var, _var));

    _diag_save_in[i] = var;
    var->sys().addVariableToZeroOnJacobian(_diag_save_in_strings[i]);
    addMooseVariableDependency(var);
  }

  _has_diag_save_in = _diag_save_in.size() > 0;
}

template <typename T>
void
ADIntegratedBCTempl<T>::computeResidual()
{
  _residuals.resize(_test.size(), 0);
  for (auto & r : _residuals)
    r = 0;

  precalculateResidual();
  for (_qp = 0; _qp < _qrule->n_points(); _qp++)
  {
    const auto jxw_c = _JxW[_qp] * _coord[_qp];
    for (_i = 0; _i < _test.size(); _i++)
      _residuals[_i] += jxw_c * raw_value(computeQpResidual());
  }

  addResiduals(_assembly, _residuals, _var.dofIndices(), _var.scalingFactor());

  if (_has_save_in)
    for (unsigned int i = 0; i < _save_in.size(); i++)
      _save_in[i]->sys().solution().add_vector(_residuals.data(), _save_in[i]->dofIndices());
}

template <typename T>
void
ADIntegratedBCTempl<T>::computeResidualsForJacobian()
{
  if (_residuals_and_jacobians.size() != _test.size())
    _residuals_and_jacobians.resize(_test.size(), 0);
  for (auto & r : _residuals_and_jacobians)
    r = 0;

  precalculateResidual();
  if (_use_displaced_mesh)
    for (_qp = 0; _qp < _qrule->n_points(); _qp++)
    {
      _r = _ad_JxW[_qp];
      _r *= _ad_coord[_qp];
      for (_i = 0; _i < _test.size(); _i++)
        _residuals_and_jacobians[_i] += _r * computeQpResidual();
    }
  else
    for (_qp = 0; _qp < _qrule->n_points(); _qp++)
    {
      const auto jxw_c = _JxW[_qp] * _coord[_qp];
      for (_i = 0; _i < _test.size(); _i++)
        _residuals_and_jacobians[_i] += jxw_c * computeQpResidual();
    }
}

template <typename T>
void
ADIntegratedBCTempl<T>::computeResidualAndJacobian()
{
  computeResidualsForJacobian();
  addResidualsAndJacobian(
      _assembly, _residuals_and_jacobians, _var.dofIndices(), _var.scalingFactor());
}

template <typename T>
void
ADIntegratedBCTempl<T>::computeJacobian()
{
  computeADJacobian();

  if (_has_diag_save_in && !_sys.computingScalingJacobian())
    mooseError("_local_ke not computed for global AD indexing. Save-in is deprecated anyway. Use "
               "the tagging system instead.");
}

template <typename T>
void
ADIntegratedBCTempl<T>::computeADJacobian()
{
  computeResidualsForJacobian();
  addJacobian(_assembly, _residuals_and_jacobians, _var.dofIndices(), _var.scalingFactor());
}

template <typename T>
void
ADIntegratedBCTempl<T>::computeOffDiagJacobian(const unsigned int jvar)
{
  // Only need to do this once because AD does all the derivatives at once
  if (jvar == _var.number())
    computeADJacobian();
}

template <typename T>
void
ADIntegratedBCTempl<T>::computeOffDiagJacobianScalar(unsigned int /*jvar*/)
{
}

template class ADIntegratedBCTempl<Real>;
template class ADIntegratedBCTempl<RealVectorValue>;