www.mooseframework.org
Public Member Functions | Protected Attributes | List of all members
LineMaterialRankTwoScalarSampler Class Reference

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...
 

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 25 of file LineMaterialRankTwoScalarSampler.h.

Constructor & Destructor Documentation

LineMaterialRankTwoScalarSampler::LineMaterialRankTwoScalarSampler ( const InputParameters &  parameters)

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

Parameters
parametersThe input parameters

Definition at line 30 of file LineMaterialRankTwoScalarSampler.C.

32  : LineMaterialSamplerBase<RankTwoTensor>(parameters),
33  _scalar_type(getParam<MooseEnum>("scalar_type")),
34  _point1(parameters.get<Point>("point1")),
35  _point2(parameters.get<Point>("point2")),
36  _direction(parameters.get<Point>("direction") / parameters.get<Point>("direction").norm())
37 {
38 }

Member Function Documentation

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
propertyThe material property
curr_pointThe point corresponding to this material property
Returns
A scalar value from this material property to be output

Definition at line 41 of file LineMaterialRankTwoScalarSampler.C.

43 {
45  property, _scalar_type, _point1, _point2, curr_point, _direction);
46 }
Real getQuantity(const RankTwoTensor &tensor, const MooseEnum scalar_type, const Point &point1, const Point &point2, const Point &curr_point, Point &direction)

Member Data Documentation

Point LineMaterialRankTwoScalarSampler::_direction
protected

Definition at line 50 of file LineMaterialRankTwoScalarSampler.h.

Referenced by getScalarFromProperty().

const Point LineMaterialRankTwoScalarSampler::_point1
protected

Definition at line 48 of file LineMaterialRankTwoScalarSampler.h.

Referenced by getScalarFromProperty().

const Point LineMaterialRankTwoScalarSampler::_point2
protected

Definition at line 49 of file LineMaterialRankTwoScalarSampler.h.

Referenced by getScalarFromProperty().

MooseEnum LineMaterialRankTwoScalarSampler::_scalar_type
protected

Definition at line 46 of file LineMaterialRankTwoScalarSampler.h.

Referenced by getScalarFromProperty().


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