These catalogs are defined in an excel (*.xlsx) file. Each row of the worksheet defines a complete simulation. The columns of the worksheet indicate created object types, property settings, filtering, and naming.
Not all simulation conditions can be specified explicitly through the spread sheet. These include: certain object types, multiple child geometries, boundary conditions. For these cases you are encouraged to use the Base Document column to indicate a base model with the necessary complex parameters already set. Then use the excel spread sheet to indicate the few parameters that do change over your database of systems.
A basic catalog is available here to download –
Simple Catalog.xlsx . This is a good place to start to quickly get an idea how this capability works.
Ignored for now
Used to group cases. Provides a filtering mechanism in the GUI.
The name of the case. Each row should have a unique value.
- Base Document
The base template document to use. Leave blank for the default built-in document. If a value is provided, the template catalog is searched. See User Document Catalogs for more information. This column is also useful for defining more complex base model systems that include boundary conditions, or otherwise have many changes.
Specify the fluid model type. Can be one of:
Creating new objects¶
New static bodies are defined by specifying a new column
Static 1. The value can be any geometry name from the geometry catalog. So to make a standard cylindrical tank, you could use a value of
Cylindrical Tank on a given row. In this way, you specify an parent object type, and its associated child geometry type. The index allows for multiple objects to be created and referenced.
The available parent object types are:
The available child object types are listed in the geometry catalog.
Column names reference¶
The column names to change an object property value must indicate the object reference and its property name. For example, a column name of
Static 1 Diameter, would refer to the Diameter property of the associated geometry of the first static body. Some objects are special in that there is only 1, so the index is not necessary. For example the
Fluid NewtonianNu would refer to the fluid objects kinematic viscosity property.
Property names should have no spaces
Property names are searched over the parent, and then the child object in the object reference
Property names are matched with a case-insensitive search
If a property is not found, an error will be shown at time of case creation or during the check command
Some properties are vector types, and therefore allow for a component name to be specified in the column name
To further illistrate this convention, see the below examples:
Static 1 Diameter ~~~~~~~~ ~~~~~~~~ ^- Object reference ^- Property Name (no spaces)
To specify a vector location –:
Moving 1 Location X ~~~~~~~~ ~~~~~~~~ ~ ^- Object reference ^- Property Name ^- Property vector x-component
Some object types are special, so you may refer to them quickly -
SimParams-> Simulation Parameters
Lattice-> Main lattice object
Fluid-> Fluid model
Row values are specified according to their property type. The available types in the GUI are –
Simply put true or false as the value in the spread sheet. Excel recognizes this type
Indicate the value by writing the choice into the row value. For example, specify the fluid rheology type as power law with a value of
PowerLawin the cell value.
- Text value
Enter the string/text value in the cell
- Floating point value
Enter the floating point number in the cell
Values like -1, 0, 1, 2, 3, …
Browsing your catalog in the GUI¶
Make sure you have setup your Template Catalog Path on the Preferences form. Save your excel catalog file in this directory. See User Document Catalogs for more information.
In the main menu, click File -> New from excel catalog.
Your defined catalogs will show in the below form
Select your catalog, filter, and case, and click OK
The case is parsed/verified. A confirmation form lists any errors found in the definition.
The case is loaded into the GUI and you can continue pre-processing or simply run your case.
- Select Catalog
Select the excel catalog you want to browse
- Filter by Group
If you have defined groups, you may use this column to filter and down select the displayed case listing. Optional
- Select Case
The case listing, determined by your catalog and filter selection. The Name value is indicated here.
- Case Properties
A listing of the defined (non-empty) properties in the case. The can click Check Case to verify the case definition is valid.
As you develop your excel catalog, you can iterate on changes by saving your Excel document, then clicking Refresh on the catalog form