AdditiveFOAM Release v2.0.0

.clang-format

@@ -0,0 +1,66 @@
+---
+Language: Cpp
+BasedOnStyle: LLVM
+
+ColumnLimit: 80
+IndentWidth: 4
+ContinuationIndentWidth: 4
+TabWidth: 4
+UseTab: Never
+
+# OpenFOAM-style brace placement.
+BreakBeforeBraces: Custom
+BraceWrapping:
+  AfterClass: true
+  AfterControlStatement: Always
+  AfterEnum: true
+  AfterFunction: true
+  AfterNamespace: true
+  AfterStruct: true
+  AfterUnion: true
+  BeforeCatch: true
+  BeforeElse: true
+  SplitEmptyFunction: false
+  SplitEmptyRecord: false
+  SplitEmptyNamespace: false
+
+AllowShortBlocksOnASingleLine: Never
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortEnumsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: None
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLoopsOnASingleLine: false
+
+#   if (...), for (...), while (...), switch (...)
+# but:
+#   forAll(...), not forAll (...)
+SpaceBeforeParens: Custom
+SpaceBeforeParensOptions:
+  AfterControlStatements: true
+  AfterForeachMacros: false
+  AfterFunctionDeclarationName: false
+  AfterFunctionDefinitionName: false
+  AfterIfMacros: false
+  AfterOverloadedOperator: false
+  AfterPlacementOperator: false
+
+ForEachMacros:
+  - forAll
+  - forAllReverse
+  - forAllIter
+  - forAllConstIter
+  - forAllIters
+  - forAllConstIters
+
+DerivePointerAlignment: false
+PointerAlignment: Left
+ReferenceAlignment: Left
+
+SortIncludes:
+  Enabled: false
+ReflowComments: Never
+FixNamespaceComments: false
+
+BreakBeforeBinaryOperators: NonAssignment
+AlignOperands: AlignAfterOperator
+...

.github/workflows/CI.yml

@@ -21,21 +21,23 @@ jobs:
 
     runs-on: ubuntu-latest
     container:
-      image: docker.io/openfoam/openfoam10-paraview510
+      image: microfluidica/openfoam:13
       options: --user root
     steps:
       - name: Checkout AdditiveFOAM
         uses: actions/checkout@v2
       - name: Build AdditiveFOAM
         run: |
-          . /opt/openfoam10/etc/bashrc
+          . /opt/openfoam13/etc/bashrc || true
+          . ./etc/bashrc
+          test -n "$WM_PROJECT_DIR"
           ./Allwmake
       - name: Test AdditiveFOAM
         run: |
-          . /opt/openfoam10/etc/bashrc
+          . /opt/openfoam13/etc/bashrc || true
+          . ./etc/bashrc
           cp -r tutorials/AMB2018-02-B userCase
           cd userCase
-          # FIXME: use built-in "additiveFoam" smaller case when created
           blockMesh
           decomposePar
           mpirun -n 6 --oversubscribe --allow-run-as-root additiveFoam -parallel

.pre-commit-config.yaml

