AuxKernel.h

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
 
#pragma once
 
#include "AuxKernelBase.h"
#include "MooseVariableInterface.h"
 
// forward declarations
template <typename ComputeValueType>
class AuxKernelTempl;
 
typedef AuxKernelTempl<Real> AuxKernel;
typedef AuxKernelTempl<RealVectorValue> VectorAuxKernel;
typedef AuxKernelTempl<RealEigenVector> ArrayAuxKernel;
 
template <typename ComputeValueType>
class AuxKernelTempl : public AuxKernelBase, public MooseVariableInterface<ComputeValueType>
{
public:
  static InputParameters validParams();
 
  AuxKernelTempl(const InputParameters & parameters);
 
  virtual void compute() override;
 
  bool isNodal() const { return _nodal; }
 
  bool isMortar();
 
  MooseVariableField<ComputeValueType> & variable() { return _var; }
 
  template <typename T>
  const MaterialProperty<T> & getMaterialProperty(const std::string & name);
  template <typename T, bool is_ad>
  const GenericMaterialProperty<T, is_ad> & getGenericMaterialProperty(const std::string & name);
  template <typename T>
  const MaterialProperty<T> & getMaterialPropertyOld(const std::string & name);
  template <typename T>
  const MaterialProperty<T> & getMaterialPropertyOlder(const std::string & name);
 
  void insert();
 
  void determineWhetherCoincidentLowerDCalc();
 
  using MooseVariableDependencyInterface::checkVariables;
  virtual std::set<MooseVariableFieldBase *>
  checkVariables(const libMesh::Node & node,
                 const std::set<MooseVariableFieldBase *> & vars_to_check) override;
 
protected:
  virtual ComputeValueType computeValue() = 0;
 
  virtual const VariableValue & coupledDot(const std::string & var_name,
                                           unsigned int comp = 0) const override;
 
  virtual const VariableValue & coupledDotDu(const std::string & var_name,
                                             unsigned int comp = 0) const override;
 
  virtual void precalculateValue() {}
 
  const typename OutputTools<ComputeValueType>::VariableValue & uOld() const;
 
  const typename OutputTools<ComputeValueType>::VariableValue & uOlder() const;
 
  MooseVariableField<ComputeValueType> & _var;
 
  const bool _nodal;
 
  const typename OutputTools<ComputeValueType>::VariableValue & _u;
 
  const typename OutputTools<ComputeValueType>::VariableTestValue & _test;
 
  const MooseArray<Point> & _q_point;
  const QBase * const & _qrule;
  const MooseArray<Real> & _JxW;
  const MooseArray<Real> & _coord;
 
  const Elem * const & _current_elem;
  const unsigned int & _current_side;
 
  const Real & _current_elem_volume;
  const Real & _current_side_volume;
 
  const Node * const & _current_node;
 
  const BoundaryID & _current_boundary_id;
 
  NumericVector<Number> & _solution;
 
  const Elem * const & _current_lower_d_elem;
 
  unsigned int _qp;
 
  unsigned int _n_shapes;
 
  typedef typename Moose::DOFType<ComputeValueType>::type OutputData;
 
  DenseVector<OutputData> _local_re;
  DenseVector<OutputData> _local_sol;
  DenseMatrix<Number> _local_ke;
 
  std::optional<bool> _coincident_lower_d_calc;
 
  using MooseVariableInterface<ComputeValueType>::mooseVariableBase;
 
private:
  void setDofValueHelper(const ComputeValueType & dof_value);
};
 
template <typename ComputeValueType>
template <typename T>
const MaterialProperty<T> &
AuxKernelTempl<ComputeValueType>::getMaterialProperty(const std::string & name)
{
  if (isNodal())
    mooseError("Nodal AuxKernel '",
               AuxKernelTempl::name(),
               "' attempted to reference material property '",
               name,
               "'\nConsider using an elemental auxiliary variable for '",
               _var.name(),
               "'.");
 
  return MaterialPropertyInterface::getMaterialProperty<T>(name);
}
 
template <typename ComputeValueType>
template <typename T, bool is_ad>
const GenericMaterialProperty<T, is_ad> &
AuxKernelTempl<ComputeValueType>::getGenericMaterialProperty(const std::string & name)
{
  if (isNodal())
    mooseError("Nodal AuxKernel '",
               AuxKernelTempl::name(),
               "' attempted to reference material property '",
               name,
               "'\nConsider using an elemental auxiliary variable for '",
               _var.name(),
               "'.");
 
  return MaterialPropertyInterface::getGenericMaterialProperty<T, is_ad>(name);
}
 
template <typename ComputeValueType>
template <typename T>
const MaterialProperty<T> &
AuxKernelTempl<ComputeValueType>::getMaterialPropertyOld(const std::string & name)
{
  if (isNodal())
    mooseError("Nodal AuxKernel '",
               AuxKernelTempl::name(),
               "' attempted to reference material property '",
               name,
               "'\nConsider using an elemental auxiliary variable for '",
               _var.name(),
               "'.");
 
  return MaterialPropertyInterface::getMaterialPropertyOld<T>(name);
}
 
template <typename ComputeValueType>
template <typename T>
const MaterialProperty<T> &
AuxKernelTempl<ComputeValueType>::getMaterialPropertyOlder(const std::string & name)
{
  if (isNodal())
    mooseError("Nodal AuxKernel '",
               AuxKernelTempl::name(),
               "' attempted to reference material property '",
               name,
               "'\nConsider using an elemental auxiliary variable for '",
               _var.name(),
               "'.");
 
  return MaterialPropertyInterface::getMaterialPropertyOlder<T>(name);
}
 
// Declare all the specializations, as the template specialization declaration below must know
template <>
void AuxKernelTempl<Real>::setDofValueHelper(const Real & value);
template <>
void AuxKernelTempl<RealVectorValue>::setDofValueHelper(const RealVectorValue &);
template <>
void AuxKernelTempl<RealEigenVector>::compute();
 
// Prevent implicit instantiation in other translation units where these classes are used
extern template class AuxKernelTempl<Real>;
extern template class AuxKernelTempl<RealVectorValue>;
extern template class AuxKernelTempl<RealEigenVector>;