RankTwoAux Class Reference

#include <RankTwoAux.h>

Inheritance diagram for RankTwoAux:

Public Member Functions
	RankTwoAux (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual Real	computeValue ()

Private Attributes
const MaterialProperty< RankTwoTensor > &	_tensor
const unsigned int	_i
const unsigned int	_j
const bool	_has_selected_qp
	whether or not selected_qp has been set More...
const unsigned int	_selected_qp
	The std::vector will be evaluated at this quadpoint only if defined. More...

Detailed Description

Definition at line 26 of file RankTwoAux.h.

Constructor & Destructor Documentation

RankTwoAux()

RankTwoAux::RankTwoAux

(

const InputParameters &

parameters

)

Definition at line 37 of file RankTwoAux.C.

  : NodalPatchRecovery(parameters),
    _tensor(getMaterialProperty<RankTwoTensor>("rank_two_tensor")),
    _i(getParam<unsigned int>("index_i")),
    _j(getParam<unsigned int>("index_j")),
    _has_selected_qp(isParamValid("selected_qp")),
    _selected_qp(_has_selected_qp ? getParam<unsigned int>("selected_qp") : 0)
{
}

Member Function Documentation

computeValue()

Real RankTwoAux::computeValue ( )

protectedvirtual

Definition at line 48 of file RankTwoAux.C.

{
  unsigned int qp = _qp;
  if (_has_selected_qp)
  {
    if (_selected_qp >= _q_point.size())
    {
      Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
      mooseError("RankTwoAux.  selected_qp specified as ",
                 _selected_qp,
                 " but there are only ",
                 _q_point.size(),
                 " quadpoints in the element");
    }
    qp = _selected_qp;
  }
 
  return RankTwoScalarTools::component(_tensor[qp], _i, _j);
}

validParams()

InputParameters RankTwoAux::validParams ( )

static

Definition at line 18 of file RankTwoAux.C.

{
  InputParameters params = NodalPatchRecovery::validParams();
  params.addClassDescription("Access a component of a RankTwoTensor");
  params.addRequiredParam<MaterialPropertyName>("rank_two_tensor",
                                                "The rank two material tensor name");
  params.addRequiredRangeCheckedParam<unsigned int>(
      "index_i",
      "index_i >= 0 & index_i <= 2",
      "The index i of ij for the tensor to output (0, 1, 2)");
  params.addRequiredRangeCheckedParam<unsigned int>(
      "index_j",
      "index_j >= 0 & index_j <= 2",
      "The index j of ij for the tensor to output (0, 1, 2)");
  params.addParam<unsigned int>("selected_qp", "Evaluate the tensor at this specific quadpoint");
  params.addParamNamesToGroup("selected_qp", "Advanced");
  return params;
}

Member Data Documentation

_has_selected_qp

const bool RankTwoAux::_has_selected_qp

private

whether or not selected_qp has been set

Definition at line 42 of file RankTwoAux.h.

Referenced by computeValue().

_i

const unsigned int RankTwoAux::_i

private

Definition at line 38 of file RankTwoAux.h.

Referenced by computeValue().

_j

const unsigned int RankTwoAux::_j

private

Definition at line 39 of file RankTwoAux.h.

Referenced by computeValue().

_selected_qp

const unsigned int RankTwoAux::_selected_qp

private

The std::vector will be evaluated at this quadpoint only if defined.

Definition at line 45 of file RankTwoAux.h.

Referenced by computeValue().

_tensor

const MaterialProperty<RankTwoTensor>& RankTwoAux::_tensor

private

Definition at line 37 of file RankTwoAux.h.

Referenced by computeValue().

---

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

• tensor_mechanics/include/auxkernels/RankTwoAux.h
• tensor_mechanics/src/auxkernels/RankTwoAux.C