FAST.Farm slice output (terrain following, and arbitrary slice)

.gitignore

@@ -64,3 +64,8 @@ varcache
 # Python cache files
 openfast_io/dist/
 openfast_io/openfast_io/_version.py
+
+# docker with VScode config
+*.code-workspace
+docker-compose.yml
+.devcontainer/

CMakeLists.txt

@@ -43,6 +43,7 @@ option(USE_DLL_INTERFACE "Enable runtime loading of dynamic libraries" on)
 option(FPE_TRAP_ENABLED "Enable FPE trap in compiler options" off)
 option(WIN_DLL_LOAD "Enable loading of Windows only DLL's (OrcaFlex, SoilDyn)" on)  # This is mostly for testing purposes
 option(BUILD_FASTFARM "Enable building FAST.Farm" off)
+option(FASTFARM_TIMING_PRINTS "Enable FAST.Farm timing instrumentation and summary output" off)
 option(BUILD_OPENFAST_CPP_API "Enable building OpenFAST - C++ API" off)
 option(BUILD_OPENFAST_CPP_DRIVER "Enable building OpenFAST C++ driver using C++ CFD API" off)
 option(BUILD_OPENFAST_LIB_DRIVER "Enable building OpenFAST driver using C++ Library API" off)

cmake/GetGitRevisionDescription.cmake

@@ -116,7 +116,37 @@ function(git_describe _var)
 		ERROR_QUIET
 		OUTPUT_STRIP_TRAILING_WHITESPACE)
 	if(NOT res EQUAL 0)
-		set(out "${out}-${res}-NOTFOUND")
+		# git describe failed (e.g. shallow clone with no reachable tags).
+		# Fall back to the short commit hash.
+		execute_process(COMMAND
+			"${GIT_EXECUTABLE}"
+			rev-parse --short=8 HEAD
+			WORKING_DIRECTORY
+			"${CMAKE_CURRENT_SOURCE_DIR}"
+			RESULT_VARIABLE
+			res_hash
+			OUTPUT_VARIABLE
+			out_hash
+			ERROR_QUIET
+			OUTPUT_STRIP_TRAILING_WHITESPACE)
+		if(res_hash EQUAL 0)
+			# Check for dirty working tree
+			execute_process(COMMAND
+				"${GIT_EXECUTABLE}"
+				diff-index --quiet HEAD --
+				WORKING_DIRECTORY
+				"${CMAKE_CURRENT_SOURCE_DIR}"
+				RESULT_VARIABLE
+				res_dirty
+				ERROR_QUIET)
+			if(res_dirty EQUAL 0)
+				set(out "${out_hash}")
+			else()
+				set(out "${out_hash}-dirty")
+			endif()
+		else()
+			set(out "${out}-${res}-NOTFOUND")
+		endif()
 	endif()
 
 	set(${_var} "${out}" PARENT_SCOPE)

docs/source/user/aerodyn-olaf/InputFiles.rst

@@ -312,6 +312,59 @@ of a box of shape 5x20x30 and dimension 1200x300x295.  The grid contains both th
 The two other grids are vertical and horizontal planes containing only the velocity.
 
 
+Non-equidistant grid points
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+By default, grid points along each axis (X, Y, Z) are equidistant, defined by
+the ``Start``, ``End``, and ``n`` columns of the grid output table.
+
+Alternatively, a ``Start`` cell can be given as a quoted filename instead of a
+number. In that case, the corresponding axis uses an explicit, user-defined
+list of coordinates read from that file, and the ``End``/``n`` columns for
+that axis are ignored.
+
+This choice is made independently for each axis, so a single grid can mix
+equidistant and list-defined axes (e.g., equidistant in X and Z, list-defined
+in Y), and a filename can be given for ``XStart``, ``YStart``, ``ZStart``, or
+any combination of the three.
+
+The referenced file must:
+
+- contain exactly one coordinate value per line,
+- list values in strictly ascending order (no duplicates),
+- contain no comments or blank lines,
+- be located in the same directory as the main OLAF input file.
+
+Example, requesting a non-equidistant Y-axis::
+
+    GridName  GridType  TStart  TEnd     DTOut     XStart    XEnd   nX      YStart     YEnd    nY   ZStart   ZEnd   nZ
+    (-)         (-)      (s)     (s)      (s)        (m)      (m)   (-)       (m)       (m)   (-)    (m)      (m)  (-)
+    "Yline"      1     default default  default      90       90     1   "Ypoints.dat"   -     -     100      100   1
+
+with ``Ypoints.dat`` (located next to the OLAF input file) containing::
+
+    -125
+    -100
+    -75
+    -50
+    -37.5
+    -25
+    -12.5
+     0
+     12.5
+     25
+     37.5
+     50
+     75
+     100
+     125
+
+.. note::
+   Vorticity output (``GridType=2``) requires equidistant spacing
+   and is not available for a grid that uses a list-defined axis.
+   Use ``GridType=1`` (velocity only) for such grids.
+
+
 Advanced Options
 ~~~~~~~~~~~~~~~~
 

docs/source/user/api_change.rst

@@ -9,6 +9,31 @@ The changes are tabulated according to the module input file, line number, and f
 The line number corresponds to the resulting line number after all changes are implemented.
 Thus, be sure to implement each in order so that subsequent line numbers are correct.
 
+OpenFAST v5.0.x to next release
+-------------------------------
+
+Two new optional VISUALIZATION sub-sections were added to the FAST.Farm
+primary input file to give users finer control over what gets written
+as VTK output.  Legacy decks that do not include either block continue
+to work unchanged.
+
+The first block, ``--- AXIS-ALIGNED PLANE SLICES (extent-controlled) ---``,
+lets the user specify axis-aligned uniform-grid slices with explicit
+2-D extents anywhere in the low-resolution domain (Feature 2, plan
+§3). Output is XML VTK ``.vts`` + ``.vts.series``. The block header
+is optional and, when present, sits between the existing VISUALIZATION
+block and the OUTPUT block.
+
+The second block, ``--- TERRAIN-FOLLOWING SAMPLING ---``, lets the user
+emit point clouds sampled from STL surfaces or plain-text/CSV files,
+lifted to one or more offset sheets along either an explicit normal
+or the STL per-facet normal (Feature 3, plan §2). Output is XML VTK
+``.vtp`` + ``.vtp.series``.
+
+See :numref:`FF:Input:PlaneSlices` and :numref:`FF:Input:TerrainSlices`
+for the full grammar, and :numref:`FF:sec:SliceOutputs` for guidance
+on which slice path to pick.
+
 OpenFAST v4.2.x to OpenFAST  v5.0.0
 -----------------------------------
 

docs/source/user/fast.farm/FutureWork.rst

@@ -116,3 +116,12 @@ releases:
 -  Adopt the capability to support undersea marine turbine arrays (which
    may require supporting direct feedthrough of input to output to
    handle the added-mass effects).
+
+-  Extend the terrain-following sampling
+   (:numref:`FF:Input:TerrainSlices`) to also accept arbitrary
+   non-axis-aligned planar samples. Today the extent-controlled plane
+   slice feature (:numref:`FF:Input:PlaneSlices`) only accepts the
+   keywords ``XY``, ``YZ``, and ``XZ`` with a
+   fatal init error for any other value. See GitHub
+   issue `#2383 <https://github.com/OpenFAST/openfast/issues/2383>`__
+   for the motivating discussion and one proposed grammar.