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

Define the Kernel for a PrimaryConvection operator that looks like: cond * grad_pressure * grad_u. More...

#include <PrimaryConvection.h>

Inheritance diagram for PrimaryConvection:
[legend]

Public Types

typedef DerivativeMaterialPropertyNameInterface::SymbolName SymbolName
 

Public Member Functions

 PrimaryConvection (const InputParameters &parameters)
 
const GenericMaterialProperty< U, is_ad > & getDefaultMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< U, is_ad > & getDefaultMaterialPropertyByName (const std::string &name)
 
void validateDerivativeMaterialPropertyBase (const std::string &base)
 
const MaterialPropertyName derivativePropertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
 
const MaterialPropertyName derivativePropertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
 
const MaterialPropertyName derivativePropertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
 
const MaterialPropertyName derivativePropertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
void validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)
 
void validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
 
void validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)
 
void validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
 
void validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
 
void validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
 
const MaterialPropertyName propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
 
const MaterialPropertyName propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
 
const MaterialPropertyName propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
 
const MaterialPropertyName propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
 
const MaterialPropertyName propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
 
const MaterialPropertyName propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
 
const MaterialPropertyName propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
 
const MaterialPropertyName propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Member Functions

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

Protected Attributes

const MaterialProperty< Real > & _cond
 Hydraulic conductivity. More...
 
const RealVectorValue _gravity
 Gravity. More...
 
const MaterialProperty< Real > & _density
 Fluid density. More...
 
const VariableGradient_grad_p
 Pressure gradient. More...
 
const unsigned int _pvar
 Pressure variable number. More...
 

Detailed Description

Define the Kernel for a PrimaryConvection operator that looks like: cond * grad_pressure * grad_u.

Definition at line 19 of file PrimaryConvection.h.

Constructor & Destructor Documentation

◆ PrimaryConvection()

PrimaryConvection::PrimaryConvection ( const InputParameters parameters)

Definition at line 25 of file PrimaryConvection.C.

27  _cond(getMaterialProperty<Real>("conductivity")),
28  _gravity(getParam<RealVectorValue>("gravity")),
29  _density(getDefaultMaterialProperty<Real>("density")),
30  _grad_p(coupledGradient("p")),
31  _pvar(coupled("p"))
32 
33 {
34 }
const VariableGradient & _grad_p
Pressure gradient.
const RealVectorValue _gravity
Gravity.
const MaterialProperty< Real > & _cond
Hydraulic conductivity.
const unsigned int _pvar
Pressure variable number.
const MaterialProperty< Real > & _density
Fluid density.

Member Function Documentation

◆ computeQpJacobian()

Real PrimaryConvection::computeQpJacobian ( )
overrideprotectedvirtual

Definition at line 45 of file PrimaryConvection.C.

46 {
47  RealVectorValue darcy_vel = -_cond[_qp] * (_grad_p[_qp] - _density[_qp] * _gravity);
48 
49  return _test[_i][_qp] * (darcy_vel * _grad_phi[_j][_qp]);
50 }
const VariableGradient & _grad_p
Pressure gradient.
const RealVectorValue _gravity
Gravity.
const MaterialProperty< Real > & _cond
Hydraulic conductivity.
const MaterialProperty< Real > & _density
Fluid density.

◆ computeQpOffDiagJacobian()

Real PrimaryConvection::computeQpOffDiagJacobian ( unsigned int  jvar)
overrideprotectedvirtual

Definition at line 53 of file PrimaryConvection.C.

54 {
55  if (jvar == _pvar)
56  {
57  RealVectorValue ddarcy_vel_dp = -_cond[_qp] * _grad_phi[_j][_qp];
58  return _test[_i][_qp] * (ddarcy_vel_dp * _grad_u[_qp]);
59  }
60  else
61  return 0.0;
62 }
const MaterialProperty< Real > & _cond
Hydraulic conductivity.
const unsigned int _pvar
Pressure variable number.

◆ computeQpResidual()

Real PrimaryConvection::computeQpResidual ( )
overrideprotectedvirtual

Definition at line 37 of file PrimaryConvection.C.

38 {
39  RealVectorValue darcy_vel = -_cond[_qp] * (_grad_p[_qp] - _density[_qp] * _gravity);
40 
41  return _test[_i][_qp] * (darcy_vel * _grad_u[_qp]);
42 }
const VariableGradient & _grad_p
Pressure gradient.
const RealVectorValue _gravity
Gravity.
const MaterialProperty< Real > & _cond
Hydraulic conductivity.
const MaterialProperty< Real > & _density
Fluid density.

◆ validParams()

InputParameters PrimaryConvection::validParams ( )
static

Definition at line 15 of file PrimaryConvection.C.

16 {
18  params.addRequiredCoupledVar("p", "Pressure");
19  RealVectorValue g(0, 0, 0);
20  params.addParam<RealVectorValue>("gravity", g, "Gravity vector (default is (0, 0, 0))");
21  params.addClassDescription("Convection of primary species");
22  return params;
23 }
static InputParameters validParams()
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
void addRequiredCoupledVar(const std::string &name, const std::string &doc_string)
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _cond

const MaterialProperty<Real>& PrimaryConvection::_cond
protected

Hydraulic conductivity.

Definition at line 32 of file PrimaryConvection.h.

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

◆ _density

const MaterialProperty<Real>& PrimaryConvection::_density
protected

Fluid density.

Definition at line 38 of file PrimaryConvection.h.

Referenced by computeQpJacobian(), and computeQpResidual().

◆ _grad_p

const VariableGradient& PrimaryConvection::_grad_p
protected

Pressure gradient.

Definition at line 41 of file PrimaryConvection.h.

Referenced by computeQpJacobian(), and computeQpResidual().

◆ _gravity

const RealVectorValue PrimaryConvection::_gravity
protected

Gravity.

Definition at line 35 of file PrimaryConvection.h.

Referenced by computeQpJacobian(), and computeQpResidual().

◆ _pvar

const unsigned int PrimaryConvection::_pvar
protected

Pressure variable number.

Definition at line 44 of file PrimaryConvection.h.

Referenced by computeQpOffDiagJacobian().


The documentation for this class was generated from the following files: