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

Records total mass flow into an excavation defined by a RichardsExcavGeom function. More...

#include <RichardsExcavFlow.h>

Inheritance diagram for RichardsExcavFlow:
[legend]

Public Member Functions

 RichardsExcavFlow (const InputParameters &parameters)
 

Protected Member Functions

virtual Real computeQpIntegral ()
 

Protected Attributes

const RichardsVarNames_richards_name_UO
 holds info regarding the Richards variables More...
 
unsigned int _pvar
 the richards variable number for which we want the mass flow More...
 
const MaterialProperty< std::vector< RealVectorValue > > & _flux
 mass-flux of fluid (a vector in the multicomponent case) More...
 
Function & _func
 the RichardsExcavGeom that defines where on the boundary we'll compute the mass flux More...
 

Detailed Description

Records total mass flow into an excavation defined by a RichardsExcavGeom function.

Definition at line 27 of file RichardsExcavFlow.h.

Constructor & Destructor Documentation

◆ RichardsExcavFlow()

RichardsExcavFlow::RichardsExcavFlow ( const InputParameters &  parameters)

Definition at line 31 of file RichardsExcavFlow.C.

32  : SideIntegralVariablePostprocessor(parameters),
33 
34  _richards_name_UO(getUserObject<RichardsVarNames>("richardsVarNames_UO")),
35  _pvar(_richards_name_UO.richards_var_num(coupled("variable"))),
36 
37  _flux(getMaterialProperty<std::vector<RealVectorValue>>("flux")),
38 
39  _func(getFunction("excav_geom_function"))
40 {
41 }
const RichardsVarNames & _richards_name_UO
holds info regarding the Richards variables
Function & _func
the RichardsExcavGeom that defines where on the boundary we&#39;ll compute the mass flux ...
unsigned int richards_var_num(unsigned int moose_var_num) const
the richards variable number
unsigned int _pvar
the richards variable number for which we want the mass flow
const MaterialProperty< std::vector< RealVectorValue > > & _flux
mass-flux of fluid (a vector in the multicomponent case)

Member Function Documentation

◆ computeQpIntegral()

Real RichardsExcavFlow::computeQpIntegral ( )
protectedvirtual

Definition at line 44 of file RichardsExcavFlow.C.

45 {
46  return -_func.value(_t, _q_point[_qp]) * _normals[_qp] * _flux[_qp][_pvar] * _dt;
47 }
Function & _func
the RichardsExcavGeom that defines where on the boundary we&#39;ll compute the mass flux ...
unsigned int _pvar
the richards variable number for which we want the mass flow
const MaterialProperty< std::vector< RealVectorValue > > & _flux
mass-flux of fluid (a vector in the multicomponent case)

Member Data Documentation

◆ _flux

const MaterialProperty<std::vector<RealVectorValue> >& RichardsExcavFlow::_flux
protected

mass-flux of fluid (a vector in the multicomponent case)

Definition at line 42 of file RichardsExcavFlow.h.

Referenced by computeQpIntegral().

◆ _func

Function& RichardsExcavFlow::_func
protected

the RichardsExcavGeom that defines where on the boundary we'll compute the mass flux

Definition at line 45 of file RichardsExcavFlow.h.

Referenced by computeQpIntegral().

◆ _pvar

unsigned int RichardsExcavFlow::_pvar
protected

the richards variable number for which we want the mass flow

Definition at line 39 of file RichardsExcavFlow.h.

Referenced by computeQpIntegral().

◆ _richards_name_UO

const RichardsVarNames& RichardsExcavFlow::_richards_name_UO
protected

holds info regarding the Richards variables

Definition at line 36 of file RichardsExcavFlow.h.


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