commit 777838bfc506fadd7e1d3c8631710e81a3f8493b
parent d00519f1bf8cb76d2049939cd64dc9c096dc8776
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Tue, 3 Mar 2026 11:01:51 +0100
Add the sgas-lint utility manual page
Diffstat:
4 files changed, 108 insertions(+), 4 deletions(-)
diff --git a/Makefile b/Makefile
@@ -135,6 +135,7 @@ install: library util pkg
install 755 "$(DESTDIR)$(BINPREFIX)" sgas-lint; \
install 644 "$(DESTDIR)$(LIBPREFIX)/pkgconfig" sgas.pc; \
install 644 "$(DESTDIR)$(INCPREFIX)/star" src/sgas.h; \
+ install 644 "$(DESTDIR)$(MANPREFIX)/man1" doc/sgas-lint.1; \
install 644 "$(DESTDIR)$(PREFIX)/share/doc/star-gas" COPYING README.md
uninstall:
@@ -142,9 +143,13 @@ uninstall:
rm -f "$(DESTDIR)$(BINPREFIX)/sgas-lint"
rm -f "$(DESTDIR)$(LIBPREFIX)/pkgconfig/sgas.pc"
rm -f "$(DESTDIR)$(INCPREFIX)/star/sgas.h"
+ rm -f "$(DESTDIR)$(MANPREFIX)/man1/sgas-lint.1"
rm -f "$(DESTDIR)$(PREFIX)/share/doc/star-gas/COPYING"
rm -f "$(DESTDIR)$(PREFIX)/share/doc/star-gas/README.md"
clean: clean_util
rm -f $(DEP) $(OBJ) $(LIBNAME)
rm -f .config libsgas.o sgas.pc sgas-local.pc
+
+lint:
+ mandoc -Tlint -Wwarning doc/sgas-lint.1
diff --git a/README.md b/README.md
@@ -7,6 +7,7 @@ Load and structure data that describe a gas.
- C compiler
- POSIX make
- pkg-config
+- mandoc
- ATRTP library (AsToRia: Thermodynamic Properties)
- Star Mesh library
- Star Unstructured Volumetric Mesh library
diff --git a/config.mk b/config.mk
@@ -1,5 +1,10 @@
VERSION = 0.0.0
+
PREFIX = /usr/local
+BINPREFIX = $(PREFIX)/bin
+LIBPREFIX = $(PREFIX)/lib
+INCPREFIX = $(PREFIX)/include
+MANPREFIX = $(PREFIX)/share/man
LIB_TYPE = SHARED
#LIB_TYPE = STATIC
@@ -7,10 +12,6 @@ LIB_TYPE = SHARED
BUILD_TYPE = RELEASE
#BUILD_TYPE = DEBUG
-BINPREFIX = $(PREFIX)/bin
-LIBPREFIX = $(PREFIX)/lib
-INCPREFIX = $(PREFIX)/include
-
################################################################################
# Tools
################################################################################
diff --git a/doc/sgas-lint.1 b/doc/sgas-lint.1
@@ -0,0 +1,97 @@
+.\" Copyright (C) 2025, 2026 |Méso|Star> (contact@meso-star.com)
+.\" Copyright (C) 2025, 2026 Université de Lorraine
+.\"
+.\" This program is free software: you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation, either version 3 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
+.Dd March 3, 2026
+.Dt SGAS-LINT 1
+.Os
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh NAME
+.Nm sgas-lint
+.Nd check gas data loading and structuring
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh SYNOPSIS
+.Nm
+.Op Fl hv
+.Fl m Ar mesh
+.Fl p Ar therm_props_list
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh DESCRIPTION
+.Nm
+loads the data that describe a gas and structures them to accelerate the
+spatio-temporal queries of its thermodynamic properties.
+In fact, it checks the behaviour of the Star-Gas library on which it
+relies, and in doing so checks that the loading and structuring of input
+data works as expected.
+.Pp
+Input data are the volumetric gas mesh and a set of time-variable
+thermodynamic properties.
+The geometry of the gas is therefore constant but its properties may
+vary over time.
+.Pp
+The options are as follow:
+.Bl -tag -width Ds
+.\""""""""""""""""""""""""""""""""""
+.It Fl h
+Display short help and exit.
+.\""""""""""""""""""""""""""""""""""
+.It Fl m Ar mesh
+Tetrahedral gas mesh in
+.Xr smsh 5
+format.
+.\""""""""""""""""""""""""""""""""""
+.It Fl p Ar therm_props_list
+File listing the evolution of thermodynamic properties over time.
+.Pp
+This is a simple text file where each line consists of two fields
+separated b at least on space.
+The first field is a real number representing the time at which the
+thermodynamic properties are defined, followed by the path to an
+.Xr atrtp 5
+file defining the values of these properties.
+.Pp
+Properties must be listed in chronological order.
+Empty lines are ignored, as are comments, i.e., text following
+the hash sign
+.Pq # .
+.Pp
+The path to an
+.Xr atrtp 5
+file is expanded and can therefore be
+composed of variables.
+.Pp
+Here is an example file:
+.Bd -literal -offset Ds
+37 "${DATA_PATH}/37.00/therm_props.atrtp"
+37.12 "${DATA_PATH}/37.12/therm_props.atrtp"
+37.24 "${DATA_PATH}/37.24/therm_props.atrtp"
+37.36 "${DATA_PATH}/37.36/therm_props.atrtp"
+.Ed
+.\""""""""""""""""""""""""""""""""""
+.It Fl v
+Make
+.Nm
+verbose.
+Multiple
+.Fl v
+options increase the verbosity.
+The maximum is 3.
+.El
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh EXIT
+.Ex -std
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh SEE ALSO
+.Xr atrtp 5 ,
+.Xr smsh 5
