AuxKernels System

Example Input File Syntax

Available Objects

• Moose App
• ADDivergenceAuxComputes the divergence of a vector of functors.
• ADFunctorElementalAuxEvaluates a functor (variable, function or functor material property) on the current element, quadrature point, or node.
• ADFunctorElementalGradientAuxEvaluates the gradient of a functor (variable, function or functor material property) on the current element or quadrature point.
• ADFunctorMaterialRealAuxOutputs element volume-averaged material properties
• ADFunctorMaterialRealVectorValueAuxCapture a component of a vector material property in an auxiliary variable.
• ADFunctorVectorElementalAuxEvaluates a vector functor (material property usually) on the current element.For finite volume, this evaluates the vector functor at the centroid.
• ADMaterialRankFourTensorAuxAccess a component of a RankFourTensor for automatic material property output
• ADMaterialRankTwoTensorAuxAccess a component of a RankTwoTensor for automatic material property output
• ADMaterialRateRealAuxOutputs element material properties rate of change
• ADMaterialRealAuxOutputs element volume-averaged material properties
• ADMaterialRealTensorValueAuxObject for extracting a component of a rank two tensor material property to populate an auxiliary variable.
• ADMaterialRealVectorValueAuxCapture a component of a vector material property in an auxiliary variable.
• ADMaterialStdVectorAuxExtracts a component of a material type std::vector<Real> to an aux variable. If the std::vector is not of sufficient size then zero is returned
• ADMaterialSymmetricRankFourTensorAuxAccess a component of a RankTwoTensor for automatic material property output
• ADMaterialSymmetricRankTwoTensorAuxCapture a component of a vector material property in an auxiliary variable.
• ADProjectedStatefulMaterialRankFourTensorAuxPicks a component of an indexable material property to get projected on an elemental Auxvariable. For use by ProjectedStatefulMaterialStorageAction.
• ADProjectedStatefulMaterialRankTwoTensorAuxPicks a component of an indexable material property to get projected on an elemental Auxvariable. For use by ProjectedStatefulMaterialStorageAction.
• ADProjectedStatefulMaterialRealAuxPicks a component of an indexable material property to get projected on an elemental Auxvariable. For use by ProjectedStatefulMaterialStorageAction.
• ADProjectedStatefulMaterialRealVectorValueAuxPicks a component of an indexable material property to get projected on an elemental Auxvariable. For use by ProjectedStatefulMaterialStorageAction.
• ADVectorMaterialRealVectorValueAuxConverts a vector-quantity material property into a vector auxiliary variable
• AdvectiveFluxAuxCompute components of flux vector for advection problems .
• ArrayParsedAuxSets field array variable values to the evaluation of a parsed expression.
• ArrayVarReductionAuxTakes an array variable and performs a reduction operation on it (max, min, sum, average) and stores as a standard variable.
• ArrayVariableComponentCopy a component of an array variable.
• BuildArrayVariableAuxCombines multiple standard variables into an array variable.
• ConstantAuxCreates a constant field in the domain.
• ContainsPointAuxComputes a binary field where the field is 1 in the elements that contain the point and 0 everywhere else
• CopyValueAuxReturns the specified variable as an auxiliary variable with a simple copy of the variable values.
• DebugResidualAuxPopulate an auxiliary variable with the residual contribution of a variable.
• DiffusionFluxAuxCompute components of flux vector for diffusion problems .
• DivergenceAuxComputes the divergence of a vector of functors.
• ElemExtraIDAuxPuts element extra IDs into an aux variable.
• ElementAdaptivityLevelAuxstores the element hierarchy in a aux variable
• ElementH1ErrorFunctionAuxComputes the H1 or W^{1,p} error between an exact function and a coupled variable.
• ElementIntegerAuxCreates a field showing the element integer.
• ElementL2ErrorFunctionAuxA class for computing the element-wise L^2 (Euclidean) error between a function and a coupled variable.
• ElementLengthAuxCompute the element size using Elem::hmin() or Elem::hmax() from libMesh.
• ElementLpNormAuxCompute an elemental field variable (single value per element) equal to the Lp-norm of a coupled Variable.
• ElementNormalAuxAuxKernel to compute components of the element normal. This is mostly designed for 2D elements living in 3D space, however, the 1D-element and 3D-element cases are handled as special cases. The Variable for this AuxKernel must be an elemental Variable
• ElementQualityAuxGenerates a field containing the quality metric for each element. Useful for visualizing mesh quality.
• ElementUOAuxAux Kernel to display generic spatial (elemental) information from a UserObject that satisfies the underlying ElementUOProvider interface.
• ExtraElementIDAuxPuts element extra IDs into an aux variable.
• ForcingFunctionAuxAuxiliary Kernel that adds a forcing function to the value of an AuxVariable from the previous time step.
• FunctionArrayAuxAuxiliary Kernel that creates and updates an array field variable by sampling functions through space and time.
• FunctionAuxAuxiliary Kernel that creates and updates a field variable by sampling a function through space and time.
• FunctorAuxEvaluates a functor (variable, function or functor material property) on the current element, quadrature point, or node.
• FunctorCoordinatesFunctionAuxAuxiliary Kernel that creates and updates a field variable by sampling a function with functors (variables, functions, others) as the coordinates.
• FunctorElementalAuxEvaluates a functor (variable, function or functor material property) on the current element, quadrature point, or node.
• FunctorElementalGradientAuxEvaluates the gradient of a functor (variable, function or functor material property) on the current element or quadrature point.
• FunctorMaterialRealAuxOutputs element volume-averaged material properties
• FunctorMaterialRealVectorValueAuxCapture a component of a vector material property in an auxiliary variable.
• FunctorVectorElementalAuxEvaluates a vector functor (material property usually) on the current element.For finite volume, this evaluates the vector functor at the centroid.
• GapValueAuxReturn the nearest value of a variable on a boundary from across a gap.
• GhostingAuxColors the elements ghosted to the chosen PID.
• GhostingFromUOAuxColors the elements ghosted to the chosen PID.
• HardwareIDAuxCreates a field showing the assignment of partitions to physical nodes in the cluster.
• InterfaceValueUserObjectAuxGet stored value from the specified InterfaceQpUserObjectBase.
• MaterialRankFourTensorAuxAccess a component of a RankFourTensor for automatic material property output
• MaterialRankTwoTensorAuxAccess a component of a RankTwoTensor for automatic material property output
• MaterialRateRealAuxOutputs element material properties rate of change
• MaterialRealAuxOutputs element volume-averaged material properties
• MaterialRealDenseMatrixAuxPopulate an auxiliary variable with an entry from a dense matrix material property.
• MaterialRealTensorValueAuxObject for extracting a component of a rank two tensor material property to populate an auxiliary variable.
• MaterialRealVectorValueAuxCapture a component of a vector material property in an auxiliary variable.
• MaterialStdVectorAuxExtracts a component of a material type std::vector<Real> to an aux variable. If the std::vector is not of sufficient size then zero is returned
• MaterialStdVectorRealGradientAuxExtracts a component of a material's std::vector<RealGradient> to an aux variable. If the std::vector is not of sufficient size then zero is returned
• MaterialSymmetricRankFourTensorAuxAccess a component of a RankTwoTensor for automatic material property output
• MaterialSymmetricRankTwoTensorAuxCapture a component of a vector material property in an auxiliary variable.
• MeshDivisionAuxReturns the value of the mesh division index for each element / node
• NearestNodeDistanceAuxStores the distance between a block and boundary or between two boundaries.
• NearestNodeValueAuxRetrieves a field value from the closest node on the paired boundary and stores it on this boundary or block.
• NodalPatchRecoveryAuxThis Auxkernel solves a least squares problem at each node to fit a value from quantities defined on quadrature points.
• NormalizationAuxNormalizes a variable based on a Postprocessor value.
• ParsedAuxSets a field variable value to the evaluation of a parsed expression.
• ParsedVectorAuxSets a field vector variable value to the evaluation of a parsed expression.
• PenetrationAuxAuxiliary Kernel for computing several geometry related quantities between two contacting bodies.
• PorousFlowElementNormalAuxKernel to compute components of the element normal. This is mostly designed for 2D elements living in 3D space, however, the 1D-element and 3D-element cases are handled as special cases. The Variable for this AuxKernel must be an elemental Variable
• ProcessorIDAuxCreates a field showing the processors and partitioning.
• ProjectedMaterialPropertyNodalPatchRecoveryAuxThis Auxkernel solves a least squares problem at each node to fit a value from quantities defined on quadrature points.
• ProjectedStatefulMaterialRankFourTensorAuxPicks a component of an indexable material property to get projected on an elemental Auxvariable. For use by ProjectedStatefulMaterialStorageAction.
• ProjectedStatefulMaterialRankTwoTensorAuxPicks a component of an indexable material property to get projected on an elemental Auxvariable. For use by ProjectedStatefulMaterialStorageAction.
• ProjectedStatefulMaterialRealAuxPicks a component of an indexable material property to get projected on an elemental Auxvariable. For use by ProjectedStatefulMaterialStorageAction.
• ProjectedStatefulMaterialRealVectorValueAuxPicks a component of an indexable material property to get projected on an elemental Auxvariable. For use by ProjectedStatefulMaterialStorageAction.
• ProjectionAuxReturns the specified variable as an auxiliary variable with a projection of the source variable. If they are the same type, this amounts to a simple copy.
• QuotientAuxDivides two coupled variables.
• SecondTimeDerivativeAuxReturns the second order time derivative of the specified variable as an auxiliary variable.
• SelfAuxReturns the specified variable as an auxiliary variable with a projection of the source variable. If they are the same type, this amounts to a simple copy.
• SolutionAuxCreates fields by using information from a SolutionUserObject.
• SpatialUserObjectAuxPopulates an auxiliary variable with a spatial value returned from a UserObject spatialValue method.
• TagMatrixAuxCouple the diagonal of a tag matrix, and return its nodal value
• TagVectorArrayVariableAuxCouple a tagged vector, and return its evaluations at degree of freedom indices corresponding to the coupled array variable.
• TagVectorArrayVariableValueAuxCouple a tagged vector, and return its array value.
• TagVectorAuxExtract DOF values from a tagged vector into an AuxVariable
• TimeDerivativeAuxReturns the time derivative of the specified variable/functor as an auxiliary variable.
• VariableGradientComponentCreates a field consisting of one component of the gradient of a coupled variable.
• VariableTimeIntegrationAuxIntegrates a field variable in time.
• VectorFunctionAuxAuxiliary Kernel that creates and updates a vector field variable by sampling a Function object, via the vectorValue method, through space and time.
• VectorMagnitudeAuxCreates a field representing the magnitude of three coupled variables using an Euclidean norm.
• VectorMaterialRealVectorValueAuxConverts a vector-quantity material property into a vector auxiliary variable
• VectorPostprocessorVisualizationAuxRead values from a VectorPostprocessor that is producing vectors that are 'number of processors' * in length. Puts the value for each processor into an elemental auxiliary field.
• VectorVariableComponentAuxCreates a field consisting of one component of a coupled vector variable.
• VectorVariableMagnitudeAuxCreates a field consisting of the magnitude of a coupled vector variable.
• VolumeAuxAuxiliary Kernel that samples volumes.
• WeightedGapAuxReturns the specified variable as an auxiliary variable with the same value.
• Marlin App
• ProjectTensorAuxProject a Tensor buffer onto an auxiliary variable

Available Actions

• Moose App
• AddKernelActionAdd a Kernel object to the simulation.