www.mooseframework.org
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
HEVPFlowRateUOBase Class Referenceabstract

This user object is a pure virtual base classs Derived classes computes flow rate, direction and derivatives. More...

#include <HEVPFlowRateUOBase.h>

Inheritance diagram for HEVPFlowRateUOBase:
[legend]

Public Member Functions

 HEVPFlowRateUOBase (const InputParameters &parameters)
 
virtual bool computeValue (unsigned int, Real &) const =0
 
virtual bool computeDirection (unsigned int, RankTwoTensor &) const =0
 
virtual bool computeDerivative (unsigned int, const std::string &, Real &) const =0
 
virtual bool computeTensorDerivative (unsigned int, const std::string &, RankTwoTensor &) const =0
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Attributes

std::string _strength_prop_name
 
const std::string _base_name
 
const MaterialProperty< Real > & _strength
 
std::string _pk2_prop_name
 
const MaterialProperty< RankTwoTensor > & _pk2
 
const MaterialProperty< RankTwoTensor > & _ce
 

Detailed Description

This user object is a pure virtual base classs Derived classes computes flow rate, direction and derivatives.

Definition at line 25 of file HEVPFlowRateUOBase.h.

Constructor & Destructor Documentation

◆ HEVPFlowRateUOBase()

HEVPFlowRateUOBase::HEVPFlowRateUOBase ( const InputParameters &  parameters)

Definition at line 27 of file HEVPFlowRateUOBase.C.

28  : DiscreteElementUserObject(parameters),
29  _strength_prop_name(getParam<std::string>("strength_prop_name")),
30  _base_name(isParamValid("base_name") ? getParam<std::string>("base_name") + "_" : ""),
31  _strength(getMaterialPropertyByName<Real>(_strength_prop_name)),
32  _pk2_prop_name(_base_name + "pk2"),
33  _pk2(getMaterialPropertyByName<RankTwoTensor>(_pk2_prop_name)),
34  _ce(getMaterialPropertyByName<RankTwoTensor>(_base_name + "ce"))
35 {
36 }

Member Function Documentation

◆ computeDerivative()

virtual bool HEVPFlowRateUOBase::computeDerivative ( unsigned int  ,
const std::string &  ,
Real &   
) const
pure virtual

Implemented in HEVPFlowRatePowerLawJ2.

◆ computeDirection()

virtual bool HEVPFlowRateUOBase::computeDirection ( unsigned int  ,
RankTwoTensor  
) const
pure virtual

Implemented in HEVPFlowRatePowerLawJ2.

◆ computeTensorDerivative()

virtual bool HEVPFlowRateUOBase::computeTensorDerivative ( unsigned int  ,
const std::string &  ,
RankTwoTensor  
) const
pure virtual

Implemented in HEVPFlowRatePowerLawJ2.

◆ computeValue()

virtual bool HEVPFlowRateUOBase::computeValue ( unsigned int  ,
Real &   
) const
pure virtual

Implemented in HEVPFlowRatePowerLawJ2.

◆ validParams()

InputParameters HEVPFlowRateUOBase::validParams ( )
static

Definition at line 15 of file HEVPFlowRateUOBase.C.

16 {
17  InputParameters params = DiscreteElementUserObject::validParams();
18  params.addParam<std::string>(
19  "strength_prop_name",
20  "Name of strength property: Same as strength user object specified in input file");
21  params.addParam<std::string>("base_name", "Base name of tensor properties to fetch");
22  params.addClassDescription("User object to evaluate flow rate");
23 
24  return params;
25 }

Referenced by HEVPFlowRatePowerLawJ2::validParams().

Member Data Documentation

◆ _base_name

const std::string HEVPFlowRateUOBase::_base_name
protected

Definition at line 40 of file HEVPFlowRateUOBase.h.

◆ _ce

const MaterialProperty<RankTwoTensor>& HEVPFlowRateUOBase::_ce
protected

◆ _pk2

const MaterialProperty<RankTwoTensor>& HEVPFlowRateUOBase::_pk2
protected

◆ _pk2_prop_name

std::string HEVPFlowRateUOBase::_pk2_prop_name
protected

◆ _strength

const MaterialProperty<Real>& HEVPFlowRateUOBase::_strength
protected

◆ _strength_prop_name

std::string HEVPFlowRateUOBase::_strength_prop_name
protected

Definition at line 39 of file HEVPFlowRateUOBase.h.

Referenced by HEVPFlowRatePowerLawJ2::computeDerivative().


The documentation for this class was generated from the following files:
HEVPFlowRateUOBase::_base_name
const std::string _base_name
Definition: HEVPFlowRateUOBase.h:40
validParams
InputParameters validParams()
HEVPFlowRateUOBase::_strength_prop_name
std::string _strength_prop_name
Definition: HEVPFlowRateUOBase.h:39
HEVPFlowRateUOBase::_strength
const MaterialProperty< Real > & _strength
Definition: HEVPFlowRateUOBase.h:41
HEVPFlowRateUOBase::_ce
const MaterialProperty< RankTwoTensor > & _ce
Definition: HEVPFlowRateUOBase.h:44
HEVPFlowRateUOBase::_pk2
const MaterialProperty< RankTwoTensor > & _pk2
Definition: HEVPFlowRateUOBase.h:43
HEVPFlowRateUOBase::_pk2_prop_name
std::string _pk2_prop_name
Definition: HEVPFlowRateUOBase.h:42