RankTwoScalarAux Class Reference

RankTwoScalarAux uses the namespace RankTwoScalarTools to compute scalar values from Rank-2 tensors. More...

#include <RankTwoScalarAux.h>

Inheritance diagram for RankTwoScalarAux:

Public Member Functions
	RankTwoScalarAux (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual Real	computeValue ()

Protected Attributes
const MaterialProperty< RankTwoTensor > &	_tensor
MooseEnum	_scalar_type
	Determines the information to be extracted from the tensor by using the RankTwoScalarTools namespace, e.g., vonMisesStressL2norm, MaxPrincipal eigenvalue, etc. More...
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...
const Point	_point1
const Point	_point2
Point	_input_direction

Detailed Description

RankTwoScalarAux uses the namespace RankTwoScalarTools to compute scalar values from Rank-2 tensors.

Definition at line 24 of file RankTwoScalarAux.h.

Constructor & Destructor Documentation

RankTwoScalarAux()

RankTwoScalarAux::RankTwoScalarAux

(

const InputParameters &

parameters

)

Definition at line 44 of file RankTwoScalarAux.C.

  : NodalPatchRecovery(parameters),
    _tensor(getMaterialProperty<RankTwoTensor>("rank_two_tensor")),
    _scalar_type(getParam<MooseEnum>("scalar_type")),
    _has_selected_qp(isParamValid("selected_qp")),
    _selected_qp(_has_selected_qp ? getParam<unsigned int>("selected_qp") : 0),
    _point1(parameters.get<Point>("point1")),
    _point2(parameters.get<Point>("point2")),
    _input_direction(parameters.get<Point>("direction") / parameters.get<Point>("direction").norm())
{
}

Member Function Documentation

computeValue()

Real RankTwoScalarAux::computeValue ( )

protectedvirtual

Definition at line 57 of file RankTwoScalarAux.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("RankTwoScalarAux.  selected_qp specified as ",
                 _selected_qp,
                 " but there are only ",
                 _q_point.size(),
                 " quadpoints in the element");
    }
    qp = _selected_qp;
  }
 
  return RankTwoScalarTools::getQuantity(
      _tensor[qp], _scalar_type, _point1, _point2, _q_point[qp], _input_direction);
}

validParams()

InputParameters RankTwoScalarAux::validParams ( )

static

Definition at line 18 of file RankTwoScalarAux.C.

{
  InputParameters params = NodalPatchRecovery::validParams();
  params.addClassDescription("Compute a scalar property of a RankTwoTensor");
  params.addRequiredParam<MaterialPropertyName>("rank_two_tensor",
                                                "The rank two material tensor name");
  params.addParam<MooseEnum>(
      "scalar_type", RankTwoScalarTools::scalarOptions(), "Type of scalar output");
  params.addParam<unsigned int>(
      "selected_qp",
      "Evaluate the tensor at this quadpoint.  This option only needs to be used if "
      "you are interested in a particular quadpoint in each element: otherwise do "
      "not include this parameter in your input file");
  params.addParamNamesToGroup("selected_qp", "Advanced");
 
  params.addParam<Point>(
      "point1",
      Point(0, 0, 0),
      "Start point for axis used to calculate some cylindrical material tensor quantities");
  params.addParam<Point>("point2",
                         Point(0, 1, 0),
                         "End point for axis used to calculate some material tensor quantities");
  params.addParam<Point>("direction", Point(0, 0, 1), "Direction vector");
  return params;
}

Member Data Documentation

_has_selected_qp

const bool RankTwoScalarAux::_has_selected_qp

protected

whether or not selected_qp has been set

Definition at line 43 of file RankTwoScalarAux.h.

Referenced by computeValue().

_input_direction

Point RankTwoScalarAux::_input_direction

protected

Definition at line 50 of file RankTwoScalarAux.h.

Referenced by computeValue().

_point1

const Point RankTwoScalarAux::_point1

protected

Definition at line 48 of file RankTwoScalarAux.h.

Referenced by computeValue().

_point2

const Point RankTwoScalarAux::_point2

protected

Definition at line 49 of file RankTwoScalarAux.h.

Referenced by computeValue().

_scalar_type

MooseEnum RankTwoScalarAux::_scalar_type

protected

Determines the information to be extracted from the tensor by using the RankTwoScalarTools namespace, e.g., vonMisesStressL2norm, MaxPrincipal eigenvalue, etc.

Definition at line 40 of file RankTwoScalarAux.h.

Referenced by computeValue().

_selected_qp

const unsigned int RankTwoScalarAux::_selected_qp

protected

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

Definition at line 46 of file RankTwoScalarAux.h.

Referenced by computeValue().

_tensor

const MaterialProperty<RankTwoTensor>& RankTwoScalarAux::_tensor

protected

Definition at line 34 of file RankTwoScalarAux.h.

Referenced by computeValue().

---

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

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