Skip to content

document some smokeview script keywords, remove unused parameter from a script (-test) #2526

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
gforney wants to merge 4 commits into from
Closed

document some smokeview script keywords, remove unused parameter from a script (-test) #2526

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6ff0699
scripts: remove -test from the make pictures script
gforney Jan 6, 2026
b8169f1
smv ug/smokeview source: document some smokeview script keywords
gforney Jan 6, 2026
da7cf86
Merge remote-tracking branch 'origin/master'
gforney Jan 6, 2026
45ec470
smv ug/smv source: change script keyword OUTPUTSMOKESENSORS to SHOWSM…
gforney Jan 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 32 additions & 4 deletions Manuals/SMV_User_Guide/SMV_User_Guide.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3843,6 +3843,14 @@ \subsubsection{3D Smoke Files}
mesh index is loaded. If the mesh\_index is negative then volume
rendered smoke for all meshes is loaded.

%%+++++++++++++++++++++++
\hitemssf{SMOKEPROP}Set the smoke mass extinction coefficient.
Usage:
\begin{lstlisting}
SMOKEPROP
fval (float)
\end{lstlisting}

\elist

\subsubsection{Boundary Files}
Expand Down Expand Up @@ -3912,6 +3920,15 @@ \subsubsection{General Files}
file (char)
\end{lstlisting}

%%+++++++++++++++++++++++
\hitemssf{LOADSMV}
Load an smv file.
Usage:
\begin{lstlisting}
LOADSMV
file (char)
\end{lstlisting}

%%+++++++++++++++++++++++
\hitemssf{UNLOADALL}Unload all data files currently loaded.
Usage:
Expand Down Expand Up @@ -4265,13 +4282,11 @@ \subsection{Showing/Hiding Device}
\end{lstlisting}

%%+++++++++++++++++++++++
\hitemssf{OUTPUTSMOKESENSORS}Output smoke sensor data to a csv file named casename\_ss.csv.
\hitemssf{SHOWSMOKESENSORS}Output smoke sensor data to a csv file named casename\_ss.csv.
Usage:
\begin{lstlisting}
OUTPUTSMOKESENSORS
SHOWSMOKESENSORS
\end{lstlisting}


\elist
%%-----------------------------------------------------------------------
\subsection{Controlling Colorbars}
Expand Down Expand Up @@ -4500,6 +4515,14 @@ \subsection{Controlling the Scene}
0/1 min position (float) 0/1 max position (float)
\end{lstlisting}

%%+++++++++++++++++++++++
\hitemssf{SETDEMOMODE}Set demo mode from 0 to 5.
Usage:
\begin{lstlisting}
SETDEMOMODE
mode (int)
\end{lstlisting}

%%+++++++++++++++++++++++
\hitemssf{SETTIMEVAL}Set the time for displaying data to a specified value.
Usage:
Expand Down Expand Up @@ -4823,6 +4846,11 @@ \subsection{Miscellaneous}
\noindent where r, g and b are red green and blue color components each ranging from 0 to 255 and delta is an error tolerance.
If any color component difference is found to be greater than delta, a warning message is output.

%%+++++++++++++++++++++++
\hitemssf{UNLOADPLOT2D}Unload 2D plots if they are visible. Usage:
\begin{lstlisting}
UNLOADPLOT2D
\end{lstlisting}

\elist

