Initialize System

Example Input File Syntax

Available Objects

• Marlin App
• 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 = f^{eq(prescribed) + f}neq(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 NEML2 library 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 min and max.
• 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.

Available Actions

• Marlin App
• AddTensorComputeActionAdd an TensorOperator object to the simulation.