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

ComputeExtraStressBase is the base class for extra_stress, which is added to stress calculated by the material's constitutive model. More...

#include <ComputeExtraStressBase.h>

Inheritance diagram for ComputeExtraStressBase:
[legend]

Public Member Functions

 ComputeExtraStressBase (const InputParameters &parameters)
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Member Functions

virtual void computeQpProperties ()
 
virtual void computeQpExtraStress ()=0
 

Protected Attributes

const std::string _base_name
 
std::string _extra_stress_name
 
MaterialProperty< RankTwoTensor > & _extra_stress
 

Detailed Description

ComputeExtraStressBase is the base class for extra_stress, which is added to stress calculated by the material's constitutive model.

Definition at line 24 of file ComputeExtraStressBase.h.

Constructor & Destructor Documentation

◆ ComputeExtraStressBase()

ComputeExtraStressBase::ComputeExtraStressBase ( const InputParameters &  parameters)

Definition at line 25 of file ComputeExtraStressBase.C.

26  : Material(parameters),
27  _base_name(isParamValid("base_name") ? getParam<std::string>("base_name") + "_" : ""),
28  _extra_stress_name(_base_name + "extra_stress"),
29  _extra_stress(declareProperty<RankTwoTensor>(_base_name + "extra_stress"))
30 {
31 }

Member Function Documentation

◆ computeQpExtraStress()

virtual void ComputeExtraStressBase::computeQpExtraStress ( )
protectedpure virtual

◆ computeQpProperties()

void ComputeExtraStressBase::computeQpProperties ( )
protectedvirtual

Definition at line 34 of file ComputeExtraStressBase.C.

35 {
37 }

◆ validParams()

InputParameters ComputeExtraStressBase::validParams ( )
static

Definition at line 15 of file ComputeExtraStressBase.C.

16 {
17  InputParameters params = Material::validParams();
18  params.addParam<std::string>("base_name",
19  "Optional parameter that allows the user to define "
20  "multiple mechanics material systems on the same "
21  "block, i.e. for multiple phases");
22  return params;
23 }

Referenced by ComputeExtraStressConstant::validParams(), and ComputeExtraStressVDWGas::validParams().

Member Data Documentation

◆ _base_name

const std::string ComputeExtraStressBase::_base_name
protected

Definition at line 35 of file ComputeExtraStressBase.h.

◆ _extra_stress

MaterialProperty<RankTwoTensor>& ComputeExtraStressBase::_extra_stress
protected

◆ _extra_stress_name

std::string ComputeExtraStressBase::_extra_stress_name
protected

Definition at line 36 of file ComputeExtraStressBase.h.


The documentation for this class was generated from the following files:
ComputeExtraStressBase::_extra_stress_name
std::string _extra_stress_name
Definition: ComputeExtraStressBase.h:36
ComputeExtraStressBase::_extra_stress
MaterialProperty< RankTwoTensor > & _extra_stress
Definition: ComputeExtraStressBase.h:38
ComputeExtraStressBase::_base_name
const std::string _base_name
Definition: ComputeExtraStressBase.h:35
validParams
InputParameters validParams()
ComputeExtraStressBase::computeQpExtraStress
virtual void computeQpExtraStress()=0