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

#include <LineMaterialRankTwoScalarSampler.h>

Inheritance diagram for LineMaterialRankTwoScalarSampler:

[legend]

Public Member Functions
	LineMaterialRankTwoScalarSampler (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 RankTwoTensor material property to a scalar for output Call through to RankTwoScalarTools::getQuantity to access the full set of options for reducing the RankTwoTensor to a scalar quantity. More...

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
MooseEnum	_scalar_type

const Point	_point1

const Point	_point2

Point	_direction

Detailed Description

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

It provides access to the full set of options for reducing the RankTwoTensor to a scalar

Definition at line 26 of file LineMaterialRankTwoScalarSampler.h.

Constructor & Destructor Documentation

◆ LineMaterialRankTwoScalarSampler()

LineMaterialRankTwoScalarSampler::LineMaterialRankTwoScalarSampler ( 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 35 of file LineMaterialRankTwoScalarSampler.C.

   : LineMaterialSamplerBase<RankTwoTensor>(parameters),
     _scalar_type(getParam<MooseEnum>("scalar_type")),
     _point1(parameters.get<Point>("point1")),
     _point2(parameters.get<Point>("point2")),
     _direction(parameters.get<Point>("direction") / parameters.get<Point>("direction").norm())
 {
 }

Member Function Documentation

◆ getScalarFromProperty()

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

virtual

Reduce the RankTwoTensor material property to a scalar for output Call through to RankTwoScalarTools::getQuantity to access the full set of options for reducing the RankTwoTensor to a scalar quantity.

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 46 of file LineMaterialRankTwoScalarSampler.C.

 {
   return RankTwoScalarTools::getQuantity(
       property, _scalar_type, _point1, _point2, curr_point, _direction);
 }

◆ validParams()

InputParameters LineMaterialRankTwoScalarSampler::validParams ( )

static

Definition at line 18 of file LineMaterialRankTwoScalarSampler.C.

 {
   InputParameters params = LineMaterialSamplerBase<Real>::validParams();
   params.addClassDescription("Compute a scalar property of a RankTwoTensor");
   params.addParam<MooseEnum>(
       "scalar_type", RankTwoScalarTools::scalarOptions(), "A scalar to output");
   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;
 }