https://mooseframework.inl.gov
Loading...
Searching...
No Matches
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
29void
33
34void
38
39void
43
44Real
46{
47 return _value;
48}
registerMooseObject("MooseApp", PostprocessorSpatialUserObject)
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
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...
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.
User object that holds a postprocessor value.
PostprocessorSpatialUserObject(const InputParameters &parameters)
virtual void execute() override
Execute method.
virtual void finalize() override
Finalize.
virtual Real spatialValue(const Point &) const override
Optional interface function for "evaluating" a UserObject at a spatial position.
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Base class for creating a user object with the SpatialUserObject and Moose::Functor APIs.
static InputParameters validParams()