AuxScalarKernels System
An AuxiliaryScalarVariable is to a ScalarVariable what an AuxVariable is to a MooseVariable. It is not the solution of a differential equation and instead can be computed directly by algebraic operations using an auxiliary scalar kernel.
Creating a custom AuxScalarKernel object is done by creating a new C++ object that inherits from AuxScalarKernel and overriding the computeValue method.
AuxScalarKernel objects, like all Kernel objects, must operate on a variable. Thus, there is a required parameter ("variable") that indicates the variable that the AuxScalarKernel object is computing. These variables are defined in the AuxVariables block of the input file, and must be of family SCALAR.
For higher order scalar variables, computeValue is called multiple times with each order index _i for the value of each order. The definition of computeValue may depend on _i, as appropriate.
Execution schedule
Please see the documentation for field auxiliary kernels (AuxKernels) which applies identically to AuxScalarKernels.
Examples
AuxScalarKernels are essentially used for postprocessing or for decoupling solves. The examples in the documentation for field auxiliary kernels (AuxKernels) can conceptually be adapted to AuxScalarKernels.
Available Objects
- Moose App
- ConstantScalarAuxSets an auxiliary field variable to a controllable constant value.
- FunctionScalarAuxSets a value of a scalar variable based on a function.
- QuotientScalarAuxCompute the ratio of two scalar variables.
- ScalarTagMatrixAuxCouple a tag matrix, and return its nodal value
- ScalarTagVectorAuxCouple a tag vector, and return its value
- SolutionScalarAuxSets scalar variable by using information from a SolutionUserObject.
- Stochastic Tools App
- SurrogateModelScalarAuxSets a value of a scalar variable based on a surrogate model.
- Thermal Hydraulics App
- ShaftConnectedCompressor1PhaseScalarAuxComputes various quantities for a ShaftConnectedCompressor1Phase.
- ShaftConnectedPump1PhaseScalarAuxComputes various quantities for a ShaftConnectedPump1Phase.
- ShaftConnectedTurbine1PhaseScalarAuxComputes various quantities for a ShaftConnectedTurbine1Phase.
- SimpleTurbinePowerAuxComputes turbine power for 1-phase flow for a simple on/off turbine
- SimpleTurbinePowerScalarAuxComputes turbine power for 1-phase flow for a simple on/off turbine
- VolumeJunction1PhaseScalarAuxComputes various quantities for a VolumeJunction1Phase.
- Solid Mechanics App
- GeneralizedPlaneStrainReferenceResidualGeneralized Plane Strain Reference Residual Scalar Kernel
Available Actions
- Moose App
- AddScalarKernelActionAdd a AuxScalarKernel object to the simulation.