BlackBear Input File Syntax

Listed below are all of the possible input parameter options for a BlackBear input file. Click the blue link shown to the right of each heading to see a more detailed description of its purpose.

ActionComponents

Adaptivity

Adaptivity/Indicators

Adaptivity/Markers

  • Moose App
  • AddElementalFieldActionAdds elemental auxiliary variable for adaptivity system.
  • AddMarkerActionAdd a Marker object to a simulation.
  • ArrayMooseVariableUsed for grouping standard field variables with the same finite element family and order
  • BoundaryMarkerMarks all elements with sides on a given boundary for refinement/coarsening
  • BoundaryPreservedMarkerMarks elements for refinement or coarsening based on the provided marker value, while preserving the given boundary.
  • BoxMarkerMarks the region inside and outside of a 'box' domain for refinement or coarsening.
  • ComboMarkerA marker that converts many markers into a single marker by considering the maximum value of the listed markers (i.e., refinement takes precedent).
  • ErrorFractionMarkerMarks elements for refinement or coarsening based on the fraction of the min/max error from the supplied indicator.
  • ErrorToleranceMarkerCoarsen or refine elements based on an absolute tolerance allowed from the supplied indicator.
  • MooseLinearVariableFVRealBase class for Moose variables. This should never be the terminal object type
  • MooseVariableRepresents standard field variables, e.g. Lagrange, Hermite, or non-constant Monomials
  • MooseVariableBaseBase class for Moose variables. This should never be the terminal object type
  • MooseVariableConstMonomialSpecialization for constant monomials that avoids unnecessary loops
  • MooseVariableFVRealBase class for Moose variables. This should never be the terminal object type
  • MooseVariableScalarMoose wrapper class around scalar variables
  • OrientedBoxMarkerMarks inside and outside a box that can have arbitrary orientation and center point.
  • ReporterPointMarkerMarks the region inside or empty if it contains a reporter defined point for refinement or coarsening.
  • UniformMarkerUniformly mark all elements for refinement or coarsening.
  • ValueRangeMarkerMark elements for adaptivity based on the supplied upper and lower bounds and the specified variable.
  • ValueThresholdMarkerThe refinement state based on a threshold value compared to the specified variable.
  • VectorMooseVariableRepresents vector field variables, e.g. Vector Lagrange, Nedelec or Raviart-Thomas

Application

AuxKernels

  • Moose App
  • AddKernelActionAdd a Kernel object to the simulation.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Stochastic Tools App
  • SurrogateModelArrayAuxKernelSets a value of a variable based on a surrogate model.
  • SurrogateModelAuxKernelSets a value of a variable based on a surrogate model.
  • Heat Transfer App
  • JouleHeatingHeatGeneratedAuxCompute heat generated from Joule heating.
  • Solid 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
  • AccumulateAuxAccumulates one or more variables and this auxiliary variable into this auxiliary variable
  • 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.
  • 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
  • ShellLocalCoordinatesAuxThis AuxKernel stores a specific component of a shell element's local coordinate vector in an auxiliary variable.
  • ShellResultantsAuxComputes the local forces, bending moments and shear forces acting on shell elements
  • TestNewmarkTIAssigns the velocity/acceleration calculated by time integrator to the velocity/acceleration auxvariable.
  • Contact App
  • CohesiveZoneMortarUserObjectAuxPopulates an auxiliary variable with mortar cohesive zone model quantities.
  • ContactPressureAuxComputes the contact pressure from the contact force and nodal area
  • MortarArchardsLawAuxReturns the weighted gap velocity at a node. This quantity is useful for mortar contact, particularly when dual basis functions are used in contact mechanics
  • MortarFrictionalPressureVectorAuxThis class creates an auxiliary vector for outputting the mortar frictional pressure vector.
  • MortarFrictionalStateAuxThis class creates discrete states for nodes into frictional contact, including contact/no-contact and stick/slip.
  • MortarPressureComponentAuxThis class transforms the Cartesian Lagrange multiplier vector to local coordinates and outputs each individual component along the normal or tangential direction.
  • PenaltyMortarUserObjectAuxPopulates an auxiliary variable with a contact quantities from penalty mortar contact.
  • WeightedGapVelAuxReturns the weighted gap velocity at a node. This quantity is useful for mortar contact, particularly when dual basis functions are used in contact mechanics
  • XFEMApp
  • CutSubdomainIDAuxFill the elemental variable with CutSubdomainID
  • MeshCutLevelSetAuxCalculates signed distance from interface defined by InterfaceMeshCutUserObject.
  • XFEMCutPlaneAuxComputes the normal and origin of a cutting plane for each partial element.
  • XFEMMarkerAuxIdentify the crack tip elements.
  • XFEMVolFracAuxComputes the volume fraction of the physical material in each partial element.
  • Misc App
  • CoupledDirectionalMeshHeightInterpolationScales a variable based on position relative to the model bounds in a specified direction
  • Black Bear App
  • NEMLStateAux

AuxScalarKernels

AuxVariables

BCs

  • Moose App
  • AddBCActionAdd a BoundaryCondition object to the simulation.
  • ADConservativeAdvectionBCBoundary condition for advection when it is integrated by parts. Supports Dirichlet (inlet-like) and implicit (outlet-like) conditions.
  • ADCoupledVarNeumannBCImposes the integrated boundary condition , where is a variable.
  • ADDirichletBCImposes the essential boundary condition , where is a constant, controllable value.
  • ADFunctionDirichletBCImposes the essential boundary condition , where is calculated by a function.
  • ADFunctionNeumannBCImposes the integrated boundary condition , where is a (possibly) time and space-dependent MOOSE Function.
  • ADFunctionPenaltyDirichletBCEnforces a (possibly) time and space-dependent MOOSE Function Dirichlet boundary condition in a weak sense by penalizing differences between the current solution and the Dirichlet data.
  • ADMatNeumannBCImposes the integrated boundary condition , where is a constant, is a material property, and is a coefficient defined by the kernel for .
  • ADMatchedValueBCImplements a NodalBC which equates two different Variables' values on a specified boundary.
  • ADNeumannBCImposes the integrated boundary condition , where is a constant, controllable value.
  • ADPenaltyDirichletBCEnforces a Dirichlet boundary condition in a weak sense by penalizing differences between the current solution and the Dirichlet data.
  • ADRobinBCImposes the Robin integrated boundary condition .
  • ADVectorFunctionDirichletBCImposes the essential boundary condition , where components are calculated with functions.
  • ADVectorFunctionNeumannBCImposes the integrated boundary condition , where is a (possibly) time and space-dependent MOOSE Function.
  • ADVectorMatchedValueBCImplements a ADVectorNodalBC which equates two different Variables' values on a specified boundary.
  • ADVectorRobinBCImposes the Robin integrated boundary condition .
  • AdvectionIPHDGDirichletBCWeakly imposes Dirichlet boundary conditions for a hybridized discretization of an advection equation
  • AdvectionIPHDGOutflowBCImplements an outflow boundary condition for use with a hybridized discretization of the advection equation
  • ArrayDirichletBCImposes the essential boundary condition , where are constant, controllable values.
  • ArrayHFEMDirichletBCImposes the Dirichlet BC with HFEM.
  • ArrayNeumannBCImposes the integrated boundary condition , where is a constant, controllable value.
  • ArrayPenaltyDirichletBCEnforces a Dirichlet boundary condition in a weak sense with , where is the constant scalar penalty; is the test functions and is the differences between the current solution and the Dirichlet data.
  • ArrayVacuumBCImposes the Robin boundary condition .
  • ConvectiveFluxBCDetermines boundary values via the initial and final values, flux, and exposure duration
  • CoupledVarNeumannBCImposes the integrated boundary condition , where is a variable.
  • DGFunctionDiffusionDirichletBCDiffusion Dirichlet boundary condition for discontinuous Galerkin method.
  • DiffusionFluxBCComputes a boundary residual contribution consistent with the Diffusion Kernel. Does not impose a boundary condition; instead computes the boundary contribution corresponding to the current value of grad(u) and accumulates it in the residual vector.
  • DiffusionIPHDGDirichletBCWeakly imposes Dirichlet boundary conditions for a hybridized discretization of a diffusion equation
  • DiffusionIPHDGPrescribedFluxBCImplements a flux boundary condition for use with a hybridized discretization of the diffusion equation
  • DiffusionLHDGDirichletBCWeakly imposes Dirichlet boundary conditions for a hybridized discretization of a diffusion equation
  • DiffusionLHDGPrescribedGradientBCImplements a flux boundary condition for use with a hybridized discretization of the diffusion equation
  • DirectionalNeumannBCImposes the integrated boundary condition , where is a user-defined, constant vector.
  • DirichletBCImposes the essential boundary condition , where is a constant, controllable value.
  • EigenArrayDirichletBCArray Dirichlet BC for eigenvalue solvers
  • EigenDirichletBCDirichlet BC for eigenvalue solvers
  • FunctionDirichletBCImposes the essential boundary condition , where is a (possibly) time and space-dependent MOOSE Function.
  • FunctionGradientNeumannBCImposes the integrated boundary condition arising from integration by parts of a diffusion/heat conduction operator, and where the exact solution can be specified.
  • FunctionNeumannBCImposes the integrated boundary condition , where is a (possibly) time and space-dependent MOOSE Function.
  • FunctionPenaltyDirichletBCEnforces a (possibly) time and space-dependent MOOSE Function Dirichlet boundary condition in a weak sense by penalizing differences between the current solution and the Dirichlet data.
  • FunctorDirichletBCImposes the Dirichlet boundary condition , where is a functor and can have complex dependencies.
  • FunctorNeumannBCImposes the integrated boundary condition , where is a functor.
  • HFEMDirichletBCImposes the Dirichlet BC with HFEM.
  • LagrangeVecDirichletBCImposes the essential boundary condition , where are constant, controllable values.
  • LagrangeVecFunctionDirichletBCImposes the essential boundary condition , where components are calculated with functions.
  • MatNeumannBCImposes the integrated boundary condition , where is a constant, is a material property, and is a coefficient defined by the kernel for .
  • MatchedValueBCImplements a NodalBC which equates two different Variables' values on a specified boundary.
  • NeumannBCImposes the integrated boundary condition , where is a constant, controllable value.
  • OneDEqualValueConstraintBCComputes the integral of lambda times dg term from the mortar method (for two 1D domains only).
  • PenaltyDirichletBCEnforces a Dirichlet boundary condition in a weak sense by penalizing differences between the current solution and the Dirichlet data.
  • PostprocessorDirichletBCDirichlet boundary condition with value prescribed by a Postprocessor value.
  • PostprocessorNeumannBCNeumann boundary condition with value prescribed by a Postprocessor value.
  • SinDirichletBCImposes a time-varying essential boundary condition , where varies from an given initial value at time to a given final value over a specified duration.
  • SinNeumannBCImposes a time-varying flux boundary condition , where varies from an given initial value at time to a given final value over a specified duration.
  • VacuumBCVacuum boundary condition for diffusion.
  • VectorCurlPenaltyDirichletBCEnforces a Dirichlet boundary condition for the curl of vector nonlinear variables in a weak sense by applying a penalty to the difference in the current solution and the Dirichlet data.
  • VectorDirichletBCImposes the essential boundary condition , where are constant, controllable values.
  • VectorDivPenaltyDirichletBCEnforces, in a weak sense, a Dirichlet boundary condition on the divergence of a nonlinear vector variable by applying a penalty to the difference between the current solution and the Dirichlet data.
  • VectorFunctionDirichletBCImposes the essential boundary condition , where components are calculated with functions.
  • VectorNeumannBCImposes the integrated boundary condition , where is a user-defined, constant vector.
  • VectorPenaltyDirichletBCEnforces a Dirichlet boundary condition for vector nonlinear variables in a weak sense by applying a penalty to the difference in the current solution and the Dirichlet data.
  • WeakGradientBCComputes a boundary residual contribution consistent with the Diffusion Kernel. Does not impose a boundary condition; instead computes the boundary contribution corresponding to the current value of grad(u) and accumulates it in the residual vector.
  • Periodic
  • Heat Transfer App
  • ADConvectiveHeatFluxBCConvective heat transfer boundary condition with temperature and heat transfer coefficient given by material properties.
  • ADFunctionRadiativeBCBoundary condition for radiative heat exchange where the emissivity function is supplied by a Function.
  • ADInfiniteCylinderRadiativeBCBoundary condition for radiative heat exchange with a cylinderwhere the boundary is approximated as a cylinder as well.
  • ConvectiveFluxFunctionDetermines boundary value by fluid heat transfer coefficient and far-field temperature
  • ConvectiveHeatFluxBCConvective heat transfer boundary condition with temperature and heat transfer coefficent given by material properties.
  • CoupledConvectiveFlux
  • CoupledConvectiveHeatFluxBCConvective heat transfer boundary condition with temperature and heat transfer coefficent given by auxiliary variables.
  • DirectionalFluxBCApplies a directional flux multiplied by the surface normal vector. Can utilize the self shadowing calculation from a SelfShadowSideUserObject.
  • FunctionRadiativeBCBoundary condition for radiative heat exchange where the emissivity function is supplied by a Function.
  • GapHeatTransferTransfers heat across a gap between two surfaces dependent on the gap geometry specified.
  • GapPerfectConductanceEnforces equal temperatures across the gap.
  • GaussianEnergyFluxBCDescribes an incoming heat flux beam with a Gaussian profile
  • GrayLambertNeumannBCThis BC imposes a heat flux density that is computed from the GrayLambertSurfaceRadiationBase userobject.
  • HeatConductionBC
  • InfiniteCylinderRadiativeBCBoundary condition for radiative heat exchange with a cylinderwhere the boundary is approximated as a cylinder as well.
  • XFEMApp
  • CrackTipEnrichmentCutOffBCImposes the essential boundary condition , where is a constant, controllable value.
  • Solid Mechanics App
  • ADPenaltyInclinedNoDisplacementBCPenalty Enforcement of an inclined boundary condition
  • ADPressureApplies a pressure on a given boundary in a given direction
  • ADTorqueApply a moment as tractions distributed over a surface around a pivot point. This should operate on the displaced mesh for large deformations.
  • CoupledPressureBCApplies a pressure from a variable on a given boundary in a given direction
  • DashpotBCModel a dashpot boundary condition where the traction is proportional to the normal velocity.
  • DirectDirichletBCImposes the essential boundary condition , where is a constant, controllable value.
  • DirectFunctionDirichletBCImposes the essential boundary condition , where is a (possibly) time and space-dependent MOOSE Function.
  • DisplacementAboutAxisImplements a boundary condition that enforces rotationaldisplacement around an axis on a boundary
  • ExplicitDirichletBCImposes the essential boundary condition , where is a constant, controllable value.
  • ExplicitFunctionDirichletBCImposes the essential boundary condition , where is a (possibly) time and space-dependent MOOSE Function.
  • InteractionIntegralBenchmarkBCImplements a boundary condition that enforces a displacement field around a crack tip based on applied stress intensity factors.
  • PenaltyInclinedNoDisplacementBCPenalty Enforcement of an inclined boundary condition
  • PresetAccelerationPrescribe acceleration on a given boundary in a given direction
  • PresetDisplacementPrescribe the displacement on a given boundary in a given direction.
  • PresetVelocitySets the boundary displacements through time from an imposed velocity
  • PressureApplies a pressure on a given boundary in a given direction
  • StickyBCImposes the boundary condition if exceeds the bounds provided
  • TorqueApply a moment as tractions distributed over a surface around a pivot point. This should operate on the displaced mesh for large deformations.
  • CavityPressure
  • CoupledPressure
  • InclinedNoDisplacementBC
  • Pressure
  • Black Bear App
  • FunctionOffsetDirichletBCImposes the essential boundary condition , where is a (possibly) time and space-dependent MOOSE Function, but ofsetting the location where the function is evaluated.
  • SpecifiedVaporPressureBCPrescribed vapor pressure boundary condition for moisture transport in concrete.

