www.mooseframework.org
Classes | Functions
RankTwoScalarAux.h File Reference

Go to the source code of this file.

Classes

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

Functions

template<>
InputParameters validParams< RankTwoScalarAux > ()
 

Function Documentation

template<>
InputParameters validParams< RankTwoScalarAux > ( )

Definition at line 13 of file RankTwoScalarAux.C.

14 {
15  InputParameters params = validParams<AuxKernel>();
16  params.addClassDescription("Compute a scalar property of a RankTwoTensor");
17  params.addRequiredParam<MaterialPropertyName>("rank_two_tensor",
18  "The rank two material tensor name");
19  params.addParam<MooseEnum>(
20  "scalar_type", RankTwoScalarTools::scalarOptions(), "Type of scalar output");
21  params.addParam<unsigned int>(
22  "selected_qp",
23  "Evaluate the tensor at this quadpoint. This option only needs to be used if "
24  "you are interested in a particular quadpoint in each element: otherwise do "
25  "not include this parameter in your input file");
26  params.addParamNamesToGroup("selected_qp", "Advanced");
27 
28  params.addParam<Point>(
29  "point1",
30  Point(0, 0, 0),
31  "Start point for axis used to calculate some cylinderical material tensor quantities");
32  params.addParam<Point>("point2",
33  Point(0, 1, 0),
34  "End point for axis used to calculate some material tensor quantities");
35  params.addParam<Point>("direction", Point(0, 0, 1), "Direction vector");
36  return params;
37 }