www.mooseframework.org
MaterialRealDenseMatrixAux.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
11 
13 
16 {
18  params.addClassDescription(
19  "Populate an auxiliary variable with an entry from a dense matrix material property.");
20  params.addParam<unsigned int>("row", 0, "The row component to consider for this kernel");
21  params.addParam<unsigned int>("column", 0, "The column component to consider for this kernel");
22  return params;
23 }
24 
26  : MaterialAuxBase<DenseMatrix<Real>>(parameters),
27  _row(getParam<unsigned int>("row")),
28  _col(getParam<unsigned int>("column"))
29 {
30 }
31 
32 Real
34 {
35  return _prop[_qp](_row, _col);
36 }
virtual Real getRealValue() override
Returns the component of the tensor for output.
AuxKernel for outputting a DenseMatrix<Real> material property component to an AuxVariable.
A base class for the various Material related AuxKernal objects.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
MaterialRealDenseMatrixAux(const InputParameters &parameters)
Class constructor.
static InputParameters validParams()
unsigned int _col
The column index to output.
registerMooseObject("MooseApp", MaterialRealDenseMatrixAux)
const GenericMaterialProperty< T, is_ad > & _prop
Reference to the material property for this AuxKernel.
unsigned int _row
The row index to output.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
static InputParameters validParams()
unsigned int _qp
Quadrature point index.
Definition: AuxKernel.h:230
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...
void ErrorVector unsigned int