BCs/CavityPressure

BCs/CoupledPressure

  • Solid Mechanics App
  • CoupledPressureActionSet up pressure boundary condition using the CoupledPressureBC object.

BCs/InclinedNoDisplacementBC

BCs/Periodic

BCs/Pressure

  • Solid Mechanics App
  • PressureActionSet up pressure boundary condition using the Pressure object.

Bounds

ChainControls

Constraints

  • Moose App
  • AddConstraintActionAdd a Constraint object to the simulation.
  • ADEqualValueEmbeddedConstraintThis is a constraint enforcing overlapping portions of two blocks to have the same variable value
  • ADPenaltyEqualValueConstraintPenaltyEqualValueConstraint enforces solution continuity between secondary and primary sides of a mortar interface using a penalty approach (no Lagrange multipliers needed)
  • ADPenaltyPeriodicSegmentalConstraintADPenaltyPeriodicSegmentalConstraint enforces macro-micro periodic conditions between secondary and primary sides of a mortar interface using a penalty approach (no Lagrange multipliers needed). Must be used alongside PenaltyEqualValueConstraint.
  • ADPeriodicSegmentalConstraintADPeriodicSegmentalConstraint enforces macro-micro periodic conditions between secondary and primary sides of a mortar interface using Lagrange multipliers.Must be used alongside EqualValueConstraint.
  • CoupledTiedValueConstraintRequires the value of two variables to be the consistent on both sides of an interface.
  • EqualGradientConstraintEqualGradientConstraint enforces continuity of a gradient component between secondary and primary sides of a mortar interface using lagrange multipliers
  • EqualValueBoundaryConstraintConstraint for enforcing that variables on each side of a boundary are equivalent.
  • EqualValueConstraintEqualValueConstraint enforces solution continuity between secondary and primary sides of a mortar interface using lagrange multipliers
  • EqualValueEmbeddedConstraintThis is a constraint enforcing overlapping portions of two blocks to have the same variable value
  • LinearNodalConstraintConstrains secondary node to move as a linear combination of primary nodes.
  • OldEqualValueConstraintOldEqualValueConstraint enforces solution continuity between secondary and primary sides of a mortar interface using lagrange multipliers
  • PenaltyEqualValueConstraintPenaltyEqualValueConstraint enforces solution continuity between secondary and primary sides of a mortar interface using a penalty approach (no Lagrange multipliers needed)
  • PenaltyPeriodicSegmentalConstraintPenaltyPeriodicSegmentalConstraint enforces macro-micro periodic conditions between secondary and primary sides of a mortar interface using a penalty approach (no Lagrange multipliers needed). Must be used alongside PenaltyEqualValueConstraint.
  • PeriodicSegmentalConstraintPeriodicSegmentalConstraint enforces macro-micro periodic conditions between secondary and primary sides of a mortar interface using Lagrange multipliers.Must be used alongside EqualValueConstraint.
  • TiedValueConstraintConstraint that forces the value of a variable to be the same on both sides of an interface.
  • Heat Transfer App
  • ADInterfaceJouleHeatingConstraintJoule heating model, for the case of a closed gap interface, to calculate the heat flux contribution created when an electric potential difference occurs across that interface.
  • GapConductanceConstraintComputes the residual and Jacobian contributions for the 'Lagrange Multiplier' implementation of the thermal contact problem. For more information, see the detailed description here: http://tinyurl.com/gmmhbe9
  • ModularGapConductanceConstraintComputes the residual and Jacobian contributions for the 'Lagrange Multiplier' implementation of the thermal contact problem. For more information, see the detailed description here: http://tinyurl.com/gmmhbe9
  • Contact App
  • CartesianMortarMechanicalContactThis class is used to apply normal contact forces using lagrange multipliers
  • ComputeDynamicFrictionalForceLMMechanicalContactComputes the tangential frictional forces for dynamic simulations
  • ComputeDynamicWeightedGapLMMechanicalContactComputes the normal contact mortar constraints for dynamic simulations
  • ComputeFrictionalForceCartesianLMMechanicalContactComputes mortar frictional forces.
  • ComputeFrictionalForceLMMechanicalContactComputes the tangential frictional forces
  • ComputeWeightedGapCartesianLMMechanicalContactComputes the weighted gap that will later be used to enforce the zero-penetration mechanical contact conditions
  • ComputeWeightedGapLMMechanicalContactComputes the weighted gap that will later be used to enforce the zero-penetration mechanical contact conditions
  • ExplicitDynamicsContactConstraintApply non-penetration constraints on the mechanical deformation in explicit dynamics using a node on face formulation by solving uncoupled momentum-balance equations.
  • MechanicalContactConstraintApply non-penetration constraints on the mechanical deformation using a node on face, primary/secondary algorithm, and multiple options for the physical behavior on the interface and the mathematical formulation for constraint enforcement
  • MortarGenericTractionUsed to apply tangential stresses from frictional contact using lagrange multipliers
  • NormalMortarMechanicalContactThis class is used to apply normal contact forces using lagrange multipliers
  • RANFSNormalMechanicalContactApplies the Reduced Active Nonlinear Function Set scheme in which the secondary node's non-linear residual function is replaced by the zero penetration constraint equation when the constraint is active
  • TangentialMortarMechanicalContactUsed to apply tangential stresses from frictional contact using lagrange multipliers
  • XFEMApp
  • XFEMEqualValueAtInterfaceEnforce that the solution have the same value on opposing sides of an XFEM interface.
  • XFEMSingleVariableConstraintEnforce constraints on the value or flux associated with a variable at an XFEM interface.
  • Solid Mechanics App
  • NodalFrictionalConstraintFrictional nodal constraint for contact
  • NodalStickConstraintSticky nodal constraint for contact

