Abstract base class for user objects that provide an index for a given element that is independent of the block id, so that behavior can be different on subsets of element blocks. More...

#include <SubblockIndexProvider.h>

Inheritance diagram for SubblockIndexProvider:

[legend]

Public Member Functions
	SubblockIndexProvider (const InputParameters &params)

virtual unsigned int	getSubblockIndex (const Elem &) const =0
	The index of subblock this element is on. More...

virtual unsigned int	getMaxSubblockIndex () const =0
	The max index of subblock. More...

Static Public Member Functions
static InputParameters	validParams ()

Detailed Description

Abstract base class for user objects that provide an index for a given element that is independent of the block id, so that behavior can be different on subsets of element blocks.

This is used to apply independent generalized plane constraints to subsets of element blocks.

Definition at line 24 of file SubblockIndexProvider.h.

Constructor & Destructor Documentation

◆ SubblockIndexProvider()

SubblockIndexProvider::SubblockIndexProvider ( const InputParameters & params )

inline

Definition at line 29 of file SubblockIndexProvider.h.

29 : GeneralUserObject(params) {}

Member Function Documentation

◆ getMaxSubblockIndex()

virtual unsigned int SubblockIndexProvider::getMaxSubblockIndex ( ) const

pure virtual

The max index of subblock.

Implemented in TestSubblockIndexProvider.

Referenced by GeneralizedPlaneStrainUserObject::initialize().

◆ getSubblockIndex()

virtual unsigned int SubblockIndexProvider::getSubblockIndex ( const Elem & ) const

pure virtual

The index of subblock this element is on.

Implemented in TestSubblockIndexProvider.

Referenced by GeneralizedPlaneStrainOffDiag::computeOffDiagJacobianScalar(), GeneralizedPlaneStrainUserObject::execute(), ComputePlaneSmallStrain::getCurrentSubblockIndex(), ComputePlaneIncrementalStrain::getCurrentSubblockIndex(), ComputePlaneFiniteStrain::getCurrentSubblockIndex(), ComputeAxisymmetric1DSmallStrain::getCurrentSubblockIndex(), ComputeAxisymmetric1DFiniteStrain::getCurrentSubblockIndex(), and ComputeAxisymmetric1DIncrementalStrain::getCurrentSubblockIndex().

◆ validParams()

InputParameters SubblockIndexProvider::validParams ( )

static

Definition at line 15 of file SubblockIndexProvider.C.

 {
   return GeneralUserObject::validParams();
 }

Referenced by TestSubblockIndexProvider::validParams().

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

tensor_mechanics/include/userobjects/SubblockIndexProvider.h
tensor_mechanics/src/userobjects/SubblockIndexProvider.C

Public Member Functions