4.1. Usage Details

4.1.1. Purpose of this wizard

The Material Storage is a complete application that runs within Rocky and enables you to access and interact with a material repository.

The material repository can be the Ansys Granta or a local repository on your machine. The local repository is a database that the Material Storage can create and access.

4.1.2. Functionality details

The Material Storage was built to facilitate three common situations related to the calibration procedure:

  • Get previously calibrated material and use it for a new setup

  • Save a new calibrated material into the database for later use

  • Remove specific information from the database that was saved incorrectly or is outdated

Data visualization is available within the wizard, enabling users to open all information related to the entities.

Also, there are review capabilities to select and even rename entities.

4.1.3. Limitations and Considerations

  • The Material Storage can handle STL files for custom particles, like Custom Polyhedron or Custom Shell. However, when you load the STL into the particle, you should select the default scale in ‘m’.

  • This script does not support handling flexible and breakable particles.

4.1.4. Wizard Options

4.1.4.1. Menu Options

This wizard sript menu has a few options. Currently, there are menus for File, Options, and Help, which are shown in the figures below:

Figure 4.1: Material Storage menu for File.

Material Storage menu for File.


Figure 4.2: Material Storage menu for Options.

Material Storage menu for Options.


Figure 4.3: Material Storage menu for Help.

Material Storage menu for Help.


Table 4.1: Menu options

MenuOptionsDescription
FileHomeThis button resets the wizard.
CloseThis button closes the wizard.
OptionsGet MaterialThis button accesses information from the database and imports it into Rocky.
Add MaterialThis button accesses information from Rocky and exports it to the database.
Remove MaterialThis button removes information from the database.
HelpManualThis button opens the manual.

4.1.4.2. Home User-Interface View

The home user interface provides the definition of the database to be used and the ways you can interact with it.

The Select a database button opens a new dialog box to define the database.

Figure 4.4: Material Storage options to open the database selection.

Material Storage options to open the database selection.

The Material Storage wizard enables users to connect to an Ansys Granta server or to use a local repository. In case you choose a local repository, you need to define the folder location on your machine where the wizard can locate the local repository.

Figure 4.5: Material Storage options to define the database.

Material Storage options to define the database.

Table 4.2: Options for the Define database dialog

OptionsDescriptionRange
SourceThis field defines the type of database accessed.Local, Ansys Granta
AddressThis field defines the location address of the database.Path


Note:  In case you do not have a local repository, you can select an empty folder and press Validate/Save button on the Define database dialog. Then, the wizard will ask permission to create a local database file.


Figure 4.6: Material Storage options to view information from selected database.

Material Storage options to view information from selected database.

Database Information box shows the type of database and where it is currently used.

Figure 4.7: Material Storage options to view information from selected database.

Material Storage options to view information from selected database.

Material Options box has the three ways you can interact with the database, which are the same options available on the Option menu:

Table 4.3: Material Options

OptionsDescription
Get MaterialThis button accesses information from the database and imports it into Rocky.
Add MaterialThis button accesses information from Rocky and exports it to the database.
Remove MaterialThis button removes information from the database.

4.1.4.3. User-Interface for Database Interaction Options

All three options to interact with the database lead to a similar user interface. The window structure is shown below:

Figure 4.8: User-interface of “Add Material” option.

User-interface of “Add Material” option.

Regardless of the selected option (Get Material, Add Material, or Remove Material), you will visualize the same entities panel. This panel shows the Materials and Materials Interactions available in the source (the source depends on the selection and can be the database or Rocky):

  • Boundary Materials List: Details all the available materials for boundaries.

  • Particle Materials List: Details which particles are available. The particles are sorted by materials.

  • Materials Interactions List: Shows the available interactions between the selected materials for boundaries and particles


Note:   You can access this tool by right-clicking the desired entity and selecting Entity Data. You can also open the same panel by double-clicking the desired entity.


This section of the user interface also has three buttons:

  • Entities Data: This button opens a new dialog to show data visualization of all selected entities.

  • Review to Export: This button opens a new dialog to review the selected entities and then proceed with the expected function.


    Note:  This button changes depending on the option you have previously selected. If you selected Get Material, you will see Review to Import, if you selected Remove Material, you will see Review to Remove.


  • Home: This button resets the wizard.

Figure 4.9: New dialog generated by “Review to Import” button.

New dialog generated by “Review to Import” button.

In case you choose the Get Material option, the Review to Import button opens the Import Data dialog. In this dialog, you will view all entities selected. Besides that, if you have more than one particle selected, you need to specify which Particle will be used to import models. After review, clicking the “Import to Rocky” button will bring all material information into the Rocky setup.

Figure 4.10: New dialog generated by “Review to Export” button.

New dialog generated by “Review to Export” button.

In case you choose the Add Material option, the Review to Export button opens the Export Data dialog. In this dialog, you will view all selected entities. Also, you need to double-check which materials interactions you want to export. After reviewing it you can click on the Export from Rocky button to send all material information to the database.

Figure 4.11: New dialog generated by “Review to Remove” button.

New dialog generated by “Review to Remove” button.

In case you choose the Remove Material option, the Review to Remove button opens the Remove Data dialog. In this dialog, you will view all entities selected. And you need to double-check which materials you want to remove. After review, clicking on the Remove from Database button removes all material information from the database.


Note:  The dialogs for review (except the Remove panel) have additional rename tools. You can double-click on the Boundary or Particle material name and then rename the entity.


4.1.5. Setting up and using the Wizard

  1. Download the Material Storage zip and extract all files. Copy both the script_material_database.py script and the script_material_database.py.files folder to the %HOMEPATH%/Documents/Rocky/Scripts.

  2. From the PrePost script panel, launch the Material Storage by clicking its Play script button.

  3. From the Material Storage home user interface, define the database you intend to use.


    Tip:  Check your database information in the “Database Information” box.


  4. Select the option you intend to interact with the database (Get Material, Add Material, or Remove Material)

  5. Select the desired materials, then go ahead with the review and execute the function according to the selected option. According to the selected option, you will have:

    • Get Material: The entities will be created and defined within your Rocky

    • Add Material: The entities will be created and defined within your database. You will be able to access this information later.

    • Remove Material: The entities will be removed from the database.