Constraints/EqualValueEmbeddedConstraint

Contact

  • Contact App
  • ContactActionSets up all objects needed for mechanical contact enforcement

Controls

  • Moose App
  • AddControlActionAdd a Control object to the simulation.
  • BoolFunctionControlSets the value of a 'bool' input parameters to the value of a provided function.
  • ConditionalFunctionEnableControlControl for enabling/disabling objects when a function value is true
  • LibtorchNeuralNetControlControls the value of multiple controllable input parameters using a Libtorch-based neural network.
  • PIDTransientControlSets the value of a 'Real' input parameter (or postprocessor) based on a Proportional Integral Derivative control of a postprocessor to match a target a target value.
  • RealFunctionControlSets the value of a 'Real' input parameters to the value of a provided function.
  • TimePeriodControl the enabled/disabled state of objects with time.
  • TimesEnableControlControl for enabling/disabling objects when a certain time is reached.
  • WebServerControlStarts a webserver for sending/receiving JSON messages to get data and control a running MOOSE calculation
  • Solid Mechanics App
  • AnalysisStepPeriodControl the enabled/disabled state of objects with user-provided analysis steps.
  • Stochastic Tools App
  • LibtorchDRLControlSets the value of multiple 'Real' input parameters and postprocessors based on a Deep Reinforcement Learning (DRL) neural network trained using a PPO algorithm.
  • MultiAppCommandLineControlControl for modifying the command line arguments of MultiApps.
  • MultiAppSamplerControlControl for modifying the command line arguments of MultiApps.
  • SamplerReceiverControl for receiving data from a Sampler via SamplerParameterTransfer.

Convergence

Correctors

Covariance

DGKernels

  • Moose App
  • AddDGKernelActionAdd a DGKernel object to the simulation.
  • ADDGAdvectionAdds internal face advection flux contributions for discontinuous Galerkin discretizations
  • ADDGDiffusionDG kernel for diffusion operator
  • ArrayDGDiffusionImplements interior penalty method for array diffusion equations.
  • ArrayHFEMDiffusionImposes the constraints on internal sides with HFEM.
  • DGConvectionDG upwinding for the convection
  • DGDiffusionComputes residual contribution for the diffusion operator using discontinous Galerkin method.
  • HFEMDiffusionImposes the constraints on internal sides with HFEM.
  • HFEMTestJumpImposes constraints for HFEM with side-discontinuous variables.
  • HFEMTrialJumpImposes constraints for HFEM with side-discontinuous variables.

Dampers

Debug

Debug/MaterialDerivativeTest

DeprecatedBlock

DiracKernels

Distributions

  • Moose App
  • AddDistributionActionAdd a Distribution object to the simulation.
  • Stochastic Tools App
  • BetaBeta distribution
  • FDistributionF-distribution or Fisher-Snedecor distribution
  • GammaGamma distribution
  • JohnsonSBJohnson Special Bounded (SB) distribution.
  • JohnsonSBDistributionJohnson Special Bounded (SB) distribution.
  • KernelDensity1DKernelDensity1D distribution
  • LogisticLogistic distribution.
  • LogisticDistributionLogistic distribution.
  • LognormalLognormal distribution
  • NormalNormal distribution
  • NormalDistributionNormal distribution
  • StudentTStudent t-distribution
  • TruncatedNormalTruncated normal distribution
  • TruncatedNormalDistributionTruncated normal distribution
  • UniformContinuous uniform distribution.
  • UniformDistributionContinuous uniform distribution.
  • WeibullThree-parameter Weibull distribution.
  • WeibullDistributionThree-parameter Weibull distribution.

DomainIntegral

  • Solid Mechanics App
  • DomainIntegralActionCreates the MOOSE objects needed to compute fraction domain integrals

Executioner

Executioner/Adaptivity

  • Moose App
  • AdaptivityActionAdd libMesh based adaptation schemes via the Executioner/Adaptivity input syntax.

Executioner/Predictor

  • Moose App
  • SetupPredictorActionAdd a Predictor object to the simulation.
  • AdamsPredictorImplements an explicit Adams predictor based on two old solution vectors.
  • SimplePredictorAlgorithm that will predict the next solution based on previous solutions.

Executioner/Quadrature

Executioner/TimeIntegrator

  • Moose App
  • SetupTimeIntegratorActionAdd a TimeIntegrator object to the simulation.
  • AStableDirk4Fourth-order diagonally implicit Runge Kutta method (Dirk) with three stages plus an update.
  • ActuallyExplicitEulerImplementation of Explicit/Forward Euler without invoking any of the nonlinear solver
  • BDF2Second order backward differentiation formula time integration scheme.
  • CentralDifferenceImplementation of explicit, Central Difference integration without invoking any of the nonlinear solver
  • CrankNicolsonCrank-Nicolson time integrator.
  • ExplicitEulerTime integration using the explicit Euler method.
  • ExplicitMidpointTime integration using the explicit midpoint method.
  • ExplicitSSPRungeKuttaExplicit strong stability preserving Runge-Kutta methods
  • ExplicitTVDRK2Explicit TVD (total-variation-diminishing) second-order Runge-Kutta time integration method.
  • HeunHeun's (aka improved Euler) time integration method.
  • ImplicitEulerTime integration using the implicit Euler method.
  • ImplicitMidpointSecond-order Runge-Kutta (implicit midpoint) time integration.
  • LStableDirk2Second order diagonally implicit Runge Kutta method (Dirk) with two stages.
  • LStableDirk3Third order diagonally implicit Runge Kutta method (Dirk) with three stages.
  • LStableDirk4Fourth-order diagonally implicit Runge Kutta method (Dirk) with five stages.
  • NewmarkBetaComputes the first and second time derivative of variable using Newmark-Beta method.
  • RalstonRalston's time integration method.
  • Solid Mechanics App
  • DirectCentralDifferenceImplementation of explicit time integration without invoking any of the nonlinear solver.
  • ExplicitMixedOrderImplementation of explicit time integration without invoking any of the nonlinear solver.

Executioner/TimeIntegrators

  • Moose App
  • SetupTimeIntegratorActionAdd a TimeIntegrator object to the simulation.
  • AStableDirk4Fourth-order diagonally implicit Runge Kutta method (Dirk) with three stages plus an update.
  • ActuallyExplicitEulerImplementation of Explicit/Forward Euler without invoking any of the nonlinear solver
  • BDF2Second order backward differentiation formula time integration scheme.
  • CentralDifferenceImplementation of explicit, Central Difference integration without invoking any of the nonlinear solver
  • CrankNicolsonCrank-Nicolson time integrator.
  • ExplicitEulerTime integration using the explicit Euler method.
  • ExplicitMidpointTime integration using the explicit midpoint method.
  • ExplicitSSPRungeKuttaExplicit strong stability preserving Runge-Kutta methods
  • ExplicitTVDRK2Explicit TVD (total-variation-diminishing) second-order Runge-Kutta time integration method.
  • HeunHeun's (aka improved Euler) time integration method.
  • ImplicitEulerTime integration using the implicit Euler method.
  • ImplicitMidpointSecond-order Runge-Kutta (implicit midpoint) time integration.
  • LStableDirk2Second order diagonally implicit Runge Kutta method (Dirk) with two stages.
  • LStableDirk3Third order diagonally implicit Runge Kutta method (Dirk) with three stages.
  • LStableDirk4Fourth-order diagonally implicit Runge Kutta method (Dirk) with five stages.
  • NewmarkBetaComputes the first and second time derivative of variable using Newmark-Beta method.
  • RalstonRalston's time integration method.
  • Solid Mechanics App
  • DirectCentralDifferenceImplementation of explicit time integration without invoking any of the nonlinear solver.
  • ExplicitMixedOrderImplementation of explicit time integration without invoking any of the nonlinear solver.

Executioner/TimeStepper

Executioner/TimeSteppers

Executors

ExplicitDynamicsContact

FVBCs

  • Moose App
  • CheckFVBCActionCheck that boundary conditions are defined correctly for finite volume problems.
  • AddFVBCActionAdd a FVBoundaryCondition object to the simulation.
  • FVADFunctorDirichletBCUses the value of a functor to set a Dirichlet boundary value.
  • FVBoundaryIntegralValueConstraintThis class is used to enforce integral of phi = boundary area * phi_0 with a Lagrange multiplier approach.
  • FVConstantScalarOutflowBCConstant velocity scalar advection boundary conditions for finite volume method.
  • FVDirichletBCDefines a Dirichlet boundary condition for finite volume method.
  • FVFunctionDirichletBCImposes the essential boundary condition , where is a (possibly) time and space-dependent MOOSE Function.
  • FVFunctionNeumannBCNeumann boundary condition for finite volume method.
  • FVFunctorDirichletBCUses the value of a functor to set a Dirichlet boundary value.
  • FVFunctorNeumannBCNeumann boundary condition for the finite volume method.
  • FVNeumannBCNeumann boundary condition for finite volume method.
  • FVOrthogonalBoundaryDiffusionImposes an orthogonal diffusion boundary term with specified boundary function.
  • FVPostprocessorDirichletBCDefines a Dirichlet boundary condition for finite volume method.
  • Heat Transfer App
  • FVFunctorConvectiveHeatFluxBCConvective heat transfer boundary condition with temperature and heat transfer coefficient given by functors.
  • FVFunctorRadiativeBCBoundary condition for radiative heat exchange where the emissivity function is supplied by a Function.
  • FVGaussianEnergyFluxBCDescribes an incoming heat flux beam with a Gaussian profile
  • FVInfiniteCylinderRadiativeBCBoundary condition for radiative heat exchange with a cylinder where the boundary is approximated as a cylinder as well.
  • FVMarshakRadiativeBCMarshak boundary condition for radiative heat flux.
  • FVThermalResistanceBCThermal resistance Heat flux boundary condition for the fluid and solid energy equations
  • FunctorThermalResistanceBCThermal resistance heat flux boundary condition for the fluid and solid energy equations

FVICs

  • Moose App
  • AddFVInitialConditionActionAdd an FVInitialCondition object to the simulation.
  • FVConstantICSets a constant field value.
  • FVFunctionICAn initial condition that uses a normal function of x, y, z to produce values (and optionally gradients) for a field variable.

FVInterfaceKernels

