Incorporating a Module into the FRAMEwork System (FRAMES)


Title Page
Legal Notice
Table of Contents
Introduction
Example
STEP 1
STEP 2
STEP 3
STEP 4
STEP 5
APPENDIX A
APPENDIX B
APPENDIX C
APPENDIX D
 

Step 5: Categorize the Model

Often module developers are tasked with couching models in relationship to other models. The Domain Editor in FRAMES 2.0 provides a mechanism to organize how models are shown. It behaves in a similar manner to the other editors, but it allows you to state the categories of models available to the user. This information controls the model tree that is shown in the Simulation Editor, where the models are connected and used in a simulation.

Using the Domain Editor, different systems can co-exist as different domains. You can add "Classes" and "Subclasses" to each domain as required to define the collection of modules. The Domain Editor does not directly define where your model lies as much as allows the user to conceptualize their modeling before they choose modules, put in data, and run the simulation.

Within a domain, modules are categorized by groups and subgroups. There can be multiple instances of a module in a domain. When a module is added to a group or subgroup, the user may not modify the icon to be displayed in the FRAMES. If the module has an icon associated with it, that icon will be displayed. However, if a module does not specify an icon, then an icon will automatically be determined from the group or subgroup the module belongs to.

To add a module to a group,

  1. On the Editors menu, click on "Domain Editor".
  2. Select a group in the tree. A list of modules associated with the group will be provided in the available list.
  3. Click on the "Add Module" button.
  4. A form with available modules will appear. Locate a module and click the "Add Module" button. Note: only modules belonging to a specific class are available to be added. A module?s class and the domain?s class in which the group, or subgroup, resides must match to add the module.
  5. Verify that the module has been added by examining the list in the panel on the right side. Notice that an icon appears next to the module. This is the icon that will be displayed in FRAMES 2.0 for the given module under this group.

Sometimes modules are more appropriately added to a subgroup instead of a group. For example, if the group was "Water Models" and the subgroups "River," "Groundwater," and "Vadose Zone," an aquifer model might be placed under the "Groundwater" subgroup. To add a module to a subgroup,

  1. On the Editors menu, click on "Domain Editor".
  2. Select a subgroup in the tree. A list of modules associated with the subgroup will be provided in the available list.
  3. Click on the "Add Module" button.
  4. A form with available modules will appear. Locate a module and click the ?Add Module? button.
  5. A form with available modules will appear. Locate a module and click the "Add Module" button. Note: only modules belonging to a specific class are available to be added. A module?s class and the domain?s class in which the group, or subgroup, resides must match to add the module.
  6. Verify that the module has been added by examining the list in the panel on the right side. Notice that an icon appears next to the module. This is the icon that will be displayed in FRAMES 2.0 for the given module under this subgroup.
Step 1: Add Units and Measures
Step 2: Define model inputs and boundary conditions
Step 3: Invoke the model
Step 4: Provide a description of the model

Battelle Logo
Home | Security and Privacy | Contact Us