This class samples components of RankTwoTensor material properties for the integration points in all elements that are intersected by a user-defined line. More...

#include <LineMaterialRankTwoSampler.h>

Inheritance diagram for LineMaterialRankTwoSampler:

[legend]

Public Member Functions
	LineMaterialRankTwoSampler (const InputParameters &parameters)
	Class constructor Sets up variables for output based on the properties to be output. More...

virtual Real	getScalarFromProperty (const RankTwoTensor &property, const Point &curr_point)
	Reduce the material property to a scalar for output Call through to RankTwoScalarTools::component() to access the components. More...

Static Public Member Functions
static InputParameters	validParams ()

Public Attributes
const unsigned int	_i

const unsigned int	_j

Detailed Description

This class samples components of RankTwoTensor material properties for the integration points in all elements that are intersected by a user-defined line.

Definition at line 25 of file LineMaterialRankTwoSampler.h.

Constructor & Destructor Documentation

◆ LineMaterialRankTwoSampler()

LineMaterialRankTwoSampler::LineMaterialRankTwoSampler ( const InputParameters & parameters )

Class constructor Sets up variables for output based on the properties to be output.

Parameters

parameters The input parameters

Definition at line 33 of file LineMaterialRankTwoSampler.C.

   : LineMaterialSamplerBase<RankTwoTensor>(parameters),
     _i(getParam<unsigned int>("index_i")),
     _j(getParam<unsigned int>("index_j"))
 {
 }

Member Function Documentation

◆ getScalarFromProperty()

Real LineMaterialRankTwoSampler::getScalarFromProperty	(	const RankTwoTensor &	property,
		const Point &	curr_point
	)

virtual

Reduce the material property to a scalar for output Call through to RankTwoScalarTools::component() to access the components.

Parameters

property	The material property
curr_point	The point corresponding to this material property

Returns: A scalar value from this material property to be output

Definition at line 41 of file LineMaterialRankTwoSampler.C.

 {
   return RankTwoScalarTools::component(property, _i, _j);
 }

◆ validParams()

InputParameters LineMaterialRankTwoSampler::validParams ( )

static

Definition at line 18 of file LineMaterialRankTwoSampler.C.

 {
   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;
 }