The Summary class is useful for extracting data that is written to the Summary File. Information at outlets such as flow rate, pressure, and temperature is of particular interest. Note that the methods allow extraction of data at a specific inlet or outlet as referenced by an id, so it is necessary to know the id of an opening when writing the method.
Summary Class Properties
Note that all are Read-only:
| Summary Properties | Type | Values |
|
date |
String | |
|
version |
String | |
|
inputTime |
Number | |
|
analysisTime |
Number | |
|
outputTime |
Number | |
|
totalTime |
Number | |
|
maximumDynamicMemory |
Number |
Summary Class Methods
| Summary Methods | Description | data return |
|
Summary(filename) |
filename = file name and path of summary file (string) |
no |
|
load() |
loads the summary file |
no |
|
sectionExists(section) |
Query if a section exists; section = section in the summary file (string) |
yes |
|
quantityExists(section,quantity) |
Query if a quantity exists; section = section in the summary file (string); quantity = quantity in the summary file (string) |
yes |
|
Array sections() |
Returns a list of sections in the summary file |
yes |
|
Array quantities(section) |
Returns a list of quantities within a section; section = section in the summary file (string) |
yes |
|
Quantity quantity(section,quantity) |
Returns the value of a quantity; section = section in the summary file (string); quantity = quantity in the summary file (string) |
yes |