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