Visual Workshop 3B User Guide
Visual Workshop 3B User Guide
Visual Workshop 3B User Guide
Software Package
VISUAL
WORKSHOP
The ANSWERS product to
prepare and verify models,
launch jobs and visualise results for
MONK, MCBEND, RANKERN, and WIMS.
ANSWERS/VISUALWORKSHOP/REPORT/005
The distribution of this document is limited to subscriber members of ANSWERS.
The information which this document contains is accurate to the best of the knowledge and
belief of Energy, Safety and Risk Consultants (UK) Limited (hereafter referred to as AMEC),
but neither AMEC nor any person acting on behalf of AMEC make any warranty or
representation expressed or implied with respect to the use of the computer program
described, nor assume any liabilities with respect to the use of, or with respect to any
damages which may result from the use of information, method or data disclosed in this
document.
COPYRIGHT Energy, Safety and Risk Consultants (UK) Limited, part of AMEC plc
1. Introduction ..................................................................................................................... 7
1.1 Compatibility ............................................................................................................. 7
1.2 Use of Views for Model Checking ............................................................................ 8
1.3 New Features in Version 3B .................................................................................... 9
1.4 New Features in Version 3A .................................................................................. 10
2. The Visual Workshop GUI ............................................................................................ 13
2.1 Starting Visual Workshop ....................................................................................... 13
2.2 Main Window Overview ....................................................................................... 13
2.3 Main Window Menus ........................................................................................... 15
2.3.1 File Menu ........................................................................................................... 15
2.3.2 View Menu ......................................................................................................... 16
2.3.3 Tools Menu ........................................................................................................ 16
2.3.4 Help Menu .......................................................................................................... 16
2.4 Main Window Overview Tree .............................................................................. 16
2.5 Preferences Dialog ................................................................................................. 18
2.5.1 Application Options Tab ..................................................................................... 19
2.5.2 Libraries Tab ...................................................................................................... 19
2.5.3 Event Log Files Tab ........................................................................................... 21
2.5.4 Queue Tool Tab ................................................................................................. 22
2.6 File Editor ............................................................................................................... 22
3. Viewing Models ............................................................................................................. 25
3.1 The 3D Wire Tab .................................................................................................... 25
3.1.1 Image Canvas and Interactive controls ............................................................. 26
3.1.2 Display Toolbar .................................................................................................. 26
3.1.3 Options Toolbar ................................................................................................. 27
3.2 The 3D Ray Tab ..................................................................................................... 33
3.2.1 Image Canvas and Interactive controls ............................................................. 34
3.2.2 Display Toolbar .................................................................................................. 35
3.2.3 Info Toolbar ........................................................................................................ 37
3.2.4 Options Toolbar ................................................................................................. 38
3.2.5 Snapshot Window .............................................................................................. 45
3.3 The 2D Ray Tab ..................................................................................................... 46
3.3.1 Image Canvas and Interactive Controls ............................................................. 47
3.3.2 Display Toolbar .................................................................................................. 48
3.3.3 Info Toolbar ........................................................................................................ 49
3.3.4 Overlays Toolbar ................................................................................................ 50
3.3.5 2D Ray Slice Editor Dialog................................................................................. 51
3.4 The 2D WIMS Geometry Tab ................................................................................. 53
1. Introduction
Visual Workshop is the ANSWERS product designed to prepare and verify
models, launch jobs and visualise results for the MONK, MCBEND,
RANKERN, and WIMS codes. It contains the following functionality:
This User Guide provides details of the functionality of the Visual Workshop
Graphical User Interface (GUI) and a reference to the available dialogs and
options.
1.1 Compatibility
Visual Workshop 3B_RU0 is provided with ray trace libraries compatible with
the following code versions:
MCBEND10A_RU1
MCBEND11A_RU0
MONK8A_RU1 (Windows only)
MONK9A_RU1
MONK10A_RU0
RANKERN15A_RU1
One of the major uses of Visual Workshop is as a tool for checking that a
model is a correct representation of the intended geometry and that it is valid
for use by the chosen code. When using Visual Workshop to check a model
it is important to note the capabilities of the various views and their
applicability.
Only the 3D and 2D Ray Trace Views can be used to determine whether a
models geometry is valid for use by MCBEND, MONK or RANKERN. This is
because the VRFORT Ray Trace engine is built using the same code as the
analysis codes and can therefore accurately check the input for errors. When
checking a model using the 3D or 2D Ray Trace Views the VRFORT output
file should always be checked for errors. This is accessed by clicking the
Output button on the right hand side of the Ray Trace Info Bar (See Section
3.2.3).
The 3D Wireframe View, through its display of the individual FG bodies that
make up a geometry, can be used to check that a model represents the
intended geometry. This can be useful when building a geometry as the 3D
Wireframe View can be used to display incomplete geometries that are not
valid for display by the Ray Trace views.
The input parser has been updated to handle the new modules and
input features in WIMS10A_RU0.
The 2D and 3D Ray Trace views have been updated to display
CACTUS3D geometries, complete with the ability to display geometry
sub-meshing and CACTUS results.
The WIMS interface reader has been updated to extract Reaction
Rate and Heating data from an archived WIMS interface file in
addition to the existing Flux results.
The 2D WIMS view is now able to display geometries for the PRIZE,
GAM and NEWMAX modules. See Section 3.4
When an archived interface containing mesh volumes is attached,
the 2D WIMS view is also able to display geometries for the DSN,
FLURIG and THESEUS modules.
The 2D WIMS view is now able to display CACTUS results scored by
sub-mesh from an archived WIMS interface file. See Section 4.4.
The input parser has been updated to handle the new input units in
MONK10A_RU0.
The 3D Wireframe view can display Action Tallies scored in Unified
Tally bodies. See Section 4.2.
K(THREE) by stage and Shannon Entropy values can be graphed
using the built in graphing functions. See Section 4.6.1.
The contents of Birth Store and Birth Dump files can be viewed as
point data in the 3D Wireframe and 3D and 2D Ray Trace views. See
Section 4.2.1.7.
The new 2D WIMS view is able to view geometries for the CACTUS,
HEAD, PERSEUS, PIJ, PROCOL and TWOTRAN modules. See
Section 3.4.
The new 2D WIMS view is able to display CACTUS flux scored by
mesh from an archived WIMS interface file. See Section 4.4.
Parser Improvements
3D Wireframe Improvements
Verification Tool
Standalone VRFORT
Visual Workshop is started using the executable in the exec directory of the
Visual Workshop installation directory (either VisualWorkshop.exe on a
Windows PC or VisualWorkshop on Linux).
When Visual Workshop has finished loading, it will display the main window.
Once Visual Workshop has finished loading, the main window is displayed. If
no model is used as a load argument, a window similar to that seen in Figure
2 is displayed. If a model is passed as a load argument the model is loaded
and the window populated accordingly.
Menu Bar
Views Tab
Pane
Overview Tree
Sub-View
Pane
New File
Displays an Open dialog window to allow a user to create a new empty file
into which a model can be entered.
Open File
Displays an Open dialog window to allow a user to load a model into Visual
Workshop.
Select Loop
When a model has been loaded which contains looping parameters, this
menu option allow users to select which loop of the model is currently being
displayed.
Import View
Loads a saved view position for either the 3D Wireframe, 3D Ray Trace or 2D
Ray Trace view and applies it to the currently displayed model. (See Section
3.6).
Export View
Saves the current view from either the 3D Wireframe, 3D Ray Trace or 2D
Ray Trace view to allow it to be used again in the future. (See Section 3.6).
Preferences
Displays the Preferences window.
Recent Files
Allows a user to reload one of the last 8 loaded files.
Exit
Closes Visual Workshop.
Graph Utility
Displays the graph creation utility (See Section 4.5).
Verification Tool
Starts the code installation verification tool (See Section 6)
About
Displays the About dialog which contains licence and QA status information.
On the left hand side of the main window is the Overview Tree. Examples of
this are shown in Figure 4 and Figure 5. The Overview Tree shows a
hierarchical overview of the currently loaded model.
Input files can be expanded to show the sections of input text in the file which
are labelled depending on whether the wireframe parser has attempted to
parse the unit and whether the attempted parse caused any warnings or
errors to be produced.
Visual Workshop will list possible output files in grey; these can be loaded by
double clicking.
Loaded output files can be expanded to see the results data which has been
loaded.
The Overview Tree is also used to access snapshot images which have been
created for the model.
If an Input File
is loaded, the
datsets branch
of the tree is Input File and
disabled constituent units
Double clicking
the Add File
node is Possible Output
equivalent to Files are listed in
the File > grey. Double click a
Import Output possible output file
File menu to load it
option
Double clicking on any input or loaded output file will create a file editor (see
Section 2.6) displaying the contents of that file. If the Display Editor in Main
Window preference is selected the editor will be added to the sub-view pane
at the bottom of the main window. If not, a new editor window will be opened
to display the file.
Right clicking on an item in the Overview Tree will display an options menu
for that object (where appropriate). Input files and units with parser errors or
warnings will provide an option to allow the errors or warnings to be listed,
results data extracted from output files will provide an option to load the data
into the graph tool. Some WIMS input modules will provide an option to
display the module geometry in the 2D WIMS View.
Results Data
extracted from a
located output file
The tree view can be resized by dragging the separator between the tree
view and the tabbed pane.
The Preferences dialog allows the user to configure options which affect
more than one part of Visual Workshop.
The controls on the Application Options Tab (Figure 6) allow the user to
control options which affect text editors throughout Visual Workshop.
The Use Syntax Highlighting option toggles whether the text editor uses
syntax highlighting when displaying loaded model text. Disabling this can
improve the performance of the application when loading and modifying some
large inputs. Changes made using this option may not take effect until the
next time a model is loaded or reloaded.
User Specified
VRFORT
Library selector
The Libraries Tab (Figure 7) allows the user to select whether a specific
library is used to Ray Trace images (regardless of whether it is the correct
library for the code being used) or if Visual Workshop should choose a library
based on the code and version currently selected in the Launchpad tab,
which gives the user flexibility in how Visual Workshop is used.
Selecting the Extra diagnostics from library option will cause diagnostic
information from the library to be output to the console window attached to
Visual Workshop. This option will normally only be used when requested by
the ANSWERS Software Service to help diagnose a problem.
Selecting the Test input data by pre-loading option will mean that a model
data file is first loaded into a separate program to check for input errors
before loading into the Ray Trace library. Some model errors are regarded
as too severe for MONK, MCBEND or RANKERN programs to continue
processing and they will abort prematurely if one of these errors is found. As
the Ray Trace library consists of the same software that MONK, MCBEND
and RANKERN use to read and process model data, if one of these errors is
encountered Visual Workshop will be closed by the library. To guard against
this possibility the input model data can be tested by pre-loading into a
separate process. The disadvantage is that loading the input model will take
twice as long, which can be an issue with some large models. If pre-existing
models are being viewed or minor changes are being made then it is not
necessary to use this option. However, if major changes are being made
then it is advisable to use this option.
The Trim splitting mesh on 3D ray option will trim the splitting mesh to the
current model bounds. This is useful if the mesh boundaries extend a long
way beyond the model, for example when the DUMMY option is used in the
splitting mesh definition.
The Event Log Files tab (Figure 8) controls options related to the display of
event and track data. For each of the different types of event log file, options
are provided to control the maximum amount of data that is read from a
loaded log file as well as optionally setting whether an ASCII formatted log file
is written by Visual Workshop as part of the reading process.
Selecting Process events from file will cause Visual Workshop to read the
events directly from the file instead of loading the data into memory.
If events are read into memory and Visual Workshop is unable to reserve
memory for the data it will automatically switch to reading the events from the
file. The Max Events field can be used to set a limit on the number of events
that will be read before switching to processing the events from the file.
The controls on the Queue Tool Tab (Figure 9) allow the user to control
options which affect the operation of the Queue Tool.
The Queue Directory controls the location to which Visual Workshop writes
and from which the Queue Tool reads job information. The Queue Directory
must be set before the Queue Tool can be used.
Visual Workshop contains a basic text editor which can be used to edit
loaded models. The editor can either be used as an external editor window
or used as an internal sub-view beneath the main graphical views. Editors
can be swapped from internal to external mode and vice versa by using the
Pop Out and Pop In buttons on the toolbar. Examples of both types of
editor are shown in Figure 10 & Figure 11.
Display Search Bar Button Pop Out Button Close Editor Button
Save/Revert
Controls
Pop In Button
The File Editor can be used to view the contents of both input and output
files. When viewing output files, the file cannot be edited and the editing
toolbar buttons are disabled.
3. Viewing Models
The 3D Wire tab enables the user to produce three dimensional wireframe
images of the geometry bodies and additional features (such as dose points
or a splitting mesh) in a loaded FG model.
The model can be controlled by the mouse or by controls on the tab itself. An
example of the 3D Wire tab viewing the model workn6_full.dat can be seen
in Figure 12.
Display Toolbar
Image Canvas
Options Toolbar
The image canvas is the area in which the wireframe image is drawn. The
user can interact with the canvas using a mouse in order to manipulate the
image being drawn.
Clicking on the canvas with the left mouse button and then dragging rotates
the image.
Clicking on the canvas with the right mouse button and dragging controls the
zoom function. Moving the mouse upwards zooms in, and moving the mouse
downwards zooms out.
Clicking on the canvas with the middle mouse button and then dragging
translates the model on the canvas.
The Display toolbar (Figure 13) controls whether the model is displayed as a
wireframe outline, or as translucent or solid bodies (additionally overlaid with
the wireframe outline). The projection of the display (Parallel or Perspective)
can also be selected.
The Enable Stereo option controls whether the display can be displayed in
3D Stereo using compatible hardware. See Important Information about Full
Screen and Stereo below.
The VTK toolkit used by Visual Workshop to provide the 3D Wireframe view
contains the option to display content in stereo using OpenGL Quad Buffering
when Visual Workshop is run on compatible hardware with a compatible pair
of 3D glasses.
The full screen and stereo functionality of the 3D Wireframe view is not QA
Tested and is disabled by default. To enable stereo functionality, use the
following argument when starting Visual Workshop:
--enable-stereo
ANSWERS can provide advice on the setup and use of the stereo option and
the hardware required, but cannot fully support the use of this option.
All toolbars on the 3D Wire, 3D Ray and 2D Ray tabs can be floated to
increase the size of the image and can be rearranged inside their respective
tabs. To float a tab, click on the tab background with the left mouse button
and drag it away from its current position.
The Options toolbar has a number of tabs which contain controls which affect
the image displayed on the canvas. For the 3D Wireframe view, the options
toolbar contains tabs providing access to the following functionality:
Move, rotate and zoom the image being displayed. (See Section
3.1.3.1)
Set the position of cut planes in the image. (See Section 3.1.3.3)
Select which Parts and Bodies to display in the image. (See Section
3.1.3.4)
The View Tab (Figure 14) contains controls used to alter the view of the
model being displayed. The controls allow the user to rotate the view around
the model, to zoom in to or out from the model and to select from a number of
hard coded projections to view the model from along one of the primary axes.
Rotation Controls
Zoom Controls
Projection Controls
Style Control
Dimension Controls
Option Controls
The Options Tab (Figure 15) allows a user to select the style used for the
display (original, neutral or neutral with a white background for report
images), to enable or disable the display of global model dimensions along
the three primary axes and to alter a number of properties that affect either
the model being displayed (for example the polygon detail) or the controls
which affect the view (for example the rotation factor).
The controls on the Cut Plane tab (Figure 16) allow a number of cut-away
planes to be defined through the loaded model geometry. These specify a
volume in space bounded by user-defined planes and only the section of the
model that lies within this volume is displayed. In Visual Workshop, the user
is able to specify the position of the six planes that form the faces of a box,
the edges of which are aligned to the axes of the global co-ordinate system.
The Selection tab (Figure 17) allows the user to include or exclude specific
parts and bodies of the model in the displayed image. This can be useful to
focus on a specific part of a model.
Part
Constituent Bodies
Action Buttons
Hidden Feature
Visible Feature
The Features tab (Figure 18) allows the display of non-geometry features of
a model in the view to be controlled. Features which have been extracted
The Results Tab (Figure 19) allows the user to select which results are
displayed on the model image. When results data is extracted from a loaded
output file it is automatically passed to the 3D Wireframe View. If the results
data is suitable for display on the current model it is added to the Results to
Display drop down control for user selection. When a set of results data is
selected from the drop down control, the results are displayed in the image
and the Results Tab is populated with additional controls used to configure
Both the 3D and 2D Ray tabs work by passing and receiving messages to a
reading engine. This engine (VRFORT) is provided as an external library
which is loaded when the user first selects the 3D Ray or 2D Ray tabs. The
VRFORT library uses exactly the same code to parse the input files as is
used in the ANSWERS physics codes (MCBEND, MONK and RANKERN).
This ensures that the images created are exactly the same image that the
physics codes see.
Display Toolbar
Image Canvas
Options Toolbar
Info Bar
Figure 20 - 3D Ray Trace View
The Image canvas is the area in which the image is drawn. The user can
interact with the canvas using a mouse in order to manipulate the image
being drawn.
Clicking on the canvas with the left mouse button and then dragging rotates
the image.
Clicking on the canvas with the right mouse button and dragging controls the
zoom function. Moving the mouse downward zooms out, and moving the
mouse upwards zooms in, causing the image to be magnified. Clicking and
releasing the right mouse button without dragging produces a popup menu
with options to:
Clicking on the canvas with the middle mouse button and then dragging
translates the model on the canvas.
The display toolbar (Figure 21) contains a set of controls to select whether
the produced image is displayed by model materials, scoring regions or FG
zones.
The Holes checkbox enables the hole tracking routines and therefore
whether holes are displayed in the resulting image.
The Sources drop-down box selects whether unified source bodies are
displayed. There are seven available options.
The other buttons on the display toolbar allow a snapshot to be created (See
Section 3.2.5), a mouse drawn selection of the image to be magnified and
allows the rendering of an image to be stopped.
The information toolbar (Figure 22) provides information and feedback about
the image. When the mouse cursor is placed over a part of the displayed
model, the information fields change to reflect the information about the
model at the location of the cursor. The fields display the following
information:
The Cactus mesh (CM) and Cactus Sub-Mesh (SM) are only active when a
WIMS Cactus 3D model is displayed. The Cactus Sub-Mesh is only active
when a WIMS interface file is attached, then the sub-mesh numbers are
consistent with those in the WIMS output file.
The Result Value (Val) field displays the result in the current region or Cactus
Mesh / Sub-Mesh along with the statistical error if that is applicable.
When the information toolbar is floated the display fields are increased
providing more precision for the co-ordinates and display of alpha-numeric
material names.
The progress bar shows how much progress has been made in drawing the
image. How quickly the image is rendered is dependent on the available
hardware, the size of the image and the complexity of the model.
The output button produces a window which displays the text output from the
VRFORT rendering process. This text output contains debug information and
will list detected errors and double definitions.
The options toolbar has a number of tabs which contain controls which affect
the image displayed on the canvas. For the 3D Ray Trace view, the options
toolbar contains tabs providing access to the following functionality:
Set the position of cut planes in the image. (See Section 3.2.4.1)
Set the position of the cut brick planes (See Section 3.2.4.2)
Select which Materials, Regions and Zones to include or exclude
from the image. (See Section 3.2.4.3)
Select the visibility of available overlays. (See Section 3.2.4.4)
Select the view position and alter common settings. (See Section
3.2.4.5)
The controls on the Cut Plane tab (Figure 23) allow a number of cut-away
planes to be defined through the loaded model geometry. These specify a
volume in space bounded by user-defined planes and only the section of the
model that lies within this volume is displayed. In Visual Workshop, the user
is able to specify the position of the six planes that form the faces of a box,
the edges of which are aligned to the axes of the global co-ordinate system.
The controls on the Cut Brick tab (Figure 24) are used to define slice planes
aligned to the axes of the global co-ordinate system, which together with
either the maximum or minimum extent of the model define a rectangular sub
volume (brick) of the model that will be cut-away.
Pre-set Buttons
To alter the cut-away brick, either drag the sliders, enter the Min/Max model
co-ordinates in the fields and click Apply or select one of the eight buttons at
the bottom of the tab which removes one of the bricks that are created by
creating planes through the model origin along its principal axes.
The Include/Exclude tab (Figure 25) allows the user to include or exclude
specific materials, regions or zones (depending on the whether the model is
being displayed by materials, regions or zones) in the displayed image. This
Excluded Material
Shaded Material
Selection Buttons
The Settings & View Details tab (Figure 26) contains controls to alter the
detail, performance and position of the image being displayed.
The Settings section controls the detail of the generated image and the
drawing performance of Visual Workshop. Increasing the Hole Step Size
can decrease the detail of displayed holes; this depends on the hole and can
Eye Position
Selection Controls
Magnification Slider
The View Details section controls the position of the model in the generated
image. It contains controls to alter the eye position from which the model is
viewed which can be expressed in either Cartesian or Polar co-ordinates.
Buttons are available to view the model down either of the primary axes. It
also allows the point of interest (which is the positioning of the model on the
canvas) to be set. For both the point of interest and eye position, the relevant
Apply button must be pressed to save the co-ordinates while the Reset
button reverts to the default values for the model. Finally, a control is
provided to alter the magnification of the image. Note, however, that
magnifying the image with this control will not generate the same results as
zooming the image with the right mouse button since zooming with the right
mouse button moves the eye position towards and away from the point of
interest.
The Overlays tab (Figure 27) contains controls that alter the overlays which
are drawn over the 3D ray image when rendering completes.
The available overlays are displayed in the tree structure and are labelled
depending on whether they are set as visible or not. Overlays which are set
as visible are marked with a green tick icon, overlays which are set as hidden
are marked with a red cross icon, overlays which represent items from the
model that are currently unavailable for display are represented by a white
icon. An item may be unavailable for display because it is out of the field of
view or not present in the current loop being viewed of a looping case.
Hidden Overlay
The Hidden line removal check box controls whether visible overlays are
drawn on top of the 3D ray image or drawn with a simulated z plane allowing
the 3D ray image to obscure the overlay.
The Results tab (Figure 28) contains controls relating to the display of
results on the Ray Trace displays.
A result type is selected from the Results Selector drop down menu. The
supported result types are Flux by Region and Responses by Region from
MCBEND. The same controls are used for the 2D Ray Trace display.
Result Selector
The Results Selector drop down contains a list of available results to display.
The Display Options controls that appear below this option menu depend on
the result type chosen. The example shown in Figure 28 is for particle flux
results scored in FG regions.
Log Scale: Controls how the mapping between result value and colour scale
is performed. It is either Log or Linear.
Error Cut Off: Results with a statistical error greater than this value will be
omitted from the display.
Max Value, Min Value: The maximum and minimum values used to scale
the mapping between result and colour. See also Group Scale above.
When the Snapshot button is pressed, a new Snapshot Window (Figure 30)
is displayed. A snapshot is a copy of the currently displayed image plus its
associated data store and is used to store images for viewing later.
A snapshot window has the same information toolbar found in the 3D Ray
Trace View and can be used in the same way. Right clicking on the image
allows the image to be copied onto the system clipboard for inserting into
documents or other applications.
Display Toolbar
Image Canvas
Overlays Toolbar
Info Bar
Figure 31 - 2D Ray Trace View
The canvas is the area in which the image is drawn. The user can interact
with the canvas using a mouse in order to manipulate the image being drawn.
Clicking on the canvas with the left mouse button and then dragging moves
the image. Clicking on the canvas with the right mouse button and dragging
controls the zoom function. Moving the mouse downward zooms out, and
moving the mouse upwards zooms in, causing the image to be magnified.
Clicking and releasing the right mouse button without dragging produces a
popup menu with options to:
If the Shift key is held down while the right mouse button is pressed and
dragged, the model can be stepped through. This alters the position of the
currently viewed slice in the direction of the axis which the slice is looking
down. The image can also be altered by using the controls on the 2D Ray
Slice Editor dialog. The number of ray trace passes that are performed by
the 2D Ray Trace is one less than the value selected for the 3D Ray Trace.
The canvas is bordered on its left and bottom edges by rulers which show the
scale of the image being displayed. When the image is zoomed, the rulers
are changed to reflect the new scale.
The display toolbar (Figure 32) contains a set of controls to select whether
the produced image is displayed by model materials, scoring regions or FG
zones.
The Holes checkbox enables the hole tracking routines and therefore
whether holes are displayed in the resulting image.
The magnify button can be used to zoom and centre the view on a selection
box drawn with the mouse.
The Source/Scatter Res drop-down box alters the resolution at which solid
volumes of visibly overlays are shaded.
The trace direction control specifies the direction in which the ray trace scan
is performed.
The information toolbar (Figure 33) is the same as that in the 3D Ray Trace
View and provides information and feedback about the image. When the
mouse cursor is placed over a part of the displayed model, the information
fields change to reflect the information about the model at the location of the
cursor. The fields display the following information:
The Cactus mesh (CM) and Cactus Sub-Mesh (SM) are only active when a
WIMS Cactus 3D model is displayed. The Cactus Sub-Mesh is only active
when a WIMS interface file is attached, then the sub-mesh numbers are
consistent with those in the WIMS output file.
The Result Value (Val) field displays the result in the current region or Cactus
Mesh / Sub-Mesh along with the statistical error if that is applicable.
The progress bar shows how much progress has been made in drawing the
image. How quickly the image is rendered is dependent on the available
hardware, the size of the image and the complexity of the model.
The output button produces a window which displays the text output from the
VRFORT rendering process. This text output contains debug information and
will list detected errors and double definitions.
The 2D Ray Trace View does not have a full Options Toolbar as the 3D Ray
Trace View does; instead it has only the option to select the visibility of
available overlays.
The Overlays Toolbar (Figure 34) contains controls which alter the overlays
which are drawn over the 3D ray image when rendering completes.
The available overlays are displayed in the tree structure and are labelled
depending on whether they are set as visible or not. Overlays which are set
as visible are marked with a green tick icon, overlays which are set as hidden
are marked with a red cross icon, overlays which represent items from the
model that are currently unavailable for display are represented by a white
icon. An item may be unavailable for display because it is out of the field of
view or not present in the current loop being viewed of a looping case.
Hidden Overlay
Visible Overlay
Unavailable Overlay
The overlays which the 2D Ray Trace View can display are different to the
set that the 3D Ray Trace View can display.
The 2D Ray Slice Editor dialog (Figure 35) is displayed when the 2D Ray
tab is selected. It allows the image being displayed on the 2D Ray canvas to
be altered.
Title Field
Slice List
Fix Axis Buttons
Slice
Position
Fields
Action Buttons
The slice editor allows the setups for a number of 2D images to be stored and
retrieved. Initially, the editor contains three predefined slices, X Slice, Y
Slice and Z Slice which display the whole model through the origin on each
of the three primary axes.
Saved slices are displayed in the Slice List on the right of the dialog.
Selecting a slice will cause the image on the 2D Ray canvas to change
accordingly.
The Title field allows the title of a saved or new slice to be altered.
The position of the slice can be set by entering the desired x, y and z values
for the top left, top right and bottom left of the image using the slice position
fields. Alternatively the X, Y and Z buttons can be used to fix the slice
parallel to the relevant axis at the value entered in the top left position field for
that axis.
The action buttons clear the current position values, add the current settings
as a new slice in the Slice List, update the currently selected slice with the
currently entered position, undo changes made to the currently selected slice
and delete the currently selected slice from the Slice List.
Changing the slice by interacting with the 2D Ray Trace canvas will cause the
settings for the current slice to be changed in the Slice Editor.
The 2D WIMS geometry tab enables the user to view two dimensional
images of the geometry input in the following modules in WIMS:
HEAD
CACTUS
DSN
FLURIG
GAM
PERSEUS
PIJ
PROCOL
PRIZE
SPECTROX
NEWMAX
THESEUS
TWOTRAN
When a WIMS input is loaded the view will display the geometry from the first
of these modules in the input file. Other geometries can be displayed by right
clicking the appropriate module in the overview tree and selecting Display
Geometry.
The view can be controlled using the mouse. An example of the view can be
seen in Figure 36.
Options Toolbar
Image Canvas
Display Toolbar
Info Toolbar
The Image canvas is the area in which the image is drawn. The user can
interact with the canvas using a mouse in order to manipulate the image
being drawn.
Clicking on the canvas with the left mouse button and then dragging
translates the model on the canvas.
Clicking on the canvas with the right mouse button and dragging controls the
zoom function. Moving the mouse upwards zooms in, and moving the mouse
downwards zooms out. The mouse wheel can also be used to zoom the
image.
The Options toolbar (Figure 37) provides controls to select the quality of the
image being displayed and the geometry features being displayed.
Display Controls
The Anti-Alias option controls whether the image being displayed is anti-
aliased (smoothed). This can improve the quality of the displayed image.
The Display Sub-Meshes option toggles whether sub meshes are displayed
on the geometry (if available). If sub-meshes are not present in the currently
loaded geometry, this option will be disabled.
The Display toolbar (Figure 38) contains controls used to control what is
displayed on the Image Canvas.
By default, the canvas displays the geometry coloured by material and the
Display Toolbar displays the material key. It also allows the material colours,
line colour and sub-mesh colours to be customised. Clicking on any of the
listed key items will bring up a colour selection dialog which allows a new
colour to be chosen. Colour selections are stored when Visual Workshop is
closed and reread on start-up. Clicking the Reset Selections button will
reset colour selections to their initial default values.
Display Selector
The ANSWERS Software Service 55 VISUAL WORKSHOP Version 3B Issue 1
Viewing Models VISUAL WORKSHOP
When applicable results have been loaded, the Display Selector is used to
switch between displaying the geometry by material or by results values (see
Section 4.4)
The Display toolbar (Figure 39) provides information and feedback about the
model. When the mouse cursor is placed over a part of the displayed model,
the information fields change to reflect the information about the model at the
location of the cursor.
X: X Co-ordinate
Y: Y Co-ordinate
Z Co-ordinate
Z:
(visible for 3D geometries only)
M: Material Number
For 3D geometries, a Z button is added to the Info Toolbar. This allows the
current Z slice value to be selected. By default, the Z value is set at the
centre of the geometry.
The VRFORT library that provides the 3D and 2D Ray Trace functionality
does not read the Material Data input unit.
If the material definitions are supplied using the Material Specification input
unit then the alphanumeric names in the ray trace display are numbered in
the order they appear in that unit.
If material definitions are absent from the model being viewed or they are
provided by the Material data input unit then they will be numbered in the
order they appear in the Material Geometry unit.
If a mixture of alphanumeric names and numbers are used in the model they
can only be resolved correctly if the Material Specification input unit is used.
In other cases the alphanumeric names are numbered from the highest
material number encountered. This will usually mean that more materials are
listed than are in the model.
The Import View and Export View options on the File menu allow a
view from either the 3D Wireframe, 3D Ray Trace or 2D Ray Trace view to be
saved or restored. When either of these options is selected, a standard file
selection dialog is displayed allowing the user to save or load a view (which
has a .vwv file extension). This functionality has the following limitations:
4. Displaying Results
Visual Workshop has a number of ways in which a user can visualise the
results of a calculation. This section details the results displays available and
how they are used.
For MCBEND, MONK and RANKERN models, output files can be loaded
either via either the File > Import Output File menu item or the Add File
option in the Overview Tree.
A list of data which has been successfully extracted from an output file can be
seen by expanding the Output file node in the Overview Tree.
Due to the nature of a WIMS calculation, loaded results are not applicable to
the calculation as a whole but rather to the particular module from which they
were output. As a result, in order to display results from an archived WIMS
interface file, the file must be loaded by right clicking the relevant module
from the Overview Tree and selecting Attach Results from Archived
Interface.
WIMS Gamma results can be displayed but only when both a gamma and a
neutron interface file are attached. This is done by holding down the CTRL
key when selecting interfaces in the Select Archived Interface dialog to
select multiple files.
Visual Workshop reads WIMS results data from an archived interface file
created using the ARCHIVE module in WIMS. An archived interface can be
created using the following input:
ARCHIVE n
STORE AS filename
BEGIN
This will archive the contents of interface number n into a file with the given
filename. Visual Workshop does not expect an archived interface to have a
specific file extension. The archived interface can then be attached to the
module preceding the ARCHIVE module which created it.
Body Results:
2
MCBEND Flux and Response results scored in a Unified Tally body .
3
MONK Action Tallies scored in a Unified Tally body .
Track and Point data read from a MCBEND history log, collision log,
source log or leakage log file.
Track and Point data read from a RANKERN forced flight log file.
Point data read from a MONK birth dump log file.
It is important to note that not all results are suitable for all types of display.
When a set of results is not suitable for all types of display, Visual Workshop
will only allow suitable display types to be selected.
1
RANKERN Dose Point mesh results can be read from outputs produced by RANKERN16A
onwards.
2
The Tally Data and Multimap Data units are new units available in MCBEND11A.
3
The Tally Data and ATINUT Data units are new units available in MONK10A.
Applicable to:
For regular 3D arrays of results, a plane though the results data can be used
to display a non-interpolated cell plot (Figure 40). Planes are always aligned
to the X, Y or Z axis, but their position on the axis can be specified.
Additional planes can be added and removed. Cells can be excluded from the
display by specifying the range of result values to display.
For regular 3D arrays of results, the entire data array can be displayed as a
block of 3D cells coloured by result (Figure 41). The display can be cut by
altering the position of six cut planes (aligned to the X, Y and Z axes) and
cells can be excluded from the display by specifying the range of result
values to display.
Applicable to:
The Cell Plot is similar to the 2D Cell Plot but is applicable to results which do
not have subdivisions in three dimensions.
Applicable to:
Applicable to:
Applicable to:
The Contour Plot is similar to the 2D Contour Plot but is applicable to results
which do not have subdivisions in three dimensions.
Applicable to:
For 3D event data, a 3D Event Plot (Figure 46) can be used to display track
and point data read from a loaded event file at the corresponding locations in
the model. The range and type of data displayed can be controlled along
with the variables used to shade the display.
Results displayed on the Wireframe View are controlled from the Results Tab
of the Wireframe View Options Toolbar.
If the results data is suitable for display on the current model it is added to the
Results to Display drop down control for user selection. When a set of
results data is selected from the drop down control, the results are displayed
on the image and the Results Tab is populated with additional controls
required to configure the results display. These additional controls differ
depending on which style of results display is currently selected and are
outlined below.
Results Selector
Data Selection
Display Customisation
Controls
When a 2D contour plane or cell plane display is chosen, the Results Tab will
resemble that shown in Figure 47. For a 2D contour or cell display, the user
can control the planes which are displayed, whether a linear or logarithmic
scale is used and the minimum value, maximum value and number of
contours used in the display.
When a 3D contour display is chosen, the Results Tab will resemble that
shown in Figure 48. For a 3D contour display, the user can specify the
position of 6 cut planes which affect the extent of the results display which is
Depending on the type and size of results available, the available options in
the Display Customisation section will be a subset of the table below. Note
that if an option is presented without an editable selection control, then there
is only one value available for that option.
The plane control dialog (Figure 49) allows the planes used in the 2D Cell
and 2D Contour plots to be altered. The Axis and Axis Position for each
plane can be set and planes can be added and removed. However one
plane must exist at all times and the dialog will not allow the last plane to be
removed.
When a 3D event display is chosen, the Results Tab will resemble that shown
in Figure 50. The provided controls allow the user to change the size of
points displayed in the results and to open the Event File Filter dialog (see
Section 4.3.2.1).
The following results can be displayed via the 3D and 2D Ray Trace Views:
Region Results:
Track and Point data read from a MCBEND history log, collision log,
source log, forced flight log or leakage log file.
Track and Point data read from a RANKERN - MCBEND link file.
Point data read from a MONK birth dump log file.
Applicable to:
Region results.
The controls and options available for the display of Results scored by
Region are described in Section 3.2.4.6.
Applicable to:
For event, track and point data extracted from a MCBEND event log or
MONK birth store, available data is added as an Overlay to the 2D and 3D
Ray Trace (Figure 51) views. The display can be displayed or removed in
the same way as other overlays.
Right clicking the display in the overlay tree produces a pop-up menu which
provides access to the Event File Filter dialog.
The Event File Filter dialog (Figure 52) provides a method of filtering the data
from the MCBEND history log, collision log, source log or MONK birth store to
be displayed.
It allows the user to select the range of samples and types of event to be
displayed and to control how the data is coloured. Changes can be applied
to the current display by pressing the Apply button. Pressing the Undo
button reverses any changes made to the dialog since the last time the
Apply button was pressed.
Point Size
Control
Action Buttons
Figure 52 - Event Filter Dialog
For History Log data, it is assumed by default that loaded data is for neutron
events. If the loaded data is for gamma events, the Treat as Gamma
checkbox must be selected in order for the data to be displayed correctly.
Pressing the Advanced button brings up the Advanced Event Log Filter
Controls dialog.
The Advanced dialog (Figure 53) allows the data displayed to be further
filtered by limiting the range of specific fields. These fields will change
depending on what type of data is being displayed.
Pressing the Colours button brings up the Event Log Colour Selection
dialog.
Colour Selection
The Colour Selection dialog (Figure 54) allows the customisation of the
colours used by the event displays to display different event types (and the
plain colour optionally used to draw track data). Clicking on a colour
selection produces a dialog which can be used to select a new colour.
Description of the other options on the History log event file filter.
Maximum Events This option will prevent a single long lived sample from
per Sample
overloading the display.
Show start events These are any starting events including source events
of a sample read from a collision or leakage file in a
linked calculation.
Show escape These are any events that mean a particle leaves the
events
system, for example an absorption, leakage or roulette
event.
Display Tracks Defines how the tracks will be displayed. The options
are to colour by Energy, Weight or Time, use a plane
colour or exclude.
.
Description of additional options on the Collision log event file filter.
Display Events Defines how the events will be displayed. The options
5
are to colour by Energy, Weight, Time , plain or colour
by reaction type.
4
PCN stands for Particular Classification Number which is a unique number given to a type of
reaction. See the MCBEND user guide section 4.2 or the MONK user guide, chapter 2
appendix H for a list of PCN values.
5
The Energy, Weight and Time are when the particle arrives at the event.
Neutron and Gamma Flux (by Energy Group) scored by mesh or sub-
mesh.
Fission and Absorption Rates (Total and by Energy Group) scored by
mesh or sub-mesh.
Heating Rates (Total and by Component) scored by mesh or sub-
mesh.
WIMS results are read from attached interface files (see Section 4.1.1).
Results displayed on the 2D WIMS Geometry View are controlled from the
Display Toolbar.
If results data suitable for display on the current model is loaded, the Display
Selector drop down control will contain an option to display loaded results.
When a set of results data is selected from the drop down control, the results
are displayed on the image and the toolbar is populated with additional
controls required to configure the results display.
The Graph Utility can be used to produce graphs of loaded results data. The
Graph Utility can handle all types of results data extracted from output files
including those which arent suitable for display on the Wireframe, Ray Trace
or 2D WIMS views.
The Graph Utility can be started by selecting Graph Utility from the Tools
menu (See Section 2.3.3) or by right clicking a block of loaded results data in
the Overview Tree and selecting Graph Results.
The Graph Utility GUI (Figure 57) is used to select the data you want to
graph. This is done by first selecting a set of results data and then the
dimension indices within the selected results data.
If the Graph Utility is started by right clicking a block of loaded results data
then the results will be pre-selected in the Dataset section of the GUI.
Once the results dataset has been selected, the Variable Dimension (graph x
axis) needs to be selected. Once the variable dimension has been selected,
the Other Dimensions section of the GUI is populated with details of the other
dimensions in the dataset to allow indices of each dimension to be selected.
The Create Graph button will only be enabled when enough data has been
selected to create a graph. The minimum set of data is two or more indices
from the Variable Dimension. These can be selected by clicking an item in
the indices list and dragging up or down to select other indices or by selecting
an index and then selecting a second while holding the Shift key. Selections
in the list must be continuous.
Clicking the Create Graph button when enabled will create a new Graph
Panel displaying the currently selected data.
Results
Selection
Other
Dimension
Variable Selections
Dimension
Selection
Create
Graph
Figure 57 - Graph Utility Button
Graphs created by the Graph Utility or by the results by region popup menu
of the 2D or 3D Ray Trace image are displayed in a Graph Panel. An
example graph panel is shown in Figure 58.
Each graph panel is a sub-view like the file editor, so it can be displayed
under the main graphical view or popped out into its own window.
Graph
Options
Button
Graph
Different graph types are displayed depending on the results data and
dimensions selected. As examples, Figure 58 shows a graph of flux in a
specific region for a number of energy groups, Figure 59 shows a graph of
flux in a specific energy group in a number of regions and Figure 60 shows a
graph of K(THREE) by Stage for a MONK calculation.
Title Field
Colour Selectors
Axis Scale
Type
Controls
Max/Min
Contour Fields
The Graph Options dialog allows the user to configure options that affect the
graph currently being displayed. A screenshot of the dialog is shown in
Figure 61.
The Graph tab allows the user to set the main graph title and to
configure the colours used for the plot, error bars, background and
grid.
The X Axis and Y Axis tabs allow the user to select the label, the
scale type (linear or logarithmic) and the minimum and maximum
values for either the X or Y axis respectively.
5. Running Calculations
5.1 Launchpad
Launchpad can be accessed from the Launchpad tab. The Launchpad GUI
can change dramatically depending on the type and complexity of the loaded
model. An example of the GUI is shown in Figure 62.
Space Selector
Library Type
Selectors
Output Directory
Selector
Other Input File
and Library
Selectors
Output Files List
Custom Input
Channel Button
The top section allows the selection of the ANSWERS code and code version
to use when running the calculation, along with the value of the space
(memory) parameter passed to the code when run. The image in the top left
hand corner will change to reflect the currently selected code.
The Paths File field is used to specify a paths file for the calculation. This is
only enabled when the currently loaded file is a pre-created datsets file which
requires a paths file to run. When the field is active, the Browse button
opens a file selection dialog to allow the paths file to be selected.
The Output Directory field shows the path to the directory in which the
calculation will be run (sometimes called the working directory). This defaults
to the directory containing the loaded model but can be changed by clicking
the Browse button and selecting an alternative directory.
When a relevant model is loaded, the library type selectors will contain a list
of available nuclear data library types which can be assigned to the identified
input channels. The list does not restrict selection to suitable libraries; it
simply presents a list of available library types.
The Input Channels section lists a number of channels which Launchpad has
identified as required for the case to run. Each channel is listed next to a
drop-down box listing suitable libraries detected on the system. The available
libraries depend on the currently selected nuclear data library types and may
also depend on other library selections. Launchpad will not detect selected
but incompatible libraries. If Launchpad displays a channel which is not
required by the calculation it can be disabled by clicking the enable/disable
button to the right of the channel selector. Disabled channels are not written
to datsets files created by Visual Workshop.
The Output Files section lists the output files which will be created by the
calculation and their names. These files will be created in the selected output
directory. Output filenames cannot be modified. Custom output channels
can be created in the same way as custom input channels.
The Run button causes the current model to be run with the currently
selected output directory and libraries. It will open a monitor window (See
Section 5.2) to provide feedback on calculation progress.
When the Run button is pressed on the Launchpad tab and a case is run, a
monitor window (Figure 63) is created to display the progress of the
calculation and provide a way of viewing the results.
View Output
Button
Stop Button
The case name, start time, executable, datsets file, amount of allocated
space and output folder are displayed in the body of the window. This area
also changes to reflect when the calculation has completed (whether
successfully or not). Once a calculation has finished, the text (Finished) also
appears in the window title.
The View Output button is only available after a calculation has completed
and allows the output file to be loaded into Visual Workshop and displayed in
an editor window.
The Stop Running button can be used to stop execution of the calculation by
using the stop file facility. This facility sends a stop signal to MONK or
MCBEND calculations requesting the calculation stop cleanly at the earliest
Note that closing the monitor window does not stop the execution of the
calculation; however closing Visual Workshop completely can cause the
calculation to be terminated.
The Queue tab features two lists, the top of which lists the jobs currently in
the queue (where the front of the queue is the top of the list). When
operating, the queue sequentially runs through the list of calculations in the
Pending Jobs list. When a calculation is running, its label in the list is
appended with - Running.
When a calculation has been completed it is moved into the Finished Jobs
list.
Calculations in the queue can be reordered using the queue position controls
at the top of the queue tab. The Up button moves the currently selected
calculation up the queue. The Down button moves the currently selected
calculation down the queue. The Remove button removes the currently
selected calculation from the queue. Deleting the currently running
calculation does not stop it from running.
Pending
Jobs List
Finished
Jobs List
Timing Selection
Controls
Update
Interval
Control
Apply Timing Button
The Timing tab contains the options which control when the queue can run.
Timing can be controlled by time, date or a combination of both. The time
section allows the user to enable/disable time based operation and set the
start and stop times.
The date section allows the user to enable/disable date based operation and
set the start and stop dates.
Time and date based operations can be combined to specify that the queue
only runs between certain times between certain dates.
Note that limits imposed on the queue only affect new calculations starting. If
a calculation has started when the queue switches off, the calculation will not
be stopped and will run to completion no matter how long this may take.
The queue tool regularly checks for new calculations and checks to see
whether the currently running calculation has finished. The interval at which
these checks are made can be altered using the Update Interval control.
When either of the time, date or interval controls is changed, the Apply
button must be pressed in order for the changes to take effect.
The Options menu contains an Update option, which forces the queue tool
to check for new jobs and check on the status of the current job. Selecting
this menu item has no effect on the regular update interval.
For an ANSWERS code that has been installed in the standard ANSWERS
directory structure, operation of the Verification Tool will require little
additional effort.
The Verification Tool can be started by selecting Verification Tool from the
Tools menu (See Section 2.3.3).
Initially the Verification Tool (Figure 65) looks much like Launchpad with
controls available to select a code and code version and to set the space
(memory) to allocate the code for each run. The GUI also lists the folders it
has identified as containing the datsets files and reference outputs it will use
during verification and the working directory that test outputs will be written to.
These directories cannot be changed.
If, for the selected code version, the Verification Tool can read the contents of
the datsets and reference output directories, write to the working directory
and has found a validation configuration file then the Select button will be
enabled. Otherwise the Select button will be disabled and the Verification
Tool will display an error.
Code
Selection
Select Close
Button Button
When the Select button is pressed, the Verification Tool will load the
verification tests for the selected code and display them in a table along with
buttons for running the tests (Figure 66).
Test
Table
Start
Stop
Summary
Selection and Close
Buttons Buttons
The test results table lists the verification tests along with their status and
results. The columns show the following information:
<1 within 1
1-2 between 1 and 2
<2 within 2
2-3 between 2 and 3
3+ greater than 3
The summary section indicates whether the overall verification has been
successful. For versions of MCBEND and RANKERN it also displays the
number of results that are between each Standard Deviation band and these
totals as a percentage.
The Select All and Select None buttons provide shortcuts for selecting or
deselecting all of the tests in the test set.
The Start and Stop buttons start and stop running the selected tests. The
Stop button will cause the test sequence to stop after any currently running
test has completed.
The Write Summary button saves a summary of the verification results. This
is a text based representation of the Verification Tool window at the time the
summary was requested.
The input syntax for VRFORT in standalone mode is keyword driven and
similar to that of MONK, MCBEND and RANKERN. The same FG tracking
routines as MONK, MCBEND and RANKERN are used to perform the
volumes estimation and geometry checking.
The workhorse of the VRFORT stand alone program is the same dynamically
loaded VRFORT library that is used by Visual Workshop. The executable will
have a name of the form vrfort_<code name>.exe ( .out on Linux
systems) and should be located in the same directory as the dynamic library
with a name of the form libvrfort_<code name>.dll ( .so on Linux
systems). For example the RANKERN15A_RU1 code on windows would be:
Code vrfort_rankern15a_ru1.exe
Library vrfortlib_rankern15a_ru1.dll
These files may be located in the same directory as the assessment code, in
the above example this would be
..\ANSWERS\visualworkshop3b_ru0\lib\windows\rankern\
Name Description
The functions of multiple file input and paths file are processed correctly by
VRFORT so there is no requirement for further changes to the datsets file
used by the assessment code.
For large models it may be necessary to increase the space for the WRMS
array system using the space= command line argument as described in the
documentation for the assessment code.
datsets=filename
or
jclfil=filename
Tells VRFORT the datsets file that details the Input/Output files. If this is
omitted the current working directory is searched for the default filename
datsets on Linux or datsets.lis on Windows.
paths=filename
This optional argument tells VRFORT the paths file to use. There is no
default.
space=value
This optional argument tells VRFORT to use an increased space for the main
WRMS array. The default value is 500,000 and the units are 4 byte words.
Two methods are available for estimating volumes with VRFORT. The first
allows makes use of the tracking algorithms which also allows a check for
multiple definitions to run at the same time. The second uses a peppering
method.
The boundaries of the test volume may cut some of the Zones of the FG
model leading to incomplete estimates of their volume. Zones touching the
outer surface are flagged to warn of this possibility.
For volume estimation the execution will be much faster if the option to
search for doubly defined zones is switched off. However this latter option
does result in a more thorough testing of the FG model.
The volumes of the zones/regions which have been input by the user are
compared with the values obtained by the VRFORT routine and a value of
C/M (VRFORT calculated/user measured) is provided to help assess the
accuracy. It is common for the zones/regions not used for scoring to be
assigned a volume of 1.0 (by the user, or by the code in some situations); this
can cause the value of C/M to be very large. In such cases C/M is assigned
the value 999.999.
The surface areas of faces of FG bodies may be evaluated for all bodies
within the test volume. It is not possible for the code to assess whether a
surface is entirely within the specified cuboid volume, although if the zone it
forms a part of is entirely within the cubic volume it is safe to assume that the
surface is also. The face numbers used to identify faces of FG bodies can be
found in section 7.5.
Notes on Sheet 1
1. This feature sets the loop number to be used when the model to be
tested is loaded. It is the master loop number.
2. The random number generators used for sampling start points and
directions for pepper and track methods may be reset for each volume
calculation. By default the code uses fixed values 123 and 456 set once
at the start.
3. A search for parts of the problem space which have been allocated to
more than one FG zone may be requested or cancelled on each pass. By
default the option is off. The option retains its current setting until re-
defined. Note that the pepper method does not search for multiple
definitions.
4. Selects the method to be used when estimating the volumes. If the track
method is used then surface area estimation can also be requested.
RANDOM NUMBER
GENERATORS Note 2
IR1 IR2
Note 3
CANCEL MD
Continue
As with Sheet 2
Required
MVOLUMES Note 5
END
1. The cuboid volume for the current test is entered in the form of low and
high values for each dimension X, Y and Z.
2. The calculation will stop when one of the maximum samples (NSAMS) or
the maximum time (NSECS) in seconds is reached.
4. Two methods exist for specifying the required standard deviation. Either
the keyword ALL followed by the required percentage standard deviation
(e.g. 2.0 for 2%), or, the required percentage standard deviation followed
by the number of the material that it applies to. The ALL keyword refers
to positive numbered materials, excluding 0 and special/albedo materials.
Special/albedo materials can be included when material numbers are
listed individually.
5. The keyword LIMIT is used to specify additional input to stop the run after
a pre-determined number of tracks (NSAMPS) when the standard
deviation has been met for the materials that have actually been found.
Thus if a limit of 2000 tracks was specified, the code would stop
processing if for all the materials that have been found, the specified
standard deviation has already been reached. This allows the user to
specify standard deviations for materials that may not be in the cuboid
(sheet 2) that is being used. The code will still stop when the required
standard deviations for all other materials have been met.
6. The DIVISIONS option specifies how many divisions the cuboid should
be divided into when tracking Hole materials. This option only applies to
the Track method of volume estimation. The default value is 1000.
XLO XHI
YLO YHI Note 1
ZLO ZHI
NSAMS
Note 2
NSECS
SD Note 3
LIMIT
Note 5
NSAMPS
DIVISIONS Note 6
NDIV
REPORT Note 7
NSAMPS
Return to Sheet 1
For the single face FG bodies SPHERE, XREL, XTORUS etc. the face
number is 3. For the bodies XP, IHS the face number is 1.
6 z
z
RB
y RT
H
1 ZL 4 2 x
y 3 1 2
YL 3
5 XL x
BOX XL YL ZL XCONE RB RT H
z
z 2
R
y
H x 5
H
y 4
1 2 1 3
3 L P Q
B
x
XROD R H
+XZPRISM B H L P Q
z
2
H
4
6 7
y x y
8 5
X D
3
z 1
y XHEX D H
The function identifies the faces of tetrahedra that are on the surface of each
body in the TETMESH file. A derived POLY body is defined by the node
numbers on its surface and a set of triplets of node numbers that form its
triangular facets.
Two bodies in a TETMESH file may share a common boundary in two ways.
The following sketches represent sections through a TETMESH
approximation of a water filled pipe.
2. ZXY causes the coordinate triplets read from the TETMESH file to be
cycled such that: ZX; X Y; YZ.
YZX causes the coordinate triplets read from the TETMESH file to be
cycled such that: YX; Z Y; XZ
3. The coordinates read from the TETMESH file will be scaled xS to convert
from, say, mm to cm.
4. A voxel ratio R will be written in the header data of each POLY body. The
default is 6.0.
6. A container body will be derived from the node coordinates. It will have
the designated shape and envelop the entire set of POLY bodies with a
clearance of 0.1cm. If CLUSTER has been specified the body will be
appended to the list of POLY bodies.
8. If the materials in the TETMESH file are named and the POLY data are
written as a CLUSTER then the prefix STRING will be added to the
material names of each POLY body and, if it is named rather than
numbered, to the 'otherwise' material.
9. This part of the input, and in fact the only require part since all other
commands are optional, is the TETMESH file to be processed. This can
be pasted into the input data or another text file can be referenced using
the embedded file syntax.
BEGIN TETPOLY
ORIGIN
Note 1
X0 Y0 Z0
SCALE S Note 3
VRATIO R Note 4
CLUSTER Note 5
Note 6
END
BEGIN TETPOLY
otherwise 0 cluster ! control commands
ZXY prefix T01 ! control commands
ZROD VRATIO 6.0 ! control commands
<FILE1 ! embedded TETMESH file
END
The OBJ CONVERT function converts an OBJ format geometry file to a set of
POLY bodies. It is very similar in function to the TETPOL option.
Note that the OBJ CONVERT function must be used independently of any
other function of VRFORT in standalone mode and the separate flow chart for
input, see below, must be used.
The OBJ format file can contain surfaces that are complete volume definitions
and it can contain surfaces that are incomplete volumes. Only surfaces that
define complete volumes can be used in FG.
Cases have been encountered where complete volumes exist in the CAD file
and the exported OBJ file objects have occasional extra surfaces wrapping
parts of the complete volumes. For this situation and other possible
situations where incomplete surfaces exist an option is provided to exclude
these objects from the converted list of POLY bodies.
If the ray trace image shows tracking errors these may be caused by
incomplete surfaces. This can be confirmed by viewing the offending body in
the wire frame which is able to view the incomplete surface.
To remedy the problem the offending POLY body can simply be deleted from
the file or the EXCLUDE option used to exclude the object from the
conversion process and the converter re-run. To identify the original object
st
the object number is included in a comment on the 1 line of each POLY
body.
2. The coordinates read from the OBJ file will be scaled xS to convert from,
say, mm to cm.
3. A voxel ratio R will be written in the header data of each POLY body. The
default is 6.0.
5. A container body will be derived from the node coordinates. It will have
the designated shape and envelop the entire set of POLY bodies with a
clearance of 0.1cm. If CLUSTER has been specified the body will be
appended to the list of POLY bodies.
7. If material references exist in the OBJ file and the POLY data are written
as a CLUSTER then the prefix STRING will be added to the material
names of each POLY body and, if it is named rather than numbered, to
the 'otherwise' material.
8. This option specifies a list of objects in the OBJ file that will be excluded
from the conversion. The objects are referenced by the sequence they
appear in the OBJ file.
ORIGIN
Note 1
X0 Y0 Z0
SCALE S Note 2
VRATIO R Note 3
CLUSTER Note 4
Note 5
EXCLUDE
Note 8
list of object numbers
END
8. Troubleshooting
This section describes problems that might be encountered when installing or
using Visual Workshop. For each problem, one or more possible solutions
are offered.
The list is not exhaustive. If encountered, any further problems and solutions
will be added to the ANSWERS Customer Website. If a solution cannot be
found in either this section or on the website, please contact the ANSWERS
Hotline.
The messages shown are displayed in the console window from which Visual
Workshop was launched. If you start Visual Workshop by double clicking
VisualWorkshop.exe on a Windows PC, a console window will open to
display such messages. If you start Visual Workshop by double clicking
VisualWorkshop in Linux, no console window will appear.
This means that Visual Workshop cannot load one or more of the graphics
libraries it needs to run the 3D Wireframe View. This is because one or more
of the required Windows DLL libraries is missing.
When run from a DOS/Command prompt with debug on, Visual Workshop
may report the following message related to the problem:
To fix the problem, install the Microsoft Visual C++ 2008 Redistributable
Package (x86) which can be freely downloaded from the Microsoft website.
If environment variable DISPLAY is correctly set and there are still problems
you may need to enable remote access to the display using the UNIX xhost
command.
Visual Workshop has been designed so that you do not need to have
ANSWERS products installed to be able to explore most of the Visual
Workshop functionality. Some options, like launching jobs, will only be
available if you have an appropriate ANSWERS product installed and visible
to Visual Workshop.
If, when loading a model file, you see a message of the form:
Increase the memory allocation. Some large models can cause the
Wireframe parser to require a large amount of memory. The default amount
of memory requested by Visual Workshop can be increased using the
following argument with Visual Workshop:
If you see a message, when selecting the 3D or 2D ray trace tabs, of the
form:
This means that the VRFORT library has been unable to run correctly. It
could be because an incorrect library has been used. Or, it may be
associated with the following message at the terminal at the DOS prompt
(Windows):
This means that the computer does not have enough resources to load the
DLL. Possible solutions are to close other software and reduce the pre-
allocated JRE stack size (see Appendix B - Performance Start-up
Arguments).
If you see a message, when selecting the 3D or 2D ray trace tabs, of the
form:
This means that the VRFORT library cannot be loaded. This is because one
or more of the Windows DLL libraries is missing.
To fix the problem, install the Microsoft Visual C++ 2008 Redistributable
Package (x86) which can be freely downloaded from the Microsoft website.
If you see an error dialog, when loading a model or selecting the 3D or 2D ray
trace tabs, of the form:
WRMS Error ID:101 Error in RMSO. See the model log for details.
This can be caused by read only file permissions on the Visual Workshop
install directory or the directory containing the loaded input file. This problem
can be fixed by disabling the VRFORT pre-loader in the Preferences dialog or
by setting the TMPDIR environment variable to a writable directory.
This means that the VRFORT library cannot be loaded. To fix the problem,
set the LD_LIBRARY_PATH environment variable to the folder containing the
VRFORT executable.
While Visual Workshop should not have any problems loading and displaying
the majority of users models on a moderately powerful computer, there are a
few model features which can have more of an impact on application
performance than others
In general, the larger the number of parts and bodies a model has, the longer
it will take to load into the application and to display in the wireframe view.
Users should take into account that where a part is replicated in multiple
positions throughout a model, each replication is the equivalent to the
creation of a new part, so having 100 replications of one part will have the
same effect on performance as loading a model with 100 parts.
These problems affect the model parser and wireframe view more than the
ray trace views, so users encountering problems should consider disabling
the wireframe display using the environment variable outlined in Appendix C -
Environment Variables and using the ray trace views only to display their
model.
It is also important to note that the 3D Wireframe view and related results
display functionality are designed to be run in a hardware enabled graphics
environment such as on a desktop PC or laptop. Visual Workshop can be
used via a remote connection, however when run in this way, the
VW_DISABLE_WIREFRAME environment variable outlined in Appendix C -
Environment Variables should be used to disable the 3D Wireframe view as it
is not designed to be run remotely. The 2D Ray Trace and 3D Ray Trace
views can safely be used across a remote connection.
As part of the VRFORT rendering process in the 2D Ray Trace and 3D Ray
Trace views, an output file is created which contains debug information and
which lists detected errors and double definitions. This output file can be
viewed by clicking the Output button on the 2D Ray Trace or 3D Ray Trace
view Info Toolbars.
In order for the 2D Ray Trace and 3D Ray Trace views to function correctly,
Visual Workshop must be able to write this output file somewhere on the file
system. To avoid file access permissions, Visual Workshop will attempt to
find a suitable folder in which to write the output file by searching down the
following list:
If Visual Workshop does not have permission to write into any of the
directories above, it will attempt to write the output file contents to the screen.
In order to ensure that output file contents are available for checking for
errors, you must ensure that Visual Workshop and the current user has write
permissions for one of the directories listed.
Appendices
[-debug] filename
-clean
--enable-stereo
Starts the Launchpad auto-test system. Optionally runs the test sequence in
automatic mode which runs the tests, automatically creates a test report and
then exits.
Starts the VRFORT (Ray Trace) auto-test system. Optionally selects the
VRFORT library to load by specifying the code name and version to load a
compatible library for. Optionally specifies whether failures should be
-test parser
Starts the input parser auto-test system. This tests the input parser used to
read in data for the 3D Wireframe View.
Starts the wireframe auto-test system. This tests the 3D Wireframe View.
Starts the WIMS 2D view auto-test system. This test the WIMS 2D View.
VisualWorkshop.exe
To the following:
VisualWorkshop.exe -JXmx512m
This must be done before any specifying any arguments listed in Appendix A.
can appear when the specified value is too large and is stopping Visual
Workshop starting correctly.
When viewing models which use CAD in the 2D or 3D Ray Trace Views, it
may be necessary to supply additional memory for the CAD processing. This
can be done by adding an additional argument to the Visual Workshop launch
command, from:
VisualWorkshop.exe
To the following:
VisualWorkshop.exe -JXss10m
This must be done before any specifying any arguments listed in Appendix A.
Change behaviour
VW_DISABLE_WIREFRAME
Setting this environment variable to the value 1 will prevent the WireFrame
display from initialising. The feature is to enable Visual Workshop to run on
systems with no 3D graphics (OpenGL) support.
The following environment variables control the way Visual Workshop looks
for other ANSWERS codes. They are in the form of a search path. On
windows each folder in the search path is separated with a ;. On Unix/Linux
the separator is :.
ANSWERS_HOME
This environment variable is used to provide a list of folders, in the standard
ANSWERS structure, to search for ANSWERS codes and data libraries. On
a Windows PC, Visual Workshop additionally checks in the default folder
c:\answers.
CODES_SEARCH
This environment variable is used to provide a list of additional folders to
search for ANSWERS codes.
LIBRARIES_SEARCH
This environment variable is used to provide a list of additional folders to
search for data libraries.
Coffee.dat
This example consists of a geometry only model which uses hole geometry.
This example consists of a RANKERN input file which makes use of dose
points, scatter bodies and a complex source body.
Practical9o1.dat
This example consists of a MONK input file from the Introduction to MONK
course demonstrating the use of hole geometries.
simpleDD.dat
simpleUNDEF.dat
Ut-example.dat
This example consists of a MCBEND model which uses a Unified Tally body
for scoring. It is supplied with an output file (ut-example.out) which contains
Flux results scored in the Unified Tally body which demonstrates the 3D
Contour, 2D Contour and 2D Cell results display styles.
WorkShopFlaskSM.dat
ANSWERS Hotline
Contact Details: