# Complete Syntax

## ADKernels

• Moose App
• AddADKernelActionThis action is used to add ADKernel and ADKernel objects
• ADDiffusionSame as Diffusion in terms of physics/residual, but the Jacobian is computed using forward automatic differentiation
• ADDiffusionSame as Diffusion in terms of physics/residual, but the Jacobian is computed using forward automatic differentiation

## Adaptivity

### Adaptivity/Markers

• Moose App
• AddElementalFieldAction
• AddMarkerAction
• 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.
• OrientedBoxMarkerMarks inside and outside a box that can have arbitrary orientation and center point.
• 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 the refinement state based on a threshold value compared to the specified variable.
• Phase Field App
• DiscreteNucleationMarkerMark new nucleation sites for refinement

## AuxVariables

### AuxVariables/MultiAuxVariables

• Phase Field App
• MultiAuxVariablesActionSet up auxvariables for components of MaterialProperty > for polycrystal sample.

## BCs

• Moose App
• AddBCAction
• ConvectiveFluxBCDetermines boundary values via the initial and final values, flux, and exposure duration
• DGFunctionDiffusionDirichletBC
• 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.
• DirichletBCImposes the essential boundary condition , where is a constant, controllable value.
• EigenDirichletBCDirichlet BC for eigenvalue solvers
• FunctionDirichletBCImposes the essential boundary condition , where is a (possibly) time and space-dependent MOOSE Function.
• FunctionNeumannBCImposes the integrated boundary condition , where is a (possibly) time and space-dependent MOOSE Function.
• FunctionPenaltyDirichletBC
• FunctionPresetBCThe same as FunctionDirichletBC except the value is applied before the solve begins
• LagrangeVecDirichletBCImposes the essential boundary condition , where are constant, controllable values.
• LagrangeVecFunctionDirichletBCImposes the essential boundary condition , where components are calculated with functions.
• MatchedValueBCImplements a NodalBC which equates two different Variables' values on a specified boundary.
• NeumannBCImposes the integrated boundary condition , where is a constant, controllable value.
• OneDEqualValueConstraintBC
• PenaltyDirichletBCEnforces a Dirichlet boundary condition in a weak sense by penalizing differences between the current solution and the Dirichlet data.
• PostprocessorDirichletBC
• PostprocessorNeumannBC
• PresetBCSimilar to DirichletBC except the value is applied before the solve begins
• 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.
• VacuumBC
• VectorNeumannBCImposes the integrated boundary condition , where is a user-defined, constant vector.
• 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
• Rdg App
• AEFVBCA boundary condition kernel for the advection equation using a cell-centered finite volume method.
• Functional Expansion Tools App
• FXFluxBCSets a flux boundary condition, evaluated using a FunctionSeries instance. This does not fix the flux, but rather 'strongly encourages' flux agreement by penalizing the differences through contributions to the residual.
• FXValueBCImposes a fixed value boundary condition, evaluated using a FunctionSeries instance.
• FXValuePenaltyBCSets a value boundary condition, evaluated using a FunctionSeries instance. This does not fix the value, but rather 'strongly encourages' value agreement by penalizing the differences through contributions to the residual.
• XFEMApp
• CrackTipEnrichmentCutOffBCSimilar to DirichletBC except the value is applied before the solve begins
• Heat Conduction App
• ConvectiveFluxFunctionDetermines boundary value by fluid heat transfer coefficient and far-field temperature
• CoupledConvectiveFlux
• CoupledConvectiveHeatFluxBCConvective heat transfer boundary condition with temperature and heat transfer coefficent given by auxiliary variables.
• GapHeatTransferTransfers heat across a gap between two surfaces dependant on the gap geometry specified.
• HeatConductionBC
• Richards App
• Q2PPiecewiseLinearSinkSink of fluid, controlled by (pressure, bare_fluxes) interpolation. This is for use in Q2P models
• RichardsExcavAllows the user to set variable values at the face of an excavation. You must have defined the excavation start time, start position, etc, through the excav_geom_function
• RichardsHalfGaussianSink
• RichardsPiecewiseLinearSink
• Tensor Mechanics App
• CoupledPressureBCApplies a pressure from a variable on a given boundary in a given direction
• DashpotBC
• DisplacementAboutAxisImplements a boundary condition that enforces rotationaldisplacement around an axis on a boundary
• InteractionIntegralBenchmarkBC
• PresetAccelerationPrescribe acceleration on a given boundary in a given direction
• PresetDisplacementPrescribe the displacement on a given boundary in a given direction.
• PresetVelocity
• PressureApplies a pressure on a given boundary in a given direction
• StickyBCImposes the boundary condition if exceeds the bounds provided
• CavityPressure
• CoupledPressure
• Pressure
• Navier Stokes App
• EnergyFreeBC
• INSMomentumNoBCBCLaplaceFormThis class implements the 'No BC' boundary condition based on the 'Laplace' form of the viscous stress tensor.
• INSMomentumNoBCBCTractionFormThis class implements the 'No BC' boundary condition based on the 'traction' form of the viscous stress tensor.
• INSTemperatureNoBCBCThis class implements the 'No BC' boundary condition discussed by Griffiths, Papanastiou, and others.
• ImplicitNeumannBCThis class implements a form of the Neumann boundary condition in which the boundary term is treated 'implicitly'.
• MassFreeBC
• MomentumFreeBC
• MomentumFreeSlipBC
• NSEnergyInviscidSpecifiedBCThis class corresponds to the inviscid part of the 'natural' boundary condition for the energy equation.
• NSEnergyInviscidSpecifiedDensityAndVelocityBCThis class corresponds to the inviscid part of the 'natural' boundary condition for the energy equation.
• NSEnergyInviscidSpecifiedNormalFlowBCThis class corresponds to the inviscid part of the 'natural' boundary condition for the energy equation.
• NSEnergyInviscidSpecifiedPressureBCThis class corresponds to the inviscid part of the 'natural' boundary condition for the energy equation.
• NSEnergyInviscidUnspecifiedBCThis class corresponds to the inviscid part of the 'natural' boundary condition for the energy equation.
• NSEnergyViscousBCThis class couples together all the variables for the compressible Navier-Stokes equations to allow them to be used in derived IntegratedBC classes.
• NSEnergyWeakStagnationBCThe inviscid energy BC term with specified normal flow.
• NSImposedVelocityBCImpose Velocity BC.
• NSImposedVelocityDirectionBCThis class imposes a velocity direction component as a Dirichlet condition on the appropriate momentum equation.
• NSInflowThermalBCThis class is used on a boundary where the incoming flow values (rho, u, v, T) are all completely specified.
• NSMassSpecifiedNormalFlowBCThis class implements the mass equation boundary term with a specified value of rho*(u.n) imposed weakly.
• NSMassUnspecifiedNormalFlowBCThis class implements the mass equation boundary term with the rho*(u.n) boundary integral computed implicitly.
• NSMassWeakStagnationBCThe inviscid energy BC term with specified normal flow.
• NSMomentumConvectiveWeakStagnationBCThe convective part (sans pressure term) of the momentum equation boundary integral evaluated at specified stagnation temperature, stagnation pressure, and flow direction values.
• NSMomentumInviscidNoPressureImplicitFlowBCMomentum equation boundary condition used when pressure is not integrated by parts.
• NSMomentumInviscidSpecifiedNormalFlowBCMomentum equation boundary condition in which pressure is specified (given) and the value of the convective part is allowed to vary (is computed implicitly).
• NSMomentumInviscidSpecifiedPressureBCMomentum equation boundary condition in which pressure is specified (given) and the value of the convective part is allowed to vary (is computed implicitly).
• NSMomentumPressureWeakStagnationBCThis class implements the pressure term of the momentum equation boundary integral for use in weak stagnation boundary conditions.
• NSMomentumViscousBCThis class corresponds to the viscous part of the 'natural' boundary condition for the momentum equations.
• NSPenalizedNormalFlowBCThis class penalizes the the value of u.n on the boundary so that it matches some desired value.
• NSPressureNeumannBCThis kernel is appropriate for use with a 'zero normal flow' boundary condition in the context of the Euler equations.
• NSStagnationPressureBCThis Dirichlet condition imposes the condition p_0 = p_0_desired.
• NSStagnationTemperatureBCThis Dirichlet condition imposes the condition T_0 = T_0_desired.
• NSThermalBCNS thermal BC.
• Chemical Reactions App
• ChemicalOutFlowBCChemical flux boundary condition
• Porous Flow App
• PorousFlowHalfCubicSinkApplies a flux sink to a boundary. The base flux defined by PorousFlowSink is multiplied by a cubic.
• PorousFlowHalfGaussianSinkApplies a flux sink to a boundary. The base flux defined by PorousFlowSink is multiplied by a Gaussian.
• PorousFlowPiecewiseLinearSinkApplies a flux sink to a boundary. The base flux defined by PorousFlowSink is multiplied by a piecewise linear function.
• PorousFlowSinkApplies a flux sink to a boundary.

