www.mooseframework.org
InterfaceValueUserObject.C
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 
11 #include "InterfaceValueTools.h"
12 
15 {
17  params.addParam<MooseEnum>("interface_value_type",
19  "Type of scalar output");
20  params.addClassDescription(
21  "Special subclass of interface userobject giving access to interface value utilities.");
22  return params;
23 }
24 
26  : InterfaceUserObject(parameters),
27  _interface_value_type(parameters.get<MooseEnum>("interface_value_type"))
28 {
29 }
30 
31 Real
33  const Real value_secondary)
34 {
35  return InterfaceValueTools::getQuantity(_interface_value_type, value_primary, value_secondary);
36 }
static InputParameters validParams()
InterfaceValueUserObject(const InputParameters &parameters)
virtual Real computeInterfaceValueType(const Real, const Real)
method computing an interface value give two Real quantities
T * get(const std::unique_ptr< T > &u)
The MooseUtils::get() specializations are used to support making forwards-compatible code changes fro...
Definition: MooseUtils.h:1147
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
const MooseEnum _interface_value_type
the average type to be computed across the interface
MooseEnum InterfaceAverageOptions()
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition: MooseEnum.h:31
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
static InputParameters validParams()
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...
Base class for implementing interface user objects.
Real getQuantity(const MooseEnum, const Real, const Real)