https://mooseframework.inl.gov
src
postprocessors
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
13
registerMooseObject
(
"MooseApp"
,
NearestNodeNumber
);
14
15
InputParameters
16
NearestNodeNumber::validParams
()
17
{
18
InputParameters
params =
GeneralPostprocessor::validParams
();
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
25
NearestNodeNumber::NearestNodeNumber
(
const
InputParameters
& parameters)
26
:
GeneralPostprocessor
(parameters),
27
_nnn(getUserObject<
NearestNodeNumberUO
>(
"nearest_node_number_uo"
))
28
{
29
}
30
31
Real
32
NearestNodeNumber::getValue
()
const
33
{
34
return
_nnn
.
getClosestNodeId
();
35
}
NearestNodeNumber::validParams
static InputParameters validParams()
Definition:
NearestNodeNumber.C:16
NearestNodeNumber::getValue
virtual PostprocessorValue getValue() const override
This will get called to actually grab the final value the postprocessor has calculated.
Definition:
NearestNodeNumber.C:32
NearestNodeNumber::_nnn
const NearestNodeNumberUO & _nnn
The nearest node number UserObject that does all the work.
Definition:
NearestNodeNumber.h:31
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Definition:
InputParameters.h:66
UserObjectInterface.h
GeneralPostprocessor
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
Definition:
GeneralPostprocessor.h:21
NearestNodeNumber
Given a NearestNodeNumberUO, outputs the nearest node number to a given point.
Definition:
NearestNodeNumber.h:18
InputParameters::addRequiredParam
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...
Definition:
InputParameters.h:1628
GeneralPostprocessor::validParams
static InputParameters validParams()
Definition:
GeneralPostprocessor.C:13
NearestNodeNumber::NearestNodeNumber
NearestNodeNumber(const InputParameters ¶meters)
Definition:
NearestNodeNumber.C:25
registerMooseObject
registerMooseObject("MooseApp", NearestNodeNumber)
NearestNodeNumberUO
Finds the nearest node to a given point.
Definition:
NearestNodeNumberUO.h:18
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
NearestNodeNumber.h
InputParameters::addClassDescription
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...
Definition:
InputParameters.C:82
NearestNodeNumberUO::getClosestNodeId
dof_id_type getClosestNodeId() const
Returns the ID of the nearest node.
Definition:
NearestNodeNumberUO.C:80
Generated on Thu Jul 17 2025 01:32:15 for https://mooseframework.inl.gov by
1.8.14