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

Crystal plasticity system userobject base class. More...

#include <CrystalPlasticityUOBase.h>

Inheritance diagram for CrystalPlasticityUOBase:
[legend]

Public Member Functions

 CrystalPlasticityUOBase (const InputParameters &parameters)
 
virtual unsigned int variableSize () const
 Returns the size of variable. More...
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Attributes

unsigned int _variable_size
 

Detailed Description

Crystal plasticity system userobject base class.

Definition at line 22 of file CrystalPlasticityUOBase.h.

Constructor & Destructor Documentation

◆ CrystalPlasticityUOBase()

CrystalPlasticityUOBase::CrystalPlasticityUOBase ( const InputParameters &  parameters)

Definition at line 24 of file CrystalPlasticityUOBase.C.

25  : DiscreteElementUserObject(parameters), _variable_size(getParam<unsigned int>("variable_size"))
26 {
27 }

Member Function Documentation

◆ validParams()

InputParameters CrystalPlasticityUOBase::validParams ( )
static

Definition at line 15 of file CrystalPlasticityUOBase.C.

16 {
17  InputParameters params = DiscreteElementUserObject::validParams();
18  params.addRequiredParam<unsigned int>("variable_size", "The userobject's variable size.");
19  params.addClassDescription("Crystal plasticity userobject system base class. Override the "
20  "virtual functions in your class");
21  return params;
22 }

Referenced by CrystalPlasticityStateVariable::validParams(), CrystalPlasticityStateVarRateComponent::validParams(), CrystalPlasticitySlipResistance::validParams(), and CrystalPlasticitySlipRate::validParams().

◆ variableSize()

unsigned int CrystalPlasticityUOBase::variableSize ( ) const
virtual

Returns the size of variable.

Definition at line 30 of file CrystalPlasticityUOBase.C.

31 {
32  return _variable_size;
33 }

Member Data Documentation

◆ _variable_size

unsigned int CrystalPlasticityUOBase::_variable_size
protected

The documentation for this class was generated from the following files:
CrystalPlasticityUOBase::_variable_size
unsigned int _variable_size
Definition: CrystalPlasticityUOBase.h:33
validParams
InputParameters validParams()