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

#include <RankFourAux.h>

Inheritance diagram for RankFourAux:
[legend]

Public Member Functions

 RankFourAux (const InputParameters &parameters)
 
virtual ~RankFourAux ()
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Member Functions

virtual Real computeValue ()
 

Private Attributes

const MaterialProperty< RankFourTensor > & _tensor
 
const unsigned int _i
 
const unsigned int _j
 
const unsigned int _k
 
const unsigned int _l
 

Detailed Description

Definition at line 26 of file RankFourAux.h.

Constructor & Destructor Documentation

◆ RankFourAux()

RankFourAux::RankFourAux ( const InputParameters &  parameters)

Definition at line 45 of file RankFourAux.C.

46  : AuxKernel(parameters),
47  _tensor(getMaterialProperty<RankFourTensor>("rank_four_tensor")),
48  _i(getParam<unsigned int>("index_i")),
49  _j(getParam<unsigned int>("index_j")),
50  _k(getParam<unsigned int>("index_k")),
51  _l(getParam<unsigned int>("index_l"))
52 {
53 }

◆ ~RankFourAux()

virtual RankFourAux::~RankFourAux ( )
inlinevirtual

Definition at line 33 of file RankFourAux.h.

33 {}

Member Function Documentation

◆ computeValue()

Real RankFourAux::computeValue ( )
protectedvirtual

Definition at line 56 of file RankFourAux.C.

57 {
58  return _tensor[_qp](_i, _j, _k, _l);
59 }

◆ validParams()

InputParameters RankFourAux::validParams ( )
static

Definition at line 17 of file RankFourAux.C.

18 {
19  InputParameters params = AuxKernel::validParams();
20  params.addClassDescription("Access a component of a RankFourTensor");
21 
22  // add stuff here
23  params.addRequiredParam<MaterialPropertyName>("rank_four_tensor",
24  "The rank four material tensor name");
25  params.addRequiredRangeCheckedParam<unsigned int>(
26  "index_i",
27  "index_i >= 0 & index_i <= 2",
28  "The index i of ijkl for the tensor to output (0, 1, 2)");
29  params.addRequiredRangeCheckedParam<unsigned int>(
30  "index_j",
31  "index_j >= 0 & index_j <= 2",
32  "The index j of ijkl for the tensor to output (0, 1, 2)");
33  params.addRequiredRangeCheckedParam<unsigned int>(
34  "index_k",
35  "index_k >= 0 & index_k <= 2",
36  "The index k of ijkl for the tensor to output (0, 1, 2)");
37  params.addRequiredRangeCheckedParam<unsigned int>(
38  "index_l",
39  "index_l >= 0 & index_l <= 2",
40  "The index l of ijkl for the tensor to output (0, 1, 2)");
41 
42  return params;
43 }

Member Data Documentation

◆ _i

const unsigned int RankFourAux::_i
private

Definition at line 40 of file RankFourAux.h.

Referenced by computeValue().

◆ _j

const unsigned int RankFourAux::_j
private

Definition at line 41 of file RankFourAux.h.

Referenced by computeValue().

◆ _k

const unsigned int RankFourAux::_k
private

Definition at line 42 of file RankFourAux.h.

Referenced by computeValue().

◆ _l

const unsigned int RankFourAux::_l
private

Definition at line 43 of file RankFourAux.h.

Referenced by computeValue().

◆ _tensor

const MaterialProperty<RankFourTensor>& RankFourAux::_tensor
private

Definition at line 39 of file RankFourAux.h.

Referenced by computeValue().


The documentation for this class was generated from the following files:
RankFourAux::_j
const unsigned int _j
Definition: RankFourAux.h:41
RankFourAux::_l
const unsigned int _l
Definition: RankFourAux.h:43
RankFourAux::_tensor
const MaterialProperty< RankFourTensor > & _tensor
Definition: RankFourAux.h:39
validParams
InputParameters validParams()
RankFourAux::_i
const unsigned int _i
Definition: RankFourAux.h:40
RankFourAux::_k
const unsigned int _k
Definition: RankFourAux.h:42