https://mooseframework.inl.gov
include
postprocessors
ScalarVariable.h
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
#pragma once
11
12
#include "
GeneralPostprocessor.h
"
13
17
class
ScalarVariable
:
public
GeneralPostprocessor
18
{
19
public
:
20
static
InputParameters
validParams
();
21
22
ScalarVariable
(
const
InputParameters
&
parameters
);
23
24
virtual
void
initialize
()
override
;
25
virtual
void
execute
()
override
;
26
virtual
Real
getValue
()
const override
;
27
virtual
void
finalize
()
override
;
28
29
protected
:
30
MooseVariableScalar
&
_var
;
31
unsigned
int
_idx
;
32
Real
_value
;
33
};
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Definition:
InputParameters.h:66
GeneralPostprocessor
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
Definition:
GeneralPostprocessor.h:21
ScalarVariable::execute
virtual void execute() override
Execute method.
Definition:
ScalarVariable.C:44
ScalarVariable::_idx
unsigned int _idx
Definition:
ScalarVariable.h:31
ScalarVariable::validParams
static InputParameters validParams()
Definition:
ScalarVariable.C:21
ScalarVariable::finalize
virtual void finalize() override
This is called after execute() and after threadJoin()! This is probably where you want to do MPI comm...
Definition:
ScalarVariable.C:61
ScalarVariable::_var
MooseVariableScalar & _var
Definition:
ScalarVariable.h:30
ScalarVariable::initialize
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Definition:
ScalarVariable.C:39
ScalarVariable::getValue
virtual Real getValue() const override
This will get called to actually grab the final value the postprocessor has calculated.
Definition:
ScalarVariable.C:55
ScalarVariable
Definition:
ScalarVariable.h:17
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
GeneralPostprocessor.h
MooseVariableScalar
Class for scalar variables (they are different).
Definition:
MooseVariableScalar.h:28
ScalarVariable::_value
Real _value
Definition:
ScalarVariable.h:32
MooseBaseParameterInterface::parameters
const InputParameters & parameters() const
Get the parameters of the object.
Definition:
MooseBaseParameterInterface.h:62
ScalarVariable::ScalarVariable
ScalarVariable(const InputParameters ¶meters)
Definition:
ScalarVariable.C:30
Generated on Thu Jul 17 2025 01:32:07 for https://mooseframework.inl.gov by
1.8.14