https://mooseframework.inl.gov
Axisymmetric2D3DSolutionFunction.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 "Function.h"
13 
15 
24 {
25 public:
31 
33 
34  using Function::value;
35  virtual Real value(Real t, const Point & p) const override;
36 
43  virtual void initialSetup() override;
44 
45 protected:
48 
51 
54 
59 
63 
67 
70  const bool _has_component;
71 
73  const unsigned int _component;
74 
77 
79  std::vector<std::string> _var_names;
80 
82  std::vector<unsigned int> _solution_object_var_indices;
83 };
const Real _add_factor
Factor to add to the solution (default = 0)
Base class for function objects.
Definition: Function.h:36
User object that reads an existing solution from an input file and uses it in the current simulation...
std::vector< unsigned int > _solution_object_var_indices
The local SolutionUserObject indices for the variables extracted from the file.
Axisymmetric2D3DSolutionFunction(const InputParameters &parameters)
const unsigned int _component
The index of the component.
const RealVectorValue _2d_axis_point1
Two points that define the axis of rotation for the 2d model.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
const RealVectorValue _3d_axis_point1
Two points that define the axis of rotation for the 3d model.
static InputParameters validParams()
Constructor.
virtual Real value(Real t, const Point &p) const override
Override this to evaluate the scalar function at point (t,x,y,z), by default this returns zero...
const SolutionUserObjectBase * _solution_object_ptr
Pointer to SolutionUserObject containing the solution of interest.
bool _default_axes
Are the default axes of rotation being used?
std::vector< std::string > _var_names
The variable names to extract from the file.
Function for reading a 2D axisymmetric solution from file and mapping it to a 3D Cartesian system...
const Real _axial_dim_ratio
Ratio of axial dimension of 3d model to its counterpart in the 2d model.
virtual void initialSetup() override
Setup the function for use Gathers a pointer to the SolutionUserObject containing the solution that w...
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
const InputParameters & parameters() const
Get the parameters of the object.
virtual Real value(Real t, const Point &p) const
Override this to evaluate the scalar function at point (t,x,y,z), by default this returns zero...
Definition: Function.C:44
const bool _has_component
If the solution field is a vector, the desired component must be specified Has the component been spe...
const Real _scale_factor
Factor to scale the solution by (default = 1)