FVKernels

  • Moose App
  • AddFVKernelActionAdd a FVKernel object to the simulation.
  • FVAdvectionResidual contribution from advection operator for finite volume method.
  • FVAnisotropicDiffusionComputes residual for anisotropic diffusion operator for finite volume method.
  • FVBodyForceDemonstrates the multiple ways that scalar values can be introduced into finite volume kernels, e.g. (controllable) constants, functions, and postprocessors.
  • FVBoundedValueConstraintThis class is used to enforce a min or max value for a finite volume variable
  • FVCoupledForceImplements a source term proportional to the value of a coupled variable.
  • FVDiffusionComputes residual for diffusion operator for finite volume method.
  • FVDivergenceComputes the residual coming from the divergence of a vector fieldthat can be represented as a functor.
  • FVFunctorTimeKernelResidual contribution from time derivative of an AD functor (default is the variable this kernel is acting upon if the 'functor' parameter is not supplied) for the finite volume method.
  • FVIntegralValueConstraintThis class is used to enforce integral of phi = volume * phi_0 with a Lagrange multiplier approach.
  • FVMassMatrixComputes a 'mass matrix', which will just be a diagonal matrix for the finite volume method, meant for use in preconditioning schemes which require one
  • FVMatAdvectionComputes the residual of advective term using finite volume method.
  • FVOrthogonalDiffusionImposes an orthogonal diffusion term.
  • FVPointValueConstraintThis class is used to enforce integral of phi = volume * phi_0 with a Lagrange multiplier approach.
  • FVReactionSimple consuming reaction term
  • FVScalarLagrangeMultiplierThis class is used to enforce integral of phi = volume * phi_0 with a Lagrange multiplier approach.
  • FVTimeKernelResidual contribution from time derivative of a variable for the finite volume method.
  • Heat Transfer App
  • FVFunctorHeatConductionTimeDerivativeAD Time derivative term of the heat equation for quasi-constant specific heat and the density .
  • FVHeatConductionTimeDerivativeAD Time derivative term of the heat equation for quasi-constant specific heat and the density .
  • FVThermalRadiationSourceSinkImplements the source and the sink terms for radiation heat transfer.

Functions

  • Moose App
  • AddFunctionActionAdd a Function object to the simulation.
  • ADParsedFunctionFunction created by parsing a string
  • ADPiecewiseLinearLinearly interpolates between pairs of x-y data
  • Axisymmetric2D3DSolutionFunctionFunction for reading a 2D axisymmetric solution from file and mapping it to a 3D Cartesian model
  • BicubicSplineFunctionDefine a bicubic spline function from interpolated data defined by input parameters.
  • CoarsenedPiecewiseLinearPerform a point reduction of the tabulated data upon initialization, then evaluate using a linear interpolation.
  • CompositeFunctionMultiplies an arbitrary set of functions together
  • ConstantFunctionA function that returns a constant value as defined by an input parameter.
  • ImageFunctionFunction with values sampled from an image or image stack.
  • LinearCombinationFunctionReturns the linear combination of the functions
  • ParsedFunctionFunction created by parsing a string
  • ParsedGradFunctionDefines a function and its gradient using input file parameters.
  • ParsedVectorFunctionReturns a vector function based on string descriptions for each component.
  • PeriodicFunctionProvides a periodic function by repeating a user-supplied base function in time and/or any of the three Cartesian coordinate directions
  • PiecewiseBilinearInterpolates values from a csv file
  • PiecewiseConstantDefines data using a set of x-y data pairs
  • PiecewiseConstantFromCSVUses data read from CSV to assign values
  • PiecewiseLinearLinearly interpolates between pairs of x-y data
  • PiecewiseLinearFromVectorPostprocessorProvides piecewise linear interpolation of from two columns of a VectorPostprocessor
  • PiecewiseMultiConstantPiecewiseMulticonstant performs constant interpolation on 1D, 2D, 3D or 4D data. The data_file specifies the axes directions and the function values. If a point lies outside the data range, the appropriate end value is used.
  • PiecewiseMulticonstantPiecewiseMulticonstant performs constant interpolation on 1D, 2D, 3D or 4D data. The data_file specifies the axes directions and the function values. If a point lies outside the data range, the appropriate end value is used.
  • PiecewiseMultilinearPiecewiseMultilinear performs linear interpolation on 1D, 2D, 3D or 4D data. The data_file specifies the axes directions and the function values. If a point lies outside the data range, the appropriate end value is used.
  • SolutionFunctionFunction for reading a solution from file.
  • SplineFunctionDefine a spline function from interpolated data defined by input parameters.
  • VectorPostprocessorFunctionProvides piecewise linear interpolation of from two columns of a VectorPostprocessor
  • Stochastic Tools App
  • ScaledAbsDifferenceDRLRewardFunctionEvaluates a scaled absolute difference reward function for a process which is controlled by a Deep Reinforcement Learning based surrogate.

FunctorMaterials

GlobalParams

  • Moose App
  • GlobalParamsActionAction used to aid in the application of parameters defined in the GlobalParams input block.

GrayDiffuseRadiation

  • Heat Transfer App
  • RadiationTransferActionThis action sets up the net radiation calculation between specified sidesets.

HDGKernels

  • Moose App
  • AddHDGKernelActionAdd a hybridized kernel object to the simulation.
  • AdvectionIPHDGKernelAdds element and interior face integrals for a hybridized interior penalty discontinuous Galerkin discretization of an advection term.
  • DiffusionIPHDGKernelAdds the element and interior face weak forms for a hybridized interior penalty discontinuous Galerkin discretization of a diffusion term.
  • DiffusionLHDGKernelAdds the element and interior face weak forms for a hybridized local discontinuous Galerkin discretization of a diffusion term.

ICs

  • Moose App
  • AddInitialConditionActionAdd an InitialCondition object to the simulation.
  • ArrayConstantICSets constant component values for an array field variable.
  • ArrayFunctionICAn initial condition that uses a normal function of x, y, z to produce values (and optionally gradients) for a field variable.
  • BoundingBoxICBoundingBoxIC allows setting the initial condition of a value inside and outside of a specified box. The box is aligned with the x, y, z axes
  • ConstantICSets a constant field value.
  • FunctionICAn initial condition that uses a normal function of x, y, z to produce values (and optionally gradients) for a field variable.
  • FunctionScalarICInitializes a scalar variable using a function.
  • FunctorICAn initial condition that uses a normal function of x, y, z to produce values (and optionally gradients) for a field variable.
  • IntegralPreservingFunctionICFunction initial condition that preserves an integral
  • RandomICInitialize a variable with randomly generated numbers following either a uniform distribution or a user-defined distribution
  • ScalarComponentICInitial condition to set different values on each component of scalar variable.
  • ScalarConstantICInitalize a scalar variable with a constant value prescribed by an input parameter.
  • ScalarSolutionICSets the initial condition from a scalar variable stored in an Exodus file, retrieved by a SolutionUserObject
  • ScalarSolutionInitialConditionSets the initial condition from a scalar variable stored in an Exodus file, retrieved by a SolutionUserObject
  • SolutionICSets the initial condition from a field variable stored in an Exodus file, retrieved by a SolutionUserObject
  • SolutionInitialConditionSets the initial condition from a field variable stored in an Exodus file, retrieved by a SolutionUserObject
  • VectorConstantICSets constant component values for a vector field variable.
  • VectorFunctionICSets component values for a vector field variable based on a vector function.
  • Solid Mechanics App
  • VolumeWeightedWeibullInitialize a variable with randomly generated numbers following a volume-weighted Weibull distribution

InterfaceKernels

