The VMCalculator Display

The VMCalculator Display

A VMCalculator window is divided vertically into two sections. On the left side is a hierarchical list which contains all of the objects in the current session and is known as the contents list. Whatever object is currently selected in the contents list, is displayed on the right side of the window in the tabbed object view.

The divider between the contents list and the object view can be dragged to the right or left to change the relative sizes of the two areas.

You can open additional windows to view different parts of your model by selecting the New Window item from the File menu.

Contents List

The contents of any session are displayed in a hierarchical tree in the contents list. The base of this tree is a folder object called "Session". A folder can only contain three types of object:

Example Contents List

Other folders, nested to any depth
Property packages, which define a thermo model
Fluids

Collectively these types of objects are known as folder objects. Clicking on the triangles to the left of a folder name (+ or - on Windows) will reveal or hide the contents of that folder in the list.

At the bottom of the contents list there is special entry called History, which is a sort of convenience item, rather than an actual folder object. When it is selected, the right hand side of the window displays the Basic code that has been executed in response to user actions in the interface. This is intended as a convenient place for users to grab example code for use in their model building, but I am not sure how useful it really is and have only retained it so far as it is at least harmless.

Contents List Context Menu

Right clicking (Control Click on one button Mac) on an object in the contents list will bring up a context menu which will allow you to perform a number of actions related to that object:

Calculate Causes the code associates with the object to be executed.

Copy Object Path Copies the path of the object to the clipboard. Object paths are dot separated lists of the parent folders, beginning with Session and ending with the object name, for instance;
"Session.RT ExampleGP.Feed"

Copy Object Copies the object itself to the clipboard.

Add Folder from Clipboard Only available when both the object clicked on and the contents of the clipboard are folder objects. A new folder with the contents of the clipboard will be created as a sub-folder of the clicked on folder and will have the same name as the copied object. If this name is already in use in the target folder, an appropriate number is appended to make it unique.

Replace Object With Clipboard Replaces the object clicked on with the object copied to the clipboard. This is only available if the clipboard contains a compatible object (e.g. a folder cannot be replaced by a fluid.)

Rename Object Pops up a small dialog where you can type a new name for the object.

Delete Object Deletes the object and if it is a folder, any of its contents. If a property package is deleted, then any fluids that were created using it as a basis, are also deleted.

Add Fluid Only available for folder objects, this pops up a small dialog where you can create a fluid inside the folder. A property package must be available to associate with the fluid.

Add Folder Only available for folder objects, this pops up a small dialog where you can create a sub-folder inside the folder clicked on.

Add Folder From Library Only available for folder objects, this will open the library download dialog, where you can select a model stored as a folder from the online library. The new folder will be created as a sub-folder of the folder clicked on and will have the same name as the library folder. If this name is already in use, an appropriate number is appended to make it unique.

Save to Library Opens the library upload dialog, which allows you to save the object clicked on to the public online library.

Replace with Library Object Opens the library download dialog, where you can select an object from the online library, which will replace the object clicked on. The object begin replaced must be the same type (folder, fluid or property package) as the one replacing it.

Add Folder From File Only available for folder objects, this will create a file open dialog, where you can select a model previously stored as a folder on your local disk. The new folder will be created as a sub-folder of the folder clicked on and will have the same name as the library folder. If this name is already in use, an appropriate number is appended to make it unique.

Save Object to File Opens a file save dialog, which allows you to save the object clicked on to your local disk drive.

Replace with File Object Creates a file open dialog, where you can select an object previously stored on your local disk, which will replace the object clicked on. The object begin replaced must be the same type (folder, fluid or property package) as the one replacing it.

Note that the context menu does not change the selected item in the list, but does work on the object that was right clicked on.

Calculate	Causes the code associates with the object to be executed.
Copy Object Path	Copies the path of the object to the clipboard. Object paths are dot separated lists of the parent folders, beginning with Session and ending with the object name, for instance; "Session.RT ExampleGP.Feed"
Copy Object	Copies the object itself to the clipboard.
Add Folder from Clipboard	Only available when both the object clicked on and the contents of the clipboard are folder objects. A new folder with the contents of the clipboard will be created as a sub-folder of the clicked on folder and will have the same name as the copied object. If this name is already in use in the target folder, an appropriate number is appended to make it unique.
Replace Object With Clipboard	Replaces the object clicked on with the object copied to the clipboard. This is only available if the clipboard contains a compatible object (e.g. a folder cannot be replaced by a fluid.)
Rename Object	Pops up a small dialog where you can type a new name for the object.
Delete Object	Deletes the object and if it is a folder, any of its contents. If a property package is deleted, then any fluids that were created using it as a basis, are also deleted.
Add Fluid	Only available for folder objects, this pops up a small dialog where you can create a fluid inside the folder. A property package must be available to associate with the fluid.
Add Folder	Only available for folder objects, this pops up a small dialog where you can create a sub-folder inside the folder clicked on.
Add Folder From Library	Only available for folder objects, this will open the library download dialog, where you can select a model stored as a folder from the online library. The new folder will be created as a sub-folder of the folder clicked on and will have the same name as the library folder. If this name is already in use, an appropriate number is appended to make it unique.
Save to Library	Opens the library upload dialog, which allows you to save the object clicked on to the public online library.
Replace with Library Object	Opens the library download dialog, where you can select an object from the online library, which will replace the object clicked on. The object begin replaced must be the same type (folder, fluid or property package) as the one replacing it.
Add Folder From File	Only available for folder objects, this will create a file open dialog, where you can select a model previously stored as a folder on your local disk. The new folder will be created as a sub-folder of the folder clicked on and will have the same name as the library folder. If this name is already in use, an appropriate number is appended to make it unique.
Save Object to File	Opens a file save dialog, which allows you to save the object clicked on to your local disk drive.
Replace with File Object	Creates a file open dialog, where you can select an object previously stored on your local disk, which will replace the object clicked on. The object begin replaced must be the same type (folder, fluid or property package) as the one replacing it.

In addition to using the context menu, an object can be deleted from the contents list by selecting it and pressing the delete or backspace key. If the object is a folder, then all its contents will also be deleted. If the object is a property package, then all fluids that use it will also be deleted.

Object View

The object view will change depending upon which of the three object types is selected in the contents list. These are described in more detail on the following pages:

All of three object views have tabs along the top that allow you to view different aspects of the selected object.

For information about the status display that appears immediately below the object view, as well as the halt button that appears in the lower right when the program is calculating, please go to the Status and Halt page.

VMCalc Home Online

Guide Home

Functions

Display

Menus

The VMCalculator Display

The VMCalculator Display

Contents List

Example Contents List

Contents List Context Menu

Object View