www.mooseframework.org
SinNeumannBC.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 "SinNeumannBC.h"
11 
13 
14 template <>
17 {
19  params.addParam<Real>("initial", 0.0, "The initial value of the gradient on the boundary");
20  params.addParam<Real>("final", 0.0, "The final value of the gradient on the boundary");
21  params.addParam<Real>("duration", 0.0, "The duration of the ramp");
22  params.addClassDescription("Imposes a time-varying flux boundary condition $\\frac{\\partial "
23  "u}{\\partial n}=g(t)$, where $g(t)$ "
24  "varies from an given initial value at time $t=0$ to a given final "
25  "value over a specified duration.");
26  return params;
27 }
28 
30  : IntegratedBC(parameters),
31  _initial(getParam<Real>("initial")),
32  _final(getParam<Real>("final")),
33  _duration(getParam<Real>("duration"))
34 {
35 }
36 
37 Real
39 {
40  Real value;
41 
42  if (_t < _duration)
43  value = _initial + (_final - _initial) * std::sin((0.5 / _duration) * libMesh::pi * _t);
44  else
45  value = _final;
46 
47  return -_test[_i][_qp] * value;
48 }
registerMooseObject("MooseApp", SinNeumannBC)
const VariableTestValue & _test
test function values (in QPs)
Definition: IntegratedBC.h:68
InputParameters validParams< IntegratedBC >()
Definition: IntegratedBC.C:23
virtual Real computeQpResidual() override
method for computing the residual at quadrature points
Definition: SinNeumannBC.C:38
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
unsigned int _i
i-th, j-th index for enumerating test and shape functions
InputParameters validParams< SinNeumannBC >()
Definition: SinNeumannBC.C:16
unsigned int _qp
quadrature point index
SinNeumannBC(const InputParameters &parameters)
Definition: SinNeumannBC.C:29
Base class for deriving any boundary condition of a integrated type.
Definition: IntegratedBC.h:24
virtual const OutputTools< Real >::VariableValue & value()
The value of the variable this object is operating on.
Implements a spatially-constant, time-varying flux boundary condition grad(u).n = g(t)...
Definition: SinNeumannBC.h:32
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...
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...