Kernels

  • Moose App
  • AddKernelActionAdd a Kernel object to the simulation.
  • ADBodyForceDemonstrates the multiple ways that scalar values can be introduced into kernels, e.g. (controllable) constants, functions, and postprocessors. Implements the weak form .
  • ADCoefReactionImplements the residual term (p*u, test)
  • ADConservativeAdvectionConservative form of which in its weak form is given by: .
  • ADCoupledForceImplements a source term proportional to the value of a coupled variable. Weak form: .
  • ADCoupledTimeDerivativeTime derivative Kernel that acts on a coupled variable. Weak form: .
  • ADDiffusionSame as Diffusion in terms of physics/residual, but the Jacobian is computed using forward automatic differentiation
  • ADMatBodyForceKernel that defines a body force modified by a material property
  • ADMatCoupledForceKernel representing the contribution of the PDE term , where is a material property coefficient, is a coupled scalar field variable, and Jacobian derivatives are calculated using automatic differentiation.
  • ADMatDiffusionDiffusion equation kernel that takes an isotropic diffusivity from a material property
  • ADMatReactionKernel representing the contribution of the PDE term , where is a reaction rate material property, is a scalar variable (nonlinear or coupled), and whose Jacobian contribution is calculated using automatic differentiation.
  • ADMaterialPropertyValueResidual term (u - prop) to set variable u equal to a given material property prop
  • ADReactionImplements a simple consuming reaction term with weak form .
  • ADScalarLMKernelThis class is used to enforce integral of phi = V_0 with a Lagrange multiplier approach.
  • ADTimeDerivativeThe time derivative operator with the weak form of .
  • ADVectorDiffusionThe Laplacian operator (), with the weak form of . The Jacobian is computed using automatic differentiation
  • ADVectorTimeDerivativeThe time derivative operator with the weak form of .
  • AnisotropicDiffusionAnisotropic diffusion kernel with weak form given by .
  • ArrayBodyForceApplies body forces specified with functions to an array variable.
  • ArrayCoupledTimeDerivativeTime derivative Array Kernel that acts on a coupled variable. Weak form: . The coupled variable and the variable must have the same dimensionality
  • ArrayDiffusionThe array Laplacian operator (), with the weak form of .
  • ArrayReactionThe array reaction operator with the weak form of .
  • ArrayTimeDerivativeArray time derivative operator with the weak form of .
  • BodyForceDemonstrates the multiple ways that scalar values can be introduced into kernels, e.g. (controllable) constants, functions, and postprocessors. Implements the weak form .
  • CoefReactionImplements the residual term (p*u, test)
  • CoefTimeDerivativeThe time derivative operator with the weak form of .
  • ConservativeAdvectionConservative form of which in its weak form is given by: .
  • CoupledForceImplements a source term proportional to the value of a coupled variable. Weak form: .
  • CoupledTimeDerivativeTime derivative Kernel that acts on a coupled variable. Weak form: .
  • DiffusionThe Laplacian operator (), with the weak form of .
  • DivFieldThe divergence operator optionally scaled by a constant scalar coefficient. Weak form: .
  • FunctionDiffusionDiffusion with a function coefficient.
  • FunctorKernelAdds a term from a functor.
  • GradFieldThe gradient operator optionally scaled by a constant scalar coefficient. Weak form: .
  • MassEigenKernelAn eigenkernel with weak form where is the eigenvalue.
  • MassLumpedTimeDerivativeLumped formulation of the time derivative . Its corresponding weak form is where denotes the time derivative of the solution coefficient associated with node .
  • MassMatrixComputes a finite element mass matrix
  • MatBodyForceKernel that defines a body force modified by a material property
  • MatCoupledForceImplements a forcing term RHS of the form PDE = RHS, where RHS = Sum_j c_j * m_j * v_j. c_j, m_j, and v_j are provided as real coefficients, material properties, and coupled variables, respectively.
  • MatDiffusionDiffusion equation Kernel that takes an isotropic Diffusivity from a material property
  • MatReactionKernel to add -L*v, where L=reaction rate, v=variable
  • MaterialDerivativeRankFourTestKernelClass used for testing derivatives of a rank four tensor material property.
  • MaterialDerivativeRankTwoTestKernelClass used for testing derivatives of a rank two tensor material property.
  • MaterialDerivativeTestKernelClass used for testing derivatives of a scalar material property.
  • MaterialPropertyValueResidual term (u - prop) to set variable u equal to a given material property prop
  • NullKernelKernel that sets a zero residual.
  • ReactionImplements a simple consuming reaction term with weak form .
  • ScalarLMKernelThis class is used to enforce integral of phi = V_0 with a Lagrange multiplier approach.
  • ScalarLagrangeMultiplierThis class is used to enforce integral of phi = V_0 with a Lagrange multiplier approach.
  • TimeDerivativeThe time derivative operator with the weak form of .
  • UserForcingFunctionDemonstrates the multiple ways that scalar values can be introduced into kernels, e.g. (controllable) constants, functions, and postprocessors. Implements the weak form .
  • VectorBodyForceDemonstrates the multiple ways that scalar values can be introduced into kernels, e.g. (controllable) constants, functions, and postprocessors. Implements the weak form .
  • VectorCoupledTimeDerivativeTime derivative Kernel that acts on a coupled vector variable. Weak form: .
  • VectorDiffusionThe Laplacian operator (), with the weak form of .
  • VectorFunctionReactionKernel representing the contribution of the PDE term , where is a function coefficient and is a vector variable.
  • VectorTimeDerivativeThe time derivative operator with the weak form of .
  • Heat Transfer App
  • ADHeatConductionSame as Diffusion in terms of physics/residual, but the Jacobian is computed using forward automatic differentiation
  • ADHeatConductionTimeDerivativeAD Time derivative term of the heat equation for quasi-constant specific heat and the density .
  • ADJouleHeatingSourceCalculates the heat source term corresponding to electrostatic or electromagnetic Joule heating, with Jacobian contributions calculated using the automatic differentiation system.
  • ADMatHeatSourceForce term in thermal transport to represent a heat source
  • AnisoHeatConductionAnisotropic diffusive heat conduction term of the thermal energy conservation equation
  • AnisoHomogenizedHeatConductionKernel for asymptotic expansion homogenization for thermal conductivity when anisotropic thermal conductivities are used
  • HeatCapacityConductionTimeDerivativeTime derivative term of the heat equation with the heat capacity as an argument.
  • HeatConductionDiffusive heat conduction term of the thermal energy conservation equation
  • HeatConductionTimeDerivativeTime derivative term of the thermal energy conservation equation.
  • HeatSourceDemonstrates the multiple ways that scalar values can be introduced into kernels, e.g. (controllable) constants, functions, and postprocessors. Implements the weak form .
  • HomogenizedHeatConductionKernel for asymptotic expansion homogenization for thermal conductivity
  • JouleHeatingSourceCalculates the heat source term corresponding to electrostatic Joule heating.
  • SpecificHeatConductionTimeDerivativeTime derivative term of the heat equation with the specific heat and the density as arguments.
  • TrussHeatConductionComputes conduction term in heat equation for truss elements, taking cross-sectional area into account
  • TrussHeatConductionTimeDerivativeComputes time derivative term in heat equation for truss elements, taking cross-sectional area into account
  • Solid Mechanics App
  • ADDistributedLoadShellApplies a distributed load (specified in units of force per area) on the shell plane in a given direction (e.g. self_weight, wind load) or normal to the shell plan (e.g. pressure loads)
  • ADDynamicStressDivergenceTensorsResidual due to stress related Rayleigh damping and HHT time integration terms
  • ADGravityApply gravity. Value is in units of acceleration.
  • ADInertialForceCalculates the residual for the inertial force () and the contribution of mass dependent Rayleigh damping and HHT time integration scheme ($\eta \cdot M \cdot ((1+\alpha)velq2-\alpha \cdot vel-old) $)
  • ADInertialForceShellCalculates the residual for the inertial force/moment and the contribution of mass dependent Rayleigh damping and HHT time integration scheme.
  • ADStressDivergenceRSphericalTensorsCalculate stress divergence for a spherically symmetric 1D problem in polar coordinates.
  • ADStressDivergenceRZTensorsCalculate stress divergence for an axisymmetric problem in cylindrical coordinates.
  • ADStressDivergenceShellQuasi-static stress divergence kernel for Shell element
  • ADStressDivergenceTensorsStress divergence kernel with automatic differentiation for the Cartesian coordinate system
  • ADSymmetricStressDivergenceTensorsStress divergence kernel with automatic differentiation for the Cartesian coordinate system
  • ADWeakPlaneStressPlane stress kernel to provide out-of-plane strain contribution.
  • AsymptoticExpansionHomogenizationKernelKernel for asymptotic expansion homogenization for elasticity
  • CosseratStressDivergenceTensorsStress divergence tensor with the additional Jacobian terms for the Cosserat rotation variables.
  • DynamicStressDivergenceTensorsResidual due to stress related Rayleigh damping and HHT time integration terms
  • GeneralizedPlaneStrainOffDiagGeneralized Plane Strain kernel to provide contribution of the out-of-plane strain to other kernels
  • GravityApply gravity. Value is in units of acceleration.
  • HomogenizedTotalLagrangianStressDivergenceTotal Lagrangian stress equilibrium kernel with homogenization constraint Jacobian terms
  • InertialForceCalculates the residual for the inertial force () and the contribution of mass dependent Rayleigh damping and HHT time integration scheme ($\eta \cdot M \cdot ((1+\alpha)velq2-\alpha \cdot vel-old) $)
  • InertialForceBeamCalculates the residual for the inertial force/moment and the contribution of mass dependent Rayleigh damping and HHT time integration scheme.
  • InertialTorqueKernel for inertial torque: density * displacement x acceleration
  • MaterialVectorBodyForceApply a body force vector to the coupled displacement component.
  • MomentBalancingBalance of momentum for three-dimensional Cosserat media, notably in a Cosserat layered elasticity model.
  • OutOfPlanePressureApply pressure in the out-of-plane direction in 2D plane stress or generalized plane strain models
  • PhaseFieldFractureMechanicsOffDiagStress divergence kernel for phase-field fracture: Computes off diagonal damage dependent Jacobian components. To be used with StressDivergenceTensors or DynamicStressDivergenceTensors.
  • PlasticHeatEnergyPlastic heat energy density = coeff * stress * plastic_strain_rate
  • PoroMechanicsCouplingAdds , where the subscript is the component.
  • StressDivergenceBeamQuasi-static and dynamic stress divergence kernel for Beam element
  • StressDivergenceRSphericalTensorsCalculate stress divergence for a spherically symmetric 1D problem in polar coordinates.
  • StressDivergenceRZTensorsCalculate stress divergence for an axisymmetric problem in cylindrical coordinates.
  • StressDivergenceTensorsStress divergence kernel for the Cartesian coordinate system
  • StressDivergenceTensorsTrussKernel for truss element
  • TotalLagrangianStressDivergenceEnforce equilibrium with a total Lagrangian formulation in Cartesian coordinates.
  • TotalLagrangianStressDivergenceAxisymmetricCylindricalEnforce equilibrium with a total Lagrangian formulation in axisymmetric cylindrical coordinates.
  • TotalLagrangianStressDivergenceCentrosymmetricSphericalEnforce equilibrium with a total Lagrangian formulation in centrosymmetric spherical coordinates.
  • TotalLagrangianWeakPlaneStressPlane stress kernel to provide out-of-plane strain contribution.
  • UpdatedLagrangianStressDivergenceEnforce equilibrium with an updated Lagrangian formulation in Cartesian coordinates.
  • WeakPlaneStressPlane stress kernel to provide out-of-plane strain contribution.
  • DynamicSolidMechanics
  • DynamicTensorMechanics
  • PoroMechanics
  • SolidMechanics
  • TensorMechanics
  • XFEMApp
  • CrackTipEnrichmentStressDivergenceTensorsEnrich stress divergence kernel for small-strain simulations
  • Misc App
  • ADThermoDiffusionCalculates diffusion due to temperature gradient and Soret Coefficient
  • CoefDiffusionKernel for diffusion with diffusivity = coef + function
  • ThermoDiffusionKernel for thermo-diffusion (Soret effect, thermophoresis, etc.)
  • Black Bear App
  • ConcreteLatentHeatLatent heat term for heat transfer in concrete.
  • ConcreteMoistureDiffusionFickian and Soret diffusion terms for moisture transfer in concrete.
  • ConcreteMoistureTimeIntegrationTime derivative term for moisture transport in concrete.
  • ConcreteMoistureTimeIntegrationMassLumpedTime derivative term with mass lumping for moisture transport in concrete.
  • ConcreteThermalConductionConduction term for thermal transport in concrete.
  • ConcreteThermalConvectionConvective transport term for heat transfer due to fluid flow in concrete.
  • ConcreteThermalTimeIntegrationTime derivative term for heat transfer in concrete.

Kernels/DynamicSolidMechanics

Kernels/DynamicTensorMechanics

Kernels/PoroMechanics

Kernels/SolidMechanics

Kernels/TensorMechanics

Likelihood

  • Stochastic Tools App
  • AddLikelihoodActionAdds Likelihood objects.
  • ExtremeValueGeneralized extreme value likelihood function evaluating the model goodness against experiments.
  • GaussianGaussian likelihood function evaluating the model goodness against experiments.
  • TruncatedGaussianTruncatedGaussian likelihood function evaluating the model goodness against experiments.

LinearFVBCs

  • Moose App
  • AddLinearFVBCActionAdd a LinearFVBoundaryCondition object to the simulation.
  • LinearFVAdvectionDiffusionExtrapolatedBCAdds a boundary condition which calculates the face values and face gradients assuming one or two term expansions from the cell centroid. This kernel is only compatible with advection-diffusion problems.
  • LinearFVAdvectionDiffusionFunctorDirichletBCAdds a dirichlet BC which can be used for the assembly of linear finite volume system and whose face values are determined using a functor. This kernel is only designed to work with advection-diffusion problems.
  • LinearFVAdvectionDiffusionFunctorNeumannBCAdds a fixed diffusive flux BC which can be used for the assembly of linear finite volume system and whose normal face gradient values are determined using a functor. This kernel is only designed to work with advection-diffusion problems.
  • LinearFVAdvectionDiffusionOutflowBCAdds a boundary condition which represents a surface with outflowing material with a constant velocity. This kernel is only compatible with advection-diffusion problems.

