www.mooseframework.org
PorousFlowHalfCubicSink.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 
11 #include "libmesh/utility.h"
12 
14 
15 template <>
16 InputParameters
18 {
19  InputParameters params = validParams<PorousFlowSinkPTDefiner>();
20  params.addRequiredParam<Real>(
21  "max",
22  "Maximum of the cubic flux multiplier. Denote x = porepressure - center (or in the "
23  "case of a heat flux with no fluid, x = temperature - center). Then Flux out is "
24  "multiplied by (max/cutoff^3)*(2x + cutoff)(x - cutoff)^2 for cutoff < x < 0. Flux "
25  "out is multiplied by max for x >= 0. Flux out is multiplied by 0 for x <= cutoff.");
26  params.addRequiredParam<FunctionName>("cutoff",
27  "Cutoff of the cubic (measured in Pa (or K for "
28  "temperature BCs)). This needs to be less than "
29  "zero.");
30  params.addRequiredParam<Real>(
31  "center", "Center of the cubic flux multiplier (measured in Pa (or K for temperature BCs)).");
32  params.addClassDescription("Applies a flux sink to a boundary. The base flux defined by "
33  "PorousFlowSink is multiplied by a cubic.");
34  return params;
35 }
36 
37 PorousFlowHalfCubicSink::PorousFlowHalfCubicSink(const InputParameters & parameters)
38  : PorousFlowSinkPTDefiner(parameters),
39  _maximum(getParam<Real>("max")),
40  _cutoff(getFunction("cutoff")),
41  _center(getParam<Real>("center"))
42 {
43 }
44 
45 Real
47 {
48  const Real x = ptVar() - _center;
49 
50  if (x >= 0)
52 
53  const Real cutoff = _cutoff.value(_t, _q_point[_qp]);
54  if (x <= cutoff)
55  return 0.0;
56 
57  return PorousFlowSink::multiplier() * _maximum * (2 * x + cutoff) * (x - cutoff) * (x - cutoff) /
58  Utility::pow<3>(cutoff);
59 }
60 
61 Real
63 {
64  const Real x = ptVar() - _center;
65 
66  if (x >= 0)
68 
69  const Real cutoff = _cutoff.value(_t, _q_point[_qp]);
70  if (x <= cutoff)
71  return 0.0;
72 
73  const Real str =
74  _maximum * (2 * x + cutoff) * (x - cutoff) * (x - cutoff) / Utility::pow<3>(cutoff);
75  const Real deriv = _maximum * 6 * x * (x - cutoff) / Utility::pow<3>(cutoff);
76  return PorousFlowSink::dmultiplier_dvar(pvar) * str +
77  PorousFlowSink::multiplier() * deriv * dptVar(pvar);
78 }
PorousFlowSinkPTDefiner
Provides either a porepressure or a temperature to derived classes, depending on _involves_fluid defi...
Definition: PorousFlowSinkPTDefiner.h:24
PorousFlowHalfCubicSink::_maximum
const Real _maximum
Maximum of the cubic sink.
Definition: PorousFlowHalfCubicSink.h:37
PorousFlowHalfCubicSink::dmultiplier_dvar
virtual Real dmultiplier_dvar(unsigned int pvar) const override
d(multiplier)/d(Porous flow variable pvar)
Definition: PorousFlowHalfCubicSink.C:62
PorousFlowSinkPTDefiner::ptVar
virtual Real ptVar() const
Provides the variable value (either porepressure, or temperature, depending on _involves_fluid)
Definition: PorousFlowSinkPTDefiner.C:47
PorousFlowHalfCubicSink::_center
const Real _center
Center of the cubic sink.
Definition: PorousFlowHalfCubicSink.h:43
PorousFlowSinkPTDefiner::dptVar
virtual Real dptVar(unsigned pvar) const
Provides the d(variable)/(d PorousFlow Variable pvar)
Definition: PorousFlowSinkPTDefiner.C:55
validParams< PorousFlowHalfCubicSink >
InputParameters validParams< PorousFlowHalfCubicSink >()
Definition: PorousFlowHalfCubicSink.C:17
PorousFlowHalfCubicSink::multiplier
virtual Real multiplier() const override
The flux gets multiplied by this quantity.
Definition: PorousFlowHalfCubicSink.C:46
validParams< PorousFlowSinkPTDefiner >
InputParameters validParams< PorousFlowSinkPTDefiner >()
Definition: PorousFlowSinkPTDefiner.C:14
PorousFlowSink::dmultiplier_dvar
virtual Real dmultiplier_dvar(unsigned int pvar) const
d(multiplier)/d(Porous flow variable pvar)
Definition: PorousFlowSink.C:344
PorousFlowSink::multiplier
virtual Real multiplier() const
The flux gets multiplied by this quantity.
Definition: PorousFlowSink.C:338
registerMooseObject
registerMooseObject("PorousFlowApp", PorousFlowHalfCubicSink)
PorousFlowHalfCubicSink.h
PorousFlowHalfCubicSink::_cutoff
const Function & _cutoff
Denote x = porepressure - center. Then Flux out = (max/cutoff^3)*(2x + cutoff)(x - cutoff)^2 for cuto...
Definition: PorousFlowHalfCubicSink.h:40
PorousFlowHalfCubicSink::PorousFlowHalfCubicSink
PorousFlowHalfCubicSink(const InputParameters &parameters)
Definition: PorousFlowHalfCubicSink.C:37
PorousFlowHalfCubicSink
Applies a flux sink to a boundary.
Definition: PorousFlowHalfCubicSink.h:30