Expand Down
20 changes: 10 additions & 10 deletions Source/smokeview/IOscript.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,7 @@ void InitKeywords(void){
InitKeyword("LOAD3DSMOKE", SCRIPT_LOAD3DSMOKE, 1);
InitKeyword("LOADVOLSMOKE", SCRIPT_LOADVOLSMOKE, 1);
InitKeyword("LOADVOLSMOKEFRAME", SCRIPT_LOADVOLSMOKEFRAME, 1);
InitKeyword("SMOKEPROP", SCRIPT_SMOKEPROP, 1);

// boundary files
InitKeyword("LOADBOUNDARY", SCRIPT_LOADBOUNDARY, 1);
Expand Down Expand Up @@ -320,8 +321,7 @@ void InitKeywords(void){
InitKeyword("HIDEDEV", SCRIPT_HIDEDEV, 1);
InitKeyword("SHOWALLDEVS", SCRIPT_SHOWALLDEVS, 0);
InitKeyword("SHOWDEV", SCRIPT_SHOWDEV, 1);
InitKeyword("OUTPUTSMOKESENSORS", SCRIPT_OUTPUTSMOKESENSORS, 0);
InitKeyword("SHOWSMOKESENSORS", SCRIPT_OUTPUTSMOKESENSORS, 0);
InitKeyword("SHOWSMOKESENSORS", SCRIPT_SHOWSMOKESENSORS, 0);

// colorbar
InitKeyword("CBARFLIP", SCRIPT_CBARFLIP, 0);
Expand Down Expand Up @@ -356,7 +356,6 @@ void InitKeywords(void){
InitKeyword("SETDEMOMODE", SCRIPT_SETDEMOMODE, 1);
InitKeyword("SETTIMEVAL", SCRIPT_SETTIMEVAL, 1);
InitKeyword("SETVIEWPOINT", SCRIPT_SETVIEWPOINT, 1);
InitKeyword("SMOKEPROP", SCRIPT_SMOKEPROP, 1);
InitKeyword("VIEWXMIN", SCRIPT_VIEWXMIN, 0);
InitKeyword("VIEWXMAX", SCRIPT_VIEWXMAX, 0);
InitKeyword("VIEWYMIN", SCRIPT_VIEWYMIN, 0);
Expand Down Expand Up @@ -795,8 +794,8 @@ int CompileScript(char *scriptfile){
case SCRIPT_CBARNORMAL:
break;

// OUTPUTSMOKESENSORS
case SCRIPT_OUTPUTSMOKESENSORS:
// SHOWSMOKESENSORS
case SCRIPT_SHOWSMOKESENSORS:
break;

// SHOWHVACDUCTVAL
Expand Down Expand Up @@ -845,7 +844,7 @@ int CompileScript(char *scriptfile){
SETfval;
break;

// SHOWALLDEVS
// SHOWALLDEVS
case SCRIPT_SHOWALLDEVS:
break;

Expand Down Expand Up @@ -2945,9 +2944,9 @@ void ScriptHideHVACVals(void){
HVACMenu(MENU_HVAC_HIDE_ALL_VALUES);
}

/* ------------------ ScriptOutputSmokeSensors ------------------------ */
/* ------------------ ScriptShowSmokeSensors ------------------------ */

void ScriptOutputSmokeSensors(void){
void ScriptShowSmokeSensors(void){
int i,j;
FILE *stream_smokesensors;
int nsmokesensors;
Expand Down Expand Up @@ -4043,8 +4042,8 @@ int RunScriptCommand(scriptdata *script_command){
case SCRIPT_HIDEHVACVALS:
ScriptHideHVACVals();
break;
case SCRIPT_OUTPUTSMOKESENSORS:
ScriptOutputSmokeSensors();
case SCRIPT_SHOWSMOKESENSORS:
ScriptShowSmokeSensors();
break;
case SCRIPT_SHOWALLDEVS:
ShowDevicesMenu(MENU_DEVICES_SHOWALL);
Expand Down Expand Up @@ -4225,3 +4224,4 @@ int RunScriptCommand(scriptdata *script_command){
GLUTPOSTREDISPLAY;
return returnval;
}

2 changes: 1 addition & 1 deletion Source/smokeview/IOscript.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
#define SCRIPT_LOADBOUNDARYM 220
#define SCRIPT_LOADSLICEM 221
#define SCRIPT_LOADVSLICEM 222
#define SCRIPT_OUTPUTSMOKESENSORS 223
#define SCRIPT_SHOWSMOKESENSORS 223
#define SCRIPT_RGBTEST 225
#define SCRIPT_XYZVIEW 226
#define SCRIPT_VIEWXMIN 227
Expand Down
8 changes: 1 addition & 7 deletions Verification/scripts/Make_SMV_Pictures.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
set curdir=%CD%
set git_drive=c:
set DEBUG=
set TEST=
set SCRIPT_DIR=%CD%
set runsmvcases=1
set runwuicases=1
Expand Down Expand Up @@ -39,7 +38,7 @@ if %useinstalled% == 1 (
set BACKGROUND=%GITROOT%\smv\Build\background\intel_win\background.exe
set SMOKEDIFF=%GITROOT%\smv\Build\smokediff\intel_win\smokediff_win.exe
set FDS2FED=%GITROOT%\smv\Build\fds2fed\intel_win\fds2fed_win.exe
set SMOKEVIEW=%GITROOT%\smv\Build\smokeview\intel_win\smokeview_win%TEST%%DEBUG%.exe -bindir %GITROOT%\smv\for_bundle
set SMOKEVIEW=%GITROOT%\smv\Build\smokeview\intel_win\smokeview_win%DEBUG%.exe -bindir %GITROOT%\smv\for_bundle
set SMOKEZIP=%GITROOT%\smv\Build\smokezip\intel_win\smokezip_win.exe
set WIND2FDS=%GITROOT%\smv\Build\wind2fds\intel_win\wind2fds_win.exe
)
Expand Down Expand Up @@ -225,10 +224,6 @@ goto eof
set runsmvcases=0
set runwuicases=1
)
if /I "%1" EQU "-test" (
set valid=1
set TEST=_test
)
if /I "%1" EQU "-installed" (
set valid=1
set useinstalled=1
Expand All @@ -252,7 +247,6 @@ echo.
echo -help - display this message
echo -debug - run with debug Smokeview
echo -installed - use installed Smokeview
echo -test - use test Smokeview
echo -wui - run only Wui cases
exit /b

Expand Down