gfs2oogl(1)

πŸ’– gfs2oogl β€” the user-commands era of the manual pages, bestie πŸ’–

okay so before we even get into it: this is a page from section 1 of the manual (gfs2oogl(1)), which is the "User Commands" corner of the manpage universe. it's a classic, it's lowkey iconic, and we're gonna go through it together. no cap. πŸŽ€


✨ NAME ✨

so there's actually two whole commands living in here and they're besties:

  • gfs2oogl2D
  • gfs2oogl3D

and what they do is convert a Gerris simulation file into other (graphical) formats. that's the whole vibe. it's giving "your simulation data but make it pretty." πŸ’…


🌈 SYNOPSIS 🌈

here's the shape of it, exactly as written, no edits:

gfs2oogl [OPTION]<GFS_FILE

so like… you pipe a GFS_FILE in on stdin, and you hand it [OPTION]s. that's the whole deal. πŸ¦‹


🫢 DESCRIPTION 🫢

this manual page documents briefly the gfs2oogl command. and honestly? yeah. briefly. we're keeping it brief but we're keeping it real. 😌


πŸŽ€ OPTIONS πŸŽ€

these programs follow the usual GNU command line syntax, with long options starting with two dashes (`-`). a summary of options is included below.

okay so here's every single one, no skipping, no summarizing, we don't do that here πŸ’–

  • -u V, --iso=V β€” outputs a GTS file isosurface for value V. heads up bestie, the variable needs to be specified using -c. πŸ“Œ
  • -f D, --stream=D β€” draws evenly-spaced streamlines, where D is the spacing.
  • -I M, --dmin=M β€” controls the length of the evenly-spaced streamlines. default is 0.5.
  • -O M, --maxcost=M β€” controls compression of streamlines. default is 2e-7.
  • -b x,.., --box=x,y,.. β€” specify the bounding box for the streamline calculation.
  • -j, --closed β€” outputs only closed streamlines. exclusive ✨
  • -p F, --profile=F β€” output the list of values for coordinates defined in F.
  • -o, --mixed β€” output text values in mixed cells only.
  • -L L, --level=L β€” use cells at level L only. pick a lane 🧚
  • -i, --reinit β€” reinitializes refinement and solid fractions.
  • -e, --merged β€” draw boundaries of merged cells.
  • -S, --squares β€” draw (colored) squares. yes the parentheses are theirs, colored squares only πŸ’œ
  • -g, --gnuplot β€” output gnuplot data.
  • -x VAL, --sx=VAL β€” outputs a GTS surface, cross section for x = VAL of the scalar variable.
  • -y VAL, --sy=VAL β€” outputs a GTS surface, cross section for y = VAL of the scalar variable.
  • -z VAL, --sz=VAL β€” outputs a GTS surface, cross section for z = VAL of the scalar variable.
  • -s S, --surface=S β€” outputs the surface defined by file S (or the solid surface if S is equal to solid).
  • -V S, --vector=S β€” output an OOGL representation of the velocity vector field in the mixed cells.
  • -l F, --streamlines=F β€” draw streamlines starting from each point defined in file F.
  • -C F, --cylinder=F β€” draw stream cylinders starting from each point defined in file F.
  • -R F, --ribbon=F β€” draw stream ribbons starting from each point defined in file F.
  • -r β€” refines the solid surface according to the local resolution.
  • -c V, --color=V β€” color surfaces, streamlines etc... according to the. (yes that sentence just ends there in the original, i am NOT making stuff up, we report the facts as they are πŸ’€)
  • -m V, --min=V β€” set minimum scalar value to V.
  • -M V, --max=V β€” set maximum scalar value to V.
  • -v, --verbose β€” display statistics and other info. the tea β˜•
  • -h, --help β€” display the help and exit.

πŸ‘‘ AUTHOR πŸ‘‘

gfs2oogl was written by Stephane Popinet <s.popinet@niwa.co.nz>. 🫢

this manual page was written by Ruben Molina <rmolina@udea.edu.co>, for the Debian project (but may be used by others). giving credit where credit is due, always. ✨


and that's the whole page, bestie. sign-off time: this one came out of User Commands, and it's dated July 9, 2008 β€” yes, an elder. respect your elders, they're slaying. πŸ¦‹πŸŒΈ

periodt. πŸ’