This appendix is a reference location for all of the Fluent-specific Scheme macros described in part two of this guide. Each macro is listed with a short description of its purpose and a link to the section of the guide that explains the macro in greater detail. The arguments of each macro are not listed in this section due to the need for further explanation of each of these arguments. Explanation of the arguments of each macro can be found in the corresponding sections that are linked. Macros are ordered by the order in which they appear in the guide.
| Macro | Purpose | Link |
|---|---|---|
| (rp-var-define) | Creates a new RP variable. | Creating an RP Variable |
| (make-new-rpvar) | Creates a new RP variable only if it does not already exist. | Creating an RP Variable |
| (rpsetvar) | Changes the value of an RP variable. | Changing an RP Variable |
| (%rpgetvar) | Obtains the value of an RP variable. | Accessing the Value of an RP Variable In Your GUI |
| (ti-menu-load-string) | Loads a string command into the Fluent TUI. Used in this context in the .fluent file. | The .fluent File |
| (cx-create-panel) | Creates a new dialog box. | cx-create-panel |
| (cx-show-panel) | Displays an already created dialog box. | cx-show-panel |
| (cx-create-table) | Creates a table for organization of interface elements on a dialog box. | Usage |
| (cx-create-integer-entry) | Creates a new integer entry field for a dialog box. | cx-create-integer-entry |
| (cx-set-integer-entry) | Sets the value of an integer entry field. | cx-set-integer-entry |
| (cx-show-integer-entry) | Obtains the value of an integer entry field. | cx-show-integer-entry |
| (cx-create-real-entry) | Creates a new real number entry field for a dialog box. | cx-create-real-entry |
| (cx-set-real-entry) | Sets the value of a real number entry field. | cx-set-real-entry |
| (cx-show-real-entry) | Obtains the value of a real number entry field. | cx-show-real-entry |
| (cx-create-text-entry) | Creates a text entry field for a dialog box. | cx-create-text-entry |
| (cx-set-text-entry) | Sets the text in a text entry field. | cx-set-text-entry |
| (cx-show-text-entry) | Obtains the text in a text entry field. | cx-show-text-entry |
| (cx-create-button-box) | Creates a button box for check boxes and radio buttons. | cx-create-button-box |
| (cx-create-toggle-button) | Creates a check box or option button for a dialog box depending on the radio-mode attribute of the button box it resides in. | cx-create-toggle-button |
| (cx-set-toggle-button) | Sets the state of the check box or option button to selected or cleared through the Boolean values true and false. | cx-set-toggle-button |
| (cx-show-toggle-button) | Obtains the state of a check box or option button. | cx-show-toggle-button |
| (cx-create-button) | Creates a button for a dialog box. | Usage |
| (cx-create-list) | Creates a list for a dialog box. | cx-create-list |
| (cx-create-drop-down-list) | Creates a drop-down-list for a dialog box. | cx-create-drop-down-list |
| (cx-set-list-items) | Populates a list or drop-down list with list items. | cx-set-list-items |
| (cx-set-list-selections) | Sets what item/items are selected in a list or drop-down list. | cx-set-list-selections |
| (cx-show-list-selections) | Obtains the selection/selections of a list or drop-down list. | cx-show-list-selections |
| (cx-add-menu) | Adds a new menu to the right of the Fluent ribbon tabs. | Usage |
| (cx-add-hitem) | Adds a new submenu to an already existing menu on the right of the Fluent ribbon tabs. | Usage |
| (cx-add-item) | Adds a new menu item to an already existing menu or submenu on the right of the Fluent ribbon tabs. | Usage |
| (map thread-name (get-face-threads)) | Obtains all of the names of the face threads of the mesh currently loaded in Fluent. | Dialog Box Example |
| (%run-udf-apply) | Invokes a currently loaded UDF using
the DEFINE_EXECUTE_FROM_GUI statement. | Dialog Box Example |