## DiracKernels

• Moose App
• AddDiracKernelAction
• ConstantPointSource
• FunctionDiracSource
• Heat Conduction App
• GapHeatPointSourceMaster
• Richards App
• Q2PBoreholeApproximates a borehole in the mesh with given bottomhole pressure, and radii using a number of point sinks whose positions are read from a file. This DiracKernel is for use by Q2P models
• RichardsBoreholeApproximates a borehole in the mesh with given bottomhole pressure, and radii using a number of point sinks whose positions are read from a file
• RichardsPolyLineSinkApproximates a polyline sink in the mesh by using a number of point sinks whose positions are read from a file
• XFEMApp
• XFEMPressure
• Porous Flow App
• PorousFlowPeacemanBoreholeApproximates a borehole in the mesh using the Peaceman approach, ie using a number of point sinks with given radii whose positions are read from a file
• PorousFlowPolyLineSinkApproximates a polyline sink by using a number of point sinks with given weighting whose positions are read from a file
• PorousFlowSquarePulsePointSourcePoint source (or sink) that adds (removes) fluid at a constant mass flux rate for times between the specified start and end times.
• Contact App
• ContactMaster
• SlaveConstraint

## Functions

• Moose App
• AddFunctionAction
• Axisymmetric2D3DSolutionFunctionFunction for reading a 2D axisymmetric solution from file and mapping it to a 3D Cartesian model
• BicubicSplineFunction
• CompositeFunctionMultiplies an arbitrary set of functions together
• ConstantFunction
• ImageFunctionFunction with values sampled from a given image stack
• LinearCombinationFunctionReturns the linear combination of the functions
• ParsedFunction
• ParsedGradFunction
• ParsedVectorFunction
• PiecewiseBilinearInterpolates values from a csv file
• PiecewiseConstantDefines data using a set of x-y data pairs
• PiecewiseLinearLinearly interpolates between pairs of x-y data
• 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.
• SolutionFunction
• SplineFunction
• TestSetupPostprocessorDataActionFunction
• VectorPostprocessorFunction
• Richards App
• Grad2ParsedFunction
• GradParsedFunction
• RichardsExcavGeomThis function defines excavation geometry. It can be used to enforce pressures at the boundary of excavations, and to record fluid fluxes into excavations.
• Functional Expansion Tools App
• FunctionSeriesThis function uses a convolution of functional series (functional expansion or FX) to create a 1D, 2D, or 3D function
• Navier Stokes App
• WedgeFunctionFunction which computes the exact solution for Jeffery-Hamel flow in a wedge.
• Level Set App
• LevelSetOlssonBubbleImplementation of 'bubble' ranging from 0 to 1.
• LevelSetOlssonVortexA function for creating vortex velocity fields for level set equation benchmark problems.
• Porous Flow App
• MovingPlanarFrontThis function defines the position of a moving front. The front is an infinite plane with normal pointing from start_posn to end_posn. The front's distance from start_posn is defined by 'distance', so if the 'distance' function is time dependent, the front's position will change with time. Roughly speaking, the function returns true_value for points lying in between start_posn and start_posn + distance. Precisely speaking, two planes are constructed, both with normal pointing from start_posn to end_posn. The first plane passes through start_posn; the second plane passes through end_posn. Given a point p and time t, this function returns false_value if ANY of the following are true: (a) t=deactivation_time; (c) p is 'behind' start_posn (ie, p lies on one side of the start_posn plane and end_posn lies on the other side); (d) p is 'ahead' of the front (ie, p lies one one side of the front and start_posn lies on the other side); (e) the distance between p and the front is greater than active_length. Otherwise, the point is 'in the active zone' and the function returns true_value.

