SPModel output flags in the xml input file determine the parameters that need to be dumped at regular intervals. The user has to specify the interval between successive dumps. The output formats available at the moment are text and binary. Please refer to section 3 (input files).
The SPModel routine for dumping data has been abstracted out into a plugin and this allows the user to modify the way data is being output and also add or remove parameters that the user wants dumped.>
The ouput plugin must therefore be loaded at runtime and has to be listed in the plugins-list in the input xml file. Once loaded, the output plugin will read the flags in the file-output section in the input xml file to determine which of parameters need to be dumped. Please refer to section 3 (input files) for further details.
The user also has to set the outputEvery parameter in the input xml file which is the interval between successive dumps.
The topography file has 4 columns: x, y, z (= h) and boundary condition.
Erosion, Sedimentation, Isostacy and Uplift File
The erosion, sedimentation, isostacy and uplift files have a single column which lists the erosion and sedimentation accumulated up to the current time step. The column in each file is sorted by node ID, corresponding to the order in the Topography file.
The daughterNodes file has a single column and lists the receiver node for each node. A -1 flag denotes that the parent node is a boundary node. Please note that each node is only allowed to have one receiver node, which is its steepest neighbour.
SPModel has an inbuilt visualisation plugin, SPModelFlowHierarchyViewer, which is conditionally compiled if the system it is being complied on has the necessary SDL libraries. SDL stands for “Simple DirectMedia Layer”, which is a cross-platform graphics library. The main aim of this visualisation plugin has been to help debug and visualise the landscape at runtime. However its capabilities are quite limited in terms of the size of the data set.
The user has to list the aforementioned plugin name in the plugins list of the xml input file for it to be loaded at runtime. The user also has to set the outputEvery parameter in the input xml file which is the interval between successive visualizations.
The visualisation kicks in after outputEvery number of time steps and the user gets a chance to interactively view the terrain. To proceed the simulation the user has to press to give the control back to the solver loop. Once again after outputEvery number of time steps the visualisation plugin kicks in and the same process repeats so forth.
Rotation: Press LEFT Mouse button + Mouse Motion
Zoom: Press RIGHT Mouse Button + Vertical Mouse Motion
Erosion Profile: e
Sedimentation Profile: s
Flexural Isostacy Profile: f
Fault Model Profile:
Positive Vertial Exaggeration: ]
Negetive Vertial Exaggeration: [
Toggle River Network:
Toggle Catchments: c
Toggle Mesh Display Mode: m (surface/triangles/points)
spmIDL is a potsprocessing and visualisation package for SPMODEL written in IDL. At present, spmIDL requires a licensed version of IDL to run. Future versions will allow execution via a freely available runtime version of IDL.
SpmIDL comprises three files (download by clicking on the links):
spm.pro : the GUI interface.
spm_define.pro : the basic object definition and functionality.
spmpaser__define.pro : specific routines for parsing the xml input file.
With these three files placed on your IDL directory path, spmIDL can be started by typing "spm" at the IDL prompt:
Alternatively, the underlying routines can be directly accessed through the command line via :
IDL> model1= obj_new('spm')
where "model1" is an arbitrary name given to the mdoel object.
The following points should be noted :
spmIDL uses the information in the SPMODEL input xml file to locate the directory containing model output files. If these files are subsequently moved, then spmIDL will not be able to find them.
spmIDL provides a GUI interface to a variety of tools that operate on either the basic SPMODEL ascii-output files (ascii-mode), or, if prefererd, a condensed binary file that can be produced from within spmIDL (binary-mode). Using the binary -mode significantly optimises performance particularly with regard to time series.
spmIDL keeps track of the most recent settings by writing a ".spm" file in the users home directory. If this file is not found or provides incorrect information, then spmIDL raises a dialog box to ask for the location of another .xml file to process
An spmIDL object starts by parsing the relevant "*.xml" file and loading the last available output file from the SPMODEL run (in ascii-mode) or the full binary file (in binary-mode). In a typical spmIDL session several widows may be open at once as illustrated below.
An outline of the functionality of the spmIDL is provided below.
The main window comprises three panes: the TAB PANE (GENERAL, PROPS, SAVE), the BUTTON PANE and the GRAPHICS PANE. By default the last available output file in the output directory is loaded asnd displayed.
MAIN : BUTTON PANE (beneath the TAB PANE of the main
window) provides access to seven options inclucing "exiting" as
"Save" uses parameters set in the SAVE TAB to write image output files based on the current main graphic window. By default the images are written to the current ouput directory.
"Write Binary" is an intensive operation but provides significant acceleration of subsequent parameters.
"Sequence" uses parameters set in the SAVE TAB to display a sequence of images and (optionally) write a series of images to disk (to enable the wite option set "save sequence" to "yes" in the MAIN : SAVE TAB).
The MAIN : GENERAL TAB provides general information and editable
access to generic image handling functions.
"xml file" (editable) shows the current input *.xml parameter file for the model .
"set index" (editable) shows the index of the output file displayed in the MAIN:GRAPHICS PANE
"resolution" (editable) displayed data is mapped from an irregular mesh to a regular array. The "resolution" is the ratio of the spacing of the regular mesh nodes to average spacing of the irregular mesh nodes.
"vert.exag." (editable) defines the degree of vertical exageration employed in the 3D effects (ie., shading).
The MAIN:PROPS TAB sets the display parameters for the MAIN:GRAPHICS
PANE in terms of the height field (by default set to "z"), the image
data (by default set to "z") and the contour data (by default set to "sed").
The options for the exclusive buttons are
"z": surface elevation,
"sed": thickness of sediments,
"ero": cummulative erosion,
"fle": flexural displacement,
"up": tectonic displacement.
The MAIN:SAVE TAB
The MAIN:GRAPHICS PANE displays a shaded plan view of the current model output (as specified by the current index). "Mouse clicks" in the MAIN:GRAPHIC PANE generate display of current location (elevation, and xy-distance from lower left corner) in the MAIN:TAB PANE area. "Right Mouse clicks" activate river profiling as described below.
The Parameter window is opened automatically to provide editable access (including the ability to switch on/off) all parameters associated with the IDL object graphics rendering engine (ie., the Surface, Image, Network, Contour and Lights tab)
"River profiling" is activated by "right clicking" the mouse on the MAIN : GRAPHICS PANE. A River profile is generated by tracing the current flow route from the current mouse point to the nearest pit/water body/boundary. The flow route is highlighted by a red line in the MAIN : GRAPHICS PANE, while a RIVER PROFILING WINDOW is opened up to showing the longitudinal elevation profile of the flow route. This utility requires that the daughter nodes list is available as an output file.
Pressing the "Xobj" button in the MAIN : BUTTON PANE instatiates a interactive 3-D (or IDL xobjview) object and displays it in the 3-d VIEW WINDOW. MENU options allow this view to be saved in a range of standard image formats.
*IDL - interactive data language from Research Systems www.rsinc.com. IDL is a commercial product, however future releases will use a freely available IDL virtual machine to allow runing the GUI application spmIDL.