AuxScalarKernel.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 "ScalarCoupleable.h"
#include "SetupInterface.h"
#include "FunctionInterface.h"
#include "UserObjectInterface.h"
#include "PostprocessorInterface.h"
#include "DependencyResolverInterface.h"
#include "TransientInterface.h"
#include "MooseVariableScalar.h"
#include "MeshChangedInterface.h"

// Forward declarations
class MooseMesh;
class SubProblem;
class Assembly;
class AuxScalarKernel : public MooseObject,
                        public ScalarCoupleable,
                        public SetupInterface,
                        public FunctionInterface,
                        public UserObjectInterface,
                        public PostprocessorInterface,
                        public DependencyResolverInterface,
                        public TransientInterface,
                        public MeshChangedInterface
{
public:
  static InputParameters validParams();

  AuxScalarKernel(const InputParameters & parameters);

  virtual ~AuxScalarKernel();

  virtual void compute();

  MooseVariableScalar & variable() { return _var; }

  SubProblem & subProblem() { return _subproblem; }

  virtual const std::set<std::string> & getRequestedItems() override;

  virtual const std::set<std::string> & getSuppliedItems() override;

  virtual bool isActive();

protected:
  const VariableValue & uOld() const;

  SubProblem & _subproblem;
  SystemBase & _sys;

  THREAD_ID _tid;

  Assembly & _assembly;
  MooseVariableScalar & _var;
  MooseMesh & _mesh;

  unsigned int _i;

  const VariableValue & _u;

  std::set<std::string> _depend_vars;
  std::set<std::string> _supplied_vars;

  virtual Real computeValue() = 0;
};