## Kernels

• Moose App
• AddKernelAction
• AnisotropicDiffusionAnisotropic diffusion kernel with weak form given by .
• BodyForceDemonstrates the multiple ways that scalar values can be introduced into kernels, e.g. (controllable) constants, functions, and postprocessors. Implements the weak form .
• 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 .
• 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 .
• MatDiffusionDiffusion equation Kernel that takes an isotropic Diffusivity from a material property
• 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.
• NullKernelKernel that sets a zero residual.
• ReactionImplements a simple consuming reaction term with weak form .
• 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 .
• VectorDiffusionThe Laplacian operator (), with the weak form of .
• Phase Field Test App
• GaussContForcing
• Phase Field App
• ACBarrierFunctionAllen Cahn kernel used when 'mu' is a function of variables
• ACGBPolyGrain-Boundary model concentration dependent residual
• ACGrGrElasticDrivingForceAdds elastic energy contribution to the Allen-Cahn equation
• ACGrGrMultiMulti-phase poly-crystaline Allen-Cahn Kernel
• ACGrGrPolyGrain-Boundary model poly-crystaline interface Allen-Cahn Kernel
• ACInterfaceGradient energy Allen-Cahn Kernel
• ACInterface2DMultiPhase1Gradient energy Allen-Cahn Kernel where the derivative of interface parameter kappa wrt the gradient of order parameter is considered.
• ACInterface2DMultiPhase2Gradient energy Allen-Cahn Kernel where the interface parameter kappa is considered.
• ACInterfaceKobayashi1Anisotropic gradient energy Allen-Cahn Kernel Part 1
• ACInterfaceKobayashi2Anisotropic Gradient energy Allen-Cahn Kernel Part 2
• ACInterfaceStressInterface stress driving force Allen-Cahn Kernel
• ACKappaFunctionGradient energy term for when kappa as a function of the variable
• ACMultiInterfaceGradient energy Allen-Cahn Kernel with cross terms
• ACSEDGPolyStored Energy contribution to grain growth
• ACSwitchingKernel for Allen-Cahn equation that adds derivatives of switching functions and energies
• AllenCahnAllen-Cahn Kernel that uses a DerivativeMaterial Free Energy
• AllenCahnElasticEnergyOffDiagThis kernel calculates off-diagonal jacobian of elastic energy in AllenCahn with respect to displacements
• CHBulkPFCTradCahn-Hilliard kernel for a polynomial phase field crystal free energy.
• CHInterfaceGradient energy Cahn-Hilliard Kernel with a scalar (isotropic) mobility
• CHInterfaceAnisoGradient energy Cahn-Hilliard Kernel with a tensor (anisotropic) mobility
• CHMathSimple demonstration Cahn-Hilliard Kernel using an algebraic double-well potential
• CHPFCRFFCahn-Hilliard residual for the RFF form of the phase field crystal model
• CHSplitChemicalPotentialChemical potential kernel in Split Cahn-Hilliard that solves chemical potential in a weak form
• CHSplitConcentrationConcentration kernel in Split Cahn-Hilliard that solves chemical potential in a weak form
• CHSplitFluxComputes flux as nodal variable
• CahnHilliardCahn-Hilliard Kernel that uses a DerivativeMaterial Free Energy and a scalar (isotropic) mobility
• CahnHilliardAnisoCahn-Hilliard Kernel that uses a DerivativeMaterial Free Energy and a tensor (anisotropic) mobility
• CoefCoupledTimeDerivativeScaled time derivative Kernel that acts on a coupled variable
• CoefReactionImplements the residual term (p*u, test)
• ConservedLangevinNoiseSource term for noise from a ConservedNoise userobject
• CoupledAllenCahnCoupled Allen-Cahn Kernel that uses a DerivativeMaterial Free Energy
• CoupledMaterialDerivativeKernel that implements the first derivative of a function material property with respect to a coupled variable.
• CoupledSusceptibilityTimeDerivativeA modified coupled time derivative Kernel that multiplies the time derivative of a coupled variable by a generalized susceptibility
• CoupledSwitchingTimeDerivativeCoupled time derivative Kernel that multiplies the time derivative by $\frac{dh_\alpha}{d\eta_i} F_\alpha + \frac{dh_\beta}{d\eta_i} F_\beta + \dots) • DiscreteNucleationForceTerm for inserting grain nuclei or phases in non-conserved order parameter fields • GradientComponentSet the kernel variable to a specified component of the gradient of a coupled variable. • HHPFCRFFReaction type kernel for the RFF phase fit crystal model • KKSACBulkCKKS model kernel (part 2 of 2) for the Bulk Allen-Cahn. This includes all terms dependent on chemical potential. • KKSACBulkFKKS model kernel (part 1 of 2) for the Bulk Allen-Cahn. This includes all terms NOT dependent on chemical potential. • KKSCHBulkKKS model kernel for the Bulk Cahn-Hilliard term. This operates on the concentration 'c' as the non-linear variable • KKSMultiACBulkCMulti-phase KKS model kernel (part 2 of 2) for the Bulk Allen-Cahn. This includes all terms dependent on chemical potential. • KKSMultiACBulkFKKS model kernel (part 1 of 2) for the Bulk Allen-Cahn. This includes all terms NOT dependent on chemical potential. • KKSMultiPhaseConcentrationKKS multi-phase model kernel to enforce . The non-linear variable of this kernel is , the final phase concentration in the list. • KKSPhaseChemicalPotentialKKS model kernel to enforce the pointwise equality of phase chemical potentials dFa/dca = dFb/dcb. The non-linear variable of this kernel is ca. • KKSPhaseConcentrationKKS model kernel to enforce the decomposition of concentration into phase concentration (1-h(eta))ca + h(eta)cb - c = 0. The non-linear variable of this kernel is cb. • KKSSplitCHCResKKS model kernel for the split Bulk Cahn-Hilliard term. This operates on the chemical potential 'c' as the non-linear variable • LangevinNoiseSource term for non-conserved Langevin noise • LaplacianSplitSplit with a variable that holds the Laplacian of a phase field variable. • MaskedBodyForceKernel that defines a body force modified by a material mask • MatAnisoDiffusionDiffusion equation Kernel that takes an anisotropic Diffusivity from a material property • MatGradSquareCoupledGradient square of a coupled variable. • MatReactionKernel to add -L*v, where L=reaction rate, v=variable • MultiGrainRigidBodyMotionAdds rigid mody motion to grains • SimpleACInterfaceGradient energy for Allen-Cahn Kernel with constant Mobility and Interfacial parameter • SimpleCHInterfaceGradient energy for Cahn-Hilliard equation with constant Mobility and Interfacial parameter • SimpleCoupledACInterfaceGradient energy for Allen-Cahn Kernel with constant Mobility and Interfacial parameter for a coupled order parameter variable. • SimpleSplitCHWResGradient energy for split Cahn-Hilliard equation with constant Mobility for a coupled order parameter variable. • SingleGrainRigidBodyMotionAdds rigid mody motion to a single grain • SoretDiffusionAdd Soret effect to Split formulation Cahn-Hilliard Kernel • SplitCHMathSimple demonstration split formulation Cahn-Hilliard Kernel using an algebraic double-well potential • SplitCHParsedSplit formulation Cahn-Hilliard Kernel that uses a DerivativeMaterial Free Energy • SplitCHWResSplit formulation Cahn-Hilliard Kernel for the chemical potential variable with a scalar (isotropic) mobility • SplitCHWResAnisoSplit formulation Cahn-Hilliard Kernel for the chemical potential variable with a tensor (anisotropic) mobility • SusceptibilityTimeDerivativeA modified time derivative Kernel that multiplies the time derivative of a variable by a generalized susceptibility • SwitchingFunctionConstraintEtaLagrange multiplier kernel to constrain the sum of all switching functions in a multiphase system. This kernel acts on a non-conserved order parameter eta_i. • SwitchingFunctionConstraintLagrangeLagrange multiplier kernel to constrain the sum of all switching functions in a multiphase system. This kernel acts on the lagrange multiplier variable. • SwitchingFunctionPenaltyPenalty kernel to constrain the sum of all switching functions in a multiphase system. • CHPFCRFFSplitKernel • HHPFCRFFSplitKernel • PFCRFFKernel • PolycrystalElasticDrivingForce • PolycrystalKernel • PolycrystalStoredEnergy • RigidBodyMultiKernel • Misc App • CoefDiffusionKernel for diffusion with diffusivity = coef + function • ThermoDiffusionKernel for thermo-diffusion (Soret effect, thermophoresis, etc.) • Navier Stokes Test App • AdvectionThis class solves the scalar advection equation, with SUPG stabilization. • Level Set App • LevelSetAdvectionImplements the level set advection equation: , where the weak form is . • LevelSetAdvectionSUPGSUPG stablization term for the advection portion of the level set equation. • LevelSetForcingFunctionSUPGThe SUPG stablization term for a forcing function. • LevelSetOlssonReinitializationThe re-initialization equation defined by Olsson et. al. (2007). • LevelSetTimeDerivativeSUPGSUPG stablization terms for the time derivative of the level set equation. • Solid Mechanics App • HomogenizationKernel • OutOfPlaneStress • SolidMechImplicitEuler • StressDivergence • StressDivergenceRSpherical • StressDivergenceRZ • XFEMApp • CrackTipEnrichmentStressDivergenceTensorsEnrich stress divergence kernel for small-strain simulations • Heat Conduction App • AnisoHeatConduction • HeatCapacityConductionTimeDerivativeTime derivative term of the heat equation with the heat capacity as an argument. • HeatConductionComputes residual/Jacobian contribution for term. • HeatConductionTimeDerivativeTime derivative term of the heat equation for quasi-constant specific heat and the density . • HeatSourceDemonstrates the multiple ways that scalar values can be introduced into kernels, e.g. (controllable) constants, functions, and postprocessors. Implements the weak form . • HomogenizedHeatConduction • JouleHeatingSourceDemonstrates the multiple ways that scalar values can be introduced into kernels, e.g. (controllable) constants, functions, and postprocessors. Implements the weak form . • SpecificHeatConductionTimeDerivativeTime derivative term of the heat equation with the specific heat and the density as arguments. • Richards App • DarcyFluxDarcy flux. nabla_i (k_ij/mu (nabla_j P - w_j)), where k_ij is the permeability tensor, mu is the fluid viscosity, P is the fluid pressure, and w_j is the fluid weight • PoroFullSatTimeDerivativeKernel = biot_coefficient*d(volumetric_strain)/dt + (1/biot_modulus)*d(porepressure)/dt. This is the time-derivative for poromechanics for a single-phase, fully-saturated fluid with constant bulk modulus • Q2PNegativeNodalMassOld- fluid_mass • Q2PNodalMassFluid mass lumped to the nodes divided by dt • Q2PPorepressureFluxFlux according to Darcy-Richards flow. The Variable for this Kernel should be the porepressure. • Q2PSaturationDiffusionDiffusion part of the Flux according to Darcy-Richards flow. The Variable of this Kernel must be the saturation. • Q2PSaturationFluxFlux according to Darcy-Richards flow. The Variable of this Kernel must be the saturation • RichardsFlux • RichardsFullyUpwindFlux • RichardsLumpedMassChange • RichardsMassChangeThe time derivative operator with the weak form of . • RichardsPPenaltyThis adds a term to the residual that attempts to enforce variable > lower_var. The term is a*(lower - variable) for variable • Tensor Mechanics App • CosseratStressDivergenceTensorsStress divergence kernel for the Cartesian coordinate system • 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. • InertialForceCalculates the residual for the interial 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 interial force/moment and the contribution of mass dependent Rayleigh damping and HHT time integration scheme.
• InertialTorqueKernel for interial torque: density * displacement x acceleration
• MomentBalancing
• 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 an spherically symmetric 1D problem in polar coordinates.
• StressDivergenceRZTensorsCalculate stress divergence for an axisymmetric problem in cylinderical coordinates.
• StressDivergenceTensorsStress divergence kernel for the Cartesian coordinate system
• StressDivergenceTensorsTrussKernel for truss element
• WeakPlaneStressPlane stress kernel to provide out-of-plane strain contribution
• DynamicTensorMechanics
• PoroMechanics
• TensorMechanics
• Porous Flow App
• PorousFlowAdvectiveFluxFully-upwinded advective flux of the component given by fluid_component
• PorousFlowBasicAdvectionAdvective flux of a Variable using the Darcy velocity of the fluid phase
• PorousFlowDesorpedMassTimeDerivativeDesorped component mass derivative wrt time.
• PorousFlowDesorpedMassVolumetricExpansionDesorped_mass * rate_of_solid_volumetric_expansion
• PorousFlowDispersiveFluxDispersive and diffusive flux of the component given by fluid_component in all phases
• PorousFlowEffectiveStressCouplingAdds , where the subscript is the component.
• PorousFlowEnergyTimeDerivativeDerivative of heat-energy-density wrt time
• PorousFlowExponentialDecayResidual = rate * (variable - reference). Useful for modelling exponential decay of a variable
• PorousFlowFullySaturatedDarcyBaseDarcy flux suitable for models involving a fully-saturated, single phase, single component fluid. No upwinding is used
• PorousFlowFullySaturatedDarcyFlowDarcy flux suitable for models involving a fully-saturated single phase, multi-component fluid. No upwinding is used
• PorousFlowFullySaturatedHeatAdvectionHeat flux that arises from the advection of a fully-saturated single phase fluid. No upwinding is used
• PorousFlowFullySaturatedMassTimeDerivativeFully-saturated version of the single-component, single-phase fluid mass derivative wrt time
• PorousFlowHeatAdvectionFully-upwinded heat flux, advected by the fluid
• PorousFlowHeatConductionHeat conduction in the Porous Flow module
• PorousFlowHeatVolumetricExpansionEnergy-density*rate_of_solid_volumetric_expansion
• PorousFlowMassRadioactiveDecayRadioactive decay of a fluid component
• PorousFlowMassTimeDerivativeComponent mass derivative wrt time for component given by fluid_component
• PorousFlowMassVolumetricExpansionComponent_mass*rate_of_solid_volumetric_expansion
• PorousFlowPlasticHeatEnergyPlastic heat energy density source = (1 - porosity) * coeff * stress * plastic_strain_rate
• PorousFlowPreDisPrecipitation-dissolution of chemical species
• Navier Stokes App
• DistributedForce
• DistributedPower
• INSChorinCorrectorThis class computes the 'Chorin' Corrector equation in fully-discrete (both time and space) form.
• INSChorinPredictorThis class computes the 'Chorin' Predictor equation in fully-discrete (both time and space) form.
• INSChorinPressurePoissonThis class computes the pressure Poisson solve which is part of the 'split' scheme used for solving the incompressible Navier-Stokes equations.
• INSCompressibilityPenaltyThe penalty term may be used when Dirichlet boundary condition is applied to the entire boundary.
• INSMassThis class computes the mass equation residual and Jacobian contributions for the incompressible Navier-Stokes momentum equation.
• INSMassRZThis class computes the mass equation residual and Jacobian contributions for the incompressible Navier-Stokes momentum equation in RZ coordinates.
• INSMomentumLaplaceFormThis class computes momentum equation residual and Jacobian viscous contributions for the 'Laplacian' form of the governing equations.
• INSMomentumLaplaceFormRZThis class computes additional momentum equation residual and Jacobian contributions for the incompressible Navier-Stokes momentum equation in RZ (axisymmetric cylindrical) coordinates, using the 'Laplace' form of the governing equations.
• INSMomentumTimeDerivativeThis class computes the time derivative for the incompressible Navier-Stokes momentum equation.
• INSMomentumTractionFormThis class computes momentum equation residual and Jacobian viscous contributions for the 'traction' form of the governing equations.
• INSMomentumTractionFormRZThis class computes additional momentum equation residual and Jacobian contributions for the incompressible Navier-Stokes momentum equation in RZ (axisymmetric cylindrical) coordinates.
• INSPressurePoissonThis class computes the pressure Poisson solve which is part of the 'split' scheme used for solving the incompressible Navier-Stokes equations.
• INSProjectionThis class computes the 'projection' part of the 'split' method for solving incompressible Navier-Stokes.
• INSSplitMomentumThis class computes the 'split' momentum equation residual.
• INSTemperatureThis class computes the residual and Jacobian contributions for the incompressible Navier-Stokes temperature (energy) equation.
• INSTemperatureTimeDerivativeThis class computes the time derivative for the incompressible Navier-Stokes momentum equation.
• MassConvectiveFlux
• MomentumConvectiveFlux
• NSEnergyInviscidFluxThis class computes the inviscid part of the energy flux.
• NSEnergyThermalFluxThis class is responsible for computing residuals and Jacobian terms for the k * grad(T) * grad(phi) term in the Navier-Stokes energy equation.
• NSEnergyViscousFluxViscous flux terms in energy equation.
• NSGravityForceThis class computes the gravity force contribution.
• NSGravityPowerThis class computes the momentum contributed by gravity.
• NSMassInviscidFluxThis class computes the inviscid flux in the mass equation.
• NSMomentumInviscidFluxThe inviscid flux (convective + pressure terms) for the momentum conservation equations.
• NSMomentumInviscidFluxWithGradPThis class computes the inviscid flux with pressure gradient in the momentum equation.
• NSMomentumViscousFluxDerived instance of the NSViscousFluxBase class for the momentum equations.
• NSSUPGEnergyCompute residual and Jacobian terms form the SUPG terms in the energy equation.
• NSSUPGMassCompute residual and Jacobian terms form the SUPG terms in the mass equation.
• NSSUPGMomentumCompute residual and Jacobian terms form the SUPG terms in the momentum equation.
• NSTemperatureL2This class was originally used to solve for the temperature using an L2-projection.
• PressureGradient
• TotalEnergyConvectiveFlux
• Fluid Properties Test App
• NaNInterfaceTestKernelKernel to test NaNInterface using NaNInterfaceTestFluidProperties
• Chemical Reactions App
• CoupledBEEquilibriumSubDerivative of equilibrium species concentration wrt time
• CoupledBEKineticDerivative of kinetic species concentration wrt time
• CoupledConvectionReactionSubConvection of equilibrium species
• CoupledDiffusionReactionSubDiffusion of equilibrium species
• DarcyFluxPressure
• DesorptionFromMatrixMass flow rate from the matrix to the porespace. Add this to TimeDerivative kernel to get complete DE for the fluid adsorbed in the matrix
• DesorptionToPorespaceMass flow rate to the porespace from the matrix. Add this to the other kernels for the porepressure variable to form the complete DE
• PrimaryConvectionConvection of primary species
• PrimaryDiffusionDiffusion of primary species
• PrimaryTimeDerivativeDerivative of primary species concentration wrt time
• Misc Test App
• Convection

