https://mooseframework.inl.gov
PostprocessorSpatialUserObject.C
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 
11 
13 
16 {
18  params.addRequiredParam<PostprocessorName>("postprocessor", "The name of the postprocessor");
19  params.addClassDescription("User object (spatial) that holds a postprocessor value.");
20  return params;
21 }
22 
25  _value(getPostprocessorValue("postprocessor"))
26 {
27 }
28 
29 void
31 {
32 }
33 
34 void
36 {
37 }
38 
39 void
41 {
42 }
43 
44 Real
46 {
47  return _value;
48 }
virtual void finalize() override
Finalize.
static InputParameters validParams()
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...
registerMooseObject("MooseApp", PostprocessorSpatialUserObject)
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
User object that holds a postprocessor value.
virtual Real spatialValue(const Point &) const override
Optional interface function for "evaluating" a UserObject at a spatial position.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
PostprocessorSpatialUserObject(const InputParameters &parameters)
Base class for creating a user object with the SpatialUserObject and Moose::Functor APIs...
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...
virtual void execute() override
Execute method.