How foamscience/blastamr works
Project type and purpose
• This is a C++ library/module for OpenFOAM providing load-balanced adaptive mesh refinement (AMR) on polyhedral meshes, extracted from blastFoam.
• It supplies new dynamic-mesh and error-estimator components, solvers, utilities, test cases, and tutorials to integrate with an existing OpenFOAM installation.
File structure
• Top-level directories:
• applications/solvers – custom solvers (e.g., reactingDyMFoam) that link against the AMR library.
• applications/utilities – helper utilities (e.g., reconstructParMesh, updateMesh).
• src – core library modules, organized into subfolders:
– dynamicFvMesh, dynamicMesh (mesh adaptation & balancing)
– errorEstimators (various refinement criteria)
• etc – code templates for dynamic code generation (e.g., codedErrorEstimatorTemplate).
• tests – unit/integration tests for mesh adaptivity components and sample test‐cases.
• tutorials – end-to-end OpenFOAM case setups demonstrating usage.
• Build files: Allwmake, per‐module Make directories with files and options for OpenFOAM’s build system.
README for additional insights
• Describes library purpose: load-balanced AMR integration into ESI (openfoam.com) builds.
• Highlights supported features (2D/3D, polyhedral meshes), unimplemented features (particle cloud balancing), and build process via $FOAM_USER_LIBBIN.
a. Main components
• OpenFOAM Core (external dependency)
• blastAMR Library
– Dynamic Mesh Manager
· Mesh Refiner & Balancer
· Location Mapper & Mesh Tools
– Error Estimator Suite
· Coded, gradient, delta, etc. selectors
– Code-generation Templates (dynamicCode)
• Applications
– Custom Solvers (link to blastAMR + OpenFOAM)
– Utilities (mesh reconstruction/update)
• Test Harness (foamUT)
• Tutorials (case directories, driven by shell scripts Allrun)
b. Relationships & data flow
• Solvers invoke Dynamic Mesh Manager at runtime to refine/coarsen mesh based on error estimators.
• Error Estimators feed refinement criteria into Mesh Refiner.
• Code-generation templates produce custom estimator code compiled into the AMR library.
• Utilities can be run pre-/post-simulation to manipulate partitioned mesh.
• Build system (Allwmake + Makefiles) compiles src into shared libs under $FOAM_USER_LIBBIN, then links into applications.
• Tests & tutorials consume the library and validate behavior.
c. Architectural patterns & design principles
• Modular C++ library pattern: each capability (mesh adaptivity, error estimation, utilities, solvers) in its own namespace/folder.
• Plugin pattern via Make/options templates—OpenFOAM style dynamic loading of new solvers/utilities.
• Separation of concerns: Static code generation (etc), core refinement logic (src), user-facing applications (applications).
• Test-driven development: dedicated tests folder exercising individual modules.
d. Key technologies & frameworks
• C++17 (or as required by OpenFOAM version)
• OpenFOAM build system (Allwmake, custom Make/options files)
• foamUT testing framework
• GitHub Actions for CI (of2006, of2206, of2212 workflows)
Final advice
• Every folder’s role: Modules (src), user‐facing binaries (applications), support scripts (etc), validation layers (tests, tutorials).
• Keep labels concise but precise; avoid listing every file—group by functionality.
• Data/control flow at runtime (mesh → estimator → refiner → updated mesh) and build‐time dependencies.