### Kernels/PFCRFFKernel

• Phase Field App
• PFCRFFKernelActionSet up kernels for the rational function fit (RFF) phase field crystal model

### Kernels/PolycrystalStoredEnergy

• Phase Field App
• PolycrystalStoredEnergyActionAction that adds the contribution of stored energy associated with dislocations to grain growth models

### Kernels/PoroMechanics

• Tensor Mechanics App
• PoroMechanicsActionSet up stress divergence kernels with coordinate system aware logic

## Mesh

• Moose App
• CreateDisplacedProblemAction
• SetupMeshAction
• SetupMeshCompleteAction
• 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 tmin!0 and tmax!2Pi, a sector of an annulus or disc is created. In this case boundary sidesets are also created a tmin and tmax, and given these names
• ConcentricCircleMeshThis ConcentricCircleMesh source code is to generate concentric circle meshes.
• DistributedGeneratedMeshCreate a line, square, or cube mesh with uniformly spaced or biased elements.
• 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.
• MeshGeneratorMesh
• 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.
• MortarInterfaces
• Partitioner
• Phase Field App
• EBSDMeshMesh generated from a specified DREAM.3D EBSD data file.
• MortarPeriodicMeshSet up an orthogonal mesh with additional dim-1 dimensional side domains for use with the Mortar method.

