https://mooseframework.inl.gov
InterfaceUserObjectBase.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 "UserObject.h"
16 #include "TransientInterface.h"
17 #include "ElementIDInterface.h"
18 #include "FaceInfo.h"
19 
24  : public UserObject,
28  public TransientInterface,
29  public ElementIDInterface
30 {
31 public:
33 
35 
36 protected:
40  virtual void execute() override {}
41 
45  virtual void initialize() override {}
46 
48 
50  const QBase * const & _qrule;
54 
56  const Elem * const & _current_elem;
60  const unsigned int & _current_side;
62  const Elem * const & _current_side_elem;
65 
67  const Elem * const & _neighbor_elem;
70 };
A class for requiring an object to be boundary restricted.
Intermediate base class that ties together all the interfaces for getting MooseVariables with the Moo...
Base class for implementing interface user objects.
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
const unsigned int & _current_side
current side of the current element
const MooseArray< Real > & _JxW
const MooseArray< Real > & _coord
static InputParameters validParams()
Interface for objects that needs transient capabilities.
const MooseArray< Point > & _q_point
MooseMesh wraps a libMesh::Mesh object and enhances its capabilities by caching additional data and s...
Definition: MooseMesh.h:88
const Elem *const & _current_side_elem
the side element
const Real & _current_neighbor_volume
current neighbor volume
InterfaceUserObjectBase(const InputParameters &parameters)
const Elem *const & _neighbor_elem
The neighboring element.
const Real & _current_side_volume
current side volume
const MooseArray< Point > & _normals
const Real & _current_elem_volume
the volume of the current element
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
This interface is designed for DGKernel, InternalSideUserObject, InterfaceUserObject, where material properties on a side of both its primary side (face) and its secondary side (neighbor) all required.
const InputParameters & parameters() const
Get the parameters of the object.
const Elem *const & _current_elem
current element
Base class for user-specific data.
Definition: UserObject.h:40
virtual void execute() override
Execute method.