LinearFVKernels

  • Moose App
  • AddLinearFVKernelActionAdd a LinearFVKernel object to the simulation.
  • LinearFVAdvectionRepresents the matrix and right hand side contributions of an advection term in a partial differential equation.
  • LinearFVAnisotropicDiffusionRepresents the matrix and right hand side contributions of a diffusion term in a partial differential equation.
  • LinearFVDiffusionRepresents the matrix and right hand side contributions of a diffusion term in a partial differential equation.
  • LinearFVReactionRepresents the matrix and right hand side contributions of a reaction term () in a partial differential equation.
  • LinearFVSourceRepresents the matrix and right hand side contributions of a solution-independent source term in a partial differential equation.
  • LinearFVTimeDerivativeRepresents the matrix and right hand side contributions of a time derivative term in a partial differential equation.

Materials

Mesh

  • Moose App
  • CreateDisplacedProblemActionCreate a Problem object that utilizes displacements.
  • DisplayGhostingActionAction to setup AuxVariables and AuxKernels to display ghosting when running in parallel
  • ElementIDOutputActionAction for copying extra element IDs into auxiliary variables for output.
  • SetupMeshActionAdd or create Mesh object to the simulation.
  • SetupMeshCompleteActionPerform operations on the mesh in preparation for a simulation.
  • AddMeshGeneratorActionAdd a MeshGenerator object to the simulation.
  • AddMetaDataGeneratorThis mesh generator assigns extraneous mesh metadata to the input mesh
  • AdvancedExtruderGeneratorExtrudes a 1D mesh into 2D, or a 2D mesh into 3D, can have a variable height for each elevation, variable number of layers within each elevation, variable growth factors of axial element sizes within each elevation and remap subdomain_ids, boundary_ids and element extra integers within each elevation as well as interface boundaries between neighboring elevation layers.
  • AllSideSetsByNormalsGeneratorAdds sidesets to the entire mesh based on unique normals.
  • AnnularMeshGeneratorFor rmin>0: creates an annular mesh of QUAD4 elements. For rmin=0: creates a disc mesh of QUAD4 and TRI3 elements. Boundary sidesets are created at rmax and rmin, and given these names. If dmin!0 and dmax!360, a sector of an annulus or disc is created. In this case boundary sidesets are also created at dmin and dmax, and given these names
  • BlockDeletionGeneratorMesh generator which removes elements from the specified subdomains
  • BlockToMeshConverterGeneratorConverts one or more blocks (subdomains) from a mesh into a stand-alone mesh with a single block in it.
  • BoundaryDeletionGeneratorMesh generator which removes side sets
  • BoundaryLayerSubdomainGeneratorChanges the subdomain ID of elements near the specified boundary(ies).
  • BoundingBoxNodeSetGeneratorAssigns all of the nodes either inside or outside of a bounding box to a new nodeset.
  • BreakBoundaryOnSubdomainGeneratorBreak boundaries based on the subdomains to which their sides are attached. Naming convention for the new boundaries will be the old boundary name plus "_to_" plus the subdomain name
  • BreakMeshByBlockGeneratorBreak the mesh at interfaces between blocks. New nodes will be generated so elements on each side of the break are no longer connected. At the moment, this only works on a REPLICATED mesh
  • BreakMeshByElementGeneratorBreak all element-element interfaces in the specified subdomains.
  • CartesianMeshGeneratorThis CartesianMeshGenerator creates a non-uniform Cartesian mesh.
  • CircularBoundaryCorrectionGeneratorThis CircularBoundaryCorrectionGenerator object is designed to correct full or partial circular boundaries in a 2D mesh to preserve areas.
  • CoarsenBlockGeneratorMesh generator which coarsens one or more blocks in an existing mesh. The coarsening algorithm works best for regular meshes.
  • CombinerGeneratorCombine multiple meshes (or copies of one mesh) together into one (disjoint) mesh. Can optionally translate those meshes before combining them.
  • ConcentricCircleMeshGeneratorThis ConcentricCircleMeshGenerator source code is to generate concentric circle meshes.
  • CutMeshByLevelSetGeneratorThis CutMeshByLevelSetGenerator object is designed to trim the input mesh by removing all the elements on outside the give level set with special processing on the elements crossed by the cutting surface to ensure a smooth cross-section. The output mesh only consists of TET4 elements.
  • CutMeshByPlaneGeneratorThis CutMeshByPlaneGenerator object is designed to trim the input mesh by removing all the elements on one side of a given plane with special processing on the elements crossed by the cutting plane to ensure a smooth cross-section. The output mesh only consists of TET4 elements.
  • DistributedRectilinearMeshGeneratorCreate a line, square, or cube mesh with uniformly spaced or biased elements.
  • ElementGeneratorGenerates individual elements given a list of nodal positions.
  • ElementOrderConversionGeneratorMesh generator which converts orders of elements
  • ElementSubdomainIDGeneratorAllows the user to assign each element the subdomain ID of their choice
  • ElementsToSimplicesConverterSplits all non-simplex elements in a mesh into simplices.
  • ElementsToTetrahedronsConverterThis ElementsToTetrahedronsConverter object is designed to convert all the elements in a 3D mesh consisting only linear elements into TET4 elements.
  • ExamplePatchMeshGeneratorCreates 2D or 3D patch meshes.
  • ExplodeMeshGeneratorBreak all element-element interfaces in the specified subdomains.
  • ExtraNodesetGeneratorCreates a new node set and a new boundary made with the nodes the user provides.
  • FancyExtruderGeneratorExtrudes a 1D mesh into 2D, or a 2D mesh into 3D, can have a variable height for each elevation, variable number of layers within each elevation, variable growth factors of axial element sizes within each elevation and remap subdomain_ids, boundary_ids and element extra integers within each elevation as well as interface boundaries between neighboring elevation layers.
  • FileMeshGeneratorRead a mesh from a file.
  • FillBetweenCurvesGeneratorThis FillBetweenCurvesGenerator object is designed to generate a transition layer to connect two boundaries of two input meshes.
  • FillBetweenPointVectorsGeneratorThis FillBetweenPointVectorsGenerator object is designed to generate a transition layer with two sides containing different numbers of nodes.
  • FillBetweenSidesetsGeneratorThis FillBetweenSidesetsGenerator object is designed to generate a transition layer to connect two boundaries of two input meshes.
  • FlipSidesetGeneratorA Mesh Generator which flips a given sideset
  • GeneratedMeshGeneratorCreate a line, square, or cube mesh with uniformly spaced or biased elements.
  • ImageMeshGeneratorGenerated mesh with the aspect ratio of a given image stack.
  • ImageSubdomainGeneratorSamples an image at the coordinates of each element centroid, using the resulting pixel color value as each element's subdomain ID
  • LowerDBlockFromSidesetGeneratorAdds lower dimensional elements on the specified sidesets.
  • MeshCollectionGeneratorCollects multiple meshes into a single (unconnected) mesh.
  • MeshDiagnosticsGeneratorRuns a series of diagnostics on the mesh to detect potential issues such as unsupported features
  • MeshExtruderGeneratorTakes a 1D or 2D mesh and extrudes the entire structure along the specified axis increasing the dimensionality of the mesh.
  • MeshRepairGeneratorMesh generator to perform various improvement / fixing operations on an input mesh
  • MoveNodeGeneratorModifies the position of one or more nodes
  • NodeSetsFromSideSetsGeneratorMesh generator which constructs node sets from side sets
  • OrientedSubdomainBoundingBoxGeneratorDefines a subdomain inside or outside of a bounding box with arbitrary orientation.
  • OverlayMeshGeneratorCreates a Cartesian mesh overlaying the input mesh region.
  • ParsedCurveGeneratorThis ParsedCurveGenerator object is designed to generate a mesh of a curve that consists of EDGE2, EDGE3, or EDGE4 elements.
  • ParsedElementDeletionGeneratorRemoves elements such that the parsed expression is evaluated as strictly positive. The parameters of the parsed expression can be the X,Y,Z coordinates of the element vertex average (must be 'x','y','z' in the expression), the element volume (must be 'volume' in the expression) and the element id ('id' in the expression).
  • ParsedExtraElementIDGeneratorUses a parsed expression to set an extra element id for elements (via their centroids).
  • ParsedGenerateNodesetA MeshGenerator that adds nodes to a nodeset if the node satisfies the expression expression.
  • ParsedGenerateSidesetA MeshGenerator that adds element sides to a sideset if the centroid of the side satisfies the combinatorial_geometry expression.
  • ParsedNodeTransformGeneratorApplies a transform to a the x,y,z coordinates of a Mesh
  • ParsedSubdomainIDsGeneratorUses a parsed expression to determine the subdomain ids of included elements.
  • ParsedSubdomainMeshGeneratorUses a parsed expression (combinatorial_geometry) to determine if an element (via its centroid) is inside the region defined by the expression and assigns a new block ID.
  • PatchMeshGeneratorCreates 2D or 3D patch meshes.
  • PatternedMeshGeneratorCreates a 2D mesh from a specified set of unique 'tiles' meshes and a two-dimensional pattern.
  • PlaneDeletionGeneratorRemoves elements lying 'above' the plane (in the direction of the normal).
  • PlaneIDMeshGeneratorAdds an extra element integer that identifies planes in a mesh.
  • PolyLineMeshGeneratorGenerates meshes from edges connecting a list of points.
  • RefineBlockGeneratorMesh generator which refines one or more blocks in an existing mesh
  • RefineSidesetGeneratorMesh generator which refines one or more sidesets
  • RenameBlockGeneratorChanges the block IDs and/or block names for a given set of blocks defined by either block ID or block name. The changes are independent of ordering. The merging of blocks is supported.
  • RenameBoundaryGeneratorChanges the boundary IDs and/or boundary names for a given set of boundaries defined by either boundary ID or boundary name. The changes are independent of ordering. The merging of boundaries is supported.
  • RinglebMeshGeneratorCreates a mesh for the Ringleb problem.
  • SideSetExtruderGeneratorTakes a 1D or 2D mesh and extrudes a selected sideset along the specified axis.
  • SideSetsAroundSubdomainGeneratorAdds element faces that are on the exterior of the given block to the sidesets specified
  • SideSetsBetweenSubdomainsGeneratorMeshGenerator that creates a sideset composed of the nodes located between two or more subdomains.
  • SideSetsFromBoundingBoxGeneratorDefines new sidesets using currently-defined sideset IDs inside or outside of a bounding box.
  • SideSetsFromNodeSetsGeneratorMesh generator which constructs side sets from node sets
  • SideSetsFromNormalsGeneratorAdds a new named sideset to the mesh for all faces matching the specified normal.
  • SideSetsFromPointsGeneratorAdds a new sideset starting at the specified point containing all connected element faces with the same normal.
  • SmoothMeshGeneratorUtilizes a simple Laplacian based smoother to attempt to improve mesh quality. Will not move boundary nodes or nodes along block/subdomain boundaries
  • SphereMeshGeneratorGenerate a 3-D sphere mesh centered on the origin
  • SpiralAnnularMeshGeneratorCreates an annular mesh based on TRI3 or TRI6 elements on several rings.
  • StackGeneratorUse the supplied meshes and stitch them on top of each other
  • StitchBoundaryMeshGeneratorAllows a pair of boundaries to be stitched together.
  • StitchedMeshGeneratorAllows multiple mesh files to be stitched together to form a single mesh.
  • SubdomainBoundingBoxGeneratorChanges the subdomain ID of elements either (XOR) inside or outside the specified box to the specified ID.
  • SubdomainIDGeneratorSets all the elements of the input mesh to a unique subdomain ID.
  • SubdomainPerElementGeneratorAllows the user to assign each element the subdomain ID of their choice
  • SymmetryTransformGeneratorApplies a symmetry transformation to the entire mesh.
  • TiledMeshGeneratorUse the supplied mesh and create a tiled grid by repeating this mesh in the x, y, and z directions.
  • TransfiniteMeshGeneratorCreates a QUAD4 mesh given a set of corner vertices and edge types. The edge type can be either LINE, CIRCARC, DISCRETE or PARSED, with LINE as the default option. For the non-default options the user needs to specify additional parameters via the edge_parameter option as follows: for CIRCARC the deviation of the midpoint from an arccircle, for DISCRETE a set of points, or a paramterization via the PARSED option. Opposite edges may have different distributions s long as the number of points is identical. Along opposite edges a different point distribution can be prescribed via the options bias_x or bias_y for opposing edges.
  • TransformGeneratorApplies a linear transform to the entire mesh.
  • UniqueExtraIDMeshGeneratorAdd a new extra element integer ID by finding unique combinations of the existing extra element integer ID values
  • XYDelaunayGeneratorTriangulates meshes within boundaries defined by input meshes.
  • XYMeshLineCutterThis XYMeshLineCutter object is designed to trim the input mesh by removing all the elements on one side of a given straight line with special processing on the elements crossed by the cutting line to ensure a smooth cross-section.
  • XYZDelaunayGeneratorCreates tetrahedral 3D meshes within boundaries defined by input meshes.
  • AnnularMeshFor rmin>0: creates an annular mesh of QUAD4 elements. For rmin=0: creates a disc mesh of QUAD4 and TRI3 elements. Boundary sidesets are created at rmax and rmin, and given these names. If dmin!0 and dmax!360, a sector of an annulus or disc is created. In this case boundary sidesets are also created a dmin and dmax, and given these names
  • ConcentricCircleMeshThis ConcentricCircleMesh source code is to generate concentric circle meshes.
  • FileMeshRead a mesh from a file.
  • GeneratedMeshCreate a line, square, or cube mesh with uniformly spaced or biased elements.
  • ImageMeshGenerated mesh with the aspect ratio of a given image stack.
  • MeshGeneratorMeshMesh generated using mesh generators
  • PatternedMeshCreates a 2D mesh from a specified set of unique 'tiles' meshes and a two-dimensional pattern.
  • RinglebMeshCreates a mesh for the Ringleb problem.
  • SpiralAnnularMeshCreates an annual mesh based on TRI3 elements (it can also be TRI6 elements) on several rings.
  • StitchedMeshReads in all of the given meshes and stitches them all together into one mesh.
  • TiledMeshUse the supplied mesh and create a tiled grid by repeating this mesh in the x,y, and z directions.
  • BatchMeshGeneratorAction
  • Partitioner
  • Heat Transfer App
  • PatchSidesetGeneratorDivides the given sideset into smaller patches of roughly equal size.

