https://mooseframework.inl.gov
MaterialStdVectorAux.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
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 
10 #include "MaterialStdVectorAux.h"
11 
14 
15 template <bool is_ad>
18 {
20  params.addClassDescription("Extracts a component of a material type std::vector<Real> to an aux "
21  "variable. If the std::vector is not of sufficient size then zero is "
22  "returned");
23  return params;
24 }
25 
26 template <bool is_ad>
28  : MaterialStdVectorAuxBaseTempl<Real, is_ad>(parameters)
29 {
30 }
31 
32 template <bool is_ad>
33 Real
35 {
36  if (this->_full_value.size() >= _index)
37  return MetaPhysicL::raw_value(this->_full_value[_index]);
38  else
39  return 0.0;
40 }
41 
43 template class MaterialStdVectorAuxTempl<true>;
static InputParameters validParams()
registerMooseObject("MooseApp", MaterialStdVectorAux)
auto raw_value(const Eigen::Map< T > &in)
Definition: EigenADReal.h:73
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
static InputParameters validParams()
A base class for the various Material related AuxKernel objects.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
MaterialStdVectorAuxTempl(const InputParameters &parameters)
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...
AuxKernel for outputting a std::vector material-property component to an AuxVariable.
virtual Real getRealValue() override
Returns material property values at quadrature points.