https://mooseframework.inl.gov
Loading...
Searching...
No Matches
NearestNodeNumber.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
10#include "NearestNodeNumber.h"
11#include "UserObjectInterface.h"
12
14
17{
19 params.addRequiredParam<UserObjectName>("nearest_node_number_uo",
20 "The NearestNodeNumberUO that computes the nearest node");
21 params.addClassDescription("Outputs the nearest node number to a point");
22 return params;
23}
24
26 : GeneralPostprocessor(parameters),
27 _nnn(getUserObject<NearestNodeNumberUO>("nearest_node_number_uo"))
28{
29}
30
31Real
registerMooseObject("MooseApp", NearestNodeNumber)
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
static InputParameters validParams()
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.
Finds the nearest node to a given point.
dof_id_type getClosestNodeId() const
Returns the ID of the nearest node.
Given a NearestNodeNumberUO, outputs the nearest node number to a given point.
NearestNodeNumber(const InputParameters &parameters)
const NearestNodeNumberUO & _nnn
The nearest node number UserObject that does all the work.
virtual PostprocessorValue getValue() const override
This will get called to actually grab the final value the postprocessor has calculated.
static InputParameters validParams()