www.mooseframework.org
RichardsHalfGaussianSink.h
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 #pragma once
11 
12 #include "IntegratedBC.h"
13 #include "RichardsVarNames.h"
14 
15 // Forward Declarations
17 
18 template <>
20 
29 class RichardsHalfGaussianSink : public IntegratedBC
30 {
31 public:
32  RichardsHalfGaussianSink(const InputParameters & parameters);
33 
34 protected:
35  virtual Real computeQpResidual();
36 
37  virtual Real computeQpJacobian();
38 
39  virtual Real computeQpOffDiagJacobian(unsigned int jvar);
40 
42  Real _maximum;
43 
45  Real _sd;
46 
48  Real _centre;
49 
51  const Function & _m_func;
52 
58 
66  unsigned int _pvar;
67 
69  const MaterialProperty<std::vector<Real>> & _pp;
70 
72  const MaterialProperty<std::vector<std::vector<Real>>> & _dpp_dv;
73 };
RichardsHalfGaussianSink::computeQpJacobian
virtual Real computeQpJacobian()
Definition: RichardsHalfGaussianSink.C:76
RichardsHalfGaussianSink::_pp
const MaterialProperty< std::vector< Real > > & _pp
porepressure (or porepressure vector for multiphase problems)
Definition: RichardsHalfGaussianSink.h:69
RichardsHalfGaussianSink
Applies a fluid sink to the boundary.
Definition: RichardsHalfGaussianSink.h:29
RichardsVarNames
This holds maps between pressure_var or pressure_var, sat_var used in RichardsMaterial and kernels,...
Definition: RichardsVarNames.h:25
RichardsHalfGaussianSink::_dpp_dv
const MaterialProperty< std::vector< std::vector< Real > > > & _dpp_dv
d(porepressure_i)/dvariable_j
Definition: RichardsHalfGaussianSink.h:72
RichardsHalfGaussianSink::_maximum
Real _maximum
maximum of the Gaussian sink
Definition: RichardsHalfGaussianSink.h:42
RichardsHalfGaussianSink::RichardsHalfGaussianSink
RichardsHalfGaussianSink(const InputParameters &parameters)
Definition: RichardsHalfGaussianSink.C:50
RichardsHalfGaussianSink::_pvar
unsigned int _pvar
the index of this variable in the list of Richards variables held by _richards_name_UO.
Definition: RichardsHalfGaussianSink.h:66
RichardsVarNames.h
RichardsHalfGaussianSink::_m_func
const Function & _m_func
multiplying function: all fluxes will be multiplied by this
Definition: RichardsHalfGaussianSink.h:51
RichardsHalfGaussianSink::_centre
Real _centre
centre of the Gaussian sink
Definition: RichardsHalfGaussianSink.h:48
RichardsHalfGaussianSink::_sd
Real _sd
standard deviation of the Gaussian sink
Definition: RichardsHalfGaussianSink.h:45
validParams< RichardsHalfGaussianSink >
InputParameters validParams< RichardsHalfGaussianSink >()
Definition: RichardsHalfGaussianSink.C:23
RichardsHalfGaussianSink::computeQpOffDiagJacobian
virtual Real computeQpOffDiagJacobian(unsigned int jvar)
Definition: RichardsHalfGaussianSink.C:88
RichardsHalfGaussianSink::_richards_name_UO
const RichardsVarNames & _richards_name_UO
holds info regarding the names of the Richards variables and methods for extracting values of these v...
Definition: RichardsHalfGaussianSink.h:57
RichardsHalfGaussianSink::computeQpResidual
virtual Real computeQpResidual()
Definition: RichardsHalfGaussianSink.C:64