Mesh/BatchMeshGeneratorAction

Mesh/Partitioner

  • Moose App
  • PartitionerActionAdd a Partitioner object to the simulation.
  • BlockWeightedPartitionerPartition mesh by weighting blocks
  • CopyMeshPartitionerAssigns element to match the partitioning of another mesh. If in a child application, defaults to the parent app mesh if the other mesh is not specified programmatically.
  • GridPartitionerCreate a uniform grid that overlays the mesh to be partitioned. Assign all elements within each cell of the grid to the same processor.
  • HierarchicalGridPartitionerPartitions a mesh into sub-partitions for each computational node then into partitions within that node. All partitions are made using a regular grid.
  • LibmeshPartitionerMesh partitioning using capabilities defined in libMesh.
  • PetscExternalPartitionerPartition mesh using external packages via PETSc MatPartitioning interface
  • RandomPartitionerAssigns element processor ids randomly with a given seed.
  • SingleRankPartitionerAssigns element processor ids to a single MPI rank.

MeshDivisions

  • Moose App
  • AddMeshDivisionActionAdd a MeshDivision object to the simulation.
  • CartesianGridDivisionDivide the mesh along a Cartesian grid. Numbering increases from bottom to top and from left to right and from back to front. The inner ordering is X, then Y, then Z
  • CylindricalGridDivisionDivide the mesh along a cylindrical grid. The innermost numbering of divisions is the radial bins, then comes the azimuthal bins, then the axial bins
  • ExtraElementIntegerDivisionDivide the mesh by increasing extra element IDs. The division will be contiguously numbered even if the extra element ids are not
  • FunctorBinnedValuesDivisionDivide the mesh along based on uniformly binned values of a functor.
  • NearestPositionsDivisionDivide the mesh using a nearest-point / voronoi algorithm, with the points coming from a Positions object
  • NestedDivisionDivide the mesh using nested divisions objects
  • SphericalGridDivisionDivide the mesh along a spherical grid.
  • SubdomainsDivisionDivide the mesh by increasing subdomain ids. The division will be contiguously numbered even if the subdomain ids are not

MeshModifiers

Modules

Modules/HeatTransfer

Modules/HeatTransfer/ThermalContact

Modules/HeatTransfer/ThermalContact/BC
  • Heat Transfer App
  • ThermalContactActionAction that controls the creation of all of the necessary objects for calculation of Thermal Contact

Modules/TensorMechanics

Modules/TensorMechanics/CohesiveZoneMaster

Modules/TensorMechanics/DynamicMaster

Modules/TensorMechanics/GeneralizedPlaneStrain

Modules/TensorMechanics/GlobalStrain

Modules/TensorMechanics/LineElementMaster

  • Solid Mechanics App
  • CommonLineElementActionSets up variables, stress divergence kernels and materials required for a static analysis with beam or truss elements. Also sets up aux variables, aux kernels, and consistent or nodal inertia kernels for dynamic analysis with beam elements.
  • LineElementActionSets up variables, stress divergence kernels and materials required for a static analysis with beam or truss elements. Also sets up aux variables, aux kernels, and consistent or nodal inertia kernels for dynamic analysis with beam elements.

Modules/TensorMechanics/Master

Modules/TensorMechanics/MaterialVectorBodyForce

MortarGapHeatTransfer

  • Heat Transfer App
  • MortarGapHeatTransferActionAction that controls the creation of all of the necessary objects for calculation of heat transfer through an open/closed gap using a mortar formulation and a modular design approach

MultiApps

  • Moose App
  • AddMultiAppActionAdd a MultiApp object to the simulation.
  • CentroidMultiAppAutomatically generates Sub-App positions from centroids of elements in the parent app mesh.
  • FullSolveMultiAppPerforms a complete simulation during each execution.
  • QuadraturePointMultiAppAutomatically generates sub-App positions from the elemental quadrature points, with the default quadrature, in the parent mesh.
  • TransientMultiAppMultiApp for performing coupled simulations with the parent and sub-application both progressing in time.
  • Stochastic Tools App
  • PODFullSolveMultiAppCreates a full-solve type sub-application for each row of a Sampler matrix. On second call, this object creates residuals for a PODReducedBasisTrainer with given basis functions.
  • SamplerFullSolveMultiAppCreates a full-solve type sub-application for each row of each Sampler matrix.
  • SamplerTransientMultiAppCreates a sub-application for each row of each Sampler matrix.

NEML2

  • Moose App
  • NEML2ActionCommonThe NEML2 library is required but not enabled. Refer to the documentation for guidance on how to enable it. (Original description: Parse a NEML2 input file)
  • NEML2ActionThe NEML2 library is required but not enabled. Refer to the documentation for guidance on how to enable it. (Original description: Set up the NEML2 material model)

NodalKernels

NodalNormals

  • Moose App
  • AddNodalNormalsActionCreates Auxiliary variables and objects for computing the outward facing normal from a node.

Outputs

  • Moose App
  • AutoCheckpointActionAction to create shortcut syntax-specified checkpoints and automatic checkpoints.
  • CommonOutputActionAdds short-cut syntax and common parameters to the Outputs block.
  • MaterialOutputActionOutputs material properties to various Outputs objects, based on the parameters set in each Material
  • AddOutputActionAction responsible for creating Output objects.
  • BlockRestrictionDebugOutputDebug output object for displaying information regarding block-restriction of objects.
  • CSVOutput for postprocessors, vector postprocessors, and scalar variables using comma seperated values (CSV).
  • CheckpointOutput for MOOSE recovery checkpoint files.
  • ConsoleObject for screen output.
  • ControlOutputOutput for displaying objects and parameters associated with the Control system.
  • DOFMapOutput degree-of-freedom (DOF) map.
  • ExodusObject for output data in the Exodus format
  • GMVObject for outputting data in the GMV format
  • GnuplotOutput for postprocessors and scalar variables in GNU plot format.
  • JSONOutput for Reporter values using JSON format.
  • MaterialPropertyDebugOutputDebug output object for displaying material property information.
  • NemesisObject for output data in the Nemesis (parallel ExodusII) format.
  • PNGOutputOutput data in the PNG format
  • PerfGraphOutputControls output of the PerfGraph: the performance log for MOOSE
  • ProgressOutput a simulation time progress bar on the console.
  • ReporterDebugOutputDebug output object for displaying Reporter information.
  • SolutionHistoryOutputs the non-linear and linear iteration solve history.
  • SolutionInvalidityOutputControls output of the time history of solution invalidity object
  • TecplotObject for outputting data in the Tecplot format
  • TopResidualDebugOutputDebug output object for displaying the top contributing residuals.
  • VTKOutput data using the Visualization Toolkit (VTK).
  • VariableResidualNormsDebugOutputReports the residual norm for each variable.
  • XDAObject for outputting data in the XDA/XDR format.
  • XDRObject for outputting data in the XDA/XDR format.
  • XMLOutputOutput for VectorPostprocessor using XML format.
  • XFEMApp
  • XFEMCutMeshOutputOutputs XFEM MeshCut2DUserObjectBase cutter mesh in Exodus format.
  • Stochastic Tools App
  • MappingOutputOutput for mapping model data.
  • SurrogateTrainerOutputOutput for trained surrogate model data.
  • Ray Tracing App
  • RayTracingExodusOutputs ray segments and data as segments using the Exodus format.
  • RayTracingNemesisOutputs ray segments and data as segments using the Nemesis format.