@@ -0,0 +1,66 @@
+minimum_pre_commit_version: "3.7.0"
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+        files: &openfoam_cpp_files '\.(C|H|I|cc|cpp|cxx|hh|hpp|hxx)$'
+        exclude: &openfoam_excludes '(^|/)(lnInclude|ThirdParty|platforms|build|processor[0-9]+|postProcessing)/'
+
+      - id: end-of-file-fixer
+        files: *openfoam_cpp_files
+        exclude: *openfoam_excludes
+
+      - id: mixed-line-ending
+        args: [--fix=lf]
+        files: *openfoam_cpp_files
+        exclude: *openfoam_excludes
+
+      - id: check-merge-conflict
+
+      - id: check-yaml
+
+  - repo: local
+    hooks:
+      - id: openfoam-no-tabs
+        name: "OpenFOAM style: no tabs"
+        language: pygrep
+        entry: '\t'
+        files: *openfoam_cpp_files
+        exclude: *openfoam_excludes
+
+      # [Manual]: Fixing long C++ lines usually requires judgment.
+      - id: openfoam-max-80-columns
+        name: "OpenFOAM style: max 80 characters"
+        language: pygrep
+        entry: '^.{81,}$'
+        files: *openfoam_cpp_files
+        exclude: *openfoam_excludes
+        stages: [manual]
+
+      - id: openfoam-space-after-control-keyword
+        name: "OpenFOAM style: use if (...), for (...), while (...), switch (...)"
+        language: pygrep
+        entry: '^(?!\s*#).*\b(if|for|while|switch)\('
+        files: *openfoam_cpp_files
+        exclude: *openfoam_excludes
+
+      - id: openfoam-forall-no-space
+        name: "OpenFOAM style: use forAll(...), not forAll (...)"
+        language: pygrep
+        entry: '\b(forAll|forAllReverse|forAllIter|forAllConstIter|forAllIters|forAllConstIters)\s+\('
+        files: *openfoam_cpp_files
+        exclude: *openfoam_excludes
+
+  # [Manual]: clang-format is useful as a helper, but it cannot exactly
+  # represent OpenFOAM stream/math/operator spacing conventions.
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v22.1.5
+    hooks:
+      - id: clang-format
+        name: "clang-format: approximate OpenFOAM style, requires manual changes"
+        args: [--style=file]
+        files: *openfoam_cpp_files
+        exclude: *openfoam_excludes
+        stages: [manual]

Allwmake

