LineMaterialRankTwoSampler.C

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html
 
#include "LineMaterialRankTwoSampler.h"
#include "RankTwoScalarTools.h"
 
registerMooseObject("TensorMechanicsApp", LineMaterialRankTwoSampler);
 
defineLegacyParams(LineMaterialRankTwoSampler);
 
InputParameters
LineMaterialRankTwoSampler::validParams()
{
  InputParameters params = LineMaterialSamplerBase<Real>::validParams();
  params.addClassDescription("Access a component of a RankTwoTensor");
  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)");
  return params;
}
 
LineMaterialRankTwoSampler::LineMaterialRankTwoSampler(const InputParameters & parameters)
  : LineMaterialSamplerBase<RankTwoTensor>(parameters),
    _i(getParam<unsigned int>("index_i")),
    _j(getParam<unsigned int>("index_j"))
{
}
 
Real
LineMaterialRankTwoSampler::getScalarFromProperty(const RankTwoTensor & property,
                                                  const Point & /*curr_point*/)
{
  return RankTwoScalarTools::component(property, _i, _j);
}