https://mooseframework.inl.gov
SolutionAux.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 "AuxKernel.h"
13 
15 
22 class SolutionAux : public AuxKernel
23 {
24 public:
26 
28 
32  virtual void initialSetup() override;
33 
34 protected:
41  virtual Real computeValue() override;
42 
45 
47  std::string _var_name;
48 
50  bool _direct;
51 
54 
57 };
static InputParameters validParams()
Definition: SolutionAux.C:17
User object that reads an existing solution from an input file and uses it in the current simulation...
virtual Real computeValue() override
Computes a value for a node or element depending on the type of kernel, it also uses the 'direct' fla...
Definition: SolutionAux.C:73
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
SolutionAux(const InputParameters &parameters)
Definition: SolutionAux.C:40
virtual void initialSetup() override
Sets up the variable name for extraction from the SolutionUserObject.
Definition: SolutionAux.C:50
const Real _add_factor
Additional factor added to the solution, the b of ax+b.
Definition: SolutionAux.h:56
std::string _var_name
The variable name of interest.
Definition: SolutionAux.h:47
const SolutionUserObjectBase & _solution_object
Reference to the SolutionUserObject storing the solution.
Definition: SolutionAux.h:44
const Real _scale_factor
Multiplier for the solution, the a of ax+b.
Definition: SolutionAux.h:53
bool _direct
Flag for directly grabbing the data based on the dof.
Definition: SolutionAux.h:50
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
AuxKernel for reading a solution from file.
Definition: SolutionAux.h:22
const InputParameters & parameters() const
Get the parameters of the object.
Base class for creating new auxiliary kernels and auxiliary boundary conditions.
Definition: AuxKernel.h:36