commit d70c9b9eed54cd64faf03fdcfcf77c0d8ef4eb6d
parent 7ee43354e172ff6e2fbb561bb66bf994aac2caec
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 11 Jan 2023 14:00:13 +0100
Update command brief help
Diffstat:
3 files changed, 82 insertions(+), 108 deletions(-)
diff --git a/src/atmosphere/htrdr_atmosphere_args.c b/src/atmosphere/htrdr_atmosphere_args.c
@@ -32,85 +32,75 @@ static void
print_help(const char* cmd)
{
ASSERT(cmd);
- printf("Usage: %s [<opions>] -a GAS\n", cmd);
+ printf("Usage: %s [option] ... -a gas\n", cmd);
printf(
-"Render an image or compute a flux map in both the longwave and\n"
-"shortwave domains, for scenes with a cloudy atmosphere and a ground\n"
-"geometry.\n\n");
+"Simulate radiative transfer in a plane-parallel atmosphere.\n"
+"See htrdr-atmosphere(1) man page for details\n\n");
printf(
-" -a GAS filename of the gas optical properties.\n");
+" -a gas filename of the gas optical properties\n");
printf(
-" -C <perspective-camera>\n"
-" define the perspective camera. Refer to the man page\n"
-" for the list of camera options.\n");
+" -C camera configure a perspective camera\n");
printf(
-" -c CLOUDS filename of the clouds properties.\n");
+" -c clouds filename of the clouds properties\n");
printf(
-" -D AZIMUTH,ELEVATION\n"
+" -D azimuth,elevation\n"
" direction in degrees toward the sun center. By default\n"
-" AZIMUTH is %g and ELEVATION is %g.\n",
+" azimuth is %g and elevation is %g\n",
HTRDR_ATMOSPHERE_ARGS_DEFAULT.sun_azimuth,
HTRDR_ATMOSPHERE_ARGS_DEFAULT.sun_elevation);
printf(
-" -d dump volumetric acceleration structures to OUTPUT\n"
-" and exit.\n");
+" -d dump volumetric acceleration structures to output\n"
+" and exit\n");
printf(
-" -f overwrite the OUTPUT file if it already exists.\n");
+" -f overwrite the output file if it already exists\n");
printf(
-" -g GROUND filename of the ground geometry.\n");
+" -g ground filename of the ground geometry\n");
printf(
-" -h display this help and exit.\n");
+" -h display this help and exit\n");
printf(
-" -i <image> define the image to compute. Refer to the man\n"
-" page for the list of image options\n");
+" -i image image to compute\n");
printf(
-" -M MATERIALS filename of the ground materials.\n");
+" -M materials filename of the ground materials\n");
printf(
-" -m MIE filename of the Mie's data.\n");
+" -m mie filename of the Mie's data\n");
printf(
-" -n SKY-NAME name used to identify the sky in the MATERIALS file.\n"
-" Its default value is `%s'.\n",
+" -n sky-name name used to identify the sky in the materials file.\n"
+" Its default value is `%s'\n",
HTRDR_ATMOSPHERE_ARGS_DEFAULT.sky_mtl_name);
printf(
-" -O CACHE filenaname of the cache file used to store/restore the\n"
-" volumetric data. By default do not use any cache.\n");
+" -O cache filenaname of the cache file used to store/restore the\n"
+" volumetric data. By default do not use any cache\n");
printf(
-" -o OUTPUT file where data are written. If not defined, data are\n"
-" written to standard output.\n");
+" -o output file where data are written. If not defined, data are\n"
+" written to standard output\n");
printf(
-" -p <rectangle> switch in flux computation by defining the rectangular\n"
-" sensor onto which the flux is computed. Refer to the\n"
-" man page for the list of rectangle options.\n");
+" -p rectangle switch in flux computation by defining the rectangular\n"
+" sensor onto which the flux is computed\n");
printf(
-" -P <orthoraphic-camera>\n"
-" define the orthoraphic camera. Refer to the man page\n"
-" for the list of orthographic camera options.\n");
+" -P camera configure an orthoraphic camera\n");
printf(
-" -R infinitely repeat the ground along the X and Y axis.\n");
+" -R infinitely repeat the ground along the X and Y axis\n");
printf(
-" -r infinitely repeat the clouds along the X and Y axis.\n");
+" -r infinitely repeat the clouds along the X and Y axis\n");
printf(
-" -s <spectral> define the type and range of the spectral\n"
-" integration. Refer to the man page for the list\n"
-" of spectral options\n");
+" -s spectral define the spectral doamin of integration\n");
printf(
-" -T THRESHOLD optical thickness used as threshold during the\n"
-" building of the volumetric acceleration structure.\n"
-" By default its value is `%g'.\n",
+" -T optical_thickness\n"
+" optical thickness criteria for octree building.\n"
+" Default is %g\n",
HTRDR_ATMOSPHERE_ARGS_DEFAULT.optical_thickness);
printf(
-" -t THREADS hint on the number of threads to use. By default use\n"
-" as many threads as CPU cores.\n");
+" -t threads hint on the number of threads to use.\n"
+" Default assumes as many threads as CPU cores\n");
printf(
-" -V X,Y,Z maximum definition along the 3 axis of the 3D\n"
-" volumetric majorant field to partition. By default use\n"
-" the definition of the clouds data.\n");
+" -V octree_definition\n"
+" advice on the definition of the atmospheric\n"
+" acceleration structures. By default use\n"
+" the definition of the clouds data\n");
printf(
-" -v make the command verbose.\n");
+" -v make the command verbose\n");
printf("\n");
-
- htrdr_fprint_copyright(cmd, stdout);
htrdr_fprint_license(cmd, stdout);
}
@@ -311,4 +301,3 @@ htrdr_atmosphere_args_release(struct htrdr_atmosphere_args* args)
ASSERT(args);
*args = HTRDR_ATMOSPHERE_ARGS_DEFAULT;
}
-
diff --git a/src/combustion/htrdr_combustion_args.c b/src/combustion/htrdr_combustion_args.c
@@ -36,98 +36,81 @@ print_help(const char* cmd)
{
ASSERT(cmd);
printf(
-"Usage: %s [<options>] -m TETRAHEDRA -p THERMOPROPS -r REFRACT_IDS\n",
+"Usage: %s [option] ... -m mesh -p props -r refids\n",
cmd);
printf(
-"Render a monochromatic image within a sooting flame described according\n"
-"to the RDG-FA theory and lightened by a laser source.\n\n");
+"Simulate radiative transfer within a sooting flame.\n"
+"See htrdr-combustion(1) man page for details\n\n");
printf(
-" -C <perspective-camera>\n"
-" define the perspective camera. Refer to the man page\n"
-" for the list of camera options.\n");
+" -C camera configure a perspective camera\n");
printf(
-" -D FLUX_DENSITY\n"
-" flux density of the laser in W/m^2\n"
-" (default: %g W/m^2).\n",
+" -D flux_density\n"
+" flux density of the laser in W/m²\n"
+" (default: %g W/m²)\n",
HTRDR_COMBUSTION_ARGS_DEFAULT.laser_flux_density);
printf(
" -d <laser|octree>\n"
" output geometry of the laser sheet or the volumetric\n"
-" acceleration structure and exit.\n");
+" acceleration structure and exit\n");
printf(
-" -F <fractal-coefs>\n"
+" -F fractal-coefs\n"
" value of the fractal dimension and fractal prefactor\n"
-" to use in the RDG-FA model. Refer to the man page\n"
-" for the syntax of the <fractal-coefs> option\n"
-" (default fractal prefactor = %g;\n"
-" default fractal dimension = %g).\n",
- HTRDR_COMBUSTION_ARGS_DEFAULT.fractal_prefactor,
- HTRDR_COMBUSTION_ARGS_DEFAULT.fractal_dimension);
+" to use in the RDG-FA model\n");
printf(
-" -f overwrite the OUTPUT file if it already exists.\n");
+" -f force overwrite the output file\n");
printf(
-" -g <geometry> define the combustion chamber geometry. Refer to the\n"
-" man page for the list of geometry options.\n");
+" -g geometry define the combustion chamber geometry\n");
printf(
-" -h display this help and exit.\n");
+" -h display this help and exit\n");
printf(
-" -I use an isotropic phase function rather than the RDG-FA.\n");
+" -I use an isotropic phase function rather than the RDG-FA\n");
printf(
-" -i <image> define the image to compute. Refer to the man\n"
-" page for the list of image options.\n");
+" -i image image to compute\n");
printf(
-" -l <laser> define the geometry of the laser sheet. Refer to the\n"
-" man page for the list of laser options.\n");
+" -l laser configure the geometry of the laser sheet\n");
printf(
-" -R <rectangle> switch in flux computation bu defining the\n"
-" rectangular sensor onto which the flux is computed.\n"
-" Refer to the man page for the list of rectangle\n"
-" options.\n");
+" -R rectangle switch in flux computation bu defining the\n"
+" rectangular sensor onto which the flux is computed\n");
printf(
-" -m TETRAHEDRA path toward the volumetric mesh.\n");
+" -m mesh path toward the volumetric mesh\n");
printf(
-" -N precompute the tetrahedra normals.\n");
+" -N precompute tetrahedron normals\n");
printf(
-" -O CACHE path of the cache file used to store/restore the\n"
-" volumetric data. By default do not use any cache.\n");
+" -O cache path of the cache file used to store/restore the\n"
+" volumetric data\n");
printf(
-" -o OUTPUT file where data are written\n"
-" (default: write data to standard output).\n");
+" -o output file where data are written.\n"
+" (default: write data to standard output)\n");
printf(
-" -p THERMOPROPS path toward the thermodynamic properties.\n");
+" -p props path toward the thermodynamic properties\n");
printf(
-" -P <orthoraphic-camera>\n"
-" define the orthoraphic camera. Refer to the man page\n"
-" for the list of orthographic camera options.\n");
+" -P camera configure an orthoraphic camera\n");
printf(
-" -r REFRACT_ID path toward the per wavelength refractive\n"
-" indices.\n");
+" -r refids path toward the per wavelength refractive\n"
+" indices\n");
printf(
-" -s use of the SIMD instruction set if available.\n");
+" -s use of the SIMD instruction set if available\n");
printf(
-" -T THRESHOLD optical thickness used as threshold during the octree\n"
-" building. (default: %g).\n",
+" -T threshold optical thickness used as threshold during the octree\n"
+" building (default: %g)\n",
HTRDR_COMBUSTION_ARGS_DEFAULT.optical_thickness);
printf(
-" -t NTHREADS hint on the number of threads to use. By default use\n"
-" as many threads as CPU cores.\n");
+" -t threads hint on the number of threads to use.\n"
+" Default assumes as many threads as CPU cores\n");
printf(
-" -V <HINT|X,Y,Z>\n"
+" -V octree_definition\n"
" definition of the volumetric acceleration grids along\n"
" the 3 axis. By default it is computed automatically\n"
-" with a hint on the expected definition set to %u.\n",
+" with a hint on the expected definition set to %u\n",
HTRDR_COMBUSTION_ARGS_DEFAULT.grid.definition.hint);
printf(
" -v make the command verbose.\n");
printf(
" -w WAVELENGTH wavelength definition of the laser in nanometre.\n"
-" (default: %g).\n",
+" (default: %g)\n",
HTRDR_COMBUSTION_ARGS_DEFAULT.wavelength);
-
printf("\n");
-
- htrdr_fprint_copyright(cmd, stdout);
htrdr_fprint_license(cmd, stdout);
}
diff --git a/src/commands/htrdr_cmd.c b/src/commands/htrdr_cmd.c
@@ -42,7 +42,7 @@ static void
print_usage(const char* cmd)
{
ASSERT(cmd);
- printf("Usage: %s [-v] [-h] <mode> [<args>]\n", cmd);
+ printf("Usage: %s [-v] [-h] <mode> [option] ...\n", cmd);
}
static void
@@ -51,22 +51,24 @@ print_help(const char* cmd)
ASSERT(cmd);
print_usage(cmd);
+ printf("Simulate radiative transfer.\n");
+ printf("See htrdr(1) man page for details\n");
printf("\n");
printf(
-" -h display this help and exit.\n");
+" -h display this help and exit\n");
printf(
-" -v display version information and exit.\n");
+" -v display version information and exit\n");
printf("\n");
printf("These are %s modes:\n", cmd);
printf("\n");
printf(
-" atmosphere Radiative transfer computations in a cloudy atmosphere.\n");
+" atmosphere Radiative transfer in a plane-parallel atmosphere\n");
printf(
-" combustion Radiative transfer computations in a combustion medium.\n");
+" combustion Radiative transfer within a sooting flame\n");
printf(
-" planeto Radiative transfer computations in a 3D planetory atmosphere.\n");
+" planeto Radiative transfer in a 3D planetory atmosphere\n");
printf("\n");
htrdr_fprint_license(cmd, stdout);
