Bounds System

buildconstruction:Undocumented System

The Bounds system has not been documented. The content listed below should be used as a starting point for documenting the system, which includes the typical automatic documentation associated with a system; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.


# Bounds System

## Overview

!! Replace this line with information regarding the Bounds system.

## Example Input File Syntax

!! Describe and include an example of how to use the Bounds system.

!syntax list /Bounds objects=True actions=False subsystems=False

!syntax list /Bounds objects=False actions=False subsystems=True

!syntax list /Bounds objects=False actions=True subsystems=False

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 or quadrature point.
  • ADFunctorVectorElementalAuxEvaluates a vector functor (material property usually) on the current element.For finite volume, this evaluates the vector functor at the centroid.
  • ADMaterialRankTwoTensorAuxAccess a component of a RankTwoTensor for automatic material property output
  • ADMaterialRealAuxOutputs element volume-averaged material properties
  • ADMaterialRealVectorValueAuxCapture a component of a vector material property in an auxiliary variable.
  • ADTimeDerivativeAuxReturns the time derivative of the specified variable/functor as an auxiliary variable.
  • ADVectorMaterialRealVectorValueAuxConverts a vector-quantity material property into a vector auxiliary variable
  • ArrayVariableComponentCopy a component of an array variable.
  • BuildArrayVariableAuxCombines multiple standard variables into an array variable.
  • ConstantAuxCreates a constant field in the domain.
  • ConstantBoundsAuxProvides constant bound of a variable for the PETSc's variational inequalities solver
  • 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.
  • 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.
  • 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.
  • FunctorADMatPropElementalAuxEvaluates a functor (variable, function or functor material property) on the current element or quadrature point.
  • FunctorElementalAuxEvaluates a functor (variable, function or functor material property) on the current element or quadrature point.
  • FunctorMatPropElementalAuxEvaluates a functor (variable, function or functor material property) on the current element or quadrature point.
  • 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.
  • 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
  • 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
  • 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.
  • NormalizationAuxNormalizes a variable based on a Postprocessor value.
  • ParsedAuxSets a field variable value to the evaluation of a parsed expression.
  • PenetrationAuxAuxiliary Kernel for computing several geometry related quantities between two contacting bodies.
  • ProcessorIDAuxCreates a field showing the processors and partitioning.
  • QuotientAuxDivides two coupled variables.
  • SelfAuxReturns the specified variable as an auxiliary variable with the same value.
  • 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.
  • TagVectorAuxCouple a tag vector, and return its nodal value
  • 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.
  • VariableOldValueBoundsAuxProvides the upper and lower bound of the phase field fracture variable to PETSc's SNES variational inequalities solver.
  • 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.
  • Heat Conduction App
  • JouleHeatingHeatGeneratedAuxCompute heat generated from Joule heating .
  • Misc App
  • CoupledDirectionalMeshHeightInterpolationScales a variable based on position relative to the model bounds in a specified direction
  • Tensor Mechanics App
  • ADKineticEnergyAuxCompute the kinetic energy of continuum-based finite elements
  • ADRankFourAuxAccess a component of a RankFourTensor
  • ADRankTwoAuxAccess a component of a RankTwoTensor
  • ADRankTwoScalarAuxCompute a scalar property of a RankTwoTensor
  • AccumulateAux
  • CylindricalRankTwoAuxTakes RankTwoTensor material and outputs component in cylindrical coordinates
  • DomainIntegralQFunctionComputes the q-function for a segment along the crack front, used in the calculation of the J-integral
  • DomainIntegralTopologicalQFunctionDetermines if a node is within the ring of the crack front defintion; this object is normally created by the DomainIntegralAction.
  • ElasticEnergyAuxCompute the local elastic energy
  • GlobalDisplacementAuxAuxKernel to visualize the displacements generated by the global strain tensor
  • KineticEnergyAuxCompute the kinetic energy of continuum-based finite elements
  • NewmarkAccelAuxComputes the current acceleration using the Newmark method.
  • NewmarkVelAuxCalculates the current velocity using Newmark method.
  • NodalPatchRecoveryAuxThis Auxkernel solves a least squares problem at each node to fit a value from quantities defined on quadrature points.
  • RadialDisplacementCylinderAuxCompute the radial component of the displacement vector for cylindrical models.
  • RadialDisplacementSphereAuxCompute the radial component of the displacement vector for spherical models.
  • RankFourAuxAccess a component of a RankFourTensor
  • RankTwoAuxAccess a component of a RankTwoTensor
  • RankTwoScalarAuxCompute a scalar property of a RankTwoTensor
  • RotationAngleCompute the field of angular rotations of points around an axis defined by an origin point and a direction vector
  • TestNewmarkTIAssigns the velocity/acceleration calculated by time integrator to the velocity/acceleration auxvariable.

Available Actions