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

Crystal plasticity slip resistance userobject class. More...

#include <CrystalPlasticitySlipResistance.h>

Inheritance diagram for CrystalPlasticitySlipResistance:
[legend]

Public Member Functions

 CrystalPlasticitySlipResistance (const InputParameters &parameters)
 
virtual bool calcSlipResistance (unsigned int qp, std::vector< Real > &val) const =0
 
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 slip resistance userobject class.

The virtual functions written below must be over-ridden in derived classes to provide actual values.

Definition at line 24 of file CrystalPlasticitySlipResistance.h.

Constructor & Destructor Documentation

◆ CrystalPlasticitySlipResistance()

CrystalPlasticitySlipResistance::CrystalPlasticitySlipResistance ( const InputParameters &  parameters)

Definition at line 23 of file CrystalPlasticitySlipResistance.C.

24  : CrystalPlasticityUOBase(parameters)
25 {
26 }

Member Function Documentation

◆ calcSlipResistance()

virtual bool CrystalPlasticitySlipResistance::calcSlipResistance ( unsigned int  qp,
std::vector< Real > &  val 
) const
pure virtual

◆ validParams()

InputParameters CrystalPlasticitySlipResistance::validParams ( )
static

Definition at line 15 of file CrystalPlasticitySlipResistance.C.

16 {
17  InputParameters params = CrystalPlasticityUOBase::validParams();
18  params.addClassDescription("Crystal plasticity slip resistance base class. Override the virtual "
19  "functions in your class");
20  return params;
21 }

Referenced by CrystalPlasticitySlipResistanceGSS::validParams().

◆ variableSize()

unsigned int CrystalPlasticityUOBase::variableSize ( ) const
virtualinherited

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
protectedinherited

The documentation for this class was generated from the following files:
CrystalPlasticityUOBase::validParams
static InputParameters validParams()
Definition: CrystalPlasticityUOBase.C:15
CrystalPlasticityUOBase::CrystalPlasticityUOBase
CrystalPlasticityUOBase(const InputParameters &parameters)
Definition: CrystalPlasticityUOBase.C:24
CrystalPlasticityUOBase::_variable_size
unsigned int _variable_size
Definition: CrystalPlasticityUOBase.h:33