ParameterStudy

Physics

Physics/Diffusion

Physics/Diffusion/ContinuousGalerkin

  • Moose App
  • DiffusionCGDiscretizes a diffusion equation with the continuous Galerkin finite element method

Physics/Diffusion/FiniteVolume

  • Moose App
  • DiffusionFVAdd diffusion physics discretized with cell-centered finite volume

Physics/HeatConduction

Physics/HeatConduction/FiniteElement

  • Heat Transfer App
  • HeatConductionCGCreates the heat conduction equation discretized with CG

Physics/HeatConduction/FiniteVolume

  • Heat Transfer App
  • HeatConductionFVCreates the heat conduction equation discretized with nonlinear finite volume

Physics/SolidMechanics

Physics/SolidMechanics/CohesiveZone

Physics/SolidMechanics/Dynamic

Physics/SolidMechanics/GeneralizedPlaneStrain

Physics/SolidMechanics/GlobalStrain

Physics/SolidMechanics/LineElement

Physics/SolidMechanics/LineElement/QuasiStatic
  • Solid Mechanics App
  • CommonLineElementActionSets up variables, stress divergence kernels and materials required for a static analysis with beam or truss elements. Also sets up aux variables, aux kernels, and consistent or nodal inertia kernels for dynamic analysis with beam elements.
  • LineElementActionSets up variables, stress divergence kernels and materials required for a static analysis with beam or truss elements. Also sets up aux variables, aux kernels, and consistent or nodal inertia kernels for dynamic analysis with beam elements.

Physics/SolidMechanics/MaterialVectorBodyForce

Physics/SolidMechanics/QuasiStatic

Positions

Postprocessors

Preconditioning

  • Moose App
  • SetupPreconditionerActionAdd a Preconditioner object to the simulation.
  • AddFieldSplitActionAdd a Split object to the simulation.
  • SplitField split based preconditioner for nonlinear solver.
  • FDPFinite difference preconditioner (FDP) builds a numerical Jacobian for preconditioning, only use for testing and verification.
  • FSPPreconditioner designed to map onto PETSc's PCFieldSplit.
  • PBPPhysics-based preconditioner (PBP) allows individual physics to have their own preconditioner.
  • SMPSingle matrix preconditioner (SMP) builds a preconditioner using user defined off-diagonal parts of the Jacobian.
  • StaticCondensationStatic condensation preconditioner
  • VCPVariable condensation preconditioner (VCP) condenses out specified variable(s) from the Jacobian matrix and produces a system of equations with less unkowns to be solved by the underlying preconditioners.
  • Contact App
  • ContactSplitSplit-based preconditioner that partitions the domain into DOFs directly involved in contact (on contact surfaces) and those that are not

Problem

ProjectedStatefulMaterialStorage

RayBCs

  • Ray Tracing App
  • AddRayBCActionAdds a RayBC for use in ray tracing to the simulation.
  • KillRayBCA RayBC that kills a Ray on a boundary.
  • NullRayBCA RayBC that does nothing to a Ray on a boundary.
  • ReflectRayBCA RayBC that reflects a Ray in a specular manner on a boundary.
  • Heat Transfer App
  • ViewFactorRayBCThis ray boundary condition is applied on all sidesets bounding a radiation cavity except symmetry sidesets. It kills rays that hit the sideset and scores the ray for computation of view factors.

RayKernels

  • Ray Tracing App
  • AddRayKernelActionAdds a RayKernel for use in ray tracing to the simulation.
  • ADLineSourceRayKernelDemonstrates the multiple ways that scalar values can be introduced into RayKernels, e.g. (controllable) constants, functions, postprocessors, and data on rays. Implements the weak form along a line.
  • FunctionIntegralRayKernelIntegrates a function along a Ray.
  • KillRayKernelA RayKernel that kills a Ray.
  • LineSourceRayKernelDemonstrates the multiple ways that scalar values can be introduced into RayKernels, e.g. (controllable) constants, functions, postprocessors, and data on rays. Implements the weak form along a line.
  • MaterialIntegralRayKernelIntegrates a Material property along a Ray.
  • NullRayKernelA RayKernel that does nothing.
  • RayDistanceAuxAccumulates the distance traversed by each Ray segment into an aux variable for the element that the segments are in.
  • VariableIntegralRayKernelIntegrates a Variable or AuxVariable along a Ray.

Reporters

Samplers

ScalarKernels

StochasticTools

  • Stochastic Tools App
  • StochasticToolsActionAction for performing some common functions for running stochastic simulations.

Surrogates

ThermalContact

  • Heat Transfer App
  • ThermalContactActionAction that controls the creation of all of the necessary objects for calculation of Thermal Contact

Times

Trainers

Transfers

UserObjects

VariableMappings

  • Stochastic Tools App
  • AddVariableMappingActionAdds Mapping objects from a VariableMappings block.
  • PODMappingClass which provides a Proper Orthogonal Decomposition-based mapping between full-order and reduced-order spaces.

Variables

VectorPostprocessors

  • Moose App
  • AddVectorPostprocessorActionAdd a VectorPostprocessor object to the simulation.
  • CSVReaderConverts columns of a CSV file into vectors of a VectorPostprocessor.
  • CSVReaderVectorPostprocessorConverts columns of a CSV file into vectors of a VectorPostprocessor.
  • ConstantVectorPostprocessorPopulate constant VectorPostprocessorValue directly from input file.
  • CylindricalAverageCompute a cylindrical average of a variableas a function of radius throughout the simulation domain.
  • EigenvaluesReturns the Eigen values from the nonlinear Eigen system.
  • ElementMaterialSamplerRecords all Real-valued material properties of a material object, or Real-valued material properties of the supplied property names on quadrature points on elements at the indicated execution points.
  • ElementValueSamplerSamples values of variables on elements.
  • ElementVariablesDifferenceMaxComputes the largest difference between two variable fields.
  • ElementsAlongLineOutputs the IDs of every element intersected by a user-defined line
  • ElementsAlongPlaneOutputs the IDs of every element intersected by a user-defined plane
  • ExtraIDIntegralVectorPostprocessorIntegrates or averages variables based on extra element IDs
  • HistogramVectorPostprocessorCompute a histogram for each column of a VectorPostprocessor
  • IntersectionPointsAlongLineGet the intersection points for all of the elements that are intersected by a line.
  • LeastSquaresFitPerforms a polynomial least squares fit on the data contained in another VectorPostprocessor
  • LeastSquaresFitHistoryPerforms a polynomial least squares fit on the data contained in another VectorPostprocessor and stores the full time history of the coefficients
  • LineFunctionSamplerSample one or more functions along a line.
  • LineMaterialRealSamplerSamples real-valued material properties for all quadrature points in all elements that are intersected by a specified line
  • LineValueSamplerSamples variable(s) along a specified line
  • MaterialVectorPostprocessorRecords all Real-valued material properties of a material object, or Real-valued material properties of the supplied property names on quadrature points on elements at the indicated execution points.
  • MeshDivisionFunctorReductionVectorPostprocessorPerform reductions on functors based on a per-mesh-division basis
  • NearestPointIntegralVariablePostprocessorCompute element variable integrals for nearest-point based subdomains
  • NodalValueSamplerSamples values of nodal variable(s).
  • PointValueSamplerSample a variable at specific points.
  • PositionsFunctorValueSamplerSample one or more functors at points specified by a Positions object.
  • SideValueSamplerSample variable(s) along a sideset, internal or external.
  • SidesetInfoVectorPostprocessorThis VectorPostprocessor collects meta data for provided sidesets.
  • SpatialUserObjectVectorPostprocessorOutputs the values of a spatial user object in the order of the specified spatial points
  • SphericalAverageCompute a spherical average of a variable as a function of radius throughout the simulation domain.
  • VariableValueVolumeHistogramCompute a histogram of volume fractions binned according to variable values.
  • VectorMemoryUsageGet memory stats for all ranks in the simulation
  • VectorOfPostprocessorsOutputs the values of an arbitrary user-specified set of postprocessors as a vector in the order specified by the user
  • VolumeHistogramCompute a histogram of volume fractions binned according to variable values.
  • WorkBalanceComputes several metrics for workload balance per processor
  • Stochastic Tools App
  • GaussianProcessDataTool for extracting hyperparameter data from gaussian process user object and storing in VectorPostprocessor vectors.
  • SamplerDataTool for extracting Sampler object data and storing in VectorPostprocessor vectors.
  • SobolStatisticsCompute SOBOL statistics values of a given VectorPostprocessor objects and vectors.
  • StatisticsCompute statistical values of a given VectorPostprocessor objects and vectors.
  • StochasticResultsStorage container for stochastic simulation results coming from a Postprocessor.
  • Ray Tracing App
  • PerProcessorRayTracingResultsVectorPostprocessorAccumulates ray tracing results (information about the trace) on a per-processor basis.
  • Heat Transfer App
  • SurfaceRadiationVectorPostprocessorVectorPostprocessor for accessing information stored in surface radiation user object
  • ViewfactorVectorPostprocessorVectorPostprocessor for accessing view factors from GrayLambertSurfaceRadiationBase UO
  • Solid Mechanics App
  • ADInteractionIntegralComputes the interaction integral, which is used to compute various fracture mechanics parameters at a crack tip, including KI, KII, KIII, and the T stress.
  • AverageSectionValueSamplerCompute the section's variable average in three-dimensions given a user-defined definition of the cross section.
  • CrackFrontNonlocalScalarMaterialComputes the average material at points provided by the crack_front_definition vectorpostprocessor.
  • CrackFrontNonlocalStressComputes the average stress normal to the crack face.
  • InteractionIntegralComputes the interaction integral, which is used to compute various fracture mechanics parameters at a crack tip, including KI, KII, KIII, and the T stress.
  • JIntegralComputes the J-Integral, a measure of the strain energy release rate at a crack tip, which can be used as a criterion for fracture growth. It can, alternatively, compute the C(t) integral
  • LineMaterialRankTwoSamplerAccess a component of a RankTwoTensor
  • LineMaterialRankTwoScalarSamplerCompute a scalar property of a RankTwoTensor
  • MixedModeEquivalentKComputes the mixed-mode stress intensity factor given the , , and stress intensity factors

XFEM

  • XFEMApp
  • XFEMActionAction to input general parameters and simulation options for use in XFEM.