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.
- Solid Mechanics App
- GeneralizedPlaneStrainReferenceResidualGeneralized Plane Strain Reference Residual Scalar Kernel
- Thermal Hydraulics App
- Compressor1PhaseDeltaPAuxReturns the change in pressure computed in the 1-phase shaft-connected compressor.
- Compressor1PhaseDissipationTorqueAuxReturns the dissipation torque computed in the 1-phase shaft-connected compressor.
- Compressor1PhaseFrictionAuxReturns the friction torque computed in the 1-phase shaft-connected compressor.
- Compressor1PhaseInertiaAuxReturns the moment of inertia computed in the 1-phase shaft-connected compressor.
- Compressor1PhaseIsentropicTorqueAuxReturns the isentropic torque computed in the 1-phase shaft-connected compressor.
- HydraulicTorqueAuxReturns the hydraulic torque computed in the 1-phase shaft-connected pump.
- PumpFrictionAuxReturns the friction torque computed in the 1-phase shaft-connected pump.
- PumpHeadAuxReturns the head computed in the 1-phase shaft-connected pump.
- PumpHydraulicTorqueAuxReturns the hydraulic torque computed in the 1-phase shaft-connected pump.
- PumpInertiaAuxReturns the moment of inertia computed in the 1-phase shaft-connected pump.
- SimpleTurbinePowerAuxComputes turbine power for 1-phase flow for a simple on/off turbine
- Turbine1PhaseDeltaPAuxReturns the change in pressure computed in the 1-phase shaft-connected turbine.
- Turbine1PhaseDrivingTorqueAuxReturns the driving torque computed in the 1-phase shaft-connected turbine.
- Turbine1PhaseFlowCoefficientAuxReturns the flow coefficient computed in the 1-phase shaft-connected turbine.
- Turbine1PhaseFrictionTorqueAuxReturns the friction torque computed in the 1-phase shaft-connected turbine.
- Turbine1PhaseMomentOfInertiaAuxReturns the moment of inertia computed in the 1-phase shaft-connected turbine.
- Turbine1PhasePowerAuxReturns the change in pressure computed in the 1-phase shaft-connected turbine.
- VolumeJunction1PhasePressureAuxComputes pressure from the 1-phase volume junction variables.
- VolumeJunction1PhaseTemperatureAuxComputes temperature from the 1-phase volume junction variables.
- VolumeJunction1PhaseVelocityMagnitudeAuxComputes magnitude of velocity from the 1-phase volume junction variables.
- Stochastic Tools App
- SurrogateModelScalarAuxSets a value of a scalar variable based on a surrogate model.
Available Actions
- Moose App
- AddScalarKernelActionAdd a AuxScalarKernel object to the simulation.