https://mooseframework.inl.gov
ElementIDAux.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 "ElementIDAux.h"
11 
13 
16 {
18  params.addClassDescription("Displays the current mesh element ID.");
19  return params;
20 }
21 
22 ElementIDAux::ElementIDAux(const InputParameters & parameters) : AuxKernel(parameters) {}
23 
24 Real
26 {
27  return _current_elem->id();
28 }
registerMooseObject("MooseApp", ElementIDAux)
Auxiliary kernel to return the current element ID from the mesh.
Definition: ElementIDAux.h:17
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
ElementIDAux(const InputParameters &parameters)
Definition: ElementIDAux.C:22
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
const Elem *const & _current_elem
Current element (valid only for elemental kernels)
Definition: AuxKernel.h:133
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...
static InputParameters validParams()
Definition: AuxKernel.C:27
virtual Real computeValue()
Compute and return the value of the aux variable.
Definition: ElementIDAux.C:25
static InputParameters validParams()
Definition: ElementIDAux.C:15