## MeshGenerators

• Moose App
• AddMeshGeneratorAction
• AllSideSetsByNormalsGenerator
• 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 tmin!0 and tmax!2Pi, a sector of an annulus or disc is created. In this case boundary sidesets are also created a tmin and tmax, and given these names
• BlockDeletionGeneratorMesh modifier which removes elements with the specified subdomain ID
• 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 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. At the momentthis only works on REPLICATED mesh
• ConcentricCircleMeshGeneratorThis ConcentricCircleMesh source code is to generate concentric circle meshes.
• ElementGenerator
• ElementSubdomainIDGenerator
• ExtraNodesetGenerator
• FileMeshGenerator
• 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 value as each element's subdomain ID
• LowerDBlockFromSidesetGeneratorAdds lower dimensional elements on the specified sidesets.
• MeshExtruderGeneratorTakes a 1D or 2D mesh and extrudes the entire structure along the specified axis increasing the dimensionality of the mesh.
• MeshSideSetGeneratorAdd lower dimensional elements along the faces contained in a side set to set up mixed dimensional problems
• OrientedSubdomainBoundingBoxGenerator
• ParsedGenerateSidesetA MeshModifier that adds element's sides to a sideset if the centroid satisfies the combinatorial_geometry expression, (and optionally) if one of the side's elements is in included_subdomain_ids and if it features the correct normal.
• ParsedSubdomainMeshGeneratorMeshModifier that uses a parsed expression (combinatorial_geometry) to determine if an element (aka its centroid) is inside the combinatorial geometry and assigns a new block id.
• PatternedMeshGeneratorCreates a 2D mesh from a specified set of unique 'tiles' meshes and a two-dimensional pattern.
• RenameBlockGeneratorRenameBlock re-numbers or re-names an old_block_id or old_block_name with a new_block_id or new_block_name. If using RenameBlock to merge blocks (by giving them the same name, for instance) it is advisable to specify all your blocks in old_blocks to avoid inconsistencies
• RenameBoundaryGeneratorRenameBoundaryGenerator re-numbers or re-names an old_boundary_id or old_boundary_name with a new_boundary_id or new_boundary_name. If using RenameBoundaryGenerator to merge boundaries (by giving them the same name, for instance) it is advisable to specify all your boundaries in old_boundaries to avoid inconsistencies
• RinglebMeshGeneratorCreates a mesh for the Ringleb problem.
• SideSetsAroundSubdomainGeneratorAdds element faces that are on the exterior of the given block to the sidesets specified
• SideSetsBetweenSubdomainsGenerator
• SideSetsFromBoundingBoxGeneratorFind sidesets with given boundary ids in bounding box and add new boundary id. This can be done by finding all required boundary and adding the new boundary id to those sidesets. Alternatively, a number of boundary ids can be provided and all nodes within the bounding box that have all the required boundary ids will have a newboundary id added.
• 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
• SpiralAnnularMeshGeneratorCreates an annual mesh based on TRI3 elements (it can also be TRI6 elements) on several rings.
• StitchedMeshGenerator
• SubdomainBoundingBoxGeneratorChanges the subdomain ID of elements either (XOR) inside or outside the specified box to the specified ID.
• SubdomainIDGenerator
• TiledMeshGeneratorUse the supplied mesh and create a tiled grid by repeating this mesh in the x,y, and z directions.
• TransformGeneratorApplies a linear transform to the entire mesh.

