www.mooseframework.org
FXVolumeUserObject.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
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 #include "FXVolumeUserObject.h"
11 
12 registerMooseObject("FunctionalExpansionToolsApp", FXVolumeUserObject);
13 
14 template <>
15 InputParameters
17 {
18  InputParameters params = validParams<ElementIntegralVariableUserObject>();
19 
21 
22  params.addClassDescription("Generates an Functional Expansion representation of a variable value "
23  "over a volume using a 'FunctionSeries'-type Function");
24 
25  return params;
26 }
27 
28 FXVolumeUserObject::FXVolumeUserObject(const InputParameters & parameters)
29  : FXIntegralBaseUserObject<ElementIntegralVariableUserObject>(parameters)
30 {
31  mooseInfo("Using FXVolumeUserObject '",
32  name(),
33  "'.\nNote: it is your responsibility to ensure that the dimensionality, order, and "
34  "series parameters for FunctionSeries '",
35  _function_series.name(),
36  "' are sane.");
37 }
38 
39 Point
41 {
42  return _current_elem->centroid();
43 }
44 
45 Real
47 {
48  return _current_elem_volume;
49 }
validParams< FXVolumeUserObject >
InputParameters validParams< FXVolumeUserObject >()
Definition: FXVolumeUserObject.C:16
FXIntegralBaseUserObject
This class interacts with a MooseApp through functional expansions.
Definition: FXIntegralBaseUserObject.h:43
FXVolumeUserObject::FXVolumeUserObject
FXVolumeUserObject(const InputParameters &parameters)
Definition: FXVolumeUserObject.C:28
FXVolumeUserObject::getCentroid
virtual Point getCentroid() const
Get the centroid of the evaluated unit.
Definition: FXVolumeUserObject.C:40
name
const std::string name
Definition: Setup.h:21
FXVolumeUserObject
This volumetric FX calculates the value.
Definition: FXVolumeUserObject.h:23
FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::_function_series
FunctionSeries & _function_series
Reference to the underlying function series.
Definition: FXIntegralBaseUserObject.h:98
FXVolumeUserObject.h
validParams< FXIntegralBaseUserObjectParameters >
InputParameters validParams< FXIntegralBaseUserObjectParameters >()
Definition: FXntegralBaseUserObjectParameters.C:14
FXVolumeUserObject::getVolume
virtual Real getVolume() const
Get the volume of the evaluated unit.
Definition: FXVolumeUserObject.C:46
registerMooseObject
registerMooseObject("FunctionalExpansionToolsApp", FXVolumeUserObject)