www.mooseframework.org
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
PoroMechanicsCoupling Class Reference

PoroMechanicsCoupling computes -coefficient*porepressure*grad_test[component]. More...

#include <PoroMechanicsCoupling.h>

Inheritance diagram for PoroMechanicsCoupling:
[legend]

Public Member Functions

 PoroMechanicsCoupling (const InputParameters &parameters)
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Member Functions

virtual Real computeQpResidual ()
 
virtual Real computeQpJacobian ()
 
virtual Real computeQpOffDiagJacobian (unsigned int jvar)
 

Private Attributes

const MaterialProperty< Real > & _coefficient
 Biot coefficient. More...
 
const VariableValue & _porepressure
 
unsigned int _porepressure_var_num
 
unsigned int _component
 

Detailed Description

PoroMechanicsCoupling computes -coefficient*porepressure*grad_test[component].

Definition at line 23 of file PoroMechanicsCoupling.h.

Constructor & Destructor Documentation

◆ PoroMechanicsCoupling()

PoroMechanicsCoupling::PoroMechanicsCoupling ( const InputParameters &  parameters)

Definition at line 33 of file PoroMechanicsCoupling.C.

34  : Kernel(parameters),
35  _coefficient(getMaterialProperty<Real>("biot_coefficient")),
36  _porepressure(coupledValue("porepressure")),
37  _porepressure_var_num(coupled("porepressure")),
38  _component(getParam<unsigned int>("component"))
39 {
40  if (_component >= _mesh.dimension())
41  mooseError("PoroMechanicsCoupling: component should not be greater than the mesh dimension\n");
42 }

Member Function Documentation

◆ computeQpJacobian()

Real PoroMechanicsCoupling::computeQpJacobian ( )
protectedvirtual

Definition at line 51 of file PoroMechanicsCoupling.C.

52 {
53  if (_var.number() != _porepressure_var_num)
54  return 0.0;
55  return -_coefficient[_qp] * _phi[_j][_qp] * _grad_test[_i][_qp](_component);
56 }

◆ computeQpOffDiagJacobian()

Real PoroMechanicsCoupling::computeQpOffDiagJacobian ( unsigned int  jvar)
protectedvirtual

Definition at line 59 of file PoroMechanicsCoupling.C.

60 {
61  if (jvar != _porepressure_var_num)
62  return 0.0;
63  return -_coefficient[_qp] * _phi[_j][_qp] * _grad_test[_i][_qp](_component);
64 }

◆ computeQpResidual()

Real PoroMechanicsCoupling::computeQpResidual ( )
protectedvirtual

Definition at line 45 of file PoroMechanicsCoupling.C.

46 {
47  return -_coefficient[_qp] * _porepressure[_qp] * _grad_test[_i][_qp](_component);
48 }

◆ validParams()

InputParameters PoroMechanicsCoupling::validParams ( )
static

Definition at line 22 of file PoroMechanicsCoupling.C.

23 {
24  InputParameters params = Kernel::validParams();
25  params.addClassDescription(
26  "Adds $-Bi \\cdot p_s \\cdot \\nabla \\Psi_c$, where the subscript $c$ is the component.");
27  params.addRequiredCoupledVar("porepressure", "Pore pressure, $p_s$.");
28  params.addRequiredParam<unsigned int>("component",
29  "The gradient direction (0 for x, 1 for y and 2 for z)");
30  return params;
31 }

Member Data Documentation

◆ _coefficient

const MaterialProperty<Real>& PoroMechanicsCoupling::_coefficient
private

Biot coefficient.

Definition at line 39 of file PoroMechanicsCoupling.h.

Referenced by computeQpJacobian(), computeQpOffDiagJacobian(), and computeQpResidual().

◆ _component

unsigned int PoroMechanicsCoupling::_component
private

◆ _porepressure

const VariableValue& PoroMechanicsCoupling::_porepressure
private

Definition at line 41 of file PoroMechanicsCoupling.h.

Referenced by computeQpResidual().

◆ _porepressure_var_num

unsigned int PoroMechanicsCoupling::_porepressure_var_num
private

Definition at line 43 of file PoroMechanicsCoupling.h.

Referenced by computeQpJacobian(), and computeQpOffDiagJacobian().


The documentation for this class was generated from the following files:
PoroMechanicsCoupling::_porepressure_var_num
unsigned int _porepressure_var_num
Definition: PoroMechanicsCoupling.h:43
PoroMechanicsCoupling::_component
unsigned int _component
Definition: PoroMechanicsCoupling.h:45
PoroMechanicsCoupling::_coefficient
const MaterialProperty< Real > & _coefficient
Biot coefficient.
Definition: PoroMechanicsCoupling.h:39
validParams
InputParameters validParams()
PoroMechanicsCoupling::_porepressure
const VariableValue & _porepressure
Definition: PoroMechanicsCoupling.h:41