How saeedvdi/golem works
Project type and purpose
• GOLEM is a C++ scientific simulation application built on the MOOSE framework. It models coupled Thermo-Hydro-Mechanical (THM) processes in faulted geothermal reservoirs.
• Key indicators:
• “A MOOSE-based application” (README header)
• src/ and include/ hold kernels, boundary conditions (BCs), userobjects, etc.
• Examples/ and test/ directories for input files (.i, .geo, .msh) and regression tests.
File structure
• Top-level:
• /: header files organized by component (actions, auxkernels, bcs, controls, dirackernels, functions, kernels, materials, userobjects, utils)
• src/: implementation files in the same sub‐folders as include/ plus main.C
• test/: integration/regression tests (input decks and gold outputs)
• unit/: example unit tests with a minimal test harness
• Examples/: sample input files and meshes
• doc/: documentation content for static site generation via moosedocs.py and configuration
• scripts/: helper scripts (e.g., install format hook)
• Makefile and run_tests: build and test orchestrator
• Architectural patterns:
• Plugin/Factory pattern: MOOSE ObjectFactory registers and instantiates Kernels, BCs, Materials, UserObjects, AuxKernels, Actions, Controls, DiracKernels.
• Monolithic executable (“golem-opt”) that links MOOSE core libs with GOLEM modules.
• Parallel processing via MPI (mpiexec -n <nprocs>).
README for additional insights
• Reinforces that GOLEM extends MOOSE, requires a MOOSE installation.
• Usage: CLI → mpiexec → golem-opt with an input file.
• Testing: run_tests script orchestrates the test folder.
Elements
• GOLEM modules in another (blue)
• External libraries/solvers in a third (green)