https://mooseframework.inl.gov
SolutionScalarAux.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 "AuxScalarKernel.h"
13 
15 
23 {
24 public:
26 
28 
29  virtual void initialSetup() override;
30 
31 protected:
32  virtual Real computeValue() override;
33 
36 
38  std::string _var_name;
39 
42 
45 };
SolutionScalarAux(const InputParameters &parameters)
User object that reads an existing solution from an input file and uses it in the current simulation...
const Real _scale_factor
Multiplier for the solution, the a of ax+b.
virtual Real computeValue() override
Compute the value of this kernel.
const SolutionUserObjectBase & _solution_object
Reference to the SolutionUserObject storing the solution.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
std::string _var_name
The variable name of interest.
const Real _add_factor
Additional factor added to the solution, the b of ax+b.
AuxScalarKernel for reading a solution from file.
Base class for making kernels that work on auxiliary scalar variables.
virtual void initialSetup() override
Gets called at the beginning of the simulation before this object is asked to do its job...
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
const InputParameters & parameters() const
Get the parameters of the object.
static InputParameters validParams()