ComputeGlobalStrain Class Reference

ComputeGlobalStrain calculates the global strain tensor from the scalar variables. More...

#include <ComputeGlobalStrain.h>

Inheritance diagram for ComputeGlobalStrain:

Public Member Functions
	ComputeGlobalStrain (const InputParameters &parameters)
virtual void	computeProperties ()

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual void	initQpStatefulProperties ()

Protected Attributes
const std::string	_base_name
	Base name prepended to material property name. More...
const VariableValue &	_scalar_global_strain
MaterialProperty< RankTwoTensor > &	_global_strain
const GlobalStrainUserObjectInterface &	_pst
const VectorValue< bool > &	_periodic_dir
const unsigned int	_dim
const unsigned int	_ndisp

Detailed Description

ComputeGlobalStrain calculates the global strain tensor from the scalar variables.

Definition at line 27 of file ComputeGlobalStrain.h.

Constructor & Destructor Documentation

ComputeGlobalStrain()

ComputeGlobalStrain::ComputeGlobalStrain

(

const InputParameters &

parameters

)

Definition at line 38 of file ComputeGlobalStrain.C.

  : Material(parameters),
    _base_name(isParamValid("base_name") ? getParam<std::string>("base_name") + "_" : ""),
    _scalar_global_strain(coupledScalarValue("scalar_global_strain")),
    _global_strain(declareProperty<RankTwoTensor>(_base_name + "global_strain")),
    _pst(getUserObject<GlobalStrainUserObjectInterface>("global_strain_uo")),
    _periodic_dir(_pst.getPeriodicDirections()),
    _dim(_mesh.dimension()),
    _ndisp(coupledComponents("displacements"))
{
}

Member Function Documentation

computeProperties()

void ComputeGlobalStrain::computeProperties ( )

virtual

Definition at line 57 of file ComputeGlobalStrain.C.

{
  RankTwoTensor & strain = _global_strain[0];
  strain.fillFromScalarVariable(_scalar_global_strain);
 
  for (unsigned int dir = 0; dir < _dim; ++dir)
    if (!_periodic_dir(dir))
      for (unsigned int var = 0; var < _ndisp; ++var)
        strain(dir, var) = 0.0;
 
  for (_qp = 0; _qp < _qrule->n_points(); ++_qp)
    _global_strain[_qp] = strain;
}

initQpStatefulProperties()

void ComputeGlobalStrain::initQpStatefulProperties ( )

protectedvirtual

Definition at line 51 of file ComputeGlobalStrain.C.

{
  _global_strain[_qp].zero();
}

validParams()

InputParameters ComputeGlobalStrain::validParams ( )

static

Definition at line 21 of file ComputeGlobalStrain.C.

{
  InputParameters params = Material::validParams();
  params.addClassDescription(
      "Material for storing the global strain values from the scalar variable");
  params.addParam<std::string>("base_name",
                               "Optional parameter that allows the user to define "
                               "multiple mechanics material systems on the same "
                               "block, i.e. for multiple phases");
  params.addCoupledVar("scalar_global_strain", "Scalar variable for global strain");
  params.addCoupledVar("displacements", "The name of the displacement variables");
  params.addRequiredParam<UserObjectName>("global_strain_uo",
                                          "The name of the GlobalStrainUserObject");
 
  return params;
}

Member Data Documentation

_base_name

const std::string ComputeGlobalStrain::_base_name

protected

Base name prepended to material property name.

Definition at line 40 of file ComputeGlobalStrain.h.

_dim

const unsigned int ComputeGlobalStrain::_dim

protected

Definition at line 47 of file ComputeGlobalStrain.h.

Referenced by computeProperties().

_global_strain

MaterialProperty<RankTwoTensor>& ComputeGlobalStrain::_global_strain

protected

Definition at line 42 of file ComputeGlobalStrain.h.

Referenced by computeProperties(), and initQpStatefulProperties().

_ndisp

const unsigned int ComputeGlobalStrain::_ndisp

protected

Definition at line 48 of file ComputeGlobalStrain.h.

Referenced by computeProperties().

_periodic_dir

const VectorValue<bool>& ComputeGlobalStrain::_periodic_dir

protected

Definition at line 45 of file ComputeGlobalStrain.h.

Referenced by computeProperties().

_pst

const GlobalStrainUserObjectInterface& ComputeGlobalStrain::_pst

protected

Definition at line 44 of file ComputeGlobalStrain.h.

_scalar_global_strain

const VariableValue& ComputeGlobalStrain::_scalar_global_strain

protected

Definition at line 41 of file ComputeGlobalStrain.h.

Referenced by computeProperties().

---

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

• tensor_mechanics/include/materials/ComputeGlobalStrain.h
• tensor_mechanics/src/materials/ComputeGlobalStrain.C