https://mooseframework.inl.gov
Loading...
Searching...
No Matches
src
postprocessors
NumPositions.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
// MOOSE includes
11
#include "
NumPositions.h
"
12
#include "
Positions.h
"
13
14
registerMooseObject
(
"MooseApp"
,
NumPositions
);
15
16
InputParameters
17
NumPositions::validParams
()
18
{
19
InputParameters
params =
GeneralPostprocessor::validParams
();
20
params.
addRequiredParam
<PositionsName>(
"positions"
,
"Positions to count the number of"
);
21
22
params.
addClassDescription
(
"Return the number of Positions from a Positions object."
);
23
return
params;
24
}
25
26
NumPositions::NumPositions
(
const
InputParameters
& parameters)
27
:
GeneralPostprocessor
(parameters),
28
_positions(_fe_problem.getPositionsObject(getParam<PositionsName>(
"positions"
)))
29
{
30
}
31
32
Real
33
NumPositions::getValue
()
const
34
{
35
if
(
_fe_problem
.
getCurrentExecuteOnFlag
() ==
EXEC_INITIAL
)
36
return
_positions
.
getPositions
(
/*initial=*/
true
).size();
37
else
38
return
_positions
.
getPositions
(
/*initial=*/
false
).size();
39
}
EXEC_INITIAL
const ExecFlagType EXEC_INITIAL
Definition
Moose.C:30
registerMooseObject
registerMooseObject("MooseApp", NumPositions)
NumPositions.h
Positions.h
FEProblemBase::getCurrentExecuteOnFlag
const ExecFlagType & getCurrentExecuteOnFlag() const
Return/set the current execution flag.
Definition
FEProblemBase.C:5061
GeneralPostprocessor
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
Definition
GeneralPostprocessor.h:22
GeneralPostprocessor::validParams
static InputParameters validParams()
Definition
GeneralPostprocessor.C:13
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition
InputParameters.h:68
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:1806
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:81
NumPositions
Counts the number of positions from a Positions object.
Definition
NumPositions.h:20
NumPositions::getValue
virtual Real getValue() const override
This will get called to actually grab the final value the postprocessor has calculated.
Definition
NumPositions.C:33
NumPositions::validParams
static InputParameters validParams()
Definition
NumPositions.C:17
NumPositions::NumPositions
NumPositions(const InputParameters ¶meters)
Definition
NumPositions.C:26
NumPositions::_positions
const Positions & _positions
Definition
NumPositions.h:33
Positions::getPositions
const std::vector< Point > & getPositions(bool initial) const
{ Getters for the positions vector for the desired dimension 1D will be the only one guaranteed to su...
Definition
Positions.C:116
UserObjectBase::_fe_problem
FEProblemBase & _fe_problem
Reference to the FEProblemBase for this user object.
Definition
UserObjectBase.h:180
Generated on Fri Aug 21 2026 13:33:59 for https://mooseframework.inl.gov by
1.9.8