@@ -1,10 +1,29 @@
 #!/bin/sh
 cd ${0%/*} || exit 1    # Run from this directory
 
-# Parse arguments for library compilation
-. $WM_PROJECT_DIR/wmake/scripts/AllwmakeParseArguments
+# Source the AdditiveFOAM environment variables
+. "${0%/*}/etc/bashrc" || exit 1
 
+# Parse arguments for library/application compilation
+. $WM_PROJECT_DIR/wmake/scripts/AllwmakeParseArguments || exit 1
+
+#------------------------------------------------------------------------------
+# AdditiveFOAM build information
+
+GIT_DESCRIBE=$(git describe --tags --always 2>/dev/null) \
+    || GIT_DESCRIBE="undefined"
+
+GIT_SHA1=$(git rev-parse HEAD 2>/dev/null) \
+    || GIT_SHA1="undefined"
+
+export ADDITIVEFOAM_BUILD_FLAGS="\
+$ADDITIVEFOAM_BUILD_FLAGS \
+-DADDITIVEFOAM_GIT_DESCRIBE=\\\"$GIT_DESCRIBE\\\" \
+-DADDITIVEFOAM_GIT_SHA1=\\\"$GIT_SHA1\\\""
+
+#------------------------------------------------------------------------------
 # Compile AdditiveFOAM libraries and applications
+
 applications/Allwmake $targetType $*
 
 #------------------------------------------------------------------------------

README.md

@@ -12,22 +12,43 @@ The documentation for `AdditiveFOAM` is hosted on [GitHub Pages](https://ornl.gi
 | Link                                                | Description                              |
 |-----------------------------------------------------------|------------------------------------------|
 | [solver](applications/solvers/additiveFoam)               | Development version of the solver        |
-| [utilities](applications/utilities)                       | Utilities for post-processing and code wrappers |
 | [tutorials](tutorials)                                     | Tutorial cases |
 
-## Installation and Dependencies
-[![OpenFOAM-10](https://img.shields.io/badge/OpenFOAM-10-blue.svg)](https://github.com/OpenFOAM/OpenFOAM-10)
+## Installation
+[![OpenFOAM-13](https://img.shields.io/badge/OpenFOAM-13-blue.svg)](https://github.com/OpenFOAM/OpenFOAM-13)
 
-AdditiveFOAM is built on source code released by the OpenFOAM Foundation [openfoam.org](https://openfoam.org/), which is available in public [OpenFOAM repositories](https://github.com/OpenFOAM).
+AdditiveFOAM requires OpenFOAM-13 from the OpenFOAM Foundation. Install or
+build OpenFOAM-13 first, then source the OpenFOAM environment:
 
-[![Spack-Dev](https://img.shields.io/badge/Spack-Dev-blue.svg)](https://github.com/spack/spack)
+```sh
+source /path/to/OpenFOAM-13/etc/bashrc
+```
+
+Clone AdditiveFOAM, enter the repository, and source the AdditiveFOAM
+environment:
 
-The easiest way to install AdditiveFOAM is using [spack](https://spack.readthedocs.io/en/latest/):  
+```sh
+git clone https://github.com/ORNL/AdditiveFOAM.git
+cd AdditiveFOAM
+source etc/bashrc
 ```
-spack install additivefoam
+
+The AdditiveFOAM `etc/bashrc` checks that OpenFOAM-13 is active and sets the required paths.
+
+Build all AdditiveFOAM libraries, solvers, and utilities with the master build
+script from the repository root:
+
+```sh
+./Allwmake
 ```
 
-See the [installation instructions](https://ornl.github.io/AdditiveFOAM/docs/installation/#installation) in the [documentation](https://ornl.github.io/AdditiveFOAM/) for other options for building `AdditiveFOAM`.
+For regular use, source both environments in each new shell or add them to your
+shell startup file:
+
+```sh
+source /path/to/OpenFOAM-13/etc/bashrc
+source /path/to/AdditiveFOAM/etc/bashrc
+```
 
 ## Citing
 [![DOI](https://joss.theoj.org/papers/10.21105/joss.07770/status.svg)](https://doi.org/10.21105/joss.07770)

applications/solvers/additiveFoam/Allwclean

@@ -4,6 +4,7 @@ cd ${0%/*} || exit 1    # Run from this directory
 rm -rf Make/gitInfo.H
 
 wclean libso functionObjects
+wmake  libso utilities
 wclean libso movingHeatSource
 wclean
 

applications/solvers/additiveFoam/Allwmake

@@ -4,29 +4,8 @@ cd ${0%/*} || exit 1    # Run from this directory
 # Parse arguments for library compilation
 . $WM_PROJECT_DIR/wmake/scripts/AllwmakeParseArguments
 
-#------------------------------------------------------------------------------
-# Generate header for git information
-HEADER_FILE="${0%/*}/Make/gitInfo.H"
-GIT_DESCRIBE=$(git describe --tags --always 2>/dev/null) || GIT_DESCRIBE="undefined"
-GIT_SHA1=$(git rev-parse HEAD 2>/dev/null) || GIT_SHA1="undefined"
-
-cat > "$HEADER_FILE" << EOF
-#ifndef gitInfo_H
-#define gitInfo_H
-
-// Git describe
-#define ADDITIVEFOAM_GIT_DESCRIBE "$GIT_DESCRIBE"
-
-// Git hash
-#define ADDITIVEFOAM_GIT_SHA1 "$GIT_SHA1"
-
-#endif
-EOF
-
-export ADDITIVEFOAM_BUILD_FLAGS="-DGIT_MODULE_ENABLED=1"
-
-#------------------------------------------------------------------------------
 # Build libraries and solver
+wmake $targetType utilities
 wmake $targetType functionObjects
 wmake $targetType movingHeatSource
 wmake $targetType

applications/solvers/additiveFoam/Make/options

@@ -2,13 +2,15 @@ EXE_INC = \
     $(ADDITIVEFOAM_BUILD_FLAGS) \
     -I. \
     -ImovingHeatSource/lnInclude \
+    -Iutilities/lnInclude \
     -I$(LIB_SRC)/finiteVolume/lnInclude \
     -I$(LIB_SRC)/meshTools/lnInclude \
     -I$(LIB_SRC)/randomProcesses/lnInclude
 
 EXE_LIBS = \
     -L$(FOAM_USER_LIBBIN) \
     -lmovingBeamModels \
+    -ladditiveFoamUtilities \
     -lfiniteVolume \
     -lmeshTools \
     -lrandomProcesses