Marlin Application Syntax
Marlin uses the MOOSE hierarchial input text (HIT) format, but adds a whole bunch of new toplevel syntax. In addition some syntax allows for hierarchial nesting with a semantic meaning. In the [TensorCompute] syntax the nesting is used to group computes.
[Domain]
The domain block sets up the problem domain. As Marlin is a grid based FFT code it does not use a libMesh mesh ([Mesh] block) as a computation domain. However a mesh can be set up to automatically match the grid domain if coupling to a finite element run is desired. In that case Marlin supports fast copying of grid based tensor buffers to the mesh and back.
The DomainAction also automatically sets up a TensorProblem object if the user didn;t explicitly specify a problem type. Note that to use any Marlin objects the problem type has to be TensorProblem or a class derived from TensorProblem.
[TensorComputes]
TensorComputes (or tensor operators) are the Marlin explicit equivalent to Kernels in MOOSE. Instead of computing point forces (and Jacobians) tensor computes perform an explicit operation on a set of input buffers (tensors) resulting in a set of (one or more) output buffers. Marlin performs automatic dependency resolution to sort the tensor computes according to requested inputs and outputs.
[TensorSolver]
The TensorSolver advances the problem to the next time step (or rather sub step) and closes the dependency cycle.
[TensorOutputs]
While output using meshbased MOOSE outputs, such as Exodus, is possible, Marlin provides a faster system to output tensor grids directly using a threaded output system. Especially when running simulations on GPU devices this asynchronous output is running on a CPU copy of the output buffers, while the next timestep is already computing on the GPU. This allows for GPU utilizations up to 100%.
Syntax
- Marlin App
- ProjectTensorAuxProject a Tensor buffer onto an auxiliary variable
- Marlin App
- DomainActionSet up the domain and compute devices.
- Marlin App
- DomainMeshGeneratorCreate a line, square, or cube mesh with uniformly spaced or biased elements.
- UniformTensorMeshCreate a line, square, or cube mesh with uniformly spaced elements.
- Marlin App
- DomainPartitionerCreate a uniform grid that overlays the mesh to be partitioned. Assign all elements within each cell of the grid to the same processor.
- Marlin App
- ComputeGroupExecutionCountReturn the number of computeBuffer() calls issued to the given compute group object.
- ComputeReynoldsNumberCompute Reynolds number.
- ReciprocalIntegralExtract the zero k-vector value (corresponding to the integral).
- SemiImplicitCriticalTimeStepCompute the critical timestep given the reciprocal space representation of the linear operator in a semi-implicit time integrator.
- TensorAveragePostprocessorCompute the average value over a buffer.
- TensorExtremeValuePostprocessorFind extreme values in the Tensor buffer
- TensorIntegralChangePostprocessorCompute the integral over a buffer
- TensorIntegralPostprocessorCompute the integral over a buffer
- TensorInterfaceVelocityPostprocessorCompute the integral over a buffer
- Marlin App
- LatticeBoltzmannProblemProblem object to enable solving lattice Boltzmann problems
- TensorProblemA normal Problem object that adds the ability to perform spectral solves.
- Marlin App
- AddLBMStencilActionAdd LBM stencil object to the simulation.
- LBMD2Q9LBMD2Q9 Stencil object.
- LBMD3Q19LBMD3Q19 Stencil object.
- LBMD3Q27LBMD3Q27 Stencil object.
- Marlin App
- AddTensorBufferActionAdd a TensorBuffer object to the simulation.
- LBMTensorBufferTensor wrapper form LBM tensors
- PlainTensorBufferGeneric TensorBuffer object.
- SR2TensorThis tensor type requires Marlin to be built woth NEML2.
- VectorTensorThis tensor type requires Marlin to be built woth NEML2.
- Marlin App
- Boundary
- Initialize
- Postprocess
- Solve
- Marlin App
- AddLBMBCActionAdd LBM boundary condition object.
- ComputeDisplacementsCompute updated displacements from the deformation gradient tensor.
- ComputeGroupGroup of operators with internal dependency resolution and optional JIT tracing support.
- ComputeVonMisesStressCompute vonMises stress.
- ConstantReciprocalTensorConstant tensor in reciprocal space.
- ConstantTensorConstant tensor in real space.
- DeAliasingTensorCreate a de-aliasing filter.
- FCCPFCLinearReciprocal space linear prefactor for the two-mode FCC phase-field crystal model.
- FCCPFCNonlinearReciprocal space nonlinear term for the two-mode FCC phase-field crystal model.
- FFTElasticChemicalPotentialFFT based elastic strain energy chemical potential solve.
- FFTGradientTensor gradient.
- FFTGradientSquareTensor gradient.
- FFTMechanicsdeGeus variational mechanics solve. Updates the coupled buffer holding the deformation gradient tensor.
- FFTQuasistaticElasticityFFT based monolithic homogeneous quasistatic elasticity solve.
- FiniteDifferenceLaplacianComputes the Laplacian using finite differences.
- ForwardFFTPerformFFT object.
- GradientVectorGradient of the coupled tensor buffer returned as a stacked torch tensor.
- HyperElasticIsotropicHyperelastic isotropic constitutive model.
- InverseFFTPerformFFT object.
- LBMAllenCahnSourceCompute Allen-Cahn source term for phase field model.
- LBMApplyForcesCompute object for LB forces
- LBMBGKCollisionTemplate object for LBM collision dynamics
- LBMBounceBackLBMBounceBack object
- LBMComputeChemicalPotentialCompute LB checmial potential for pahse field coupling.
- LBMComputeDensityCompute object for macroscopic density reconstruction.
- LBMComputeEffectiveRelaxationCompute local effective relaxation time matrix based on local pore size and Knudsen number.
- LBMComputeForcesCompute object for LB forces
- LBMComputeResidualCompute object for LBM residual.
- LBMComputeSurfaceForcesCompute object for LB surface forces
- LBMComputeVelocityCompute object for macroscopic velocity reconstruction.
- LBMComputeVelocityMagnitudeLBMComputeVelocityMagnitude object.
- LBMConstantTensorLBMConstantTensor object.
- LBMConvectiveOutflowConvective outflow boundary condition. Applies df/dt + U_c * df/dn = 0 at the boundary, discretized as f(x_b, t) = (f(x_b, t-1) + U_c * f(x_n, t)) / (1 + U_c). U_c can be a fixed value or computed automatically as the mean normal velocity at the boundary plane.
- LBMDirichletBCLBMDirichletBC object
- LBMEquilibriumCompute LB equilibrium distribution object.
- LBMFixedFirstOrderBCLBMFixedFirstOrderBC object
- LBMFixedZerothOrderBCLBMFixedZerothOrderBC object
- LBMForceDistributionCompute object for the force distribution function (source term) for phase field model..
- LBMIsotropicGradientCompute isotropic gradient object.
- LBMIsotropicLaplacianCompute isotropic Laplacian object.
- LBMMRTCollisionTemplate object for LBM collision dynamics
- LBMMicroscopicZeroGradientBCLBMMicroscopicZeroGradientBC object
- LBMNeumannBCLBMNeumannBC object
- LBMNonEquilibriumExtrapolationNon-equilibrium extrapolation boundary condition (Guo et al., 2002). Reconstructs the boundary distribution as f = feq(prescribed) + fneq(interior), where the missing moment is extrapolated from interior nodes. Density, velocity, and equilibrium are computed on-the-fly from the streamed population.
- LBMPhaseEquilibriumCompute LB equilibrium distribution object for phase field parameter.
- LBMPhaseFieldPressureCompute pressure for phase field model.
- LBMPressureCorrectedEquilibriumCompute object for correcting the equilibrium distribution function for phase field model.
- LBMSmagorinskyCollisionTemplate object for LBM collision dynamics
- LBMSmagorinskyMRTCollisionTemplate object for LBM collision dynamics
- LBMSpecularReflectionBoundaryLBM combination of bounce-back and specular reflection boundary condition. Uses a precomputed lookup table to determine specular reflection directions for each boundary node type in complex geometries (D2Q9 only).
- LBMStackTensorsStack given scalar tensor buffers and output vectorial tensor.
- LibtorchGibbsEnergyCalculates Gibbs energy, chemical potential, and driving force for order parameters using a Libtorch model.
- MacroscopicShearTensorDeGeus mechanics test material.
- MooseFunctionTensorMap a MooseFunction to a tensor.
- NEML2GradientVectorObject requires NEML2.
- NEML2TensorComputeThe
NEML2library is required but not enabled. Refer to the documentation for guidance on how to enable it. (Original description: Compute object wrapper for a NEML2 model) - ParsedComputeParsedCompute object.
- PhaseMechanicsTestDeGeus mechanics test material.
- RandomTensorUniform random IC with values between
minandmax. - RankTwoIdentityRank two identity tensor in real space.
- ReciprocalAllenCahnCalculates the Allen-Cahn bulk driving force masked using psi.
- ReciprocalLaplacianFactorReciprocal space Laplacian IC.
- ReciprocalLaplacianSquareFactorReciprocal space Laplacian squared IC.
- ReciprocalMatDiffusionCalculates the divergence of flux for a variable mobility in reciprocal space.
- SmoothRectangleComputeInterpolate a value between the inside and outside of a rectangle smoothly.
- SwiftHohenbergLinearReciprocal space linear term in the semi-implicit time integration of the Swift-Hohenberg equation IC.
- Marlin App
- AddTensorComputeActionAdd an TensorOperator object to the simulation.
- ComputeDisplacementsCompute updated displacements from the deformation gradient tensor.
- ComputeGroupGroup of operators with internal dependency resolution and optional JIT tracing support.
- ComputeVonMisesStressCompute vonMises stress.
- ConstantReciprocalTensorConstant tensor in reciprocal space.
- ConstantTensorConstant tensor in real space.
- DeAliasingTensorCreate a de-aliasing filter.
- FCCPFCLinearReciprocal space linear prefactor for the two-mode FCC phase-field crystal model.
- FCCPFCNonlinearReciprocal space nonlinear term for the two-mode FCC phase-field crystal model.
- FFTElasticChemicalPotentialFFT based elastic strain energy chemical potential solve.
- FFTGradientTensor gradient.
- FFTGradientSquareTensor gradient.
- FFTMechanicsdeGeus variational mechanics solve. Updates the coupled buffer holding the deformation gradient tensor.
- FFTQuasistaticElasticityFFT based monolithic homogeneous quasistatic elasticity solve.
- FiniteDifferenceLaplacianComputes the Laplacian using finite differences.
- ForwardFFTPerformFFT object.
- GradientVectorGradient of the coupled tensor buffer returned as a stacked torch tensor.
- HyperElasticIsotropicHyperelastic isotropic constitutive model.
- InverseFFTPerformFFT object.
- LBMAllenCahnSourceCompute Allen-Cahn source term for phase field model.
- LBMApplyForcesCompute object for LB forces
- LBMBGKCollisionTemplate object for LBM collision dynamics
- LBMBounceBackLBMBounceBack object
- LBMComputeChemicalPotentialCompute LB checmial potential for pahse field coupling.
- LBMComputeDensityCompute object for macroscopic density reconstruction.
- LBMComputeEffectiveRelaxationCompute local effective relaxation time matrix based on local pore size and Knudsen number.
- LBMComputeForcesCompute object for LB forces
- LBMComputeResidualCompute object for LBM residual.
- LBMComputeSurfaceForcesCompute object for LB surface forces
- LBMComputeVelocityCompute object for macroscopic velocity reconstruction.
- LBMComputeVelocityMagnitudeLBMComputeVelocityMagnitude object.
- LBMConstantTensorLBMConstantTensor object.
- LBMConvectiveOutflowConvective outflow boundary condition. Applies df/dt + U_c * df/dn = 0 at the boundary, discretized as f(x_b, t) = (f(x_b, t-1) + U_c * f(x_n, t)) / (1 + U_c). U_c can be a fixed value or computed automatically as the mean normal velocity at the boundary plane.
- LBMDirichletBCLBMDirichletBC object
- LBMEquilibriumCompute LB equilibrium distribution object.
- LBMFixedFirstOrderBCLBMFixedFirstOrderBC object
- LBMFixedZerothOrderBCLBMFixedZerothOrderBC object
- LBMForceDistributionCompute object for the force distribution function (source term) for phase field model..
- LBMIsotropicGradientCompute isotropic gradient object.
- LBMIsotropicLaplacianCompute isotropic Laplacian object.
- LBMMRTCollisionTemplate object for LBM collision dynamics
- LBMMicroscopicZeroGradientBCLBMMicroscopicZeroGradientBC object
- LBMNeumannBCLBMNeumannBC object
- LBMNonEquilibriumExtrapolationNon-equilibrium extrapolation boundary condition (Guo et al., 2002). Reconstructs the boundary distribution as f = feq(prescribed) + fneq(interior), where the missing moment is extrapolated from interior nodes. Density, velocity, and equilibrium are computed on-the-fly from the streamed population.
- LBMPhaseEquilibriumCompute LB equilibrium distribution object for phase field parameter.
- LBMPhaseFieldPressureCompute pressure for phase field model.
- LBMPressureCorrectedEquilibriumCompute object for correcting the equilibrium distribution function for phase field model.
- LBMSmagorinskyCollisionTemplate object for LBM collision dynamics
- LBMSmagorinskyMRTCollisionTemplate object for LBM collision dynamics
- LBMSpecularReflectionBoundaryLBM combination of bounce-back and specular reflection boundary condition. Uses a precomputed lookup table to determine specular reflection directions for each boundary node type in complex geometries (D2Q9 only).
- LBMStackTensorsStack given scalar tensor buffers and output vectorial tensor.
- LibtorchGibbsEnergyCalculates Gibbs energy, chemical potential, and driving force for order parameters using a Libtorch model.
- MacroscopicShearTensorDeGeus mechanics test material.
- MooseFunctionTensorMap a MooseFunction to a tensor.
- NEML2GradientVectorObject requires NEML2.
- NEML2TensorComputeThe
NEML2library is required but not enabled. Refer to the documentation for guidance on how to enable it. (Original description: Compute object wrapper for a NEML2 model) - ParsedComputeParsedCompute object.
- PhaseMechanicsTestDeGeus mechanics test material.
- RandomTensorUniform random IC with values between
minandmax. - RankTwoIdentityRank two identity tensor in real space.
- ReciprocalAllenCahnCalculates the Allen-Cahn bulk driving force masked using psi.
- ReciprocalLaplacianFactorReciprocal space Laplacian IC.
- ReciprocalLaplacianSquareFactorReciprocal space Laplacian squared IC.
- ReciprocalMatDiffusionCalculates the divergence of flux for a variable mobility in reciprocal space.
- SmoothRectangleComputeInterpolate a value between the inside and outside of a rectangle smoothly.
- SwiftHohenbergLinearReciprocal space linear term in the semi-implicit time integration of the Swift-Hohenberg equation IC.
- Marlin App
- AddTensorComputeActionAdd an TensorOperator object to the simulation.
- ComputeDisplacementsCompute updated displacements from the deformation gradient tensor.
- ComputeGroupGroup of operators with internal dependency resolution and optional JIT tracing support.
- ComputeVonMisesStressCompute vonMises stress.
- ConstantReciprocalTensorConstant tensor in reciprocal space.
- ConstantTensorConstant tensor in real space.
- DeAliasingTensorCreate a de-aliasing filter.
- FCCPFCLinearReciprocal space linear prefactor for the two-mode FCC phase-field crystal model.
- FCCPFCNonlinearReciprocal space nonlinear term for the two-mode FCC phase-field crystal model.
- FFTElasticChemicalPotentialFFT based elastic strain energy chemical potential solve.
- FFTGradientTensor gradient.
- FFTGradientSquareTensor gradient.
- FFTMechanicsdeGeus variational mechanics solve. Updates the coupled buffer holding the deformation gradient tensor.
- FFTQuasistaticElasticityFFT based monolithic homogeneous quasistatic elasticity solve.
- FiniteDifferenceLaplacianComputes the Laplacian using finite differences.
- ForwardFFTPerformFFT object.
- GradientVectorGradient of the coupled tensor buffer returned as a stacked torch tensor.
- HyperElasticIsotropicHyperelastic isotropic constitutive model.
- InverseFFTPerformFFT object.
- LBMAllenCahnSourceCompute Allen-Cahn source term for phase field model.
- LBMApplyForcesCompute object for LB forces
- LBMBGKCollisionTemplate object for LBM collision dynamics
- LBMBounceBackLBMBounceBack object
- LBMComputeChemicalPotentialCompute LB checmial potential for pahse field coupling.
- LBMComputeDensityCompute object for macroscopic density reconstruction.
- LBMComputeEffectiveRelaxationCompute local effective relaxation time matrix based on local pore size and Knudsen number.
- LBMComputeForcesCompute object for LB forces
- LBMComputeResidualCompute object for LBM residual.
- LBMComputeSurfaceForcesCompute object for LB surface forces
- LBMComputeVelocityCompute object for macroscopic velocity reconstruction.
- LBMComputeVelocityMagnitudeLBMComputeVelocityMagnitude object.
- LBMConstantTensorLBMConstantTensor object.
- LBMConvectiveOutflowConvective outflow boundary condition. Applies df/dt + U_c * df/dn = 0 at the boundary, discretized as f(x_b, t) = (f(x_b, t-1) + U_c * f(x_n, t)) / (1 + U_c). U_c can be a fixed value or computed automatically as the mean normal velocity at the boundary plane.
- LBMDirichletBCLBMDirichletBC object
- LBMEquilibriumCompute LB equilibrium distribution object.
- LBMFixedFirstOrderBCLBMFixedFirstOrderBC object
- LBMFixedZerothOrderBCLBMFixedZerothOrderBC object
- LBMForceDistributionCompute object for the force distribution function (source term) for phase field model..
- LBMIsotropicGradientCompute isotropic gradient object.
- LBMIsotropicLaplacianCompute isotropic Laplacian object.
- LBMMRTCollisionTemplate object for LBM collision dynamics
- LBMMicroscopicZeroGradientBCLBMMicroscopicZeroGradientBC object
- LBMNeumannBCLBMNeumannBC object
- LBMNonEquilibriumExtrapolationNon-equilibrium extrapolation boundary condition (Guo et al., 2002). Reconstructs the boundary distribution as f = feq(prescribed) + fneq(interior), where the missing moment is extrapolated from interior nodes. Density, velocity, and equilibrium are computed on-the-fly from the streamed population.
- LBMPhaseEquilibriumCompute LB equilibrium distribution object for phase field parameter.
- LBMPhaseFieldPressureCompute pressure for phase field model.
- LBMPressureCorrectedEquilibriumCompute object for correcting the equilibrium distribution function for phase field model.
- LBMSmagorinskyCollisionTemplate object for LBM collision dynamics
- LBMSmagorinskyMRTCollisionTemplate object for LBM collision dynamics
- LBMSpecularReflectionBoundaryLBM combination of bounce-back and specular reflection boundary condition. Uses a precomputed lookup table to determine specular reflection directions for each boundary node type in complex geometries (D2Q9 only).
- LBMStackTensorsStack given scalar tensor buffers and output vectorial tensor.
- LibtorchGibbsEnergyCalculates Gibbs energy, chemical potential, and driving force for order parameters using a Libtorch model.
- MacroscopicShearTensorDeGeus mechanics test material.
- MooseFunctionTensorMap a MooseFunction to a tensor.
- NEML2GradientVectorObject requires NEML2.
- NEML2TensorComputeThe
NEML2library is required but not enabled. Refer to the documentation for guidance on how to enable it. (Original description: Compute object wrapper for a NEML2 model) - ParsedComputeParsedCompute object.
- PhaseMechanicsTestDeGeus mechanics test material.
- RandomTensorUniform random IC with values between
minandmax. - RankTwoIdentityRank two identity tensor in real space.
- ReciprocalAllenCahnCalculates the Allen-Cahn bulk driving force masked using psi.
- ReciprocalLaplacianFactorReciprocal space Laplacian IC.
- ReciprocalLaplacianSquareFactorReciprocal space Laplacian squared IC.
- ReciprocalMatDiffusionCalculates the divergence of flux for a variable mobility in reciprocal space.
- SmoothRectangleComputeInterpolate a value between the inside and outside of a rectangle smoothly.
- SwiftHohenbergLinearReciprocal space linear term in the semi-implicit time integration of the Swift-Hohenberg equation IC.
- Marlin App
- AddTensorComputeActionAdd an TensorOperator object to the simulation.
- ComputeDisplacementsCompute updated displacements from the deformation gradient tensor.
- ComputeGroupGroup of operators with internal dependency resolution and optional JIT tracing support.
- ComputeVonMisesStressCompute vonMises stress.
- ConstantReciprocalTensorConstant tensor in reciprocal space.
- ConstantTensorConstant tensor in real space.
- DeAliasingTensorCreate a de-aliasing filter.
- FCCPFCLinearReciprocal space linear prefactor for the two-mode FCC phase-field crystal model.
- FCCPFCNonlinearReciprocal space nonlinear term for the two-mode FCC phase-field crystal model.
- FFTElasticChemicalPotentialFFT based elastic strain energy chemical potential solve.
- FFTGradientTensor gradient.
- FFTGradientSquareTensor gradient.
- FFTMechanicsdeGeus variational mechanics solve. Updates the coupled buffer holding the deformation gradient tensor.
- FFTQuasistaticElasticityFFT based monolithic homogeneous quasistatic elasticity solve.
- FiniteDifferenceLaplacianComputes the Laplacian using finite differences.
- ForwardFFTPerformFFT object.
- GradientVectorGradient of the coupled tensor buffer returned as a stacked torch tensor.
- HyperElasticIsotropicHyperelastic isotropic constitutive model.
- InverseFFTPerformFFT object.
- LBMAllenCahnSourceCompute Allen-Cahn source term for phase field model.
- LBMApplyForcesCompute object for LB forces
- LBMBGKCollisionTemplate object for LBM collision dynamics
- LBMBounceBackLBMBounceBack object
- LBMComputeChemicalPotentialCompute LB checmial potential for pahse field coupling.
- LBMComputeDensityCompute object for macroscopic density reconstruction.
- LBMComputeEffectiveRelaxationCompute local effective relaxation time matrix based on local pore size and Knudsen number.
- LBMComputeForcesCompute object for LB forces
- LBMComputeResidualCompute object for LBM residual.
- LBMComputeSurfaceForcesCompute object for LB surface forces
- LBMComputeVelocityCompute object for macroscopic velocity reconstruction.
- LBMComputeVelocityMagnitudeLBMComputeVelocityMagnitude object.
- LBMConstantTensorLBMConstantTensor object.
- LBMConvectiveOutflowConvective outflow boundary condition. Applies df/dt + U_c * df/dn = 0 at the boundary, discretized as f(x_b, t) = (f(x_b, t-1) + U_c * f(x_n, t)) / (1 + U_c). U_c can be a fixed value or computed automatically as the mean normal velocity at the boundary plane.
- LBMDirichletBCLBMDirichletBC object
- LBMEquilibriumCompute LB equilibrium distribution object.
- LBMFixedFirstOrderBCLBMFixedFirstOrderBC object
- LBMFixedZerothOrderBCLBMFixedZerothOrderBC object
- LBMForceDistributionCompute object for the force distribution function (source term) for phase field model..
- LBMIsotropicGradientCompute isotropic gradient object.
- LBMIsotropicLaplacianCompute isotropic Laplacian object.
- LBMMRTCollisionTemplate object for LBM collision dynamics
- LBMMicroscopicZeroGradientBCLBMMicroscopicZeroGradientBC object
- LBMNeumannBCLBMNeumannBC object
- LBMNonEquilibriumExtrapolationNon-equilibrium extrapolation boundary condition (Guo et al., 2002). Reconstructs the boundary distribution as f = feq(prescribed) + fneq(interior), where the missing moment is extrapolated from interior nodes. Density, velocity, and equilibrium are computed on-the-fly from the streamed population.
- LBMPhaseEquilibriumCompute LB equilibrium distribution object for phase field parameter.
- LBMPhaseFieldPressureCompute pressure for phase field model.
- LBMPressureCorrectedEquilibriumCompute object for correcting the equilibrium distribution function for phase field model.
- LBMSmagorinskyCollisionTemplate object for LBM collision dynamics
- LBMSmagorinskyMRTCollisionTemplate object for LBM collision dynamics
- LBMSpecularReflectionBoundaryLBM combination of bounce-back and specular reflection boundary condition. Uses a precomputed lookup table to determine specular reflection directions for each boundary node type in complex geometries (D2Q9 only).
- LBMStackTensorsStack given scalar tensor buffers and output vectorial tensor.
- LibtorchGibbsEnergyCalculates Gibbs energy, chemical potential, and driving force for order parameters using a Libtorch model.
- MacroscopicShearTensorDeGeus mechanics test material.
- MooseFunctionTensorMap a MooseFunction to a tensor.
- NEML2GradientVectorObject requires NEML2.
- NEML2TensorComputeThe
NEML2library is required but not enabled. Refer to the documentation for guidance on how to enable it. (Original description: Compute object wrapper for a NEML2 model) - ParsedComputeParsedCompute object.
- PhaseMechanicsTestDeGeus mechanics test material.
- RandomTensorUniform random IC with values between
minandmax. - RankTwoIdentityRank two identity tensor in real space.
- ReciprocalAllenCahnCalculates the Allen-Cahn bulk driving force masked using psi.
- ReciprocalLaplacianFactorReciprocal space Laplacian IC.
- ReciprocalLaplacianSquareFactorReciprocal space Laplacian squared IC.
- ReciprocalMatDiffusionCalculates the divergence of flux for a variable mobility in reciprocal space.
- SmoothRectangleComputeInterpolate a value between the inside and outside of a rectangle smoothly.
- SwiftHohenbergLinearReciprocal space linear term in the semi-implicit time integration of the Swift-Hohenberg equation IC.
- Marlin App
- AddTensorOutputActionAdd an TensorOutput object to the simulation.
- XDMFTensorOutputOutput a tensor in XDMF format.
- Marlin App
- CreateTensorSolverActionCreate a TensorSolver.
- AdamsBashforthMoultonAdams-Bashforth-Moulton semi-implicit/explicit time integration solver with optional implicit corrector.
- AdamsBashforthMoultonCoupledCoupled Adams-Bashforth-Moulton solver with dense linear operator and batched torch solve in reciprocal space.
- BroydenSolverImplicit secant solver time integration.
- ETDRK4SolverFourth-order exponential time differencing solver.
- ForwardEulerSolverSemi-implicit time integration solver.
- LBMStreamLBM Streaming operation.
- RealSpaceForwardEulerReal space forward Euler solver.
- SecantSolverImplicit secant solver time integration.
- SemiImplicitSolverAdams-Bashforth-Moulton semi-implicit/explicit time integration solver with optional implicit corrector.
- Predictors
- Marlin App
- AddTensorPredictorActionAdd an TensorPredictor object to the simulation.
- Marlin App
- ComputeGroupExecutionCountReturn the number of computeBuffer() calls issued to the given compute group object.
- ComputeReynoldsNumberCompute Reynolds number.
- ReciprocalIntegralExtract the zero k-vector value (corresponding to the integral).
- SemiImplicitCriticalTimeStepCompute the critical timestep given the reciprocal space representation of the linear operator in a semi-implicit time integrator.
- TensorAveragePostprocessorCompute the average value over a buffer.
- TensorExtremeValuePostprocessorFind extreme values in the Tensor buffer
- TensorIntegralChangePostprocessorCompute the integral over a buffer
- TensorIntegralPostprocessorCompute the integral over a buffer
- TensorInterfaceVelocityPostprocessorCompute the integral over a buffer
- Marlin App
- TensorHistogramCompute a histogram of the given tensor.