## MeshModifiers

• Moose App
• AddMeshModifierAction
• AddAllSideSetsByNormals
• AddExtraNodeset
• AddSideSetsFromBoundingBoxFind sidesets with given boundary ids in bounding box and add new boundary id. This can be done by finding all required boundary and adding the new boundary id to those sidesets. Alternatively, a number of boundary ids can be provided and all nodes within the bounding box that have all the required boundary ids will have a newboundary id added.
• AssignElementSubdomainID
• AssignSubdomainID
• BlockDeleterMesh modifier which removes elements with the specified subdomain ID
• BoundingBoxNodeSetAssigns all of the nodes either inside or outside of a bounding box to a new nodeset.
• BreakBoundaryOnSubdomainBreak 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
• BreakMeshByBlockBreak 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. At the momentthis only works on REPLICATED mesh
• ImageSubdomainSamples an image at the coordinates of each element centroid using the resulting value as each element's subdomain ID
• LowerDBlockFromSidesetAdds lower dimensional elements on the specified sidesets.
• MeshExtruderTakes a 1D or 2D mesh and extrudes the entire structure along the specified axis increasing the dimensionality of the mesh.
• MeshSideSetAdd lower dimensional elements along the faces contained in a side set to set up mixed dimensional problems
• OrientedSubdomainBoundingBox
• ParsedAddSidesetA MeshModifier that adds element's sides to a sideset if the centroid satisfies the combinatorial_geometry expression, (and optionally) if one of the side's elements is in included_subdomain_ids and if it features the correct normal.
• ParsedSubdomainMeshModifierMeshModifier that uses a parsed expression (combinatorial_geometry) to determine if an element (aka its centroid) is inside the combinatorial geometry and assigns a new block id.
• RenameBlockRenameBlock re-numbers or re-names an old_block_id or old_block_name with a new_block_id or new_block_name. If using RenameBlock to merge blocks (by giving them the same name, for instance) it is advisable to specify all your blocks in old_blocks to avoid inconsistencies
• SideSetsAroundSubdomainAdds element faces that are on the exterior of the given block to the sidesets specified
• SideSetsBetweenSubdomains
• SideSetsFromNormalsAdds a new named sideset to the mesh for all faces matching the specified normal.
• SideSetsFromPointsAdds a new sideset starting at the specified point containing all connected element faces with the same normal.
• SmoothMeshUtilizes a simple Laplacian based smoother to attempt to improve mesh quality. Will not move boundary nodes or nodes along block/subdomain boundaries
• SubdomainBoundingBoxChanges the subdomain ID of elements either (XOR) inside or outside the specified box to the specified ID.
• TransformApplies a linear transform to the entire mesh.

