https://mooseframework.inl.gov
NodalVoidVolumeAux.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 "NodalVoidVolumeAux.h"
11 
12 registerMooseObject("GeochemistryApp", NodalVoidVolumeAux);
13 
16 {
18  params.addClassDescription(
19  "Extracts information from the NodalVoidVolume UserObject and records it in the AuxVariable");
20  params.addRequiredParam<UserObjectName>("nodal_void_volume_uo",
21  "The name of the NodalVoidVolume UserObject.");
22  return params;
23 }
24 
26  : AuxKernel(parameters), _nvv(getUserObject<NodalVoidVolume>("nodal_void_volume_uo"))
27 {
28  if (!_var.isNodal())
29  mooseError("NodalVoidVolumeAux: variable must be nodal (eg, linear Lagrange)");
30 }
31 
32 Real
34 {
36 }
Computes the void volume associated with each node.
virtual bool isNodal() const
Real getNodalVoidVolume(const Node *node) const
AuxKernel to extract information from a NodalVoidVolume UserObject to record into an AuxVariable...
registerMooseObject("GeochemistryApp", NodalVoidVolumeAux)
const Node *const & _current_node
NodalVoidVolumeAux(const InputParameters &parameters)
void addRequiredParam(const std::string &name, const std::string &doc_string)
virtual Real computeValue() override
static InputParameters validParams()
MooseVariableField< Real > & _var
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
void mooseError(Args &&... args) const
void addClassDescription(const std::string &doc_string)
const NodalVoidVolume & _nvv
static InputParameters validParams()