https://mooseframework.inl.gov
Loading...
Searching...
No Matches
FXVolumeUserObject.C
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#include "FXVolumeUserObject.h"
11
12registerMooseObject("FunctionalExpansionToolsApp", FXVolumeUserObject);
13
16{
17 InputParameters params =
19
20 params.addClassDescription("Generates an Functional Expansion representation of a variable value "
21 "over a volume using a 'FunctionSeries'-type Function");
22
23 return params;
24}
25
28{
29 mooseInfo("Using FXVolumeUserObject '",
30 name(),
31 "'.\nNote: it is your responsibility to ensure that the dimensionality, order, and "
32 "series parameters for FunctionSeries '",
34 "' are sane.");
35}
36
37Point
39{
40 return _current_elem->vertex_average();
41}
42
43Real
registerMooseObject("FunctionalExpansionToolsApp", FXVolumeUserObject)
const Elem *const & _current_elem
This class interacts with a MooseApp through functional expansions.
FunctionSeries & _function_series
Reference to the underlying function series.
static InputParameters validParams()
This volumetric FX calculates the value.
FXVolumeUserObject(const InputParameters &parameters)
virtual Point getCentroid() const
Get the centroid of the evaluated unit.
static InputParameters validParams()
virtual Real getVolume() const
Get the volume of the evaluated unit.
void addClassDescription(const std::string &doc_string)
const std::string & name() const
void mooseInfo(Args &&... args) const