https://mooseframework.inl.gov
Loading...
Searching...
No Matches
QuotientScalarAux.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 "QuotientScalarAux.h"
11
13
16{
18 params.addClassDescription("Compute the ratio of two scalar variables.");
19 params.addCoupledVar("numerator", "The upstairs of the quotient variable");
20 params.addCoupledVar("denominator", "The downstairs of the quotient variable");
21
22 return params;
23}
24
26 : AuxScalarKernel(parameters),
27 _a(coupledScalarValue("numerator")),
28 _b(coupledScalarValue("denominator"))
29{
30}
31
32Real
34{
35 return _a[0] / _b[0];
36}
registerMooseObject("MooseApp", QuotientScalarAux)
Base class for making kernels that work on auxiliary scalar variables.
static InputParameters validParams()
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
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 addCoupledVar(const std::string &name, const std::string &doc_string)
This method adds a coupled variable name pair.
This auxiliary kernel computes its value by dividing "numerator" by "denominator.
const VariableValue & _a
virtual Real computeValue() override
Compute the value of this kernel.
QuotientScalarAux(const InputParameters &parameters)
static InputParameters validParams()
const VariableValue & _b