www.mooseframework.org
SolutionAux.h
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
15 #ifndef SOLUTIONAUX_H
16 #define SOLUTIONAUX_H
17 
18 #include "AuxKernel.h"
19 
20 // Forward declaration
21 class SolutionAux;
22 class SolutionUserObject;
23 
24 template <>
26 
33 class SolutionAux : public AuxKernel
34 {
35 public:
37 
41  virtual void initialSetup() override;
42 
43 protected:
50  virtual Real computeValue() override;
51 
54 
56  std::string _var_name;
57 
59  bool _direct;
60 
62  const Real _scale_factor;
63 
65  const Real _add_factor;
66 };
67 
68 #endif // SOLUTIONAUX_H
virtual Real computeValue() override
Computes a value for a node or element depending on the type of kernel, it also uses the &#39;direct&#39; fla...
Definition: SolutionAux.C:82
const SolutionUserObject & _solution_object
Reference to the SolutionUserObject storing the solution.
Definition: SolutionAux.h:53
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
SolutionAux(const InputParameters &parameters)
Definition: SolutionAux.C:44
virtual void initialSetup() override
Sets up the variable name for extraction from the SolutionUserObject.
Definition: SolutionAux.C:54
const Real _add_factor
Additional factor added to the solution, the b of ax+b.
Definition: SolutionAux.h:65
std::string _var_name
The variable name of interest.
Definition: SolutionAux.h:56
InputParameters validParams< SolutionAux >()
Definition: SolutionAux.C:21
const Real _scale_factor
Multiplier for the solution, the a of ax+b.
Definition: SolutionAux.h:62
bool _direct
Flag for directly grabbing the data based on the dof.
Definition: SolutionAux.h:59
Base class for creating new auxiliary kernels and auxiliary boundary conditions.
Definition: AuxKernel.h:51
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:53
AuxKernel for reading a solution from file.
Definition: SolutionAux.h:33
User object that reads an existing solution from an input file and uses it in the current simulation...