https://mooseframework.inl.gov
Loading...
Searching...
No Matches
AuxScalarKernel.h
Go to the documentation of this file.
1//* This file is part of the MOOSE framework
2//* https://mooseframework.inl.gov
3//*
4//* All rights reserved, see COPYRIGHT for full restrictions
5//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6//*
7//* Licensed under LGPL 2.1, please see LICENSE for details
8//* https://www.gnu.org/licenses/lgpl-2.1.html
9
10#pragma once
11
12#include "MooseObject.h"
13#include "ScalarCoupleable.h"
14#include "SetupInterface.h"
15#include "FunctionInterface.h"
16#include "UserObjectInterface.h"
19#include "TransientInterface.h"
20#include "MooseVariableScalar.h"
22
23// Forward declarations
24class MooseMesh;
25class SubProblem;
26class Assembly;
31 public ScalarCoupleable,
32 public SetupInterface,
33 public FunctionInterface,
37 public TransientInterface,
39{
40public:
42
44
45 virtual ~AuxScalarKernel();
46
50 virtual void compute();
51
56
58
59 virtual const std::set<std::string> & getRequestedItems() override;
60
61 virtual const std::set<std::string> & getSuppliedItems() override;
62
67 virtual bool isActive();
68
69protected:
75 const VariableValue & uOld() const;
76
79
81
85
86 unsigned int _i;
87
89
91 std::set<std::string> _depend_vars;
92 std::set<std::string> _supplied_vars;
93
100 virtual Real computeValue() = 0;
101};
OutputTools< Real >::VariableValue VariableValue
Definition MooseTypes.h:348
unsigned int THREAD_ID
Definition MooseTypes.h:237
Keeps track of stuff related to assembling.
Definition Assembly.h:110
Base class for making kernels that work on auxiliary scalar variables.
Assembly & _assembly
const VariableValue & _u
unsigned int _i
SystemBase & _sys
virtual ~AuxScalarKernel()
static InputParameters validParams()
SubProblem & subProblem()
virtual const std::set< std::string > & getSuppliedItems() override
Return a set containing the names of items owned by the object.
virtual Real computeValue()=0
Compute the value of this kernel.
MooseVariableScalar & _var
virtual bool isActive()
Use this to enable/disable the constraint.
virtual const std::set< std::string > & getRequestedItems() override
Return a set containing the names of items requested by the object.
std::set< std::string > _supplied_vars
MooseMesh & _mesh
std::set< std::string > _depend_vars
Depend AuxKernels.
SubProblem & _subproblem
const VariableValue & uOld() const
Retrieves the old value of the variable that this AuxScalarKernel operates on.
virtual void compute()
Evaluate the kernel.
MooseVariableScalar & variable()
The variable that this kernel operates on.
Interface for sorting dependent vectors of objects.
Interface for objects that need to use functions.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Interface for notifications that the mesh has changed.
const InputParameters & parameters() const
Get the parameters of the object.
Definition MooseBase.h:131
MooseMesh wraps a libMesh::Mesh object and enhances its capabilities by caching additional data and s...
Definition MooseMesh.h:95
Every object that can be built by the factory should be derived from this class.
Definition MooseObject.h:31
Class for scalar variables (they are different).
Interface class for classes which interact with Postprocessors.
Interface for objects that needs scalar coupling capabilities.
Generic class for solving transient nonlinear problems.
Definition SubProblem.h:79
Base class for a system (of equations)
Definition SystemBase.h:87
Interface for objects that needs transient capabilities.
Interface for objects that need to use UserObjects.