https://mooseframework.inl.gov
Loading...
Searching...
No Matches
FunctionDiracSource.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 "FunctionDiracSource.h"
11#include "Function.h"
12
14
17{
19 params.addClassDescription("Residual contribution from a point source defined by a function.");
20 params.addRequiredParam<FunctionName>(
21 "function", "The function to use for controlling the specified dirac source.");
22 params.addRequiredParam<Point>("point", "The x,y,z coordinates of the point");
23 return params;
24}
25
27 : DiracKernel(parameters), _function(getFunction("function")), _p(getParam<Point>("point"))
28{
29}
30
31void
36
37Real
registerMooseObject("MooseApp", FunctionDiracSource)
unsigned int _i
i-th, j-th index for enumerating shape and test functions
unsigned int _qp
Quadrature point index.
void addPoint(const Elem *elem, Point p, unsigned id=libMesh::invalid_uint, Real value=1.0)
Add the physical x,y,z point located in the element "elem" to the list of points this DiracKernel wil...
A DiracKernel is used when you need to add contributions to the residual by means of multiplying some...
Definition DiracKernel.h:33
static InputParameters validParams()
Definition DiracKernel.C:24
const OutputTools< T >::VariableTestValue & _test
Values of test functions at QPs.
Definition DiracKernel.h:91
virtual Real computeQpResidual() override
This is the virtual that derived classes should override for computing the residual.
virtual void addPoints() override
This is where the DiracKernel should call addPoint() for each point it needs to have a value distribu...
static InputParameters validParams()
FunctionDiracSource(const InputParameters &parameters)
const Function & _function
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:30
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
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...
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.