https://mooseframework.inl.gov
Loading...
Searching...
No Matches
TagVectorSum.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 "TagVectorSum.h"
11
12// MOOSE includes
13#include "NonlinearSystemBase.h"
14#include "FEProblemBase.h"
15
16// libMesh includes
17#include "libmesh/numeric_vector.h"
18
20
23{
25 params.addRequiredParam<TagName>("vector", "The name of the vector to compute the sum for");
26 params.addClassDescription("Computes the sum of components of the requested tagged vector");
27 return params;
28}
29
31 : GeneralPostprocessor(parameters),
32 _vec(_fe_problem.getNonlinearSystemBase(_sys.number())
33 .getVector(_fe_problem.getVectorTagID(getParam<TagName>("vector"))))
34{
35}
36
37void
41
42void
47
50{
51 return _sum;
52}
Real PostprocessorValue
various MOOSE typedefs
Definition MooseTypes.h:230
registerMooseObject("MooseApp", TagVectorSum)
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.
Computes the sum of components of the requested tagged vector.
Number _sum
The vector sum.
static InputParameters validParams()
virtual PostprocessorValue getValue() const override
This will get called to actually grab the final value the postprocessor has calculated.
TagVectorSum(const InputParameters &parameters)
const NumericVector< Number > & _vec
The vector we will take the sum of.
virtual void execute() override
Execute method.
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
virtual T sum() const=0