AuxKernel.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* 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 "MooseObject.h"
#include "MooseVariableFE.h"
#include "SetupInterface.h"
#include "CoupleableMooseVariableDependencyIntermediateInterface.h"
#include "MaterialPropertyInterface.h"
#include "FunctionInterface.h"
#include "UserObjectInterface.h"
#include "TransientInterface.h"
#include "PostprocessorInterface.h"
#include "DependencyResolverInterface.h"
#include "RandomInterface.h"
#include "GeometricSearchInterface.h"
#include "BlockRestrictable.h"
#include "BoundaryRestrictable.h"
#include "Restartable.h"
#include "MeshChangedInterface.h"
#include "VectorPostprocessorInterface.h"
#include "MooseVariableInterface.h"
#include "MemberTemplateMacros.h"
#include "ElementIDInterface.h"
 
// forward declarations
template <typename ComputeValueType>
class AuxKernelTempl;
 
typedef AuxKernelTempl<Real> AuxKernel;
typedef AuxKernelTempl<RealVectorValue> VectorAuxKernel;
 
class SubProblem;
class AuxiliarySystem;
class SystemBase;
class MooseMesh;
 
template <>
InputParameters validParams<AuxKernel>();
 
template <>
InputParameters validParams<VectorAuxKernel>();
 
template <typename ComputeValueType>
class AuxKernelTempl : public MooseObject,
                       public MooseVariableInterface<ComputeValueType>,
                       public BlockRestrictable,
                       public BoundaryRestrictable,
                       public SetupInterface,
                       public CoupleableMooseVariableDependencyIntermediateInterface,
                       public FunctionInterface,
                       public UserObjectInterface,
                       public TransientInterface,
                       public MaterialPropertyInterface,
                       public PostprocessorInterface,
                       public DependencyResolverInterface,
                       public RandomInterface,
                       protected GeometricSearchInterface,
                       public Restartable,
                       public MeshChangedInterface,
                       protected VectorPostprocessorInterface,
                       public ElementIDInterface
{
public:
  static InputParameters validParams();
 
  AuxKernelTempl(const InputParameters & parameters);
 
  virtual void compute();
 
  bool isNodal() const { return _nodal; }
 
  MooseVariableFE<ComputeValueType> & variable() { return _var; }
 
  const std::set<std::string> & getDependObjects() const { return _depend_uo; }
 
  void coupledCallback(const std::string & var_name, bool is_old) override;
 
  virtual const std::set<std::string> & getRequestedItems() override;
 
  virtual const std::set<std::string> & getSuppliedItems() override;
 
  template <typename T>
  const MaterialProperty<T> & getMaterialPropertyTempl(const std::string & name);
  template <typename T>
  const MaterialProperty<T> & getMaterialPropertyOldTempl(const std::string & name);
  template <typename T>
  const MaterialProperty<T> & getMaterialPropertyOlderTempl(const std::string & name);
 
  template <typename T>
  const T & getUserObjectTempl(const std::string & name);
  template <typename T>
  const T & getUserObjectByNameTempl(const UserObjectName & name);
 
  const UserObject & getUserObjectBase(const std::string & name);
 
  virtual const PostprocessorValue & getPostprocessorValue(const std::string & name);
  virtual const PostprocessorValue & getPostprocessorValueByName(const PostprocessorName & name);
 
  virtual const VectorPostprocessorValue &
  getVectorPostprocessorValue(const std::string & name, const std::string & vector_name) override;
  virtual const VectorPostprocessorValue &
  getVectorPostprocessorValueByName(const VectorPostprocessorName &,
                                    const std::string & vector_name) override;
 
  virtual const VectorPostprocessorValue & getVectorPostprocessorValue(
      const std::string & name, const std::string & vector_name, bool needs_broadcast) override;
  virtual const VectorPostprocessorValue &
  getVectorPostprocessorValueByName(const VectorPostprocessorName &,
                                    const std::string & vector_name,
                                    bool needs_broadcast) override;
 
  virtual const ScatterVectorPostprocessorValue &
  getScatterVectorPostprocessorValue(const std::string & name,
                                     const std::string & vector_name) override;
 
  virtual const ScatterVectorPostprocessorValue &
  getScatterVectorPostprocessorValueByName(const std::string & name,
                                           const std::string & vector_name) override;
 
protected:
  virtual ComputeValueType computeValue() = 0;
 
  virtual const VariableValue & coupledDot(const std::string & var_name,
                                           unsigned int comp = 0) override;
 
  virtual const VariableValue & coupledDotDu(const std::string & var_name,
                                             unsigned int comp = 0) override;
 
  virtual void precalculateValue() {}
 
  SubProblem & _subproblem;
  SystemBase & _sys;
  SystemBase & _nl_sys;
  AuxiliarySystem & _aux_sys;
 
  THREAD_ID _tid;
 
  MooseVariableFE<ComputeValueType> & _var;
 
  bool _nodal;
 
  const typename OutputTools<ComputeValueType>::VariableValue & _u;
 
  const typename OutputTools<ComputeValueType>::VariableValue & _u_old;
 
  const typename OutputTools<ComputeValueType>::VariableValue & _u_older;
 
  const typename OutputTools<ComputeValueType>::VariableTestValue & _test;
 
  Assembly & _assembly;
 
  bool _bnd;
  MooseMesh & _mesh;
  //  unsigned int _dim;
 
  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;
 
  unsigned int _qp;
 
  std::set<std::string> _depend_vars;
  std::set<std::string> _supplied_vars;
 
  std::set<std::string> _depend_uo;
 
  unsigned int _n_local_dofs;
 
  DenseVector<Number> _local_re;
  DenseVector<Number> _local_sol;
  DenseMatrix<Number> _local_ke;
 
  using MooseVariableInterface<ComputeValueType>::mooseVariable;
};
 
template <typename ComputeValueType>
template <typename T>
const MaterialProperty<T> &
AuxKernelTempl<ComputeValueType>::getMaterialPropertyTempl(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::getMaterialPropertyTempl<T>(name);
}
 
template <typename ComputeValueType>
template <typename T>
const MaterialProperty<T> &
AuxKernelTempl<ComputeValueType>::getMaterialPropertyOldTempl(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::getMaterialPropertyOldTempl<T>(name);
}
 
template <typename ComputeValueType>
template <typename T>
const MaterialProperty<T> &
AuxKernelTempl<ComputeValueType>::getMaterialPropertyOlderTempl(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::getMaterialPropertyOlderTempl<T>(name);
}
 
template <typename ComputeValueType>
template <typename T>
const T &
AuxKernelTempl<ComputeValueType>::getUserObjectTempl(const std::string & name)
{
  _depend_uo.insert(_pars.get<UserObjectName>(name));
  return UserObjectInterface::getUserObjectTempl<T>(name);
}
 
template <typename ComputeValueType>
template <typename T>
const T &
AuxKernelTempl<ComputeValueType>::getUserObjectByNameTempl(const UserObjectName & name)
{
  _depend_uo.insert(name);
  return UserObjectInterface::getUserObjectByNameTempl<T>(name);
}