www.mooseframework.org
SpatialUserObjectAux.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 "SpatialUserObjectAux.h"
11 #include "UserObject.h"
12 
14 
16 
19 {
21  params.addRequiredParam<UserObjectName>(
22  "user_object",
23  "The UserObject UserObject to get values from. Note that the UserObject "
24  "_must_ implement the spatialValue() virtual function!");
25  return params;
26 }
27 
29  : AuxKernel(parameters), _user_object(getUserObjectBase("user_object"))
30 {
31 }
32 
33 Real
35 {
36  if (isNodal())
38  else
39  return _user_object.spatialValue(_current_elem->centroid());
40 }
SpatialUserObjectAux::validParams
static InputParameters validParams()
Definition: SpatialUserObjectAux.C:18
UserObject::spatialValue
virtual Real spatialValue(const Point &) const
Optional interface function for "evaluating" a UserObject at a spatial position.
Definition: UserObject.h:87
AuxKernelTempl
Base class for creating new auxiliary kernels and auxiliary boundary conditions.
Definition: AuxKernel.h:35
SpatialUserObjectAux::_user_object
const UserObject & _user_object
UserObject to be queried for a value.
Definition: SpatialUserObjectAux.h:39
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition: InputParameters.h:53
SpatialUserObjectAux::SpatialUserObjectAux
SpatialUserObjectAux(const InputParameters &parameters)
Factory constructor, takes parameters so that all derived classes can be built using the same constru...
Definition: SpatialUserObjectAux.C:28
registerMooseObject
registerMooseObject("MooseApp", SpatialUserObjectAux)
AuxKernelTempl::_current_elem
const Elem *const & _current_elem
Current element (valid only for elemental kernels)
Definition: AuxKernel.h:208
AuxKernelTempl::validParams
static InputParameters validParams()
Definition: AuxKernel.C:28
AuxKernelTempl::isNodal
bool isNodal() const
Nodal or elemental kernel?
Definition: AuxKernel.h:89
SpatialUserObjectAux
Function auxiliary value.
Definition: SpatialUserObjectAux.h:24
AuxKernelTempl::_current_node
const Node *const & _current_node
Current node (valid only for nodal kernels)
Definition: AuxKernel.h:218
defineLegacyParams
defineLegacyParams(SpatialUserObjectAux)
SpatialUserObjectAux::computeValue
virtual Real computeValue() override
Compute and return the value of the aux variable.
Definition: SpatialUserObjectAux.C:34
SpatialUserObjectAux.h
UserObject.h
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
Definition: InputParameters.h:1176