https://mooseframework.inl.gov
QuotientAux.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 "QuotientAux.h"
11 
12 registerMooseObject("MooseApp", QuotientAux);
13 
16 {
18  params.addClassDescription("Divides two coupled variables.");
19  params.addCoupledVar("numerator", "The upstairs of the quotient variable");
20  params.addCoupledVar("denominator", "The downstairs of the quotient variable");
21  return params;
22 }
23 
25  : AuxKernel(parameters),
26  _numerator(coupledValue("numerator")),
27  _denominator(coupledValue("denominator"))
28 {
29 }
30 
31 Real
33 {
34  return _numerator[_qp] / _denominator[_qp];
35 }
const VariableValue & _numerator
Definition: QuotientAux.h:30
QuotientAux(const InputParameters &parameters)
Definition: QuotientAux.C:24
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
registerMooseObject("MooseApp", QuotientAux)
const VariableValue & _denominator
Definition: QuotientAux.h:31
static InputParameters validParams()
Definition: QuotientAux.C:15
void addCoupledVar(const std::string &name, const std::string &doc_string)
This method adds a coupled variable name pair.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
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...
static InputParameters validParams()
Definition: AuxKernel.C:27
virtual Real computeValue() override
Compute and return the value of the aux variable.
Definition: QuotientAux.C:32
This auxiliary kernel computes its value by dividing "numerator" by "denominator. ...
Definition: QuotientAux.h:20