www.mooseframework.org
VectorFunctionAux.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 "VectorFunctionAux.h"
11 #include "Function.h"
12 
14 
15 template <>
18 {
20  params.addClassDescription(
21  "Auxiliary Kernel that creates and updates a vector field variable by "
22  "sampling a Function object, via the vectorValue method, through space and time.");
23  params.addRequiredParam<FunctionName>("function", "The function to use as the value.");
24  return params;
25 }
26 
28  : VectorAuxKernel(parameters), _function(getFunction("function"))
29 {
30 }
31 
34 {
35  if (isNodal())
37  else
39 }
Function auxiliary value.
VectorValue< Real > RealVectorValue
Definition: Assembly.h:31
const Node *const & _current_node
Current node (valid only for nodal kernels)
Definition: AuxKernel.h:213
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
virtual RealVectorValue computeValue() override
Compute and return the value of the aux variable.
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...
Function & _function
Function being used to compute the value of this kernel.
registerMooseObject("MooseApp", VectorFunctionAux)
bool isNodal()
Nodal or elemental kernel?
Definition: AuxKernel.h:84
InputParameters validParams< VectorAuxKernel >()
Definition: AuxKernel.C:63
virtual RealVectorValue vectorValue(Real t, const Point &p)
Override this to evaluate the vector function at a point (t,x,y,z), by default this returns a zero ve...
Definition: Function.C:57
unsigned int _qp
Quadrature point index.
Definition: AuxKernel.h:219
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
Base class for creating new auxiliary kernels and auxiliary boundary conditions.
Definition: AuxKernel.h:33
VectorFunctionAux(const InputParameters &parameters)
Factory constructor, takes parameters so that all derived classes can be built using the same constru...
const MooseArray< Point > & _q_point
Dimension of the problem being solved.
Definition: AuxKernel.h:195
InputParameters validParams< VectorFunctionAux >()