## Modules

### Modules/NavierStokes

#### Modules/NavierStokes/BCs

• Navier Stokes App
• AddNavierStokesBCsActionThis class allows us to have a section of the input file like the following which adds BC objects for each requested boundary condition.
• NSNoPenetrationBCThis class facilitates adding solid wall 'no penetration' BCs for the Euler equations.
• NSStaticPressureOutletBCThis class facilitates adding specified static pressure outlet BCs for the Euler equations.
• NSWeakStagnationInletBCThis class facilitates adding weak stagnation inlet BCs via an Action by setting up the required parameters.

#### Modules/NavierStokes/ICs

• Navier Stokes App
• AddNavierStokesICsActionThis class allows us to have a section of the input file like the following which automatically adds initial conditions for all the required nonlinear and auxiliary variables.

#### Modules/NavierStokes/Kernels

• Navier Stokes App
• AddNavierStokesKernelsActionThis class allows us to have a section of the input file like the following which automatically adds Kernels and AuxKernels for all the required nonlinear and auxiliary variables.

#### Modules/NavierStokes/Variables

• Navier Stokes App
• AddNavierStokesVariablesActionThis class allows us to have a section of the input file like the following which automatically adds all the required nonlinear variables with the appropriate scaling.

### Modules/PhaseField

#### Modules/PhaseField/Conserved

