OpenPronghorn Input File Syntax
Listed below are all of the possible input parameter options for a OpenPronghorn input file. Click the blue link shown to the right of each heading to see a more detailed description of its purpose.
For a filtered list of OpenPronghorn-only syntax, please click here.
ActionComponents
- Moose App
- CombineComponentsMeshesCombines meshes generated by disjoined components.
- CreateMeshSetupActionsForComponentsAdds the SetupMesh-Actions to the simulation, if they are not created by the Mesh block.
- AddActionComponentActionAction responsible for creating component actions. A component action is a component derived from an Action base class
- ComponentJunctionComponent to join two other components.
- CylinderComponentCylindrical component.
- MeshGeneratorComponentComponent with a mesh coming from a mesh generator.
Adaptivity
- Moose App
- SetAdaptivityOptionsActionAction for defining adaptivity parameters.
- Indicators
- Markers
Adaptivity/Indicators
- Moose App
- AddElementalFieldActionAdds elemental auxiliary variable for adaptivity system.
- AddIndicatorActionAdd an Indicator object to a simulation.
- AnalyticalIndicatorCompute the square of the error as the difference between an unknown variable and an analytical solution.
- ArrayMooseVariableUsed for grouping standard field variables with the same finite element family and order
- GradientJumpIndicatorCompute the jump of the solution gradient across element boundaries.
- LaplacianJumpIndicatorCompute the jump of the solution laplacian across element bondaries.
- 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
- ValueJumpIndicatorCompute the jump of the solution across element bondaries.
- VectorMooseVariableRepresents vector field variables, e.g. Vector Lagrange, Nedelec or Raviart-Thomas
- VectorValueJumpIndicatorCompute the jump of the solution across element bondaries.
- Navier Stokes App
- BernoulliPressureVariableBase class for Moose variables. This should never be the terminal object type
- INSFVEnergyVariableBase class for Moose variables. This should never be the terminal object type
- INSFVPressureVariableBase class for Moose variables. This should never be the terminal object type
- INSFVScalarFieldVariableBase class for Moose variables. This should never be the terminal object type
- INSFVVelocityVariableBase class for Moose variables. This should never be the terminal object type
- PINSFVSuperficialVelocityVariableBase class for Moose variables. This should never be the terminal object type
- PiecewiseConstantVariableBase class for Moose variables. This should never be the terminal object type
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
- Navier Stokes App
- BernoulliPressureVariableBase class for Moose variables. This should never be the terminal object type
- INSFVEnergyVariableBase class for Moose variables. This should never be the terminal object type
- INSFVPressureVariableBase class for Moose variables. This should never be the terminal object type
- INSFVScalarFieldVariableBase class for Moose variables. This should never be the terminal object type
- INSFVVelocityVariableBase class for Moose variables. This should never be the terminal object type
- PINSFVSuperficialVelocityVariableBase class for Moose variables. This should never be the terminal object type
- PiecewiseConstantVariableBase class for Moose variables. This should never be the terminal object type
Application
- Moose App
- CreateApplicationBlockActionAdds application and application related parameters.
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.
- ElementAdaptivityLevelAuxstores the element hierarchy in a aux variable
- ElementH1ErrorFunctionAuxComputes the H1 or W^{1,p} error between an exact function and a coupled variable.
- ElementIntegerAuxCreates a field showing the element integer.
- ElementL2ErrorFunctionAuxA class for computing the element-wise L^2 (Euclidean) error between a function and a coupled variable.
- ElementLengthAuxCompute the element size using Elem::hmin() or Elem::hmax() from libMesh.
- ElementLpNormAuxCompute an elemental field variable (single value per element) equal to the Lp-norm of a coupled Variable.
- ElementNormalAuxAuxKernel to compute components of the element normal. This is mostly designed for 2D elements living in 3D space, however, the 1D-element and 3D-element cases are handled as special cases. The Variable for this AuxKernel must be an elemental Variable
- ElementQualityAuxGenerates a field containing the quality metric for each element. Useful for visualizing mesh quality.
- ElementUOAuxAux Kernel to display generic spatial (elemental) information from a UserObject that satisfies the underlying ElementUOProvider interface.
- ExtraElementIDAuxPuts element extra IDs into an aux variable.
- ForcingFunctionAuxAuxiliary Kernel that adds a forcing function to the value of an AuxVariable from the previous time step.
- FunctionArrayAuxAuxiliary Kernel that creates and updates an array field variable by sampling functions through space and time.
- FunctionAuxAuxiliary Kernel that creates and updates a field variable by sampling a function through space and time.
- FunctorAuxEvaluates a functor (variable, function or functor material property) on the current element, quadrature point, or node.
- FunctorCoordinatesFunctionAuxAuxiliary Kernel that creates and updates a field variable by sampling a function with functors (variables, functions, others) as the coordinates.
- FunctorElementalAuxEvaluates a functor (variable, function or functor material property) on the current element, quadrature point, or node.
- FunctorElementalGradientAuxEvaluates the gradient of a functor (variable, function or functor material property) on the current element or quadrature point.
- FunctorMaterialRealAuxOutputs element volume-averaged material properties
- FunctorMaterialRealVectorValueAuxCapture a component of a vector material property in an auxiliary variable.
- FunctorVectorElementalAuxEvaluates a vector functor (material property usually) on the current element.For finite volume, this evaluates the vector functor at the centroid.
- GapValueAuxReturn the nearest value of a variable on a boundary from across a gap.
- GhostingAuxColors the elements ghosted to the chosen PID.
- GhostingFromUOAuxColors the elements ghosted to the chosen PID.
- HardwareIDAuxCreates a field showing the assignment of partitions to physical nodes in the cluster.
- InterfaceValueUserObjectAuxGet stored value from the specified InterfaceQpUserObjectBase.
- MaterialRankFourTensorAuxAccess a component of a RankFourTensor for automatic material property output
- MaterialRankTwoTensorAuxAccess a component of a RankTwoTensor for automatic material property output
- MaterialRateRealAuxOutputs element material properties rate of change
- MaterialRealAuxOutputs element volume-averaged material properties
- MaterialRealDenseMatrixAuxPopulate an auxiliary variable with an entry from a dense matrix material property.
- MaterialRealTensorValueAuxObject for extracting a component of a rank two tensor material property to populate an auxiliary variable.
- MaterialRealVectorValueAuxCapture a component of a vector material property in an auxiliary variable.
- MaterialStdVectorAuxExtracts a component of a material type std::vector<Real> to an aux variable. If the std::vector is not of sufficient size then zero is returned
- MaterialStdVectorRealGradientAuxExtracts a component of a material's std::vector<RealGradient> to an aux variable. If the std::vector is not of sufficient size then zero is returned
- MaterialSymmetricRankFourTensorAuxAccess a component of a RankTwoTensor for automatic material property output
- MaterialSymmetricRankTwoTensorAuxCapture a component of a vector material property in an auxiliary variable.
- MeshDivisionAuxReturns the value of the mesh division index for each element / node
- NearestNodeDistanceAuxStores the distance between a block and boundary or between two boundaries.
- NearestNodeValueAuxRetrieves a field value from the closest node on the paired boundary and stores it on this boundary or block.
- NodalPatchRecoveryAuxThis Auxkernel solves a least squares problem at each node to fit a value from quantities defined on quadrature points.
- NormalizationAuxNormalizes a variable based on a Postprocessor value.
- ParsedAuxSets a field variable value to the evaluation of a parsed expression.
- ParsedVectorAuxSets a field vector variable value to the evaluation of a parsed expression.
- PenetrationAuxAuxiliary Kernel for computing several geometry related quantities between two contacting bodies.
- PorousFlowElementNormalAuxKernel to compute components of the element normal. This is mostly designed for 2D elements living in 3D space, however, the 1D-element and 3D-element cases are handled as special cases. The Variable for this AuxKernel must be an elemental Variable
- ProcessorIDAuxCreates a field showing the processors and partitioning.
- ProjectedMaterialPropertyNodalPatchRecoveryAuxThis Auxkernel solves a least squares problem at each node to fit a value from quantities defined on quadrature points.
- ProjectedStatefulMaterialRankFourTensorAuxPicks a component of an indexable material property to get projected on an elemental Auxvariable. For use by ProjectedStatefulMaterialStorageAction.
- ProjectedStatefulMaterialRankTwoTensorAuxPicks a component of an indexable material property to get projected on an elemental Auxvariable. For use by ProjectedStatefulMaterialStorageAction.
- ProjectedStatefulMaterialRealAuxPicks a component of an indexable material property to get projected on an elemental Auxvariable. For use by ProjectedStatefulMaterialStorageAction.
- ProjectedStatefulMaterialRealVectorValueAuxPicks a component of an indexable material property to get projected on an elemental Auxvariable. For use by ProjectedStatefulMaterialStorageAction.
- ProjectionAuxReturns the specified variable as an auxiliary variable with a projection of the source variable. If they are the same type, this amounts to a simple copy.
- QuotientAuxDivides two coupled variables.
- SecondTimeDerivativeAuxReturns the second order time derivative of the specified variable as an auxiliary variable.
- SelfAuxReturns the specified variable as an auxiliary variable with a projection of the source variable. If they are the same type, this amounts to a simple copy.
- SolutionAuxCreates fields by using information from a SolutionUserObject.
- SpatialUserObjectAuxPopulates an auxiliary variable with a spatial value returned from a UserObject spatialValue method.
- TagMatrixAuxCouple the diagonal of a tag matrix, and return its nodal value
- TagVectorArrayVariableAuxCouple a tagged vector, and return its evaluations at degree of freedom indices corresponding to the coupled array variable.
- TagVectorArrayVariableValueAuxCouple a tagged vector, and return its array value.
- TagVectorAuxExtract DOF values from a tagged vector into an AuxVariable
- TimeDerivativeAuxReturns the time derivative of the specified variable/functor as an auxiliary variable.
- VariableGradientComponentCreates a field consisting of one component of the gradient of a coupled variable.
- VariableTimeIntegrationAuxIntegrates a field variable in time.
- VectorFunctionAuxAuxiliary Kernel that creates and updates a vector field variable by sampling a Function object, via the vectorValue method, through space and time.
- VectorMagnitudeAuxCreates a field representing the magnitude of three coupled variables using an Euclidean norm.
- VectorMaterialRealVectorValueAuxConverts a vector-quantity material property into a vector auxiliary variable
- VectorPostprocessorVisualizationAuxRead values from a VectorPostprocessor that is producing vectors that are 'number of processors' * in length. Puts the value for each processor into an elemental auxiliary field.
- VectorVariableComponentAuxCreates a field consisting of one component of a coupled vector variable.
- VectorVariableMagnitudeAuxCreates a field consisting of the magnitude of a coupled vector variable.
- VolumeAuxAuxiliary Kernel that samples volumes.
- WeightedGapAuxReturns the specified variable as an auxiliary variable with the same value.
- Misc App
- CoupledDirectionalMeshHeightInterpolationScales a variable based on position relative to the model bounds in a specified direction
- Fluid Properties App
- FluidDensityAuxComputes density from pressure and temperature
- PressureAuxComputes pressure given specific volume and specific internal energy
- SaturationTemperatureAuxComputes saturation temperature from pressure and 2-phase fluid properties object
- SpecificEnthalpyAuxComputes specific enthalpy from pressure and temperature
- StagnationPressureAuxComputes stagnation pressure from specific volume, specific internal energy, and velocity
- StagnationTemperatureAuxComputes stagnation temperature from specific volume, specific internal energy, and velocity
- TemperatureAuxComputes temperature given specific volume and specific internal energy
- Open Pronghorn App
- WallDistanceAuxComputes the distance from the nearest wall.
- kEpsilonViscosityCalculates the turbulent viscosity according to the k-epsilon family of models.
- Navier Stokes App
- CourantComputes |u| dt / h_min.
- EnthalpyAuxThis AuxKernel computes the specific enthalpy of the fluidfrom the total energy and the pressure.
- HasPorosityJumpFaceShows whether an element has any attached porosity jump faces
- INSCourantComputes h_min / |u|.
- INSFVMixingLengthTurbulentViscosityAuxComputes the turbulent viscosity for the mixing length model.
- INSQCriterionAuxThis class computes the Q criterion, a scalar whichaids in vortex identification in turbulent flows
- INSStressComponentAuxThis class computes the stress component based on pressure and velocity for incompressible Navier-Stokes
- InternalEnergyAuxThis AuxKernel computes the internal energy based on the equation of state / fluid properties and the local pressure and density.
- NSInternalEnergyAuxAuxiliary kernel for computing the internal energy of the fluid.
- NSLiquidFractionAuxComputes liquid fraction given the temperature.
- NSMachAuxAuxiliary kernel for computing the Mach number assuming an ideal gas.
- NSPressureAuxNodal auxiliary variable, for computing pressure at the nodes.
- NSSpecificTotalEnthalpyAuxNodal auxiliary variable, for computing enthalpy at the nodes.
- NSTemperatureAuxTemperature is an auxiliary value computed from the total energy based on the FluidProperties.
- NSVelocityAuxVelocity auxiliary value.
- PecletNumberFunctorAuxComputes the Peclet number: u*L/alpha.
- RANSYPlusAuxCalculates non-dimensional wall distance (y+) value.
- ReynoldsNumberFunctorAuxComputes rho*u*L/mu.
- SpecificInternalEnergyAuxThis AuxKernel computes the specific internal energy based from the total and the kinetic energy.
- SpecificVolumeAuxThis auxkernel computes the specific volume of the fluid.
- TurbulentConductivityAuxCalculates the turbulent heat conductivity.
- WallDistanceMixingLengthAuxComputes the turbulent mixing length by assuming that it is proportional to the distance from the nearest wall. The mixinglength is capped at a distance proportional to inputted parameter delta.
- WallFunctionWallShearStressAuxCalculates the wall shear stress based on algebraic standard velocity wall functions.
- WallFunctionYPlusAuxCalculates y+ value according to the algebraic velocity standard wall function.
- kEpsilonViscosityAuxCalculates the turbulent viscosity according to the k-epsilon model.
- Heat Transfer App
- JouleHeatingHeatGeneratedAuxCompute heat generated from Joule heating.
AuxScalarKernels
- Moose App
- AddScalarKernelActionAdd a AuxScalarKernel object to the simulation.
- ConstantScalarAuxSets an auxiliary field variable to a controllable constant value.
- FunctionScalarAuxSets a value of a scalar variable based on a function.
- QuotientScalarAuxCompute the ratio of two scalar variables.
- ScalarTagMatrixAuxCouple a tag matrix, and return its nodal value
- ScalarTagVectorAuxCouple a tag vector, and return its value
- SolutionScalarAuxSets scalar variable by using information from a SolutionUserObject.
AuxVariables
- Moose App
- AddAuxVariableActionAdd auxiliary variable to the simulation.
- CopyNodalVarsActionCopies variable information from a file.
- ArrayMooseVariableUsed for grouping standard field variables with the same finite element family and order
- 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
- VectorMooseVariableRepresents vector field variables, e.g. Vector Lagrange, Nedelec or Raviart-Thomas
- Navier Stokes App
- BernoulliPressureVariableBase class for Moose variables. This should never be the terminal object type
- INSFVEnergyVariableBase class for Moose variables. This should never be the terminal object type
- INSFVPressureVariableBase class for Moose variables. This should never be the terminal object type
- INSFVScalarFieldVariableBase class for Moose variables. This should never be the terminal object type
- INSFVVelocityVariableBase class for Moose variables. This should never be the terminal object type
- PINSFVSuperficialVelocityVariableBase class for Moose variables. This should never be the terminal object type
- PiecewiseConstantVariableBase class for Moose variables. This should never be the terminal object type
BCs
- Moose App
- AddBCActionAdd a BoundaryCondition object to the simulation.
- ADArrayDirichletBCImposes the essential boundary condition , where are constant, controllable values.
- 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
- AdvectionIPHDGPrescribedFluxBCImplements a prescribed flux 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 .
- BoundaryIntegralValueConstraintEnforces a prescribed average value for a finite element variable on a boundary using a scalar Lagrange multiplier.
- ConservativeAdvectionBCBoundary condition for advection when it is integrated by parts. Supports Dirichlet (inlet-like) and implicit (outlet-like) conditions.
- 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.
- CoupledConvectiveFluxIntegrated boundary condition for modeling a convective heat flux.
- 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.
- HeatConductionBCBoundary condition for a diffusive heat flux.
- InfiniteCylinderRadiativeBCBoundary condition for radiative heat exchange with a cylinderwhere the boundary is approximated as a cylinder as well.
- Navier Stokes App
- AdvectionBCBoundary conditions for outflow/outflow of advected quantities: phi * velocity * normal, where phi is the advected quantitiy
- EnergyFreeBCImplements free advective flow boundary conditions for the energy equation.
- FluidWallMomentumBCImplicitly sets normal component of velocity to zero if the advection term of the momentum equation is integrated by parts
- INSADDisplaceBoundaryBCBoundary condition for displacing a boundary
- INSADDummyDisplaceBoundaryIntegratedBCThis object adds Jacobian entries for the boundary displacement dependence on the velocity
- INSADMomentumNoBCBCThis class implements the 'No BC' boundary condition based on the 'Laplace' form of the viscous stress tensor.
- INSADSurfaceTensionBCSurface tension stresses.
- INSADVaporRecoilPressureMomentumFluxBCVapor recoil pressure momentum flux
- INSFEFluidEnergyBCSpecifies flow of energy through a boundary
- INSFEFluidEnergyDirichletBCImposes a Dirichlet condition on temperature at inlets. Is not applied at outlets
- INSFEFluidMassBCSpecifies flow of mass through a boundary given a velocity function or postprocessor
- INSFEFluidMomentumBCSpecifies flow of momentum through a boundary
- INSFEFluidWallMomentumBCImplicitly sets normal component of velocity to zero if the advection term of the momentum equation is integrated by parts
- INSFEMomentumFreeSlipBCImplements free slip boundary conditions for the Navier Stokesmomentum equation.
- 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'.
- MDFluidEnergyBCSpecifies flow of energy through a boundary
- MDFluidEnergyDirichletBCImposes a Dirichlet condition on temperature at inlets. Is not applied at outlets
- MDFluidMassBCSpecifies flow of mass through a boundary given a velocity function or postprocessor
- MDFluidMomentumBCSpecifies flow of momentum through a boundary
- MDMomentumFreeSlipBCImplements free slip boundary conditions for the Navier Stokesmomentum equation.
- MassContinuityIPHDGBCAdds to mass conservation terms on boundary faces
- MassFluxPenaltyBCintroduces a jump correction on exterior faces for grad-div stabilization for discontinuous Galerkin methods.
- MassFreeBCImplements free advective flow boundary conditions for the mass equation.
- MassMatrixIntegratedBCComputes a finite element mass matrix meant for use in preconditioning schemes which require one
- MomentumFreeBCImplements free flow boundary conditions for one of the momentum equations.
- MomentumFreeSlipBCImplements free slip boundary conditions for the Navier Stokesmomentum equation.
- 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.
- NavierStokesLHDGOutflowBCImplements an outflow boundary condition for use with a hybridized discretization of the incompressible Navier-Stokes equations
- NavierStokesLHDGVelocityDirichletBCWeakly imposes Dirichlet boundary conditions for the velocity for a hybridized discretization of the Navier-Stokes equations
- NavierStokesStressIPHDGDirichletBCWeakly imposes Dirichlet boundary conditions for a hybridized discretization of a Navier-Stokes equation stress term
- NavierStokesStressIPHDGPrescribedTractionBCImplements a prescribed stress boundary condition for use with a hybridized discretization of the Navier-Stokes equation
- Rdg App
- AEFVBCA boundary condition kernel for the advection equation using a cell-centered finite volume method.
BCs/Periodic
- Moose App
- AddPeriodicBCActionAction that adds periodic boundary conditions
Bounds
- Moose App
- AddBoundsVectorsActionAction to add vectors to nonlinear system when using the Bounds syntax.
- AddBoundActionAdd a Kernel object to the simulation.
- ConstantBoundsProvides constant bound of a variable for the PETSc's variational inequalities solver
- ConstantBoundsAuxProvides constant bound of a variable for the PETSc's variational inequalities solver
- VariableOldValueBoundsUses the old variable values as the bounds for the new solve.
- VariableOldValueBoundsAuxUses the old variable values as the bounds for the new solve.
ChainControls
- Moose App
- AddChainControlActionAdds a ChainControl to the control warehouse.
- GetFunctionValueChainControlCreates a control data and populates it by evaluating a Function.
- GetPostprocessorChainControlCopies a post-processor value into a ChainControlData.
- LimitChainControlLimits a control value by a range.
- PIDChainControlImplements a proportional-integral-derivative (PID) controller.
- ParsedChainControlParses and evaluates a function expression to populate a control value.
- RealToBoolChainControlConverts a Real-valued chain control data to boolean.
- ScaleOldChainControlScales an old control value by another control value.
- SetBoolValueChainControlSets parameter(s) of type 'bool' to a control data value of type 'bool'.
- SetRealValueChainControlSets parameter(s) of type 'double' to a control data value of type 'double'.
- SmootherChainControlComputes a moving average of the input control with a user-specified number of points to average.
- TerminateChainControlTerminates the simulation when a boolean chain control data has a certain value.
- UnitTripChainControlTrips a boolean value if an input boolean value is a certain value.
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
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
- 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
Convergence
- Moose App
- AddConvergenceActionAdd a Convergence object to the simulation.
- DefaultMultiAppFixedPointConvergenceDefault fixed point convergence criteria.
- DefaultNonlinearConvergenceDefault convergence criteria for FEProblem.
- DefaultSteadyStateConvergenceDefault convergence criteria for steady-state detection in a transient simulation.
- IterationCountConvergenceChecks the iteration count.
- MultiPostprocessorConvergenceConverges if multiple post-processors are all less than tolerances.
- ParsedConvergenceEvaluates convergence from a parsed expression.
- PostprocessorConvergenceCompares the absolute value of a post-processor to a tolerance.
- PostprocessorSteadyStateConvergenceCompares the absolute value of a post-processor to a tolerance for steady-state checks.
- ReferenceResidualConvergenceCheck the convergence of a problem with respect to a user-supplied reference solution. Replaces ReferenceResidualProblem, currently still used in conjunction with it.
Correctors
- Moose App
- AddCorrectorActionAdd a Corrector object to the simulation.
- PointwiseRenormalizeVectorPointwise renormalize the solution of a set of variables comprising a vector
- Navier Stokes App
- NSFVPressurePinPins the pressure after a solve
- NSPressurePinPins the pressure after a solve
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.
- Navier Stokes App
- MassFluxPenaltyIntroduces a jump correction on internal faces for grad-div stabilization for discontinuous Galerkin methods. Because this is derived from DGKernel this class executes once per face.
- MassMatrixDGKernelComputes a finite element mass matrix on internal faces meant for use in preconditioning schemes which require one
- Rdg App
- AEFVKernelA dgkernel for the advection equation using a cell-centered finite volume method.
Dampers
- Moose App
- AddDamperActionAdd a Damper object to the simulation.
- BoundingValueElementDamperThis class implements a damper that limits the value of a variable to be within user-specified bounds.
- BoundingValueNodalDamperLimits the value of a variable to be within user-specified bounds.
- ConstantDamperModifies the non-linear step by applying a constant damping factor.
- MaxIncrementLimits a variable's update by some max fraction
Debug
- Moose App
- SetupDebugActionAdds various debugging type output to the simulation system.
- SetupResidualDebugActionAdds the necessary objects for computing the residuals for individual variables.
- MaterialDerivativeTest
Debug/MaterialDerivativeTest
- Moose App
- MaterialDerivativeTestActionAction for setting up the necessary objects for debugging material property derivatives.
DeprecatedBlock
- Moose App
- DeprecatedBlockActionTool for marking input syntax as deprecated.
DiracKernels
- Moose App
- AddDiracKernelActionAdd a DiracKernel object to the simulation.
- ConstantPointSourceResidual contribution of a constant point source term.
- FunctionDiracSourceResidual contribution from a point source defined by a function.
- FunctorDiracKernelComputes a dirac source using a functor.
- ReporterPointSourceApply a point load defined by Reporter.
- VectorConstantPointSourceResidual contribution of a constant point source term.
- Heat Transfer App
- GapHeatPointSourceMasterDirac kernel to create a heat source on the primary contact surface in thermal contact.
Distributions
- Moose App
- AddDistributionActionAdd a Distribution object to the simulation.
Executioner
- Moose App
- CreateExecutionerActionAdd an Executioner object to the simulation.
- EigenvalueEigenvalue solves a standard/generalized linear or nonlinear eigenvalue problem
- InversePowerMethodInverse power method for eigenvalue problems.
- NonlinearEigenExecutioner for eigenvalue problems.
- SteadyExecutioner for steady-state simulations.
- TransientExecutioner for time varying simulations.
- Adaptivity
- Predictor
- Quadrature
- TimeIntegrator
- TimeIntegrators
- TimeStepper
- TimeSteppers
- Navier Stokes App
- PIMPLESolves the transient Navier-Stokes equations using the PIMPLE algorithm and linear finite volume variables.
- SIMPLESolves the Navier-Stokes equations using the SIMPLE algorithm and linear finite volume variables.
- SIMPLENonlinearAssemblySolves the Navier-Stokes equations using the SIMPLENonlinearAssembly algorithm.
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
- Moose App
- SetupQuadratureActionSets the quadrature type for the simulation.
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.
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.
Executioner/TimeStepper
- Moose App
- AddTimeStepperActionAdd a TimeStepper object to the simulation.
- AB2PredictorCorrectorImplements second order Adams-Bashforth method for timestep calculation.
- CSVTimeSequenceStepperSolves the Transient problem at a sequence of given time points read in a file.
- CompositionDTThe time stepper takes all the other time steppers as input and returns the minimum time step size.
- ConstantDTTimestepper that takes a constant time step size
- ExodusTimeSequenceStepperSolves the Transient problem at a sequence of time points taken from a specified exodus file.
- FixedPointIterationAdaptiveDTComputes time step size based on a target number of fixed point iterations
- FunctionDTTimestepper whose steps vary over time according to a user-defined function
- IterationAdaptiveDTAdjust the timestep based on the number of iterations
- LogConstantDTTimeStepper which imposes a time step constant in the logarithmic space
- PostprocessorDTComputes timestep based on a Postprocessor value.
- SolutionTimeAdaptiveDTCompute simulation timestep based on actual solution time.
- TimeSequenceFromTimesSolves the Transient problem at a sequence of time points taken from a specified Times object.
- TimeSequenceStepperSolves the Transient problem at a sequence of given time points.
Executioner/TimeSteppers
- Moose App
- ComposeTimeStepperActionAdd the composition time stepper if multiple time steppers have been created.
- AddTimeStepperActionAdd a TimeStepper object to the simulation.
- AB2PredictorCorrectorImplements second order Adams-Bashforth method for timestep calculation.
- CSVTimeSequenceStepperSolves the Transient problem at a sequence of given time points read in a file.
- CompositionDTThe time stepper takes all the other time steppers as input and returns the minimum time step size.
- ConstantDTTimestepper that takes a constant time step size
- ExodusTimeSequenceStepperSolves the Transient problem at a sequence of time points taken from a specified exodus file.
- FixedPointIterationAdaptiveDTComputes time step size based on a target number of fixed point iterations
- FunctionDTTimestepper whose steps vary over time according to a user-defined function
- IterationAdaptiveDTAdjust the timestep based on the number of iterations
- LogConstantDTTimeStepper which imposes a time step constant in the logarithmic space
- PostprocessorDTComputes timestep based on a Postprocessor value.
- SolutionTimeAdaptiveDTCompute simulation timestep based on actual solution time.
- TimeSequenceFromTimesSolves the Transient problem at a sequence of time points taken from a specified Times object.
- TimeSequenceStepperSolves the Transient problem at a sequence of given time points.
Executors
- Moose App
- ReadExecutorParamsActionAdd an Executor object to the simulation.
- NullExecutorDummy executor that does nothing. Useful for testing among other things.
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
- Navier Stokes App
- CNSFVHLLCFluidEnergyImplicitBCImplements an implicit advective boundary flux for the fluid energy equation for an HLLC discretization
- CNSFVHLLCFluidEnergyStagnationInletBCAdds the boundary fluid energy flux for HLLC when provided stagnation temperature and pressure
- CNSFVHLLCMassImplicitBCImplements an implicit advective boundary flux for the mass equation for an HLLC discretization
- CNSFVHLLCMassStagnationInletBCAdds the boundary mass flux for HLLC when provided stagnation temperature and pressure
- CNSFVHLLCMomentumImplicitBCImplements an implicit advective boundary flux for the momentum equation for an HLLC discretization
- CNSFVHLLCMomentumSpecifiedPressureBCImplements an HLLC boundary condition for the momentum conservation equation in which the pressure is specified.
- CNSFVHLLCMomentumStagnationInletBCAdds the boundary momentum flux for HLLC when provided stagnation temperature and pressure
- CNSFVHLLCSpecifiedMassFluxAndTemperatureFluidEnergyBCImplements the fluid energy boundary flux portion of the free-flow HLLC discretization given specified mass fluxes and fluid temperature
- CNSFVHLLCSpecifiedMassFluxAndTemperatureMassBCImplements the mass boundary flux portion of the free-flow HLLC discretization given specified mass fluxes and fluid temperature
- CNSFVHLLCSpecifiedMassFluxAndTemperatureMomentumBCImplements the momentum boundary flux portion of the free-flow HLLC discretization given specified mass fluxes and fluid temperature
- CNSFVHLLCSpecifiedPressureFluidEnergyBCImplements the fluid energy boundary flux portion of the free-flow HLLC discretization given specified pressure
- CNSFVHLLCSpecifiedPressureMassBCImplements the mass boundary flux portion of the free-flow HLLC discretization given specified pressure
- CNSFVHLLCSpecifiedPressureMomentumBCImplements the momentum boundary flux portion of the free-flow HLLC discretization given specified pressure
- CNSFVMomImplicitPressureBCAdds an implicit pressure flux contribution on the boundary using interior cell information
- FVSpecificEnthalpyFromPressureTemperatureDirichletBCComputes the specific enthalpy at the boundary from the pressure and temperature.
- INSFVAveragePressureValueBCThis class is used to enforce integral of phi = boundary area * phi_0 with a Lagrange multiplier approach.
- INSFVInletIntensityTKEBCAdds inlet boudnary conditon for the turbulent kinetic energy based on turbulent intensity.
- INSFVInletVelocityBCUses the value of a functor to set a Dirichlet boundary value.
- INSFVMassAdvectionOutflowBCOutflow boundary condition for advecting mass.
- INSFVMixingLengthTKEDBCAdds inlet boundary condition for the turbulent kinetic energy dissipation rate based on characteristic length.
- INSFVMomentumAdvectionOutflowBCFully developed outflow boundary condition for advecting momentum. This will impose a zero normal gradient on the boundary velocity.
- INSFVNaturalFreeSlipBCImplements a free slip boundary condition naturally.
- INSFVNoSlipWallBCImplements a no slip boundary condition.
- INSFVOutletPressureBCDefines a Dirichlet boundary condition for finite volume method.
- INSFVScalarFieldSeparatorBCA separator boundary condition that prevents any type of scalar flux and can be used within the domain.
- INSFVSwitchableOutletPressureBCAdds switchable pressure-outlet boundary condition
- INSFVSymmetryPressureBCThough not applied to velocity, this object ensures that the flux (velocity times the advected quantity) into a symmetry boundary is zero. When applied to pressure for the mass equation, this makes the normal velocity zero since density is constant
- INSFVSymmetryScalarBCThough not applied to velocity, this object ensures that the flux (velocity times the advected quantity) into a symmetry boundary is zero. When applied to pressure for the mass equation, this makes the normal velocity zero since density is constant
- INSFVSymmetryVelocityBCImplements a symmetry boundary condition for the velocity.
- INSFVTKEDWallFunctionBCAdds Reichardt extrapolated wall values to set up directly theDirichlet BC for the turbulent kinetic energy dissipation rate.
- INSFVTurbulentTemperatureWallFunctionAdds turbulent temperature wall function.
- INSFVTurbulentViscosityWallFunctionAdds Dirichlet BC for wall values of the turbulent viscosity.
- INSFVVaporRecoilPressureMomentumFluxBCImparts a surface recoil force on the momentum equation due to liquid phase evaporation
- INSFVVelocityHydraulicSeparatorBCA separator boundary condition that prevents any type of momentum flux and can be used within the domain.
- INSFVWallFunctionBCImplements a wall shear BC for the momentum equation based on algebraic standard velocity wall functions.
- NSFVFunctorHeatFluxBCConstant heat flux boundary condition with phase splitting for fluid and solid energy equations
- NSFVHeatFluxBCConstant heat flux boundary condition with phase splitting for fluid and solid energy equations
- NSFVOutflowTemperatureBCOutflow velocity temperature advection boundary conditions for finite volume method allowing for thermal backflow.
- PCNSFVHLLCSpecifiedMassFluxAndTemperatureFluidEnergyBCImplements the fluid energy boundary flux portion of the porous HLLC discretization given specified mass fluxes and fluid temperature
- PCNSFVHLLCSpecifiedMassFluxAndTemperatureMassBCImplements the mass boundary flux portion of the porous HLLC discretization given specified mass fluxes and fluid temperature
- PCNSFVHLLCSpecifiedMassFluxAndTemperatureMomentumBCImplements the momentum boundary flux portion of the porous HLLC discretization given specified mass fluxes and fluid temperature
- PCNSFVHLLCSpecifiedPressureFluidEnergyBCImplements the fluid energy boundary flux portion of the porous HLLC discretization given specified pressure
- PCNSFVHLLCSpecifiedPressureMassBCImplements the mass boundary flux portion of the porous HLLC discretization given specified pressure
- PCNSFVHLLCSpecifiedPressureMomentumBCImplements the momentum boundary flux portion of the porous HLLC discretization given specified pressure
- PCNSFVImplicitMomentumPressureBCSpecifies an implicit pressure at a boundary for the momentum equations.
- PCNSFVStrongBCComputes the residual of advective term using finite volume method.
- PINSFVMomentumAdvectionOutflowBCOutflow boundary condition for advecting momentum in the porous media momentum equation. This will impose a zero normal gradient on the boundary velocity.
- PINSFVSymmetryVelocityBCImplements a symmetry boundary condition for the velocity.
- PWCNSFVMomentumFluxBCFlux boundary conditions for porous momentum advection.
- WCNSFVEnergyFluxBCFlux boundary conditions for energy advection.
- WCNSFVInletTemperatureBCDefines a Dirichlet boundary condition for finite volume method.
- WCNSFVInletVelocityBCDefines a Dirichlet boundary condition for finite volume method.
- WCNSFVMassFluxBCFlux boundary conditions for mass advection.
- WCNSFVMomentumFluxBCFlux boundary conditions for momentum advection.
- WCNSFVScalarFluxBCFlux boundary conditions for scalar quantity advection.
- WCNSFVSwitchableInletVelocityBCAdds switchable inlet-velocity boundary conditionfor weakly compressible flows.
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
- Moose App
- AddFVInterfaceKernelActionAdd a FVInterfaceKernel object to the simulation.
- FVDiffusionInterfaceComputes the residual for diffusion operator across an interface for the finite volume method.
- FVOneVarDiffusionInterfaceComputes residual for diffusion operator across an interface for finite volume method.
- FVTwoVarContinuityConstraintForces two variables to be equal on an interface for the finite volume method.
- Navier Stokes App
- FVConvectionCorrelationInterfaceComputes the residual for a convective heat transfer across an interface for the finite volume method, using a correlation for the heat transfer coefficient.
FVInterpolationMethods
- Moose App
- AddFVInterpolationMethodActionAdd an FVInterpolationMethod object to the simulation.
- FVAdvectedMinmodWeightBasedMinmod interpolation for advected quantities implemented as limited blending weights (no MUSCL reconstruction, no deferred correction).
- FVAdvectedUpwindUpwind interpolation for advected quantities using the face mass flux sign.
- FVAdvectedVanLeerWeightBasedVan Leer interpolation for advected quantities implemented as limited blending weights (no MUSCL reconstruction, no deferred correction).
- FVAdvectedVenkatakrishnanDeferredCorrectionMUSCL reconstruction with Venkatakrishnan-limited cell gradients using deferred correction.
- FVGeometricAverageLinear interpolation that uses the geometric weighting on FaceInfo.
- FVHarmonicAverageHarmonic mean interpolation for finite-volume quantities using FaceInfo geometry weights.
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.
- Navier Stokes App
- CNSFVFluidEnergyHLLCImplements the fluid energy flux portion of the free-flow HLLC discretization.
- CNSFVMassHLLCImplements the mass flux portion of the free-flow HLLC discretization.
- CNSFVMomentumHLLCImplements the momentum flux portion of the free-flow HLLC discretization.
- FVMatPropTimeKernelReturns a material property which should correspond to a time derivative.
- FVPorosityTimeDerivativeA time derivative multiplied by a porosity material property
- INSFVBodyForceBody force that contributes to the Rhie-Chow interpolation
- INSFVEnergyAdvectionAdvects energy, e.g. rho*cp*T. A user may still override what quantity is advected, but the default is rho*cp*T
- INSFVEnergyTimeDerivativeAdds the time derivative term to the incompressible Navier-Stokes energy equation.
- INSFVMassAdvectionObject for advecting mass, e.g. rho
- INSFVMeshAdvectionImplements a source/sink term for this object's variable/advected-quantity proportional to the divergence of the mesh velocity
- INSFVMixingLengthReynoldsStressComputes the force due to the Reynolds stress term in the incompressible Reynolds-averaged Navier-Stokes equations.
- INSFVMixingLengthScalarDiffusionComputes the turbulent diffusive flux that appears in Reynolds-averaged fluid conservation equations.
- INSFVMomentumAdvectionObject for advecting momentum, e.g. rho*u
- INSFVMomentumBoussinesqComputes a body force for natural convection buoyancy.
- INSFVMomentumDiffusionImplements the Laplace form of the viscous stress in the Navier-Stokes equation.
- INSFVMomentumGravityComputes a body force due to gravity in Rhie-Chow based simulations.
- INSFVMomentumMeshAdvectionImplements a momentum source/sink term proportional to the divergence of the mesh velocity
- INSFVMomentumPressureIntroduces the coupled pressure term into the Navier-Stokes momentum equation.
- INSFVMomentumPressureFluxMomentum pressure term eps grad_P, as a flux kernel using the divergence theoreom, in the incompressible Navier-Stokes momentum equation.
- INSFVMomentumTimeDerivativeAdds the time derivative term to the incompressible Navier-Stokes momentum equation.
- INSFVMomentumViscousSourceRZAdds the -\mu u_r / r^2 viscous source term (sign for RHS) that appears in the cylindrical form of the Navier-Stokes momentum equations (axisymmetric, no swirl).
- INSFVPumpEffective body force for a pump that contributes to the Rhie-Chow interpolation
- INSFVScalarFieldAdvectionAdvects an arbitrary quantity, the associated nonlinear 'variable'.
- INSFVTKEDSourceSinkElemental kernel to compute the production and destruction terms of turbulent kinetic energy dissipation (TKED).
- INSFVTKESourceSinkElemental kernel to compute the production and destruction terms of turbulent kinetic energy (TKE).
- INSFVTurbulentAdvectionAdvects an arbitrary turbulent quantity, the associated nonlinear 'variable'.
- INSFVTurbulentDiffusionComputes residual for the turbulent scaled diffusion operator for finite volume method.
- NSFVEnergyAmbientConvectionImplements a solid-fluid ambient convection volumetric term proportional to the difference between the fluid and ambient temperatures : .
- NSFVMixturePhaseInterfaceImplements a phase-to-phase volumetric exchange.
- NSFVPhaseChangeSourceComputes the energy source due to solidification/melting.
- PCNSFVDensityTimeDerivativeA time derivative kernel for which the form is eps * ddt(rho*var).
- PCNSFVFluidEnergyHLLCImplements the fluid energy flux portion of the porous HLLC discretization.
- PCNSFVKTComputes the residual of advective term using finite volume method.
- PCNSFVKTDCComputes the residual of advective term using finite volume method using a deferred correction approach.
- PCNSFVMassHLLCImplements the mass flux portion of the porous HLLC discretization.
- PCNSFVMomentumFrictionComputes a friction force term on fluid in porous media in the Navier Stokes i-th momentum equation.
- PCNSFVMomentumHLLCImplements the momentum flux portion of the porous HLLC discretization.
- PINSFVEnergyAdvectionAdvects energy, e.g. rho*cp*T. A user may still override what quantity is advected, but the default is rho*cp*T
- PINSFVEnergyAmbientConvectionImplements the solid-fluid ambient convection term in the porous media Navier Stokes energy equation.
- PINSFVEnergyAnisotropicDiffusionAnisotropic diffusion term in the porous media incompressible Navier-Stokes equations : -div(kappa grad(T))
- PINSFVEnergyDiffusionDiffusion term in the porous media incompressible Navier-Stokes fluid energy equations :
- PINSFVEnergyTimeDerivativeAdds the time derivative term to the Navier-Stokes energy equation: for fluids: d(eps * rho * cp * T)/dt, for solids: (1 - eps) * d(rho * cp * T)/dtMaterial property derivatives are ignored if not provided.
- PINSFVMassAdvectionObject for advecting mass in porous media mass equation
- PINSFVMomentumAdvectionObject for advecting superficial momentum, e.g. rho*u_d, in the porous media momentum equation
- PINSFVMomentumBoussinesqComputes a body force for natural convection buoyancy in porous media: eps alpha (T-T_0)
- PINSFVMomentumDiffusionViscous diffusion term, div(mu eps grad(u_d / eps)), in the porous media incompressible Navier-Stokes momentum equation.
- PINSFVMomentumFrictionComputes a friction force term on fluid in porous media in the Navier Stokes i-th momentum equation in Rhie-Chow (incompressible) contexts.
- PINSFVMomentumFrictionCorrectionComputes a correction term to avoid oscillations from average pressure interpolation in regions of high changes in friction coefficients.
- PINSFVMomentumGravityComputes a body force, due to gravity on fluid in porous media in Rhie-Chow (incompressible) contexts.
- PINSFVMomentumPressureIntroduces the coupled pressure term into the Navier-Stokes porous media momentum equation.
- PINSFVMomentumPressureFluxMomentum pressure term eps grad_P, as a flux kernel using the divergence theoreom, in the porous media incompressible Navier-Stokes momentum equation. This kernel is also executed on boundaries.
- PINSFVMomentumPressurePorosityGradientIntroduces the coupled pressure times porosity gradient term into the Navier-Stokes porous media momentum equation.
- PINSFVMomentumTimeDerivativeAdds the time derivative term: d(rho u_d) / dt to the porous media incompressible Navier-Stokes momentum equation.
- PINSFVScalarFieldAdvectionAdvects an arbitrary quantity, the associated nonlinear 'variable' in porous medium.
- PNSFVMomentumPressureFluxRZAdds the porous term into the radial component of the Navier-Stokes momentum equation for the problems in the RZ coordinate system when integrating by parts.
- PNSFVMomentumPressureRZAdds the porous term into the radial component of the Navier-Stokes momentum equation for the problems in the RZ coordinate system when integrating by parts.
- PNSFVPGradEpsilonIntroduces a -p * grad_eps term.
- PWCNSFVMassAdvectionObject for advecting mass in porous media mass equation
- PWCNSFVMassTimeDerivativeAdds the time derivative term to the porous weakly-compressible Navier-Stokes continuity equation.
- WCNSFV2PInterfaceAreaSourceSinkSource and sink of interfacial area for two-phase flow mixture model.
- WCNSFV2PMomentumAdvectionSlipComputes the slip velocity advection kernel for two-phase mixture model.
- WCNSFV2PMomentumDriftFluxImplements the drift momentum flux source.
- WCNSFVEnergyTimeDerivativeAdds the time derivative term to the incompressible Navier-Stokes momentum equation.
- WCNSFVMassAdvectionObject for advecting mass, e.g. rho
- WCNSFVMassTimeDerivativeAdds the time derivative term to the weakly-compressible Navier-Stokes continuity equation.
- WCNSFVMixingLengthEnergyDiffusionComputes the turbulent diffusive flux that appears in Reynolds-averaged fluid energy conservation equations.
- WCNSFVMomentumTimeDerivativeAdds the time derivative term to the incompressible Navier-Stokes momentum equation.
FluidProperties
- Fluid Properties App
- AddFluidPropertiesActionAdd a UserObject object to the simulation.
- BrineFluidPropertiesFluid properties for brine
- CO2FluidPropertiesFluid properties for carbon dioxide (CO2) using the Span & Wagner EOS
- CaloricallyImperfectGasFluid properties for an ideal gas with imperfect caloric behavior.
- FlibeFluidPropertiesFluid properties for flibe
- FlinakFluidPropertiesFluid properties for flinak
- HeliumFluidPropertiesFluid properties for helium
- HydrogenFluidPropertiesFluid properties for Hydrogen (H2)
- IdealGasFluidPropertiesFluid properties for an ideal gas
- IdealGasMixtureFluidPropertiesClass for fluid properties of an ideal gas mixture
- IdealRealGasMixtureFluidPropertiesClass for fluid properties of an arbitrary vapor mixture
- LeadBismuthFluidPropertiesFluid properties for Lead Bismuth eutectic 2LiF-BeF2
- LeadFluidPropertiesFluid properties for Lead
- LeadLithiumFluidPropertiesFluid properties for Lead Lithium eutectic (83% Pb, 17% Li)
- MethaneFluidPropertiesFluid properties for methane (CH4)
- NaClFluidPropertiesFluid properties for NaCl
- NaKFluidPropertiesFluid properties for NaK
- NitrogenFluidPropertiesFluid properties for Nitrogen (N2)
- SalineMoltenSaltFluidPropertiesTo use this object, you need to have the
Salinelibrary installed. Refer to the documentation for guidance on how to enable it. (Original description: Molten salt fluid properties using Saline) - SimpleFluidPropertiesFluid properties for a simple fluid with a constant bulk density
- SodiumPropertiesFluid properties for sodium
- SodiumSaturationFluidPropertiesFluid properties for liquid sodium at saturation conditions
- StiffenedGasFluidPropertiesFluid properties for a stiffened gas
- StiffenedGasTwoPhaseFluidPropertiesTwo-phase stiffened gas fluid properties
- TabulatedBicubicFluidPropertiesFluid properties using bicubic interpolation on tabulated values provided
- TabulatedFluidPropertiesFluid properties using bicubic interpolation on tabulated values provided
- TemperaturePressureFunctionFluidPropertiesSingle-phase fluid properties that allows to provide thermal conductivity, density, and viscosity as functions of temperature and pressure.
- TwoPhaseFluidPropertiesIndependent2-phase fluid properties for 2 independent single-phase fluid properties
- TwoPhaseNCGPartialPressureFluidPropertiesTwo-phase fluid with single NCG using partial pressure mixture model
- Water97FluidPropertiesFluid properties for water and steam (H2O) using IAPWS-IF97
FluidPropertiesInterrogator
- Fluid Properties App
- AddFluidPropertiesInterrogatorActionAction that sets up the fluid properties interrogator
Functions
- Moose App
- AddFunctionActionAdd a Function object to the simulation.
- 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 piece-wise constant data using a set of x-y data pairs
- PiecewiseConstantFromCSVUses data read from CSV to assign values
- PiecewiseFunctionFunction which provides a piecewise representation of arbitrary functions
- 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
- Fluid Properties App
- HydrostaticPressureFunctionComputes hydrostatic pressure from a reference point.
- SaturationDensityFunctionComputes saturation density from temperature function
- SaturationPressureFunctionComputes saturation pressure from temperature function and 2-phase fluid properties object
- SaturationTemperatureFunctionComputes saturation temperature from pressure function and 2-phase fluid properties object
- TwoPhaseNCGPartialPressureFunctionComputes a property from a TwoPhaseNCGPartialPressureFluidProperties object.
FunctorMaterials
- Moose App
- AddFunctorMaterialActionAdd a Functor Material object to the simulation.
- ADFunctorChangeFunctorMaterialAdds a functor material property that computes the change in a functor value over a time step, fixed point iteration, or nonlinear iteration.
- ADGenericConstantFunctorMaterialFunctorMaterial object for declaring properties that are populated by evaluation of a Functor (a constant, variable, function or functor material property) objects.
- ADGenericConstantVectorFunctorMaterialFunctorMaterial object for declaring vector properties that are populated by evaluation of functor (constants, functions, variables, matprops) object.
- ADGenericFunctionFunctorMaterialFunctorMaterial object for declaring properties that are populated by evaluation of a Functor (a constant, variable, function or functor material property) objects.
- ADGenericFunctorGradientMaterialFunctorMaterial object for declaring properties that are populated by evaluation of gradients of Functors (a constant, variable, function or functor material property) objects.
- ADGenericFunctorMaterialFunctorMaterial object for declaring properties that are populated by evaluation of a Functor (a constant, variable, function or functor material property) objects.
- ADGenericFunctorTimeDerivativeMaterialFunctorMaterial object for declaring properties that are populated by evaluation of time derivatives of Functors objects. (such as variables, constants, postprocessors). The time derivative is only returned if the 'dot' functor routine is implemented.
- ADGenericVectorFunctorMaterialFunctorMaterial object for declaring vector properties that are populated by evaluation of functor (constants, functions, variables, matprops) object.
- ADParsedFunctorMaterialComputes a functor material from a parsed expression of other functors.
- ADPiecewiseByBlockFunctorMaterialComputes a property value on a per-subdomain basis
- ADPiecewiseByBlockVectorFunctorMaterialComputes a property value on a per-subdomain basis
- ADVectorMagnitudeFunctorMaterialThis class takes up to three scalar-valued functors corresponding to vector components or a single vector functor and computes the Euclidean norm.
- FVADPropValPerSubdomainMaterialComputes a property value on a per-subdomain basis
- FVPropValPerSubdomainMaterialComputes a property value on a per-subdomain basis
- FunctorADConverterConverts regular functors to AD functors and AD functors to regular functors
- FunctorChangeFunctorMaterialAdds a functor material property that computes the change in a functor value over a time step, fixed point iteration, or nonlinear iteration.
- FunctorSmootherCreates smoother functor(s) using various averaging techniques
- GenericConstantFunctorMaterialFunctorMaterial object for declaring properties that are populated by evaluation of a Functor (a constant, variable, function or functor material property) objects.
- GenericConstantVectorFunctorMaterialFunctorMaterial object for declaring vector properties that are populated by evaluation of functor (constants, functions, variables, matprops) object.
- GenericFunctionFunctorMaterialFunctorMaterial object for declaring properties that are populated by evaluation of a Functor (a constant, variable, function or functor material property) objects.
- GenericFunctorGradientMaterialFunctorMaterial object for declaring properties that are populated by evaluation of gradients of Functors (a constant, variable, function or functor material property) objects.
- GenericFunctorMaterialFunctorMaterial object for declaring properties that are populated by evaluation of a Functor (a constant, variable, function or functor material property) objects.
- GenericFunctorTimeDerivativeMaterialFunctorMaterial object for declaring properties that are populated by evaluation of time derivatives of Functors objects. (such as variables, constants, postprocessors). The time derivative is only returned if the 'dot' functor routine is implemented.
- GenericVectorFunctorMaterialFunctorMaterial object for declaring vector properties that are populated by evaluation of functor (constants, functions, variables, matprops) object.
- ParsedFunctorMaterialComputes a functor material from a parsed expression of other functors.
- PiecewiseByBlockFunctorMaterialComputes a property value on a per-subdomain basis
- PiecewiseByBlockVectorFunctorMaterialComputes a property value on a per-subdomain basis
- VectorFunctorADConverterConverts regular functors to AD functors and AD functors to regular functors
- VectorMagnitudeFunctorMaterialThis class takes up to three scalar-valued functors corresponding to vector components or a single vector functor and computes the Euclidean norm.
- Heat Transfer App
- ADChurchillChuHTCFunctorMaterialComputes a heat transfer coefficient using the Churchill-Chu correlation for natural convection.
- ADConvectionHeatFluxFunctorMaterialComputes a convection heat flux from a solid surface to a fluid.
- ADCylindricalGapHeatFluxFunctorMaterialComputes cylindrical gap heat flux due to conduction and radiation.
- ADFinEfficiencyFunctorMaterialComputes fin efficiency.
- ADFinEnhancementFactorFunctorMaterialComputes a heat transfer enhancement factor for fins.
- ADRadiativeP1DiffusionCoefficientMaterialComputes the P1 diffusion coefficient from the opacity and effective scattering cross section.
- ChurchillChuHTCFunctorMaterialComputes a heat transfer coefficient using the Churchill-Chu correlation for natural convection.
- ConvectionHeatFluxFunctorMaterialComputes a convection heat flux from a solid surface to a fluid.
- CylindricalGapHeatFluxFunctorMaterialComputes cylindrical gap heat flux due to conduction and radiation.
- FinEfficiencyFunctorMaterialComputes fin efficiency.
- FinEnhancementFactorFunctorMaterialComputes a heat transfer enhancement factor for fins.
- RadiativeP1DiffusionCoefficientMaterialComputes the P1 diffusion coefficient from the opacity and effective scattering cross section.
- Navier Stokes App
- ADDittusBoelterFunctorMaterialComputes wall heat transfer coefficient using Dittus-Boelter equation
- ADFunctorEffectiveDynamicViscosityComputes the effective dynamic viscosity mu_eff = mu + mu_t / factor
- DittusBoelterFunctorMaterialComputes wall heat transfer coefficient using Dittus-Boelter equation
- ExponentialFrictionFunctorMaterialComputes a Reynolds number-exponential friction factor.
- ExponentialFrictionMaterialComputes a Reynolds number-exponential friction factor.
- FunctorEffectiveDynamicViscosityComputes the effective dynamic viscosity mu_eff = mu + mu_t / factor
- FunctorErgunDragCoefficientsMaterial providing linear and quadratic drag coefficients based on the correlation developed by Ergun.
- FunctorKappaFluidZero-thermal dispersion conductivity
- GeneralFunctorFluidPropsCreates functor fluid properties using a (P, T) formulation
- INSFVEnthalpyFunctorMaterialThis is the material class used to compute enthalpy for the incompressible/weakly-compressible finite-volume implementation of the Navier-Stokes equations.
- INSFVEnthalpyMaterialThis is the material class used to compute enthalpy for the incompressible/weakly-compressible finite-volume implementation of the Navier-Stokes equations.
- INSFVMushyPorousFrictionFunctorMaterialComputes the mushy zone porous resistance for solidification/melting problems.
- INSFVMushyPorousFrictionMaterialComputes the mushy zone porous resistance for solidification/melting problems.
- INSFVkEpsilonViscosityFunctorMaterialComputes the turbulent dynamic viscosity given k and epsilon.
- INSFVkEpsilonViscosityMaterialComputes the turbulent dynamic viscosity given k and epsilon.
- LinearFVEnthalpyFunctorMaterialCreates functors for conversions between specific enthalpy and temperature
- LinearFrictionFactorFunctorMaterialMaterial class used to compute a friction factor of the form A * f(r, t) + B * g(r, t) * |v_I| with A, B vector constants, f(r, t) and g(r, t) functors of space and time, and |v_I| the interstitial speed
- MixingLengthTurbulentViscosityFunctorMaterialComputes the material property corresponding to the total viscositycomprising the mixing length model turbulent total_viscosityand the molecular viscosity.
- MixingLengthTurbulentViscosityMaterialComputes the material property corresponding to the total viscositycomprising the mixing length model turbulent total_viscosityand the molecular viscosity.
- NSFVDispersePhaseDragFunctorMaterialComputes drag coefficient for dispersed phase.
- NSFVFrictionFlowDiodeFunctorMaterialIncreases the anistropic friction coefficients, linear or quadratic, by K_i * |direction_i| when the diode is turned on with a boolean
- NSFVFrictionFlowDiodeMaterialIncreases the anistropic friction coefficients, linear or quadratic, by K_i * |direction_i| when the diode is turned on with a boolean
- NSFVMixtureFunctorMaterialCompute the arithmetic mean of material properties using a phase fraction.
- NSFVMixtureMaterialCompute the arithmetic mean of material properties using a phase fraction.
- NSFVPumpFunctorMaterialComputes the effective pump body force.
- NSFVPumpMaterialComputes the effective pump body force.
- NonADGeneralFunctorFluidPropsCreates functor fluid properties using a (P, T) formulation
- PINSFVSpeedFunctorMaterialThis is the material class used to compute the interstitial velocity norm for the incompressible and weakly compressible primitive superficial finite-volume implementation of porous media equations.
- ReynoldsNumberFunctorMaterialComputes a Reynolds number.
- RhoFromPTFunctorMaterialComputes the density from coupled pressure and temperature functors (variables, functions, functor material properties
- ThermalDiffusivityFunctorMaterialComputes the thermal diffusivity given the thermal conductivity, specific heat capacity, and fluid density.
- WCNSFV2PSlipVelocityFunctorMaterialComputes the slip velocity for two-phase mixture model.
- WCNSLinearFVMixtureFunctorMaterialCompute the arithmetic mean of material properties using a phase fraction.
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.
- Navier Stokes App
- MassContinuityIPHDGKernelAdds element and interior face integrals for a hybridized interior penalty discontinuous Galerkin discretization of a conservation of mass term for incompressible Navier-Stokes.
- MassFluxPenaltyIPHDGintroduces a jump correction on internal faces for grad-div stabilization for discontinuous Galerkin methods.
- MassMatrixHDGComputes a finite element mass matrix on internal faces (element by element!) meant for use in preconditioning schemes which require one
- NavierStokesLHDGKernelImplements the steady incompressible Navier-Stokes equations for a hybridized discretization
- NavierStokesStressIPHDGKernelAdds viscous and pressure stress terms for element interiors and interior faces
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.
- Navier Stokes App
- NSFunctionInitialConditionSets intial values for all variables.
- NSInitialConditionNSInitialCondition sets intial constant values for all variables.
- PNSInitialConditionPNSInitialCondition sets intial constant values for any porous flow variable.
- Fluid Properties App
- RhoFromPressureTemperatureICComputes the density from pressure and temperature.
- RhoVaporMixtureFromPressureTemperatureICComputes the density of a vapor mixture from pressure and temperature.
- SpecificEnthalpyFromPressureTemperatureICComputes the specific enthalpy from pressure and temperature.
InterfaceKernels
- Moose App
- AddInterfaceKernelActionAdd an InterfaceKernel object to the simulation.
- ADMatInterfaceReactionImplements a reaction to establish ReactionRate=k_f*u-k_b*v at interface.
- ADPenaltyInterfaceDiffusionA penalty-based interface condition that forcesthe continuity of variables and the flux equivalence across an interface.
- ADVectorPenaltyInterfaceDiffusionA penalty-based interface condition that forcesthe continuity of variables and the flux equivalence across an interface.
- InterfaceDiffusionThe kernel is utilized to establish flux equivalence on an interface for variables.
- InterfaceReactionImplements a reaction to establish ReactionRate=k_f*u-k_b*v at interface.
- PenaltyInterfaceDiffusionA penalty-based interface condition that forcesthe continuity of variables and the flux equivalence across an interface.
- VectorPenaltyInterfaceDiffusionA penalty-based interface condition that forcesthe continuity of variables and the flux equivalence across an interface.
- Heat Transfer App
- ConjugateHeatTransferThis InterfaceKernel models conjugate heat transfer. Fluid side must be primary side and solid side must be secondary side. T_fluid is provided in case that variable ( fluid energy variable) is not temperature but e.g. internal energy.
- SideSetHeatTransferKernelModeling conduction, convection, and radiation across internal side set.
- ThinLayerHeatTransferModel heat transfer across a thin domain with an interface.
Kernels
- Moose App
- AddKernelActionAdd a Kernel object to the simulation.
- ADArrayDiffusionThe array Laplacian operator (), with the weak form of .
- ADArrayReactionAn automatic differentiation kernel for the array reaction operator ()
- 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: . Velocity can be given as 1) a variable, for which the gradient is automatically taken, 2) a vector variable, or a 3) vector material.
- 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
Diffusionin terms of physics/residual, but the Jacobian is computed using forward automatic differentiation - ADFluxDivergenceComputes divergence of a flux vector provided by a material.
- 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 to add -L*v, where L=reaction rate, v=variable
- 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.
- ADScaledCoupledTimeDerivativeExtension of the ADCoupledTimeDerivative kernel that calculates the time derivative of a coupled variable scaled by a material property.
- 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: . Velocity can be given as 1) a variable, for which the gradient is automatically taken, 2) a vector variable, or a 3) vector material.
- 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 .
- DivDivFieldThe grad-div operator optionally scaled by a constant scalar coefficient.Weak form: .
- 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
Diffusionin 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
- Navier Stokes App
- DistributedForceImplements a force term in the Navier Stokes momentum equation.
- DistributedPowerImplements the power term of a specified force in the Navier Stokes energy equation.
- GradDivAdds grad-div stabilization for scalar field velocity component Navier-Stokes implementations.
- INSADBoussinesqBodyForceComputes a body force for natural convection buoyancy.
- INSADEnergyAdvectionThis class computes the residual and Jacobian contributions for temperature advection for a divergence free velocity field.
- INSADEnergyAmbientConvectionComputes a heat source/sink due to convection from ambient surroundings.
- INSADEnergyMeshAdvectionThis class computes the residual and Jacobian contributions for temperature advection from mesh velocity in an ALE simulation.
- INSADEnergySUPGAdds the supg stabilization to the INS temperature/energy equation
- INSADEnergySourceComputes an arbitrary volumetric heat source (or sink).
- INSADGravityForceComputes a body force due to gravity.
- INSADHeatConductionTimeDerivativeAD Time derivative term of the heat equation for quasi-constant specific heat and the density .
- INSADMassThis class computes the mass equation residual and Jacobian contributions (the latter using automatic differentiation) for the incompressible Navier-Stokes equations.
- INSADMassPSPGThis class adds PSPG stabilization to the mass equation, enabling use of equal order shape functions for pressure and velocity variables
- INSADMomentumAdvectionAdds the advective term to the INS momentum equation
- INSADMomentumCoupledForceComputes a body force due to a coupled vector variable or a vector function
- INSADMomentumGradDivAdds grad-div stabilization to the INS momentum equation
- INSADMomentumMeshAdvectionCorrects the convective derivative for situations in which the fluid mesh is dynamic.
- INSADMomentumPressureAdds the pressure term to the INS momentum equation
- INSADMomentumSUPGAdds the supg stabilization to the INS momentum equation
- INSADMomentumTimeDerivativeThis class computes the time derivative for the incompressible Navier-Stokes momentum equation.
- INSADMomentumViscousAdds the viscous term to the INS momentum equation
- INSADSmagorinskyEddyViscosityComputes eddy viscosity term using Smagorinky's LES model
- 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.
- INSFEFluidEnergyKernelAdds advection, diffusion, and heat source terms to energy equation, potentially with stabilization
- INSFEFluidMassKernelAdds advective term of mass conservation equation along with pressure-stabilized Petrov-Galerkin terms
- INSFEFluidMomentumKernelAdds advection, viscous, pressure, friction, and gravity terms to the Navier-Stokes momentum equation, potentially with stabilization
- 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.
- MDFluidEnergyKernelAdds advection, diffusion, and heat source terms to energy equation, potentially with stabilization
- MDFluidMassKernelAdds advective term of mass conservation equation along with pressure-stabilized Petrov-Galerkin terms
- MDFluidMomentumKernelAdds advection, viscous, pressure, friction, and gravity terms to the Navier-Stokes momentum equation, potentially with stabilization
- MassConvectiveFluxImplements the advection term for the Navier Stokes mass equation.
- MomentumConvectiveFluxImplements the advective term of the Navier Stokes momentum equation.
- 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.
- PINSFEFluidPressureTimeDerivativeAdds the transient term of the porous-media mass conservation equation
- PINSFEFluidTemperatureTimeDerivativeAdds the transient term of the porous media energy conservation equation
- PINSFEFluidVelocityTimeDerivativeAdd the transient term for one component of the porous media momentum conservation equation
- PMFluidPressureTimeDerivativeAdds the transient term of the porous-media mass conservation equation
- PMFluidTemperatureTimeDerivativeAdds the transient term of the porous media energy conservation equation
- PMFluidVelocityTimeDerivativeAdd the transient term for one component of the porous media momentum conservation equation
- PressureGradientImplements the pressure gradient term for one of the Navier Stokes momentum equations.
- TotalEnergyConvectiveFluxImplements the advection term for the Navier Stokes energy equation.
- VectorMassMatrixComputes a finite element mass matrix meant for use in preconditioning schemes which require one
- 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.)
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.
- LinearFVAdvectionDiffusionFunctorRobinBCAdds a Robin BC of the form \alpha * \nabla \phi*n + \beta * \phi = \gamma, which can be used for the assembly of linear finite volume system and whose face values are determined using three functors. 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.
- LinearFVAdvectionDiffusionScalarSymmetryBCAdds a symmetry boundary condition for a scalar quantity.
- Heat Transfer App
- LinearFVFunctorRadiativeBCBoundary condition for radiative heat flux in a linear finite volume system. The nonlinear radiative flux q = sigma * emissivity * (T4 - Tinfinity4) is linearized via first-order Taylor expansion around the extrapolated boundary face temperature from the previous iteration, yielding a Robin-type condition with second-order spatial accuracy. The lagged coefficients are updated on every linear system assembly. Fixed point iterations can be used to converge the nonlinear problem every time step.
- LinearFVP1RadiationMarshakBCMarshak boundary condition for radiative heat flux.
- Navier Stokes App
- LinearFVConvectiveHeatTransferBCClass describing a convective heat transfer between two domains.
- LinearFVDirichletCHTBCConjugate heat transfer BC for Dirichlet boundary condition-based coupling.
- LinearFVExtrapolatedPressureBCAdds a boundary condition which can be used to extrapolate pressure values to the boundary using either a two-term or a one-term expansion.
- LinearFVNormalVelocityFunctorDirichletBCAdds a dirichlet BC for a velocity parallel to the normal direction. A positive dirichlet value would denote outflow, while negative denotes inflow.
- LinearFVPressureFluxBCAdds 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 the H/A flux. This kernel is only designed to work with advection-diffusion problems.
- LinearFVPressureSymmetryBCAdds a symmetry boundary condition for pressure in a segregated velocity and pressure solve.
- LinearFVRobinCHTBCConjugate heat transfer BC for Robin boundary condition-based coupling.
- LinearFVTurbulentViscosityWallFunctionBCAdds Dirichlet BC for wall values of the turbulent viscosity.
- LinearFVVelocitySymmetryBCAdds a symmetry boundary condition for the velocity.
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.
- Heat Transfer App
- LinearFVP1RadiationSourceSinkImplements the source and sink term for the P1 radiation model solving for incident radiation G.
- LinearFVP1TemperatureSourceSinkImplements the source and sink term for the temperature in the P1 radiation formulation.
- Navier Stokes App
- LinearFVDivergenceRepresents a divergence term. Note, this term does not contribute to the system matrix, only takes the divergence of a face flux field and adds it to the right hand side of the linear system.
- LinearFVEnergyAdvectionRepresents the matrix and right hand side contributions of an advection term for the energy e.g. h=int(cp dT). A user may still override what quantity is advected, but the default is temperature.
- LinearFVMomentumBoussinesqRepresents the Boussinesq term in the Navier Stokes momentum equations, added to the right hand side.
- LinearFVMomentumBuoyancyRepresents the buoyancy term in the Navier Stokes momentum equations, added to the right hand side.
- LinearFVMomentumFrictionComputes a Darcy friction force term on fluid in the Navier Stokes i-th momentum equation.
- LinearFVMomentumPressureRepresents the pressure gradient term in the Navier Stokes momentum equations, added to the right hand side.
- LinearFVRZViscousSourceAdds the axisymmetric viscous source term mu * u_r / r^2 to the FV momentum equations.
- LinearFVScalarAdvectionRepresents the matrix and right hand side contributions of an advection term for a passive scalar.
- LinearFVTKEDSourceSinkElemental kernel to compute the production and destruction terms of turbulent kinetic energy dissipation (TKED).
- LinearFVTKESourceSinkElemental kernel to compute the production and destruction terms of turbulent kinetic energy (TKE).
- LinearFVTurbulentAdvectionRepresents the matrix and right hand side contributions of an advection term for a turbulence variable.
- LinearFVTurbulentDiffusionRepresents the matrix and right hand side contributions of a diffusion term for a turbulent variable in a partial differential equation.
- LinearFVVolumetricHeatTransferRepresents a heat transfer term between the fluid and a homogenized structure.
- LinearWCNSFV2PMomentumDriftFluxImplements the drift momentum flux source.
- LinearWCNSFVMomentumFluxRepresents the matrix and right hand side contributions of the stress and advection terms of the momentum equation.
- Open Pronghorn App
- kEpsilonTKEDSourceSinkElemental kernel to compute the production and destruction terms of the turbulent dissipation rate epsilon.
- kEpsilonTKESourceSinkElemental kernel to compute the production and destruction terms of turbulent kinetic energy (TKE).
Materials
- Moose App
- AddMaterialActionAdd a Material object to the simulation.
- ADCoupledGradientMaterialCreates a gradient material equal to the gradient of the coupled variable times a scalar material property.
- ADCoupledValueFunctionMaterialCompute a function value from coupled variables
- ADDerivativeParsedMaterialParsed Function Material with automatic derivatives.
- ADDerivativeSumMaterialMeta-material to sum up multiple derivative materials
- ADFluxFromGradientMaterialComputes a flux vector material property based on the gradient of a coupled variable and a scalar diffusivity.
- ADFunctorChangeFunctorMaterialAdds a functor material property that computes the change in a functor value over a time step, fixed point iteration, or nonlinear iteration.
- ADGenericConstant2DArrayA material evaluating one material property in type of RealEigenMatrix
- ADGenericConstantFunctorMaterialFunctorMaterial object for declaring properties that are populated by evaluation of a Functor (a constant, variable, function or functor material property) objects.
- ADGenericConstantMaterialDeclares material properties based on names and values prescribed by input parameters.
- ADGenericConstantRankTwoTensorObject for declaring a constant rank two tensor as a material property.
- ADGenericConstantRealVectorValueObject for declaring a constant 3-vector as a material property.
- ADGenericConstantStdVectorMaterialDeclares material properties based on names and vector values prescribed by input parameters.
- ADGenericConstantSymmetricRankTwoTensorObject for declaring a constant symmetric rank two tensor as a material property.
- ADGenericConstantVectorFunctorMaterialFunctorMaterial object for declaring vector properties that are populated by evaluation of functor (constants, functions, variables, matprops) object.
- ADGenericConstantVectorMaterialDeclares material properties based on names and vector values prescribed by input parameters.
- ADGenericFunctionFunctorMaterialFunctorMaterial object for declaring properties that are populated by evaluation of a Functor (a constant, variable, function or functor material property) objects.
- ADGenericFunctionMaterialMaterial object for declaring properties that are populated by evaluation of Function object.
- ADGenericFunctionRankTwoTensorMaterial object for defining rank two tensor properties using functions.
- ADGenericFunctionVectorMaterialMaterial object for declaring vector properties that are populated by evaluation of Function objects.
- ADGenericFunctorGradientMaterialFunctorMaterial object for declaring properties that are populated by evaluation of gradients of Functors (a constant, variable, function or functor material property) objects.
- ADGenericFunctorMaterialFunctorMaterial object for declaring properties that are populated by evaluation of a Functor (a constant, variable, function or functor material property) objects.
- ADGenericFunctorTimeDerivativeMaterialFunctorMaterial object for declaring properties that are populated by evaluation of time derivatives of Functors objects. (such as variables, constants, postprocessors). The time derivative is only returned if the 'dot' functor routine is implemented.
- ADGenericVectorFunctorMaterialFunctorMaterial object for declaring vector properties that are populated by evaluation of functor (constants, functions, variables, matprops) object.
- ADParsedFunctorMaterialComputes a functor material from a parsed expression of other functors.
- ADParsedMaterialParsed expression Material.
- ADPiecewiseByBlockFunctorMaterialComputes a property value on a per-subdomain basis
- ADPiecewiseByBlockVectorFunctorMaterialComputes a property value on a per-subdomain basis
- ADPiecewiseConstantByBlockMaterialComputes a property value on a per-subdomain basis
- ADPiecewiseLinearInterpolationMaterialCompute a property using a piecewise linear interpolation to define its dependence on a variable
- ADVectorFromComponentVariablesMaterialComputes a vector material property from coupled variables
- ADVectorMagnitudeFunctorMaterialThis class takes up to three scalar-valued functors corresponding to vector components or a single vector functor and computes the Euclidean norm.
- CoupledGradientMaterialCreates a gradient material equal to the gradient of the coupled variable times a scalar material property.
- CoupledValueFunctionMaterialCompute a function value from coupled variables
- DerivativeParsedMaterialParsed Function Material with automatic derivatives.
- DerivativeSumMaterialMeta-material to sum up multiple derivative materials
- FVADPropValPerSubdomainMaterialComputes a property value on a per-subdomain basis
- FVPropValPerSubdomainMaterialComputes a property value on a per-subdomain basis
- FunctorADConverterConverts regular functors to AD functors and AD functors to regular functors
- FunctorChangeFunctorMaterialAdds a functor material property that computes the change in a functor value over a time step, fixed point iteration, or nonlinear iteration.
- FunctorSmootherCreates smoother functor(s) using various averaging techniques
- GenericConstant2DArrayA material evaluating one material property in type of RealEigenMatrix
- GenericConstantArrayA material evaluating one material property in type of RealEigenVector
- GenericConstantFunctorMaterialFunctorMaterial object for declaring properties that are populated by evaluation of a Functor (a constant, variable, function or functor material property) objects.
- GenericConstantMaterialDeclares material properties based on names and values prescribed by input parameters.
- GenericConstantRankTwoTensorObject for declaring a constant rank two tensor as a material property.
- GenericConstantRealVectorValueObject for declaring a constant 3-vector as a material property.
- GenericConstantStdVectorMaterialDeclares material properties based on names and vector values prescribed by input parameters.
- GenericConstantSymmetricRankTwoTensorObject for declaring a constant symmetric rank two tensor as a material property.
- GenericConstantVectorFunctorMaterialFunctorMaterial object for declaring vector properties that are populated by evaluation of functor (constants, functions, variables, matprops) object.
- GenericConstantVectorMaterialDeclares material properties based on names and vector values prescribed by input parameters.
- GenericFunctionFunctorMaterialFunctorMaterial object for declaring properties that are populated by evaluation of a Functor (a constant, variable, function or functor material property) objects.
- GenericFunctionMaterialMaterial object for declaring properties that are populated by evaluation of Function object.
- GenericFunctionRankTwoTensorMaterial object for defining rank two tensor properties using functions.
- GenericFunctionVectorMaterialMaterial object for declaring vector properties that are populated by evaluation of Function objects.
- GenericFunctorGradientMaterialFunctorMaterial object for declaring properties that are populated by evaluation of gradients of Functors (a constant, variable, function or functor material property) objects.
- GenericFunctorMaterialFunctorMaterial object for declaring properties that are populated by evaluation of a Functor (a constant, variable, function or functor material property) objects.
- GenericFunctorTimeDerivativeMaterialFunctorMaterial object for declaring properties that are populated by evaluation of time derivatives of Functors objects. (such as variables, constants, postprocessors). The time derivative is only returned if the 'dot' functor routine is implemented.
- GenericVectorFunctorMaterialFunctorMaterial object for declaring vector properties that are populated by evaluation of functor (constants, functions, variables, matprops) object.
- InterpolatedStatefulMaterialRankFourTensorAccess old state from projected data.
- InterpolatedStatefulMaterialRankTwoTensorAccess old state from projected data.
- InterpolatedStatefulMaterialRealAccess old state from projected data.
- InterpolatedStatefulMaterialRealVectorValueAccess old state from projected data.
- MaterialADConverterConverts regular material properties to AD properties and vice versa
- MaterialConverterConverts regular material properties to AD properties and vice versa
- MaterialFunctorConverterConverts functor to non-AD and AD regular material properties
- NEML2ToMOOSERankFourTensorMaterialPropertyProvide an output (or its derivative) from a NEML2 model as a MOOSE material property of type RankFourTensorTempl<double>.
- NEML2ToMOOSERankTwoTensorMaterialPropertyProvide an output (or its derivative) from a NEML2 model as a MOOSE material property of type RankTwoTensorTempl<double>.
- NEML2ToMOOSERealMaterialPropertyProvide an output (or its derivative) from a NEML2 model as a MOOSE material property of type double.
- NEML2ToMOOSERealVectorValueMaterialPropertyProvide an output (or its derivative) from a NEML2 model as a MOOSE material property of type libMesh::VectorValue<double>.
- NEML2ToMOOSESymmetricRankFourTensorMaterialPropertyProvide an output (or its derivative) from a NEML2 model as a MOOSE material property of type SymmetricRankFourTensorTempl<double>.
- NEML2ToMOOSESymmetricRankTwoTensorMaterialPropertyProvide an output (or its derivative) from a NEML2 model as a MOOSE material property of type SymmetricRankTwoTensorTempl<double>.
- ParsedFunctorMaterialComputes a functor material from a parsed expression of other functors.
- ParsedMaterialParsed expression Material.
- PiecewiseByBlockFunctorMaterialComputes a property value on a per-subdomain basis
- PiecewiseByBlockVectorFunctorMaterialComputes a property value on a per-subdomain basis
- PiecewiseConstantByBlockMaterialComputes a property value on a per-subdomain basis
- PiecewiseLinearInterpolationMaterialCompute a property using a piecewise linear interpolation to define its dependence on a variable
- RankFourTensorMaterialADConverterConverts regular material properties to AD properties and vice versa
- RankFourTensorMaterialConverterConverts regular material properties to AD properties and vice versa
- RankTwoTensorFromComponentPropertiesAssembles a RankTwoTensor from scalar material properties or constants
- RankTwoTensorMaterialADConverterConverts regular material properties to AD properties and vice versa
- RankTwoTensorMaterialConverterConverts regular material properties to AD properties and vice versa
- VectorFromComponentVariablesMaterialComputes a vector material property from coupled variables
- VectorFunctorADConverterConverts regular functors to AD functors and AD functors to regular functors
- VectorMagnitudeFunctorMaterialThis class takes up to three scalar-valued functors corresponding to vector components or a single vector functor and computes the Euclidean norm.
- VectorMaterialFunctorConverterConverts functor to non-AD and AD regular material properties
- Misc App
- ADArrheniusMaterialPropertyArbitrary material property of the sum of an arbitary number () of Arrhenius functions , where is the frequency factor, is the activation energy, and is the gas constant.
- ADDensityCreates density material property. This class is deprecated, and its functionalityis replaced by StrainAdjustedDensity for cases when the density should be adjustedto account for material deformation. If it is not desired to adjust the density fordeformation, a variety of general-purpose Materials, such as GenericConstantMaterialor ParsedMaterial can be used to define the density. A StrainAdjustedDensity can also be used with '0 0 0' for the displacements.
- ArrheniusMaterialPropertyArbitrary material property of the sum of an arbitary number () of Arrhenius functions , where is the frequency factor, is the activation energy, and is the gas constant.
- DensityCreates density material property. This class is deprecated, and its functionalityis replaced by StrainAdjustedDensity for cases when the density should be adjustedto account for material deformation. If it is not desired to adjust the density fordeformation, a variety of general-purpose Materials, such as GenericConstantMaterialor ParsedMaterial can be used to define the density. A StrainAdjustedDensity can also be used with '0 0 0' for the displacements.
- Fluid Properties App
- ADSaturationPressureMaterialComputes saturation pressure at some temperature.
- ADSaturationTemperatureMaterialComputes saturation temperature at some pressure
- ADSurfaceTensionMaterialComputes surface tension at some temperature
- FluidPropertiesMaterialComputes fluid properties using (specific internal energy, specific volume) formulation
- FluidPropertiesMaterialPTFluid properties using the (pressure, temperature) formulation
- FluidPropertiesMaterialVEComputes fluid properties using (specific internal energy, specific volume) formulation
- SaturationPressureMaterialComputes saturation pressure at some temperature.
- SodiumPropertiesMaterialMaterial properties for liquid sodium sampled from SodiumProperties.
- Navier Stokes App
- ADDittusBoelterFunctorMaterialComputes wall heat transfer coefficient using Dittus-Boelter equation
- ADFunctorEffectiveDynamicViscosityComputes the effective dynamic viscosity mu_eff = mu + mu_t / factor
- AirAir.
- ConservedVarValuesMaterialProvides access to variables for a conserved variable set of density, total fluid energy, and momentum
- DittusBoelterFunctorMaterialComputes wall heat transfer coefficient using Dittus-Boelter equation
- ExponentialFrictionFunctorMaterialComputes a Reynolds number-exponential friction factor.
- ExponentialFrictionMaterialComputes a Reynolds number-exponential friction factor.
- FunctorEffectiveDynamicViscosityComputes the effective dynamic viscosity mu_eff = mu + mu_t / factor
- FunctorErgunDragCoefficientsMaterial providing linear and quadratic drag coefficients based on the correlation developed by Ergun.
- FunctorKappaFluidZero-thermal dispersion conductivity
- GeneralFluidPropsComputes fluid properties using a (P, T) formulation
- GeneralFunctorFluidPropsCreates functor fluid properties using a (P, T) formulation
- GenericPorousMediumMaterialComputes generic material properties related to simulation of fluid flow in a porous medium
- INSAD3EqnThis material computes properties needed for stabilized formulations of the mass, momentum, and energy equations.
- INSADMaterialThis is the material class used to compute some of the strong residuals for the INS equations.
- INSADStabilized3EqnThis is the material class used to compute the stabilization parameter tau for momentum and tau_energy for the energy equation.
- INSADTauMaterialThis is the material class used to compute the stabilization parameter tau.
- INSFEMaterialComputes generic material properties related to simulation of fluid flow
- INSFVEnthalpyFunctorMaterialThis is the material class used to compute enthalpy for the incompressible/weakly-compressible finite-volume implementation of the Navier-Stokes equations.
- INSFVEnthalpyMaterialThis is the material class used to compute enthalpy for the incompressible/weakly-compressible finite-volume implementation of the Navier-Stokes equations.
- INSFVMushyPorousFrictionFunctorMaterialComputes the mushy zone porous resistance for solidification/melting problems.
- INSFVMushyPorousFrictionMaterialComputes the mushy zone porous resistance for solidification/melting problems.
- INSFVkEpsilonViscosityFunctorMaterialComputes the turbulent dynamic viscosity given k and epsilon.
- INSFVkEpsilonViscosityMaterialComputes the turbulent dynamic viscosity given k and epsilon.
- LinearFVEnthalpyFunctorMaterialCreates functors for conversions between specific enthalpy and temperature
- LinearFrictionFactorFunctorMaterialMaterial class used to compute a friction factor of the form A * f(r, t) + B * g(r, t) * |v_I| with A, B vector constants, f(r, t) and g(r, t) functors of space and time, and |v_I| the interstitial speed
- MDFluidMaterialComputes generic material properties related to simulation of fluid flow
- MixingLengthTurbulentViscosityFunctorMaterialComputes the material property corresponding to the total viscositycomprising the mixing length model turbulent total_viscosityand the molecular viscosity.
- MixingLengthTurbulentViscosityMaterialComputes the material property corresponding to the total viscositycomprising the mixing length model turbulent total_viscosityand the molecular viscosity.
- NSFVDispersePhaseDragFunctorMaterialComputes drag coefficient for dispersed phase.
- NSFVFrictionFlowDiodeFunctorMaterialIncreases the anistropic friction coefficients, linear or quadratic, by K_i * |direction_i| when the diode is turned on with a boolean
- NSFVFrictionFlowDiodeMaterialIncreases the anistropic friction coefficients, linear or quadratic, by K_i * |direction_i| when the diode is turned on with a boolean
- NSFVMixtureFunctorMaterialCompute the arithmetic mean of material properties using a phase fraction.
- NSFVMixtureMaterialCompute the arithmetic mean of material properties using a phase fraction.
- NSFVPumpFunctorMaterialComputes the effective pump body force.
- NSFVPumpMaterialComputes the effective pump body force.
- NonADGeneralFunctorFluidPropsCreates functor fluid properties using a (P, T) formulation
- PINSFEMaterialComputes generic material properties related to simulation of fluid flow in a porous medium
- PINSFVSpeedFunctorMaterialThis is the material class used to compute the interstitial velocity norm for the incompressible and weakly compressible primitive superficial finite-volume implementation of porous media equations.
- PorousConservedVarMaterialProvides access to variables for a conserved variable set of density, total fluid energy, and momentum
- PorousMixedVarMaterialProvides access to variables for a primitive variable set of pressure, temperature, and superficial velocity
- PorousPrimitiveVarMaterialProvides access to variables for a primitive variable set of pressure, temperature, and superficial velocity
- ReynoldsNumberFunctorMaterialComputes a Reynolds number.
- RhoFromPTFunctorMaterialComputes the density from coupled pressure and temperature functors (variables, functions, functor material properties
- SoundspeedMatComputes the speed of sound
- ThermalDiffusivityFunctorMaterialComputes the thermal diffusivity given the thermal conductivity, specific heat capacity, and fluid density.
- WCNSFV2PSlipVelocityFunctorMaterialComputes the slip velocity for two-phase mixture model.
- WCNSLinearFVMixtureFunctorMaterialCompute the arithmetic mean of material properties using a phase fraction.
- Rdg App
- AEFVMaterialA material kernel for the advection equation using a cell-centered finite volume method.
- Heat Transfer App
- ADAnisoHeatConductionMaterialGeneral-purpose material model for anisotropic heat conduction
- ADChurchillChuHTCFunctorMaterialComputes a heat transfer coefficient using the Churchill-Chu correlation for natural convection.
- ADConvectionHeatFluxFunctorMaterialComputes a convection heat flux from a solid surface to a fluid.
- ADCylindricalGapHeatFluxFunctorMaterialComputes cylindrical gap heat flux due to conduction and radiation.
- ADElectricalConductivityCalculates resistivity and electrical conductivity as a function of temperature, using copper for parameter defaults.
- ADFinEfficiencyFunctorMaterialComputes fin efficiency.
- ADFinEnhancementFactorFunctorMaterialComputes a heat transfer enhancement factor for fins.
- ADHeatConductionMaterialGeneral-purpose material model for heat conduction
- ADRadiativeP1DiffusionCoefficientMaterialComputes the P1 diffusion coefficient from the opacity and effective scattering cross section.
- AnisoHeatConductionMaterialGeneral-purpose material model for anisotropic heat conduction
- ChurchillChuHTCFunctorMaterialComputes a heat transfer coefficient using the Churchill-Chu correlation for natural convection.
- ConvectionHeatFluxFunctorMaterialComputes a convection heat flux from a solid surface to a fluid.
- CylindricalGapHeatFluxFunctorMaterialComputes cylindrical gap heat flux due to conduction and radiation.
- ElectricalConductivityCalculates resistivity and electrical conductivity as a function of temperature, using copper for parameter defaults.
- ElectromagneticHeatingMaterialMaterial class used to provide the electric field as a material property and computes the residual contributions for electromagnetic/electrostatic heating objects.
- FinEfficiencyFunctorMaterialComputes fin efficiency.
- FinEnhancementFactorFunctorMaterialComputes a heat transfer enhancement factor for fins.
- FunctionPathEllipsoidHeatSourceDouble ellipsoid volumetric source heat with function path.
- GapConductanceMaterial to compute an effective gap conductance based on the thermal conductivity of the gap and diffusive approximation to the radiative heat transfer.
- GapConductanceConstantMaterial to compute a constant, prescribed gap conductance
- HeatConductionMaterialGeneral-purpose material model for heat conduction
- RadiativeP1DiffusionCoefficientMaterialComputes the P1 diffusion coefficient from the opacity and effective scattering cross section.
- SemiconductorLinearConductivityCalculates electrical conductivity of a semiconductor from temperature
- SideSetHeatTransferMaterialThis material constructs the necessary coefficients and properties for SideSetHeatTransferKernel.
- ThermalComplianceComputes cost sensitivity needed for multimaterial SIMP method.
- ThermalSensitivityComputes cost sensitivity needed for multimaterial SIMP method.
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, and supports 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, as well as following a 1D curve and modifying the radial (normal to the extrusion axis) extent of the geometry.
- 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
- BSplineCurveGeneratorThis BSplineMeshGenerator object is designed to generate a mesh of a curve that consists of EDGE2, EDGE3, or EDGE4 elements drawn using an open uniform B-Spline.
- 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.
- Boundary2DDelaunayGeneratorMesh generator that convert a 2D surface given as one or a few boundaries of a 3D mesh into a 2D mesh using Delaunay triangulation.
- BoundaryDeletionGeneratorMesh generator which removes side sets
- BoundaryElementConversionGeneratorConvert the elements involved in a set of external boundaries to ensure that the boundary set only contains TRI3 elements
- 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.
- 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.
- DeleteElementsNearMeshGeneratorRemoves elements lying "near" another mesh. The proximity is examined by the distance from the element's centroid to the faces of elements of the "proximity_mesh"
- 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, and supports 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, as well as following a 1D curve and modifying the radial (normal to the extrusion axis) extent of the geometry.
- 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.
- ManifoldSubdomainGeneratorChanges the subdomain ID of elements whose vertex-average point lies inside or outside a closed manifold defined by surface mesh.
- 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
- OrientSurfaceMeshGeneratorChange the orientation of (part of) the surface mesh.
- 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
expressionexpression. - ParsedGenerateSidesetA MeshGenerator that adds element sides to a sideset if the centroid of the side satisfies the
combinatorial_geometryexpression. - 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.
- PolyLineMeshFollowingNodeSetGeneratorGenerates a polyline (open ended or looped) of Edge elements by marching along a nodeeset and trying to be as close as possible to the nodes of the nodeset
- PolyLineMeshGeneratorGenerates meshes from edges connecting a list of points.
- ProjectSideSetOntoLevelSetGeneratorProjects a sideset onto a surface defined by a level set and creates a surface mesh.
- 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.
- RenumberBySubdomainGeneratorChanges the element and node IDs so that elements and nodes are contiguous within a subdomain. Note that DoF ordering may be affected as well, and that the mesh renumbering will be turned off.
- 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.
- SideSetsFromAllNormalsGeneratorAdds sidesets to the entire mesh based on unique normals.
- 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 the specified smoothing algorithm to attempt to improve mesh quality.
- 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.
- StitchMeshGeneratorAllows multiple mesh files to be stitched together to form a single mesh.
- 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
- SubdomainsFromPartitionerGeneratorChanges the subdomain ID of elements based on the output of the partitioner
- SurfaceSubdomainsDelaunayRemesherMesh generator that re-meshes a 2D surface mesh given as one or more subdomains into a 2D surface mesh using Delaunay triangulation.
- SurfaceSubdomainsFromAllNormalsGeneratorAdds subdomains to surface (2D) elements in the (3D) mesh based on unique normals.
- 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.
- XYTriangleBoundaryLayerGeneratorGenerate a 2D layered mesh that represents a conformal boundary layer along the boundary of an input 2D mesh or a 1D loop mesh.
- 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
- Moose App
- BatchMeshGeneratorActionBatch generate meshes using actions.
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
- Moose App
- AddMeshModifiersActionAdd a MeshModifier object to the simulation.
- ActivateElementsByPathDetermine activated elements.
- ActivateElementsCoupledDetermine activated elements.
- CoupledVarThresholdElementSubdomainModifierModify the element subdomain ID if a coupled variable satisfies the criterion for the threshold (above, equal, or below)
- SidesetAroundSubdomainUpdaterSets up a boundary between inner_subdomains and outer_subdomains
- TimedSubdomainModifierModify element subdomain ID of entire subdomains for given points in time. This mesh modifier only runs on the undisplaced mesh, and it will modify both the undisplaced and the displaced mesh.
- VariableValueElementSubdomainModifierModify the element subdomain ID based on the provided variable value.
Modules
Modules/CompressibleNavierStokes
- Navier Stokes App
- CNSActionThis 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/FluidProperties
- Fluid Properties App
- AddFluidPropertiesDeprecatedActionAdd a UserObject object to the simulation.
- BrineFluidPropertiesFluid properties for brine
- CO2FluidPropertiesFluid properties for carbon dioxide (CO2) using the Span & Wagner EOS
- CaloricallyImperfectGasFluid properties for an ideal gas with imperfect caloric behavior.
- FlibeFluidPropertiesFluid properties for flibe
- FlinakFluidPropertiesFluid properties for flinak
- HeliumFluidPropertiesFluid properties for helium
- HydrogenFluidPropertiesFluid properties for Hydrogen (H2)
- IdealGasFluidPropertiesFluid properties for an ideal gas
- IdealGasMixtureFluidPropertiesClass for fluid properties of an ideal gas mixture
- IdealRealGasMixtureFluidPropertiesClass for fluid properties of an arbitrary vapor mixture
- LeadBismuthFluidPropertiesFluid properties for Lead Bismuth eutectic 2LiF-BeF2
- LeadFluidPropertiesFluid properties for Lead
- LeadLithiumFluidPropertiesFluid properties for Lead Lithium eutectic (83% Pb, 17% Li)
- MethaneFluidPropertiesFluid properties for methane (CH4)
- NaClFluidPropertiesFluid properties for NaCl
- NaKFluidPropertiesFluid properties for NaK
- NitrogenFluidPropertiesFluid properties for Nitrogen (N2)
- SalineMoltenSaltFluidPropertiesTo use this object, you need to have the
Salinelibrary installed. Refer to the documentation for guidance on how to enable it. (Original description: Molten salt fluid properties using Saline) - SimpleFluidPropertiesFluid properties for a simple fluid with a constant bulk density
- SodiumPropertiesFluid properties for sodium
- SodiumSaturationFluidPropertiesFluid properties for liquid sodium at saturation conditions
- StiffenedGasFluidPropertiesFluid properties for a stiffened gas
- StiffenedGasTwoPhaseFluidPropertiesTwo-phase stiffened gas fluid properties
- TabulatedBicubicFluidPropertiesFluid properties using bicubic interpolation on tabulated values provided
- TabulatedFluidPropertiesFluid properties using bicubic interpolation on tabulated values provided
- TemperaturePressureFunctionFluidPropertiesSingle-phase fluid properties that allows to provide thermal conductivity, density, and viscosity as functions of temperature and pressure.
- TwoPhaseFluidPropertiesIndependent2-phase fluid properties for 2 independent single-phase fluid properties
- TwoPhaseNCGPartialPressureFluidPropertiesTwo-phase fluid with single NCG using partial pressure mixture model
- Water97FluidPropertiesFluid properties for water and steam (H2O) using IAPWS-IF97
Modules/IncompressibleNavierStokes
- Navier Stokes App
- INSActionThis class allows us to have a section of the input file for setting up incompressible Navier-Stokes equations.
Modules/NavierStokesFV
- Navier Stokes App
- NSFVActionDeprecationHelper class to smooth the deprecation of the NSFV Action
- WCNSFVFlowPhysicsDefine the Navier Stokes weakly-compressible mass and momentum equations
- WCNSFVFluidHeatTransferPhysicsDefine the Navier Stokes weakly-compressible energy equation
- WCNSFVScalarTransportPhysicsDefine the Navier Stokes weakly-compressible scalar field transport equation(s) using the nonlinear finite volume discretization
- WCNSFVTurbulencePhysicsDefine a turbulence model for a incompressible or weakly-compressible Navier Stokes flow with a finite volume discretization
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.
NEML2
- Moose App
- NEML2ActionCommonParse a NEML2 input file
- NEML2ActionSet up the NEML2 material model
NodalKernels
- Moose App
- AddNodalKernelActionAdd a NodalKernel object to the simulation.
- ADArrayReactionNodalKernelImplements a simple consuming reaction term at nodes for an array variable
- ArrayReactionNodalKernelImplements a simple consuming reaction term at nodes for an array variable
- ArrayTimeDerivativeNodalKernelForms the contribution to the residual and jacobian of the time derivative term for an array variable for ODEs being solved at all nodes.
- ConstantRateComputes residual or the rate in a simple ODE of du/dt = rate.
- CoupledForceNodalKernelAdds a force proportional to the value of the coupled variable
- LowerBoundNodalKernelUsed to prevent a coupled variable from going below a lower bound
- PenaltyDirichletNodalKernelEnforces a Dirichlet boundary condition in a weak sense by penalizing differences between the current solution and the Dirichlet value on nodesets.
- ReactionNodalKernelImplements a simple consuming reaction term at nodes
- TimeDerivativeNodalKernelForms the contribution to the residual and jacobian of the time derivative term from an ODE being solved at all nodes.
- UpperBoundNodalKernelUsed to prevent a coupled variable from going above a upper bound
- UserForcingFunctionNodalKernelResidual contribution to an ODE from a source function acting at nodes.
- UserForcingFunctorNodalKernelResidual contribution to an ODE from a source functor acting at nodes.
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.
- 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 regular warnings and solution invalidity errors and warnings
- 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.
- 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.
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/NavierStokes
Physics/NavierStokes/Flow
- Navier Stokes App
- WCNSFVFlowPhysicsDefine the Navier Stokes weakly-compressible mass and momentum equations
Physics/NavierStokes/FlowSegregated
- Navier Stokes App
- WCNSLinearFVFlowPhysicsDefine the Navier Stokes weakly-compressible equations with the linear solver implementation of the SIMPLE scheme
Physics/NavierStokes/FluidHeatTransfer
- Navier Stokes App
- WCNSFVFluidHeatTransferPhysicsDefine the Navier Stokes weakly-compressible energy equation
Physics/NavierStokes/FluidHeatTransferSegregated
- Navier Stokes App
- WCNSLinearFVFluidHeatTransferPhysicsDefine the Navier Stokes weakly-compressible energy equation
Physics/NavierStokes/ScalarTransport
- Navier Stokes App
- WCNSFVScalarTransportPhysicsDefine the Navier Stokes weakly-compressible scalar field transport equation(s) using the nonlinear finite volume discretization
Physics/NavierStokes/ScalarTransportSegregated
- Navier Stokes App
- WCNSLinearFVScalarTransportPhysicsDefine the Navier Stokes weakly-compressible scalar field transport equation(s) using the linear finite volume discretization
Physics/NavierStokes/SolidHeatTransfer
- Navier Stokes App
- PNSFVSolidHeatTransferPhysicsDefine the Navier Stokes porous media solid energy equation
Physics/NavierStokes/Turbulence
- Navier Stokes App
- WCNSFVTurbulencePhysicsDefine a turbulence model for a incompressible or weakly-compressible Navier Stokes flow with a finite volume discretization
Physics/NavierStokes/TurbulenceSegregated
- Navier Stokes App
- WCNSLinearFVTurbulencePhysicsDefine a turbulence model for an incompressible or weakly-compressible Navier Stokes flow with a linear finite volume discretization
Physics/NavierStokes/TwoPhaseMixture
- Navier Stokes App
- WCNSFVTwoPhaseMixturePhysicsDefine the additional terms for a mixture model for the two phase weakly-compressible Navier Stokes equations
Physics/NavierStokes/TwoPhaseMixtureSegregated
- Navier Stokes App
- WCNSLinearFVTwoPhaseMixturePhysicsDefine the additional terms for a mixture model for the two phase weakly-compressible Navier Stokes equations using the linearized segregated finite volume discretization
Positions
- Moose App
- AddPositionsActionAdd a Positions object to the simulation.
- DistributedPositionsDistribute positions, using translations, over one or more positions
- ElementCentroidPositionsPositions of element centroids.
- ElementGroupCentroidPositionsGets the Positions of the centroid of groups of elements. Groups may be defined using subdomains or element extra ids.
- FilePositionsImport positions from one or more files.
- FunctorExtremaPositionsSearches the geometry for the extrema of the functors
- FunctorPositionsComputes positions from groups of three functors specified by the user
- InputPositionsPositions set directly from a user parameter in the input file
- MultiAppPositionsObtain positions from MultiApps. This may only be used to set the positions of those same multiapps if an 'initial_positions' parameter is used.
- NodePositionsPositions of element nodes.
- ParsedDownSelectionPositionsExamines input positions object(s) to find all positions matching a user-specifed parsed expression criterion. The order of the positions in the input is kept.
- QuadraturePointsPositionsPositions of element quadrature points.
- ReporterPositionsImport positions from one or more reporters, for example other Positions
- TransformedPositionsTransform, with a linear transformation, positions from another Positions object
Postprocessors
- Moose App
- AddPostprocessorActionAdd a Postprocessor object to the simulation.
- ADElementAverageMaterialPropertyComputes the average of a material property over a volume.
- ADElementExtremeFunctorValueFinds either the min or max elemental value of a functor over the domain.
- ADElementExtremeMaterialPropertyDetermines the minimum or maximum of a material property over a volume.
- ADElementIntegralFunctorPostprocessorComputes a volume integral of the specified functor
- ADElementIntegralMaterialPropertyCompute the integral of the material property over the domain
- ADElementL2FunctorErrorComputes L2 error between an 'approximate' functor and an 'exact' functor
- ADInterfaceDiffusiveFluxAverageComputes the diffusive flux on the interface.
- ADInterfaceDiffusiveFluxIntegralComputes the diffusive flux on the interface.
- ADSideAdvectiveFluxIntegralComputes the volumetric advected quantity through a sideset.
- ADSideAverageMaterialPropertyComputes the average of a material property over a side set.
- ADSideDiffusiveFluxAverageComputes the average of the diffusive flux over the specified boundary
- ADSideDiffusiveFluxIntegralComputes the integral of the diffusive flux over the specified boundary
- ADSideFluxAverageComputes the average of the diffusive flux over the specified boundary
- ADSideFluxIntegralComputes the integral of the diffusive flux over the specified boundary
- ADSideIntegralFunctorPostprocessorComputes a surface integral of the specified functor, using the single-sided face argument, which usually means that the functor will be evaluated from a single side of the surface, not interpolated between both sides.
- ADSideIntegralMaterialPropertyCompute the integral of a scalar material property component over the domain.
- ADSideVectorDiffusivityFluxIntegralComputes the integral of the diffusive flux over the specified boundary
- AreaPostprocessorComputes the "area" or dimension - 1 "volume" of a given boundary or boundaries in your mesh.
- AverageElementSizeComputes the average element size.
- AverageNodalVariableValueComputes the average value of a field by sampling all nodal solutions on the domain or within a subdomain
- AverageVariableChangeComputes the volume-weighted L1 or L2 norm of the change of a variable over a time step or between nonlinear iterations.
- AxisymmetricCenterlineAverageValueComputes the average value of a variable on a sideset located along the centerline of an axisymmetric model.
- BoundaryLinearFVFluxIntegralComputes the side integral of selected LinearFVFluxKernel boundary flux contributions.
- ChainControlDataPostprocessorGets a Real or bool chain control value.
- ChangeOverFixedPointPostprocessorComputes the change or relative change in a post-processor value over a single or multiple fixed point iterations
- ChangeOverTimePostprocessorComputes the change or relative change in a post-processor value over a timestep or the entire transient
- ChangeOverTimestepPostprocessorComputes the change or relative change in a post-processor value over a timestep or the entire transient
- ConstantPostprocessorPostprocessor that holds a constant value
- CumulativeValuePostprocessorCreates a cumulative sum of a Postprocessor value with time.
- DifferencePostprocessorComputes the difference between two postprocessors
- DiscreteVariableResidualNormComputes a discrete norm for a block-restricted variable residual.
- ElementArrayL2NormEvaluates L2-norm of a component of an array variable
- ElementAverageMaterialPropertyComputes the average of a material property over a volume.
- ElementAverageSecondTimeDerivativeComputes the element averaged second derivative of variable
- ElementAverageTimeDerivativeComputes a volume integral of the time derivative of a given variable
- ElementAverageValueComputes the volumetric average of a variable
- ElementExtremeFunctorValueFinds either the min or max elemental value of a functor over the domain.
- ElementExtremeMaterialPropertyDetermines the minimum or maximum of a material property over a volume.
- ElementExtremeValueFinds either the min or max elemental value of a variable over the domain.
- ElementH1ErrorComputes the H1 error between a variable and a function
- ElementH1SemiErrorReturns the gradient difference norm part of the H1 error
- ElementHCurlErrorReturns the H(curl)-norm of the difference between a pair of computed and analytical vector-valued solutions.
- ElementHCurlSemiErrorReturns the H(curl)-seminorm of the difference between a pair of computed and analytical vector-valued solutions.
- ElementHDivErrorReturns the H(div)-norm of the difference between a pair of computed and analytical vector-valued solutions.
- ElementHDivSemiErrorReturns the H(div)-seminorm of the difference between a pair of computed and analytical vector-valued solutions.
- ElementIntegralArrayVariablePostprocessorIntegral of one component of an array variable.
- ElementIntegralFunctorPostprocessorComputes a volume integral of the specified functor
- ElementIntegralMaterialPropertyCompute the integral of the material property over the domain
- ElementIntegralVariablePostprocessorComputes a volume integral of the specified variable
- ElementL1ErrorComputes L1 error between an elemental field variable and an analytical function.
- ElementL2DifferenceComputes the element-wise L2 difference between the current variable and a coupled variable.
- ElementL2ErrorComputes L2 error between a field variable and an analytical function
- ElementL2FunctorErrorComputes L2 error between an 'approximate' functor and an 'exact' functor
- ElementL2NormComputes a volume integral of the specified variable
- ElementMaxLevelPostProcessorComputes the maximum element adaptivity level (for either h or p refinement).
- ElementSidesL2NormComputes the L2 norm of a variable over element sides.
- ElementVectorL2ErrorReturns the L2-norm of the difference between a pair of computed and analytical vector-valued solutions.
- ElementW1pErrorComputes the W1p norm of the difference between a variable and an analytic solution, as a function
- ElementalVariableValueOutputs an elemental variable value at a particular location
- EmptyPostprocessorA postprocessor object that returns a value of zero.
- FindValueOnLineFind a specific target value along a sampling line. The variable values along the line should change monotonically. The target value is searched using a bisection algorithm.
- FunctionElementAverageComputes the average of a function over a volume.
- FunctionElementIntegralIntegrates a function over elements
- FunctionSideAverageComputes the average of a function over a boundary.
- FunctionSideIntegralComputes the integral of a function over a boundary.
- FunctionValuePostprocessorComputes the value of a supplied function at a single point (scalable)
- GreaterThanLessThanPostprocessorCount number of DOFs of a non-linear variable that are greater than or less than a given threshold
- InterfaceAverageVariableValuePostprocessorComputes the average value of a variable on an interface. Note that this cannot be used on the centerline of an axisymmetric model.
- InterfaceDiffusiveFluxAverageComputes the diffusive flux on the interface.
- InterfaceDiffusiveFluxIntegralComputes the diffusive flux on the interface.
- InterfaceIntegralVariableValuePostprocessorAdd access to variables and their gradient on an interface.
- InternalSideIntegralVariablePostprocessorComputes an integral on internal sides of the specified variable
- LinearCombinationPostprocessorComputes a linear combination between an arbitrary number of post-processors
- MatrixSymmetryCheckReport whether a matrix is symmetric or not.
- MemoryUsageMemory usage statistics for the running simulation.
- NearestNodeNumberOutputs the nearest node number to a point
- NodalExtremeValueFinds either the min or max elemental value of a variable over the domain.
- NodalL2ErrorThe L2-norm of the difference between a variable and a function computed at nodes.
- NodalL2NormComputes the nodal L2-norm of the coupled variable, which is defined by summing the square of its value at every node and taking the square root.
- NodalMaxValueComputes the maximum (over all the nodal values) of a variable.
- NodalMaxValueIdFinds the node id with the maximum nodal value across all postprocessors.
- NodalProxyMaxValueFinds the node id with the maximum nodal value across all postprocessors.
- NodalSumComputes the sum of all of the nodal values of the specified variable. Note: This object sets the default "unique_node_execute" flag to true to avoid double counting nodes between shared blocks.
- NodalVariableValueOutputs values of a nodal variable at a particular location
- NumDOFsReturn the number of Degrees of freedom from either the NL, Aux or both systems.
- NumElementsReturn the number of active or total elements in the simulation.
- NumElemsReturn the number of active or total elements in the simulation.
- NumFailedTimeStepsCollects the number of failed time steps from the time stepper.
- NumFixedPointIterationsReturns the number of fixed point iterations taken by the executioner.
- NumLinearIterationsCompute the number of linear iterations.
- NumMeshDivisionsReturn the number of divisions/regions from a MeshDivision object.
- NumNodesReturns the total number of nodes in a simulation (works with DistributedMesh)
- NumNonlinearIterationsOutputs the number of nonlinear iterations
- NumPicardIterationsReturns the number of fixed point iterations taken by the executioner.
- NumPositionsReturn the number of Positions from a Positions object.
- NumRelationshipManagersReturn the number of relationship managers active.
- NumResidualEvaluationsReturns the total number of residual evaluations performed.
- NumTimeStepsReports the timestep number
- NumVarsReturn the number of variables from either the NL, Aux, or both systems.
- ParsedPostprocessorComputes a parsed expression with post-processors
- PercentChangePostprocessorComputes the percent change of a postprocessor value compared to the value at the previous timestep.
- PerfGraphDataRetrieves performance information about a section from the PerfGraph.
- PointValueCompute the value of a variable at a specified location
- PostprocessorComparisonCompares two post-processors and produces a boolean value
- PseudoTimestepComputes pseudo-time steps for obtaining steady-state solutions through a pseudo transient process.
- ReceiverReports the value stored in this processor, which is usually filled in by another object. The Receiver does not compute its own value.
- RelativeDifferencePostprocessorComputes the absolute value of the relative difference between 2 post-processor values.
- RelativeSolutionDifferenceNormComputes the relative norm of the solution difference of two consecutive time steps.
- ResidualReport the non-linear residual.
- ScalarL2ErrorCompute L2 error of a scalar variable using analytic function.
- ScalarVariableReturns the value of a scalar variable as a postprocessor value.
- ScalePostprocessorScales a post-processor by a value
- SideAdvectiveFluxIntegralComputes the volumetric advected quantity through a sideset.
- SideAverageFunctorPostprocessorComputes the average of a functor over a side set.
- SideAverageMaterialPropertyComputes the average of a material property over a side set.
- SideAverageValueComputes the average value of a variable on a sideset. Note that this cannot be used on the centerline of an axisymmetric model.
- SideDiffusiveFluxAverageComputes the average of the diffusive flux over the specified boundary
- SideDiffusiveFluxIntegralComputes the integral of the diffusive flux over the specified boundary
- SideExtremeValueFinds either the min or max variable value of a variable over a boundary.
- SideFVFluxBCIntegralComputes the side integral of different finite volume flux boundary conditions.
- SideFluxAverageComputes the average of the diffusive flux over the specified boundary
- SideFluxIntegralComputes the integral of the diffusive flux over the specified boundary
- SideIntegralFunctorPostprocessorComputes a surface integral of the specified functor, using the single-sided face argument, which usually means that the functor will be evaluated from a single side of the surface, not interpolated between both sides.
- SideIntegralMaterialPropertyCompute the integral of a scalar material property component over the domain.
- SideIntegralVariablePostprocessorComputes a surface integral of the specified variable
- SideVectorDiffusivityFluxIntegralComputes the integral of the diffusive flux over the specified boundary
- SumPostprocessorSums the values of several postprocessors
- TagVectorSumComputes the sum of components of the requested tagged vector
- TimeExtremeValueA postprocessor for reporting the extreme value of another postprocessor over time.
- TimeIntegratedPostprocessorIntegrate a Postprocessor value over time.
- TimePostprocessorReports the current time
- TimestepSizeReports the timestep size
- TotalVariableValueIntegrate a Postprocessor value over time.
- VariableInnerProductComputes a volume integral of the specified variable
- VariableResidualComputes the L2 norm of the residual of a single variable in the solution vector.
- VectorPostprocessorComparisonCompares two vector post-processors of equal size and produces a boolean value
- VectorPostprocessorComponentReturns the value of the specified component of a VectorPostprocessor
- VectorPostprocessorReductionValueTakes a VectorPostprocessor and performs a reduction operation on it (max, min, sum, average) and stores as postprocessor.
- VolumePostprocessorComputes the volume of a specified block
- Misc App
- GeneralSensorPostprocessorThis is a GeneralSensorPostprocessor, and functions as a base class for other sensor postprocessors
- InternalVolumeComputes the volume of an enclosed area by performing an integral over a user-supplied boundary.
- ThermocoupleSensorPostprocessorThis is a ThermocoupleSensorPostprocessor for various classes of thermocouples, described by the 'thermocouple_type' parameter
- Navier Stokes App
- ADCFLTimeStepSizeComputes a time step size based on a user-specified CFL number
- CFLTimeStepSizeComputes a time step size based on a user-specified CFL number
- INSADElementIntegralEnergyAdvectionComputes the net volumetric balance of energy transported by advection
- INSElementIntegralEnergyAdvectionComputes the net volumetric balance of energy transported by advection
- INSExplicitTimestepSelectorPostprocessor that computes the minimum value of h_min/|u|, where |u| is coupled in as an aux variable.
- IntegralDirectedSurfaceForceComputes the directed force coming from friction and pressure differences on a surface. One can use this object for the computation of the drag and lift coefficient as well.
- MassFluxWeightedFlowRateComputes the mass flux weighted average of the quantity provided by advected_quantity over a boundary.
- MatrixEigenvalueCheckReport the number of zero eigenvalues of a matrix.
- MatrixEqualityCheckReport whether two matrices are the same or not.
- MfrPostprocessorObject for outputting boundary mass fluxes in conjunction with FVFluxBC derived objects that support it
- NSEntropyErrorComputes entropy error.
- PressureDropComputes the pressure drop between an upstream and a downstream boundary.
- RayleighNumberPostprocessor that computes the Rayleigh number for free flow with natural circulation
- VolumetricFlowRateComputes the volumetric flow rate of an advected quantity through a sideset.
- Rdg App
- BoundaryFluxPostprocessorComputes the side integral of a flux entry from a BoundaryFluxBase user object
- RDGBoundaryFluxPostprocessorComputes the side integral of a flux entry from a BoundaryFluxBase user object
- Ray Tracing App
- RayDataValueObtains a value from the data or aux data of a Ray after tracing has been completed.
- RayIntegralValueObtains the integrated value accumulated into a Ray from an IntegralRayKernel-derived class.
- RayTracingStudyResultGets a result from a RayTracingStudy.
- Heat Transfer App
- ADConvectiveHeatTransferSideIntegralComputes the total convective heat transfer across a boundary.
- ConvectiveHeatTransferSideIntegralComputes the total convective heat transfer across a boundary.
- ExposedSideAverageValueComputes the average value of a variable on the exposed portion of a sideset. Note that this cannot be used on the centerline of an axisymmetric model.
- GrayLambertSurfaceRadiationPPThis postprocessor allows to extract radiosity, heat flux density, and temperature from the GrayLambertSurfaceRadiationBase object.
- HomogenizedThermalConductivityPostprocessor for asymptotic expansion homogenization for thermal conductivity
- ThermalConductivityComputes the effective thermal conductivity averaged on a boundary.
- ViewFactorPPThis postprocessor allows to extract view factors from ViewFactor userobjects.
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.
- SCFSPPreconditioner designed to map onto PETSc's PCFieldSplit.
- 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.
Problem
- Moose App
- CreateProblemActionAdd a Problem object to the simulation.
- DynamicObjectRegistrationActionRegister MooseObjects from other applications dynamically.
- DisplacedProblemA Problem object for providing access to the displaced finite element mesh and associated variables.
- DumpObjectsProblemSingle purpose problem object that does not run the given input but allows deconstructing actions into their series of underlying Moose objects and variables.
- EigenProblemProblem object for solving an eigenvalue problem.
- FEProblemA normal (default) Problem object that contains a single NonlinearSystem and a single AuxiliarySystem object.
- ReferenceResidualProblemProblem that checks for convergence relative to a user-supplied reference quantity rather than the initial residual
- Navier Stokes App
- NavierStokesProblemA problem that handles Schur complement preconditioning of the incompressible Navier-Stokes equations
ProjectedStatefulMaterialStorage
- Moose App
- ProjectedStatefulMaterialStorageActionMark material properties for projected stateful storage.
RayBCs
- 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.
- Ray Tracing App
- AddRayBCActionAdds a RayBC for use in ray tracing to the simulation.
- SetupPeriodicRayBCActionSets up the periodic boundaries for a PeriodicRayBC if applicable.
- KillRayBCA RayBC that kills a Ray on a boundary.
- NullRayBCA RayBC that does nothing to a Ray on a boundary.
- PeriodicRayBCA RayBC that enforces periodic boundaries.
- ReflectRayBCA RayBC that reflects a Ray in a specular manner on a boundary.
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
- Moose App
- AddReporterActionAdd a Reporter object to the simulation.
- ADElementExtremeMaterialPropertyReporterDetermines the location of the minimum or maximum value of a material property over a volume, and provides its coordinates and optionally other requested data at that location.
- AccumulateReporterReporter which accumulates the value of a inputted reporter value over time into a vector reporter value of the same type.
- ConstantReporterReporter with constant values to be accessed by other objects, can be modified using transfers.
- ElementExtremeMaterialPropertyReporterDetermines the location of the minimum or maximum value of a material property over a volume, and provides its coordinates and optionally other requested data at that location.
- ElementVariableStatisticsElement reporter to get statistics for a coupled variable. This can be transfered to other apps.
- ExtraIDIntegralReporterThis ExtraIDIntegralReporter source code is to integrate variables based on parsed extra IDs based on reporter system.
- IterationInfoReport the time and iteration information for the simulation.
- MeshInfoReport mesh information, such as the number of elements, nodes, and degrees of freedom.
- MeshMetaDataReporterReports the mesh meta data.
- MortarSegmentMeshReporterReports mortar segment mesh statistics (element counts and volume statistics) for all mortar interfaces. One entry per primary-secondary subdomain pair is appended to each output vector.
- NodalVariableStatisticsNodal reporter to get statistics for a coupled variable. This can be transfered to other apps.
- ParsedScalarReporterApplies parsed functions to scalar entries held in reporters.
- ParsedVectorRealReductionReporterUse a parsed function to iterate through a vector and reduce it to a scalar.
- ParsedVectorReporterApply parsed functions to vector entries held in reporters.
- ParsedVectorVectorRealReductionReporterUse a parsed function to iterate through a rows of a vector of vector and reduce it to a vector.
- PerfGraphReporterReports the full performance graph from the PerfGraph.
- RestartableDataReporterReports restartable data and restartable meta data.
- SolutionInvalidityReporterReports the Summary Table of Solution Invalid Counts.
Samplers
- Moose App
- AddSamplerActionAdd a Sampler object to the simulation.
ScalarKernels
- Moose App
- AddScalarKernelActionAdd a AuxScalarKernel object to the simulation.
- ADScalarTimeDerivativeAdds the time derivative contribution to the residual for a scalar variable.
- AverageValueConstraintThis class is used to enforce integral of phi with a Lagrange multiplier approach.
- CoupledODETimeDerivativeResidual contribution of ODE from the time derivative of a coupled variable.
- NodalEqualValueConstraintConstrain two nodes to have identical values.
- NullScalarKernelScalar kernel that sets a zero residual, to avoid error from system missing this variable.
- ODETimeDerivativeReturns the time derivative contribution to the residual for a scalar variable.
- ParsedODEKernelParsed expression ODE kernel.
ThermalContact
- Heat Transfer App
- ThermalContactActionAction that controls the creation of all of the necessary objects for calculation of Thermal Contact
Times
- Moose App
- AddTimesActionAdd a Times object to the simulation.
- CSVFileTimesImport times from one or more files.
- ControllableInputTimesTimes set directly from a user parameter in the input file
- ExodusFileTimesImport times from one or more Exodus files.
- FunctorTimesTimes created by evaluating a functor at the (0,0,0) point and the current time
- InputTimesTimes set directly from a user parameter in the input file
- ReporterTimesImport times from one or more reporters, for example other Times
- SimulationTimesTimes simulated
- TimeIntervalTimesTimes between a start time and end time with a fixed time interval.
Transfers
- Moose App
- AddTransferActionAdd a Transfer object to the simulation.
- MultiAppCloneReporterTransferDeclare and transfer reporter data from sub-application(s) to main application.
- MultiAppCopyTransferCopies variables (nonlinear and auxiliary) between multiapps that have identical meshes.
- MultiAppGeneralFieldFunctorTransferTransfers functor data at the MultiApp position by evaluating the functor inside its domain of definition and extrapolating with a user-selected behavior outside
- MultiAppGeneralFieldNearestLocationTransferTransfers field data at the MultiApp position by finding the value at the nearest neighbor(s) in the origin application.
- MultiAppGeneralFieldNearestNodeTransferTransfers field data at the MultiApp position by finding the value at the nearest neighbor(s) in the origin application.
- MultiAppGeneralFieldShapeEvaluationTransferTransfers field data at the MultiApp position using the finite element shape functions from the origin application.
- MultiAppGeneralFieldUserObjectTransferTransfers user object spatial evaluations from an origin app onto a variable in the target application.
- MultiAppGeometricInterpolationTransferTransfers the value to the target domain from a combination/interpolation of the values on the nearest nodes in the source domain, using coefficients based on the distance to each node.
- MultiAppInterpolationTransferTransfers the value to the target domain from a combination/interpolation of the values on the nearest nodes in the source domain, using coefficients based on the distance to each node.
- MultiAppMeshFunctionTransferTransfers field data at the MultiApp position using solution the finite element function from the main/parent application, via a 'libMesh::MeshFunction' object.
- MultiAppNearestNodeTransferTransfer the value to the target domain from the nearest node in the source domain.
- MultiAppPostprocessorInterpolationTransferTransfer postprocessor data from sub-application into field data on the parent application.
- MultiAppPostprocessorToAuxScalarTransferTransfers from a postprocessor to a scalar auxiliary variable.
- MultiAppPostprocessorTransferTransfers postprocessor data between the master application and sub-application(s).
- MultiAppProjectionTransferPerform a projection between a master and sub-application mesh of a field variable.
- MultiAppReporterTransferTransfers reporter data between two applications.
- MultiAppScalarToAuxScalarTransferTransfers data from a scalar variable to an auxiliary scalar variable from different applications.
- MultiAppShapeEvaluationTransferTransfers field data at the MultiApp position using solution the finite element function from the main/parent application, via a 'libMesh::MeshFunction' object.
- MultiAppUserObjectTransferSamples a variable's value in the Parent app domain at the point where the MultiApp is and copies that value into a post-processor in the MultiApp
- MultiAppVariableValueSamplePostprocessorTransferSamples the value of a variable within the main application at each sub-application position and transfers the value to a postprocessor on the sub-application(s) when performing the to-multiapp transfer. Reconstructs the value of a CONSTANT MONOMIAL variable associating the value of each element to the value of the postprocessor in the closest sub-application whem performing the from-multiapp transfer.
- MultiAppVariableValueSampleTransferTransfers the value of a variable within the master application at each sub-application position and transfers the value to a field variable on the sub-application(s).
- MultiAppVectorPostprocessorTransferThis transfer distributes the N values of a VectorPostprocessor to Postprocessors located in N sub-apps or collects Postprocessor values from N sub-apps into a VectorPostprocessor
UserObjects
- Moose App
- AddUserObjectActionAdd a UserObject object to the simulation.
- ADElementAverageMaterialPropertyComputes the average of a material property over a volume.
- ADElementExtremeFunctorValueFinds either the min or max elemental value of a functor over the domain.
- ADElementExtremeMaterialPropertyDetermines the minimum or maximum of a material property over a volume.
- ADElementIntegralFunctorPostprocessorComputes a volume integral of the specified functor
- ADElementIntegralMaterialPropertyCompute the integral of the material property over the domain
- ADElementL2FunctorErrorComputes L2 error between an 'approximate' functor and an 'exact' functor
- ADInterfaceDiffusiveFluxAverageComputes the diffusive flux on the interface.
- ADInterfaceDiffusiveFluxIntegralComputes the diffusive flux on the interface.
- ADProjectedStatefulMaterialNodalPatchRecoveryRankFourTensorPrepare patches for use in nodal patch recovery based on a material property for material property states projected onto nodal variables.
- ADProjectedStatefulMaterialNodalPatchRecoveryRankTwoTensorPrepare patches for use in nodal patch recovery based on a material property for material property states projected onto nodal variables.
- ADProjectedStatefulMaterialNodalPatchRecoveryRealPrepare patches for use in nodal patch recovery based on a material property for material property states projected onto nodal variables.
- ADProjectedStatefulMaterialNodalPatchRecoveryRealVectorValuePrepare patches for use in nodal patch recovery based on a material property for material property states projected onto nodal variables.
- ADSideAdvectiveFluxIntegralComputes the volumetric advected quantity through a sideset.
- ADSideAverageMaterialPropertyComputes the average of a material property over a side set.
- ADSideDiffusiveFluxAverageComputes the average of the diffusive flux over the specified boundary
- ADSideDiffusiveFluxIntegralComputes the integral of the diffusive flux over the specified boundary
- ADSideFluxAverageComputes the average of the diffusive flux over the specified boundary
- ADSideFluxIntegralComputes the integral of the diffusive flux over the specified boundary
- ADSideIntegralFunctorPostprocessorComputes a surface integral of the specified functor, using the single-sided face argument, which usually means that the functor will be evaluated from a single side of the surface, not interpolated between both sides.
- ADSideIntegralMaterialPropertyCompute the integral of a scalar material property component over the domain.
- ADSideVectorDiffusivityFluxIntegralComputes the integral of the diffusive flux over the specified boundary
- ActivateElementsByPathDetermine activated elements.
- ActivateElementsCoupledDetermine activated elements.
- AreaPostprocessorComputes the "area" or dimension - 1 "volume" of a given boundary or boundaries in your mesh.
- AverageElementSizeComputes the average element size.
- AverageNodalVariableValueComputes the average value of a field by sampling all nodal solutions on the domain or within a subdomain
- AverageVariableChangeComputes the volume-weighted L1 or L2 norm of the change of a variable over a time step or between nonlinear iterations.
- AxisymmetricCenterlineAverageValueComputes the average value of a variable on a sideset located along the centerline of an axisymmetric model.
- BoundaryLinearFVFluxIntegralComputes the side integral of selected LinearFVFluxKernel boundary flux contributions.
- ChainControlDataPostprocessorGets a Real or bool chain control value.
- ChangeOverFixedPointPostprocessorComputes the change or relative change in a post-processor value over a single or multiple fixed point iterations
- ChangeOverTimePostprocessorComputes the change or relative change in a post-processor value over a timestep or the entire transient
- ChangeOverTimestepPostprocessorComputes the change or relative change in a post-processor value over a timestep or the entire transient
- ConstantPostprocessorPostprocessor that holds a constant value
- CoupledVarThresholdElementSubdomainModifierModify the element subdomain ID if a coupled variable satisfies the criterion for the threshold (above, equal, or below)
- CumulativeValuePostprocessorCreates a cumulative sum of a Postprocessor value with time.
- DifferencePostprocessorComputes the difference between two postprocessors
- DiscreteVariableResidualNormComputes a discrete norm for a block-restricted variable residual.
- ElemSideNeighborLayersGeomTesterUser object to calculate ghosted elements on a single processor or the union across all processors.
- ElemSideNeighborLayersTesterUser object to calculate ghosted elements on a single processor or the union across all processors.
- ElementArrayL2NormEvaluates L2-norm of a component of an array variable
- ElementAverageMaterialPropertyComputes the average of a material property over a volume.
- ElementAverageSecondTimeDerivativeComputes the element averaged second derivative of variable
- ElementAverageTimeDerivativeComputes a volume integral of the time derivative of a given variable
- ElementAverageValueComputes the volumetric average of a variable
- ElementExtremeFunctorValueFinds either the min or max elemental value of a functor over the domain.
- ElementExtremeMaterialPropertyDetermines the minimum or maximum of a material property over a volume.
- ElementExtremeValueFinds either the min or max elemental value of a variable over the domain.
- ElementH1ErrorComputes the H1 error between a variable and a function
- ElementH1SemiErrorReturns the gradient difference norm part of the H1 error
- ElementHCurlErrorReturns the H(curl)-norm of the difference between a pair of computed and analytical vector-valued solutions.
- ElementHCurlSemiErrorReturns the H(curl)-seminorm of the difference between a pair of computed and analytical vector-valued solutions.
- ElementHDivErrorReturns the H(div)-norm of the difference between a pair of computed and analytical vector-valued solutions.
- ElementHDivSemiErrorReturns the H(div)-seminorm of the difference between a pair of computed and analytical vector-valued solutions.
- ElementIntegralArrayVariablePostprocessorIntegral of one component of an array variable.
- ElementIntegralFunctorPostprocessorComputes a volume integral of the specified functor
- ElementIntegralMaterialPropertyCompute the integral of the material property over the domain
- ElementIntegralVariablePostprocessorComputes a volume integral of the specified variable
- ElementIntegralVariableUserObjectcomputes a volume integral of a variable.
- ElementL1ErrorComputes L1 error between an elemental field variable and an analytical function.
- ElementL2DifferenceComputes the element-wise L2 difference between the current variable and a coupled variable.
- ElementL2ErrorComputes L2 error between a field variable and an analytical function
- ElementL2FunctorErrorComputes L2 error between an 'approximate' functor and an 'exact' functor
- ElementL2NormComputes a volume integral of the specified variable
- ElementMaxLevelPostProcessorComputes the maximum element adaptivity level (for either h or p refinement).
- ElementPropertyReadFileUser Object to read property data from an external file and assign it to elements / nodes / subdomains etc.
- ElementQualityCheckerClass to check the quality of each element using different metrics from libmesh.
- ElementSidesL2NormComputes the L2 norm of a variable over element sides.
- ElementVectorL2ErrorReturns the L2-norm of the difference between a pair of computed and analytical vector-valued solutions.
- ElementW1pErrorComputes the W1p norm of the difference between a variable and an analytic solution, as a function
- ElementalVariableValueOutputs an elemental variable value at a particular location
- EmptyPostprocessorA postprocessor object that returns a value of zero.
- FindValueOnLineFind a specific target value along a sampling line. The variable values along the line should change monotonically. The target value is searched using a bisection algorithm.
- FunctionElementAverageComputes the average of a function over a volume.
- FunctionElementIntegralIntegrates a function over elements
- FunctionElementIntegralUserObjectComputes a volume integral of a function.
- FunctionLayeredIntegralIntegrates a function in layers
- FunctionSideAverageComputes the average of a function over a boundary.
- FunctionSideIntegralComputes the integral of a function over a boundary.
- FunctionValuePostprocessorComputes the value of a supplied function at a single point (scalable)
- GeometrySphereSnap nodes to the surface of a sphere either during adaptivity or on execution
- GhostingUserObjectCreates ghosting maps that can be queried by external objects.
- GreaterThanLessThanPostprocessorCount number of DOFs of a non-linear variable that are greater than or less than a given threshold
- InterfaceAverageVariableValuePostprocessorComputes the average value of a variable on an interface. Note that this cannot be used on the centerline of an axisymmetric model.
- InterfaceDiffusiveFluxAverageComputes the diffusive flux on the interface.
- InterfaceDiffusiveFluxIntegralComputes the diffusive flux on the interface.
- InterfaceIntegralVariableValuePostprocessorAdd access to variables and their gradient on an interface.
- InterfaceQpMaterialPropertyRealUOComputes the value, rate or increment of a Real Material property across an interface. The value, rate or increment is computed according to the provided interface_value_type parameter
- InterfaceQpValueUserObjectComputes the variable value, rate or increment across an interface. The value, rate or increment is computed according to the provided interface_value_type parameter
- InternalSideIntegralVariablePostprocessorComputes an integral on internal sides of the specified variable
- JSONFileReaderLoads a JSON file and makes it content available to consumers
- LayeredAverageComputes averages of variables over layers
- LayeredAverageFunctorComputes layered side averages of a functor.
- LayeredExtremumMaterialPropertyCompute material property extrema over layers.
- LayeredIntegralCompute variable integrals over layers.
- LayeredIntegralFunctorComputes layered element integrals of a functor.
- LayeredSideAverageComputes side averages of a variable storing partial sums for the specified number of intervals in a direction (x,y,z).
- LayeredSideAverageFunctorComputes layered side averages of a functor.
- LayeredSideDiffusiveFluxAverageComputes the diffusive flux of a variable on layers alongside a boundary.
- LayeredSideFluxAverageComputes the diffusive flux of a variable on layers alongside a boundary.
- LayeredSideIntegralComputes surface integral of a variable storing partial sums for the specified number of intervals in a direction (x,y,z).
- LayeredSideIntegralFunctorComputes layered side integrals of a functor.
- LinearCombinationPostprocessorComputes a linear combination between an arbitrary number of post-processors
- MOOSEOldPostprocessorToNEML2Gather a MOOSE postprocessor value for insertion into the specified input variable or model parameter of a NEML2 model.
- MOOSEOldRankTwoTensorMaterialPropertyToNEML2Gather a MOOSE material property of type RankTwoTensorTempl<double> for insertion into the specified input or model parameter of a NEML2 model.
- MOOSEOldRealMaterialPropertyToNEML2Gather a MOOSE material property of type double for insertion into the specified input or model parameter of a NEML2 model.
- MOOSEOldRealVectorValueMaterialPropertyToNEML2Gather a MOOSE material property of type libMesh::VectorValue<double> for insertion into the specified input or model parameter of a NEML2 model.
- MOOSEOldSymmetricRankTwoTensorMaterialPropertyToNEML2Gather a MOOSE material property of type SymmetricRankTwoTensorTempl<double> for insertion into the specified input or model parameter of a NEML2 model.
- MOOSEOldVariableToNEML2Gather a MOOSE variable for insertion into the specified input or model parameter of a NEML2 model.
- MOOSEPostprocessorToNEML2Gather a MOOSE postprocessor value for insertion into the specified input variable or model parameter of a NEML2 model.
- MOOSERankTwoTensorMaterialPropertyToNEML2Gather a MOOSE material property of type RankTwoTensorTempl<double> for insertion into the specified input or model parameter of a NEML2 model.
- MOOSERealMaterialPropertyToNEML2Gather a MOOSE material property of type double for insertion into the specified input or model parameter of a NEML2 model.
- MOOSERealVectorValueMaterialPropertyToNEML2Gather a MOOSE material property of type libMesh::VectorValue<double> for insertion into the specified input or model parameter of a NEML2 model.
- MOOSESymmetricRankTwoTensorMaterialPropertyToNEML2Gather a MOOSE material property of type SymmetricRankTwoTensorTempl<double> for insertion into the specified input or model parameter of a NEML2 model.
- MOOSEVariableToNEML2Gather a MOOSE variable for insertion into the specified input or model parameter of a NEML2 model.
- MatrixSymmetryCheckReport whether a matrix is symmetric or not.
- MemoryUsageMemory usage statistics for the running simulation.
- MessageFromInputPrint out a message from the input file
- MoveNodesToSphereSnap nodes to the surface of a sphere either during adaptivity or on execution
- NEML2BatchIndexGeneratorGenerates the element to batch index map for MOOSEToNEML2 gatherers, NEML2ToMOOSE retrievers, and the NEML2 executor
- NEML2ModelExecutorExecute the specified NEML2 model
- NearestNodeNumberOutputs the nearest node number to a point
- NearestNodeNumberUOFinds and outputs the nearest node number to a point
- NearestPointAverageCompute element variable averages for nearest-point based subdomains
- NearestPointLayeredAverageComputes averages of a variable storing partial sums for the specified number of intervals in a direction (x,y,z). Given a list of points this object computes the layered average closest to each one of those points.
- NearestPointLayeredIntegralComputes integrals of a variable storing partial sums for the specified number of intervals in a direction (x,y,z). Given a list of points this object computes the layered integral closest to each one of those points.
- NearestPointLayeredSideAverageCompute layered side averages for nearest-point based subdomains
- NearestPointLayeredSideAverageFunctorComputes layered side averages of a functor nearest to a set of points.
- NearestPointLayeredSideDiffusiveFluxAverageCompute layered side diffusive flux averages for nearest-point based subdivisions
- NearestPointLayeredSideFluxAverageCompute layered side diffusive flux averages for nearest-point based subdivisions
- NearestPointLayeredSideIntegralCompute layered side integrals for nearest-point based sidesets
- NearestPointLayeredSideIntegralFunctorComputes layered side integrals of a functor nearest to a set of points.
- NearestRadiusLayeredAverageComputes averages of a variable storing partial sums for the specified number of intervals in a direction (x,y,z). Given a list of points this object computes the layered average closest to each one of those points, where the distance is computed in terms of radius (or distance to the origin in the plane perpendicular to 'direction').
- NodalExtremeValueFinds either the min or max elemental value of a variable over the domain.
- NodalL2ErrorThe L2-norm of the difference between a variable and a function computed at nodes.
- NodalL2NormComputes the nodal L2-norm of the coupled variable, which is defined by summing the square of its value at every node and taking the square root.
- NodalMaxValueComputes the maximum (over all the nodal values) of a variable.
- NodalMaxValueIdFinds the node id with the maximum nodal value across all postprocessors.
- NodalNormalsCornerComputes nodal normals at boundary corners.
- NodalNormalsEvaluatorHelper object to compute nodal normal values via the NodalNormals input block.
- NodalNormalsPreprocessorAn object that prepares MOOSE for computing nodal normal vectors. This object is automatically created via the [NodalNormals] input block.
- NodalPatchRecoveryMaterialPropertyPrepare patches for use in nodal patch recovery based on a material property.
- NodalPatchRecoveryVariablePerforms patch recovery using a coupled variable.
- NodalProxyMaxValueFinds the node id with the maximum nodal value across all postprocessors.
- NodalSumComputes the sum of all of the nodal values of the specified variable. Note: This object sets the default "unique_node_execute" flag to true to avoid double counting nodes between shared blocks.
- NodalVariableValueOutputs values of a nodal variable at a particular location
- NumDOFsReturn the number of Degrees of freedom from either the NL, Aux or both systems.
- NumElementsReturn the number of active or total elements in the simulation.
- NumElemsReturn the number of active or total elements in the simulation.
- NumFailedTimeStepsCollects the number of failed time steps from the time stepper.
- NumFixedPointIterationsReturns the number of fixed point iterations taken by the executioner.
- NumLinearIterationsCompute the number of linear iterations.
- NumMeshDivisionsReturn the number of divisions/regions from a MeshDivision object.
- NumNodesReturns the total number of nodes in a simulation (works with DistributedMesh)
- NumNonlinearIterationsOutputs the number of nonlinear iterations
- NumPicardIterationsReturns the number of fixed point iterations taken by the executioner.
- NumPositionsReturn the number of Positions from a Positions object.
- NumRelationshipManagersReturn the number of relationship managers active.
- NumResidualEvaluationsReturns the total number of residual evaluations performed.
- NumTimeStepsReports the timestep number
- NumVarsReturn the number of variables from either the NL, Aux, or both systems.
- ParsedPostprocessorComputes a parsed expression with post-processors
- PercentChangePostprocessorComputes the percent change of a postprocessor value compared to the value at the previous timestep.
- PerfGraphDataRetrieves performance information about a section from the PerfGraph.
- PointValueCompute the value of a variable at a specified location
- PointwiseRenormalizeVectorPointwise renormalize the solution of a set of variables comprising a vector
- PostprocessorComparisonCompares two post-processors and produces a boolean value
- PostprocessorSpatialUserObjectUser object (spatial) that holds a postprocessor value.
- ProjectedStatefulMaterialNodalPatchRecoveryRankFourTensorPrepare patches for use in nodal patch recovery based on a material property for material property states projected onto nodal variables.
- ProjectedStatefulMaterialNodalPatchRecoveryRankTwoTensorPrepare patches for use in nodal patch recovery based on a material property for material property states projected onto nodal variables.
- ProjectedStatefulMaterialNodalPatchRecoveryRealPrepare patches for use in nodal patch recovery based on a material property for material property states projected onto nodal variables.
- ProjectedStatefulMaterialNodalPatchRecoveryRealVectorValuePrepare patches for use in nodal patch recovery based on a material property for material property states projected onto nodal variables.
- PropertyReadFileUser Object to read property data from an external file and assign it to elements / nodes / subdomains etc.
- PseudoTimestepComputes pseudo-time steps for obtaining steady-state solutions through a pseudo transient process.
- RadialAveragePerform a radial average of a material property
- ReceiverReports the value stored in this processor, which is usually filled in by another object. The Receiver does not compute its own value.
- RelativeDifferencePostprocessorComputes the absolute value of the relative difference between 2 post-processor values.
- RelativeSolutionDifferenceNormComputes the relative norm of the solution difference of two consecutive time steps.
- ResidualReport the non-linear residual.
- ScalarL2ErrorCompute L2 error of a scalar variable using analytic function.
- ScalarVariableReturns the value of a scalar variable as a postprocessor value.
- ScalePostprocessorScales a post-processor by a value
- SideAdvectiveFluxIntegralComputes the volumetric advected quantity through a sideset.
- SideAverageFunctorPostprocessorComputes the average of a functor over a side set.
- SideAverageMaterialPropertyComputes the average of a material property over a side set.
- SideAverageValueComputes the average value of a variable on a sideset. Note that this cannot be used on the centerline of an axisymmetric model.
- SideDiffusiveFluxAverageComputes the average of the diffusive flux over the specified boundary
- SideDiffusiveFluxIntegralComputes the integral of the diffusive flux over the specified boundary
- SideExtremeValueFinds either the min or max variable value of a variable over a boundary.
- SideFVFluxBCIntegralComputes the side integral of different finite volume flux boundary conditions.
- SideFluxAverageComputes the average of the diffusive flux over the specified boundary
- SideFluxIntegralComputes the integral of the diffusive flux over the specified boundary
- SideIntegralFunctorPostprocessorComputes a surface integral of the specified functor, using the single-sided face argument, which usually means that the functor will be evaluated from a single side of the surface, not interpolated between both sides.
- SideIntegralMaterialPropertyCompute the integral of a scalar material property component over the domain.
- SideIntegralVariablePostprocessorComputes a surface integral of the specified variable
- SideVectorDiffusivityFluxIntegralComputes the integral of the diffusive flux over the specified boundary
- SidesetAroundSubdomainUpdaterSets up a boundary between inner_subdomains and outer_subdomains
- SolutionUserObjectReads a variable from a mesh in one simulation to another
- SumPostprocessorSums the values of several postprocessors
- TagVectorSumComputes the sum of components of the requested tagged vector
- TerminatorRequests termination of the current solve based on the evaluation of a parsed logical expression of the Postprocessor value(s).
- TimeExtremeValueA postprocessor for reporting the extreme value of another postprocessor over time.
- TimeIntegratedPostprocessorIntegrate a Postprocessor value over time.
- TimePostprocessorReports the current time
- TimedSubdomainModifierModify element subdomain ID of entire subdomains for given points in time. This mesh modifier only runs on the undisplaced mesh, and it will modify both the undisplaced and the displaced mesh.
- TimestepSizeReports the timestep size
- TotalVariableValueIntegrate a Postprocessor value over time.
- VariableInnerProductComputes a volume integral of the specified variable
- VariableResidualComputes the L2 norm of the residual of a single variable in the solution vector.
- VariableValueElementSubdomainModifierModify the element subdomain ID based on the provided variable value.
- VectorPostprocessorComparisonCompares two vector post-processors of equal size and produces a boolean value
- VectorPostprocessorComponentReturns the value of the specified component of a VectorPostprocessor
- VectorPostprocessorReductionValueTakes a VectorPostprocessor and performs a reduction operation on it (max, min, sum, average) and stores as postprocessor.
- VerifyElementUniqueIDVerifies that all element ids are unique.
- VerifyNodalUniqueIDVerifies that all node ids are unique.
- VolumePostprocessorComputes the volume of a specified block
- Misc App
- GeneralSensorPostprocessorThis is a GeneralSensorPostprocessor, and functions as a base class for other sensor postprocessors
- InternalVolumeComputes the volume of an enclosed area by performing an integral over a user-supplied boundary.
- ThermocoupleSensorPostprocessorThis is a ThermocoupleSensorPostprocessor for various classes of thermocouples, described by the 'thermocouple_type' parameter
- Fluid Properties App
- FluidPropertiesInterrogatorUser object for querying a single-phase or two-phase fluid properties object
- Navier Stokes App
- ADCFLTimeStepSizeComputes a time step size based on a user-specified CFL number
- CFLTimeStepSizeComputes a time step size based on a user-specified CFL number
- HLLCUserObjectComputes free-flow wave speeds on internal sides, useful in HLLC contexts
- INSADElementIntegralEnergyAdvectionComputes the net volumetric balance of energy transported by advection
- INSADObjectTrackerUser object used to track the kernels added to an INS simulation and determine what properties to calculate in INSADMaterial
- INSElementIntegralEnergyAdvectionComputes the net volumetric balance of energy transported by advection
- INSExplicitTimestepSelectorPostprocessor that computes the minimum value of h_min/|u|, where |u| is coupled in as an aux variable.
- INSFVRhieChowInterpolatorComputes the Rhie-Chow velocity based on gathered 'a' coefficient data.
- INSFVRhieChowInterpolatorSegregatedComputes H/A and 1/A together with face velocities for segregated momentum-pressure equations.
- IntegralDirectedSurfaceForceComputes the directed force coming from friction and pressure differences on a surface. One can use this object for the computation of the drag and lift coefficient as well.
- MassFluxWeightedFlowRateComputes the mass flux weighted average of the quantity provided by advected_quantity over a boundary.
- MatrixEigenvalueCheckReport the number of zero eigenvalues of a matrix.
- MatrixEqualityCheckReport whether two matrices are the same or not.
- MfrPostprocessorObject for outputting boundary mass fluxes in conjunction with FVFluxBC derived objects that support it
- NSEntropyErrorComputes entropy error.
- NSFVPressurePinPins the pressure after a solve
- NSPressurePinPins the pressure after a solve
- PINSFVRhieChowInterpolatorPerforms interpolations and reconstructions of porosity and computes the Rhie-Chow face velocities.
- PINSFVRhieChowInterpolatorSegregatedComputes H/A and 1/A together with face velocities for segregated porous medium momentum-pressure equations.
- PressureDropComputes the pressure drop between an upstream and a downstream boundary.
- RayleighNumberPostprocessor that computes the Rayleigh number for free flow with natural circulation
- RhieChowMassFluxComputes H/A and 1/A together with face mass fluxes for segregated momentum-pressure equations using linear systems.
- VolumetricFlowRateComputes the volumetric flow rate of an advected quantity through a sideset.
- Rdg App
- AEFVFreeOutflowBoundaryFluxFree outflow BC based boundary flux user object for the advection equation using a cell-centered finite volume method.
- AEFVSlopeLimitingOneDOne-dimensional slope limiting to get the limited slope of cell average variable for the advection equation using a cell-centered finite volume method.
- AEFVUpwindInternalSideFluxUpwind numerical flux scheme for the advection equation using a cell-centered finite volume method.
- BoundaryFluxPostprocessorComputes the side integral of a flux entry from a BoundaryFluxBase user object
- RDGBoundaryFluxPostprocessorComputes the side integral of a flux entry from a BoundaryFluxBase user object
- Ray Tracing App
- ConeRayStudyRay study that spawns Rays in the direction of a cone from a given set of starting points.
- RayDataValueObtains a value from the data or aux data of a Ray after tracing has been completed.
- RayIntegralValueObtains the integrated value accumulated into a Ray from an IntegralRayKernel-derived class.
- RayTracingStudyResultGets a result from a RayTracingStudy.
- RepeatableRayStudyA ray tracing study that generates rays from vector of user-input start points and end points/directions.
- Heat Transfer App
- ADConvectiveHeatTransferSideIntegralComputes the total convective heat transfer across a boundary.
- ConstantViewFactorSurfaceRadiationConstantViewFactorSurfaceRadiation computes radiative heat transfer between side sets and the view factors are provided in the input file
- ConvectiveHeatTransferSideIntegralComputes the total convective heat transfer across a boundary.
- ExposedSideAverageValueComputes the average value of a variable on the exposed portion of a sideset. Note that this cannot be used on the centerline of an axisymmetric model.
- FunctorGapFluxModelConductionGap flux model for varying gap conductance using a functor for temperature.
- FunctorGapFluxModelRadiationGap flux model for heat transfer across a gap due to radiation, based on the diffusion approximation. Uses a temperature functor.
- GapFluxModelConductionGap flux model for varying gap conductance using a coupled variable for temperature
- GapFluxModelPressureDependentConductionHeat flux model across a closed gap to calculate the conductance between two solid materials
- GapFluxModelRadiationGap flux model for heat conduction across a gap due to radiation, based on the diffusion approximation. Uses a coupled temperature variable.
- GapFluxModelRadiativeGap flux demonstration model for radiative heat conductance
- GapFluxModelSimpleGap flux model with a constant conductance
- GrayLambertSurfaceRadiationPPThis postprocessor allows to extract radiosity, heat flux density, and temperature from the GrayLambertSurfaceRadiationBase object.
- HomogenizedThermalConductivityPostprocessor for asymptotic expansion homogenization for thermal conductivity
- RayTracingViewFactorComputes view factors for arbitrary geometries using raytracing.
- SelfShadowSideUserObjectCompute the illumination status for a self shadowing sideset
- SpecifiedViewFactorView factors specified directly in the input file
- ThermalConductivityComputes the effective thermal conductivity averaged on a boundary.
- UnobstructedPlanarViewFactorComputes the view factors for planar faces in unubstructed radiative heat transfer.
- ViewFactorObjectSurfaceRadiationViewFactorObjectSurfaceRadiation computes radiative heat transfer between side sets and the view factors are computed by a ViewFactor object
- ViewFactorPPThis postprocessor allows to extract view factors from ViewFactor userobjects.
- ViewFactorRayStudyThis ray study is used to compute view factors in cavities with obstruction. It sends out rays from surfaces bounding the radiation cavity into a set of directions determined by an angular quadrature. The rays are tracked and view factors are computed by determining the surface where the ray dies.
Variables
- Moose App
- AddVariableActionAdd a non-linear variable to the simulation.
- CopyNodalVarsActionCopies variable information from a file.
- ArrayMooseVariableUsed for grouping standard field variables with the same finite element family and order
- 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
- VectorMooseVariableRepresents vector field variables, e.g. Vector Lagrange, Nedelec or Raviart-Thomas
- Navier Stokes App
- BernoulliPressureVariableBase class for Moose variables. This should never be the terminal object type
- INSFVEnergyVariableBase class for Moose variables. This should never be the terminal object type
- INSFVPressureVariableBase class for Moose variables. This should never be the terminal object type
- INSFVScalarFieldVariableBase class for Moose variables. This should never be the terminal object type
- INSFVVelocityVariableBase class for Moose variables. This should never be the terminal object type
- PINSFVSuperficialVelocityVariableBase class for Moose variables. This should never be the terminal object type
- PiecewiseConstantVariableBase class for Moose variables. This should never be the terminal object type
VectorPostprocessors
- Moose App
- AddVectorPostprocessorActionAdd a VectorPostprocessor object to the simulation.
- ArrayVariableValueVolumeHistogramCompute histograms of volume fractions binned according to component values of an array variable.
- CSVReaderConverts columns of a CSV file into vectors of a VectorPostprocessor.
- CSVReaderVectorPostprocessorConverts columns of a CSV file into vectors of a VectorPostprocessor.
- CombinedVectorPostprocessorOutputs the values of an arbitrary user-specified set of vectorpostprocessors as a combined vector in the order specified by the user
- 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
- Heat Transfer App
- SurfaceRadiationVectorPostprocessorVectorPostprocessor for accessing information stored in surface radiation user object
- ViewFactorVectorPostprocessorVectorPostprocessor for accessing view factors from GrayLambertSurfaceRadiationBase UO
- ViewfactorVectorPostprocessorVectorPostprocessor for accessing view factors from GrayLambertSurfaceRadiationBase UO
- Navier Stokes App
- WaveSpeedVPPExtracts wave speeds from HLLC userobject for a given face
- Ray Tracing App
- PerProcessorRayTracingResultsVectorPostprocessorAccumulates ray tracing results (information about the trace) on a per-processor basis.