www.mooseframework.org
NodalVariableValue.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
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 
14 // Forward Declarations
15 class NodalVariableValue;
16 class MooseMesh;
17 
18 namespace libMesh
19 {
20 class Node;
21 }
22 
23 template <>
25 
31 {
32 public:
34 
36 
37  virtual void initialize() override {}
38  virtual void execute() override {}
39  virtual Real getValue() override;
40 
41 protected:
43  std::string _var_name;
44  Node * _node_ptr;
45  const Real _scale_factor;
46 };
47 
NodalVariableValue::execute
virtual void execute() override
Execute method.
Definition: NodalVariableValue.h:38
NodalVariableValue::_mesh
MooseMesh & _mesh
Definition: NodalVariableValue.h:42
libMesh
The following methods are specializations for using the libMesh::Parallel::packed_range_* routines fo...
Definition: AddPeriodicBCAction.h:16
NodalVariableValue::initialize
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Definition: NodalVariableValue.h:37
NodalVariableValue
Sums a nodal value across all processors and multiplies the result by a scale factor.
Definition: NodalVariableValue.h:30
MooseObject::parameters
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:76
NodalVariableValue::validParams
static InputParameters validParams()
Definition: NodalVariableValue.C:24
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition: InputParameters.h:53
GeneralPostprocessor.h
GeneralPostprocessor
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
Definition: GeneralPostprocessor.h:27
NodalVariableValue::_scale_factor
const Real _scale_factor
Definition: NodalVariableValue.h:45
NodalVariableValue::NodalVariableValue
NodalVariableValue(const InputParameters &parameters)
Definition: NodalVariableValue.C:34
NodalVariableValue::_node_ptr
Node * _node_ptr
Definition: NodalVariableValue.h:44
MooseMesh
MooseMesh wraps a libMesh::Mesh object and enhances its capabilities by caching additional data and s...
Definition: MooseMesh.h:74
validParams< NodalVariableValue >
InputParameters validParams< NodalVariableValue >()
NodalVariableValue::getValue
virtual Real getValue() override
This will get called to actually grab the final value the postprocessor has calculated.
Definition: NodalVariableValue.C:59
NodalVariableValue::_var_name
std::string _var_name
Definition: NodalVariableValue.h:43