• Phase Field App
• ConservedActionSet up the variable(s) and the kernels needed for a conserved phase field variable. Note that for a direct solve, the element family and order are overwritten with hermite and third.

#### Modules/PhaseField/DisplacementGradients

• Phase Field App
• DisplacementGradientsActionSet up variables, kernels, and materials for a the displacement gradients and their elastic free energy derivatives for non-split Cahn-Hilliard problems.

#### Modules/PhaseField/EulerAngles2RGB

• Phase Field App
• EulerAngle2RGBActionSet up auxvariables and auxkernels to output Euler angles as RGB values interpolated across inverse pole figure

#### Modules/PhaseField/GrainGrowth

• Phase Field App
• GrainGrowthActionSet up the variable and the kernels needed for a grain growth simulation

#### Modules/PhaseField/MortarPeriodicity

• Phase Field App
• MortarPeriodicActionAdd mortar interfaces, Lagrange multiplier variables, and constraints to implement mortar based periodicity of values or gradients on a MortarPeriodicMesh

#### Modules/PhaseField/Nonconserved

• Phase Field App
• NonconservedActionSet up the variable and the kernels needed for a nonconserved phase field variable

### Modules/TensorMechanics

#### Modules/TensorMechanics/LineElementMaster

• Tensor 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.

## PorousFlowBasicTHM

• Porous Flow App
• PorousFlowBasicTHMAdds Kernels and fluid-property Materials necessary to simulate a single-phase, single-component fully-saturated flow problem. No upwinding and no mass lumping of the fluid mass are used. The fluid-mass time derivative is close to linear, and is perfectly linear if multiply_by_density=false. These features mean the results may differ slightly from the Unsaturated Action case. To run a simulation you will also need to provide various other Materials for each mesh block, depending on your simulation type, viz: permeability, constant Biot modulus, constant thermal expansion coefficient, porosity, elasticity tensor, strain calculator, stress calculator, matrix internal energy, thermal conductivity, diffusivity

## PorousFlowFullySaturated

• Porous Flow App
• PorousFlowFullySaturatedAdds Kernels and fluid-property Materials necessary to simulate a single-phase fully-saturated flow problem. No upwinding of fluid flow is used, so the results may differ slightly from the Unsaturated Action. No Kernels for diffusion and dispersion of fluid components are added. To run a simulation you will also need to provide various other Materials for each mesh block, depending on your simulation type, viz: permeability, porosity, elasticity tensor, strain calculator, stress calculator, matrix internal energy, thermal conductivity, diffusivity

## PorousFlowUnsaturated

• Porous Flow App
• PorousFlowUnsaturatedAdds Kernels and fluid-property Materials necessary to simulate a single-phase saturated-unsaturated flow problem. The saturation is computed using van Genuchten's expression. No Kernels for diffusion and dispersion of fluid components are added. To run a simulation you will also need to provide various other Materials for each mesh block, depending on your simulation type, viz: permeability, porosity, elasticity tensor, strain calculator, stress calculator, matrix internal energy, thermal conductivity, diffusivity