Examples & Tutorials

Framework Workshops

The MOOSE development team at INL occasionally hosts live training. Registration is typically open for all who wish to attend, although space is usually limited. Below is a recording of a MOOSE training webinar given in Summer 2020, as well as links to the training presentation and other targeted, advanced workshop presentations.

• MOOSE Training Workshop

• MOOSE MultiApps Workshop

• MOOSE Verification Workshop

MOOSE training events will typically be announced on the home page, but be sure to join the mailing list for further updates!

Framework Examples

The MOOSE repository has a directory named examples with several subdirectories. Each subdirectory has code for a MOOSE-based application and input file(s) for running simulations. Each example can be used by running a binary that is first compiled by running make in the applicable subdirectory. The resulting application binary (named e.g. ex01-opt) is used to run input files. A guide explaining what each example demonstrates and how to use it is provided here:

• Example 1: As Simple As It Gets

• Example 2: Adding a Custom Kernel

• Example 3: Multiphysics Coupling

• Example 4: Custom Boundary Conditions

• Example 5: Automatic Mesh Adaptivity

• Example 6: Transient Analysis

• Example 7: Custom Initial Conditions

• Example 8: Material Properties

• Example 9: Stateful Materials Properties

• Example 10: Auxiliary Variables

• Example 11: Preconditioning

• Example 12: Physics Based Preconditioning

• Example 13: Custom Functions

• Example 14: Postprocessors and Code Verification

• Example 15: Custom Actions

• Example 16: Creating a Custom Timestepper

• Example 17: Adding a Dirac Kernel

• Example 18: ODE Coupling

• Example 19: Newton Damping

• Example 20: UserObjects

• Example 21: Debugging

Guided Framework Tutorials

Beyond individual examples, there are also general, guided tutorials that showcase application development, the MOOSE MultiApp system, and verification of calculated solutions.

• Tutorial 1: Application Development - Learn how to develop a MOOSE-based application to solve coupled systems of differential equations in a multiphysics setting. This tutorial teaches you how to create custom MOOSE objects, setup input files to invoke these objects, and how to process and visualize the results of your simulations.

• Tutorial 2: MultiApp Demonstration - Learn how to use the Multiapp and Transfer systems to couple many multiphysics applications together across differing time or length scales.

• Tutorial 3: Code Verification - Demonstrates the use of analytical solutions and the MMS for code verification.

• Tutorial 4: MOOSE Meshing - Demonstrates MOOSE meshing with the Reactor module meshing tools.

Physics Module Examples and Tutorials

The Physics Modules provide models based on the MOOSE framework for a variety of physical phenomena. These modules provide capabilities that can either be used by themselves, or serve as the basis for application-specific models tailored to specific problems. Example problems and tutorials are available for some of the individual physics modules as listed below.

• Combined (coupling models from multiple modules)

• Contact

• Geochemistry

• Heat Conduction

• Level Set

• Porous Flow

• Reconstructed Dicontinuous Galerkin

• Stochastic Tools

• Tensor Mechanics

C++ Programming References

MOOSE developers need only a basic understanding of computer programming with C++ to get started. If possible, it may be helpful to review the following resources:

• C++ Fundamentals

• cplusplus.com/doc/tutorial

• en.cppreference.com

• w3schools.com/cpp/default.asp

• geeksforgeeks.org/c-plus-plus

• Bjarne Stroustrup (2013). The C++ Programming Language, 4th Edition.

• Brian Kernighan & Dennis Ritchie (1988). The C Programming Language, 2nd Edition.

Besides checking out the references that are listed above, a strong and clear Google search can go a long way. Remember that you can always find help from our Community.