www.mooseframework.org
SideUserObject.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
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 // MOOSE includes
13 #include "UserObject.h"
16 #include "Coupleable.h"
18 #include "UserObjectInterface.h"
19 #include "TransientInterface.h"
20 #include "PostprocessorInterface.h"
21 
22 // Forward Declarations
23 class SideUserObject;
24 
25 template <>
27 
28 class SideUserObject : public UserObject,
31  public Coupleable,
33  public UserObjectInterface,
34  public TransientInterface,
35  protected PostprocessorInterface
36 {
37 public:
39 
40 protected:
42 
44  const QBase * const & _qrule;
48 
49  const Elem * const & _current_elem;
51  const unsigned int & _current_side;
52 
53  const Elem * const & _current_side_elem;
54  const Real & _current_side_volume;
55 };
56 
InputParameters validParams< SideUserObject >()
A class for requiring an object to be boundary restricted.
const unsigned int & _current_side
current side of the current element
const Elem *const & _current_side_elem
SideUserObject(const InputParameters &parameters)
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
const MooseArray< Point > & _q_point
const MooseArray< Real > & _JxW
const Real & _current_side_volume
Interface for objects that needs transient capabilities.
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:65
MooseMesh wraps a libMesh::Mesh object and enhances its capabilities by caching additional data and s...
Definition: MooseMesh.h:74
Interface for objects that need to use UserObjects.
const MooseArray< Real > & _coord
Interface for objects that needs coupling capabilities.
Definition: Coupleable.h:62
MooseMesh & _mesh
An interface for accessing Materials.
const QBase *const & _qrule
const MooseArray< Point > & _normals
const Elem *const & _current_elem
Base class for user-specific data.
Definition: UserObject.h:37
Interface class for classes which interact with Postprocessors.