Expand/Collapse all
1. Software Overview
1.1. The Ansys Product Improvement Program
1.2. Capabilities Charts
1.2.1. Rocky Particle Shapes and Capabilities
1.2.2. PyRocky
1.2.3. About This Version of Rocky
1.3. Program Limitations
1.3.1. Physics and Force Limitations
1.3.1.1. Coarse-Graining Settings Limitations
1.3.2. Geometry Limitations
1.3.3. Particle and Inlet Limitations
1.3.4. Materials and Interactions Limitations
1.3.5. SPH Limitations
1.3.6. Ansys and CFD Coupling Limitations
1.3.7. Display and Processing Limitations
1.3.8. Module Limitations
1.3.9. Known Limitations in Ansys Rocky
1.4. System Requirements
1.5. Best Practices
1.5.1. Best Practices for Installing a New Version of Rocky
1.5.2. Best Practices for Faster Processing
1.5.3. Best Practices for Creating Geometries for Import
1.5.4. Best Practices for Setting up Geometries
1.5.5. Best Practices for Setting Up Particles
2. Getting Started
2.1. Self-Guided Tutorials
2.2. User Interface
2.2.1. Main UI Components
2.2.2. Menu
2.2.3. Toolbar
2.2.4. Panels
2.2.5. Data Panel
2.2.6. Data Editors Panel
2.2.7. Info Tab
2.2.8. About the Coloring Tab
2.2.9. Windows Panel
2.2.10. Window Editors Panel
2.2.11. Log Panel
2.2.12. About the Simulation Log Panel
2.2.13. Cache Panel
2.2.14. Debug Info Panel
2.2.15. Undo/Redo History Panel
2.2.16. About Workspaces
2.2.17. Other UI Functionalities
2.3. Ansys Rocky Coupling with other Ansys Software
2.3.1. Ansys Rocky and Ansys Workbench
2.3.2. Ansys Rocky and Ansys Mechanical
2.3.3. Ansys Rocky and Ansys Fluent
2.3.4. Ansys Rocky and Ansys Motion
2.3.5. Ansys Rocky and Ansys optiSLang
2.3.6. Ansys Rocky and Ansys Minerva
2.3.7. Ansys Rocky and Ansys EnSight
2.4. Ansys Rocky Modules
2.4.1. Internal Modules (Embedded)
2.4.2. External Modules
2.4.3. Rocky Simulation Entities that can be Affected by Modules
2.5. Ansys Rocky Preferences
2.5.1. Setting Your Global Preferences
2.5.2. Defining Your Variables
2.6. Frequently Used Tasks
2.6.1. Enter Input Variables or Mathematical Functions as Parameter Values
2.6.2. Change the Speed of a Default Conveyor
2.6.3. Change Particle Adhesion
2.6.4. Set Particle Size Ranges
2.6.5. Use the 1-Way Fluent Method to Process Fluent and Rocky Simulations
2.6.6. Use the 2-Way Fluent Method to Process a Fluent and Rocky Simulation
2.6.7. Use the 2-Way Fluent Semi-Resolved Method to Process a Fluent and Rocky Simulation
2.6.8. Enable and View Particle Breakage
2.6.9. Create and View a Particle Assembly
2.6.10. Enable Thermal Modeling Calculations
2.6.11. Add a Logo to a 3D View
2.6.12. Reuse 3D View Window, Workspace, and User Process Setups in Other Projects
2.6.13. Set Up a New GPU Card
2.7. PrePost Scripting to customize Ansys Rocky software
2.7.1. About Creating and Using PrePost Scripts
2.7.2. Record a New Script
2.7.3. Add an External Script File to the Scripts Directory
2.7.4. Manually Apply a Saved Script
2.7.5. Automatically Apply Scripts Directly Before or After Processing
2.7.6. Edit a Saved Script Using the Python Programming Language
2.7.7. Copy a Script
2.7.8. Remove a Script
2.7.9. Rename a Script
2.8. Data Collection
2.8.1. To Enable and View Particle Breakage:
3. Setting Up a Simulation
3.1. Creating a Simulation Project
3.1.1. Minimum Setup Requirements
3.1.2. Open a Brand New Simulation Project
3.1.3. Open an Existing Simulation Project
3.1.4. Restoring an Archived Simulation Project
3.1.5. Begin a New Simulation Project
3.1.6. Open an Existing v3 Simulation Project
3.1.7. Open an Existing v4 or Later Simulation Project
3.1.8. Restore an Archived Simulation Project
3.2. Setting up Simulation Parameters
3.2.1. Study Parameters
3.2.2. Physics Parameters
3.2.3. Modules Parameters
3.2.4. SPH Parameters
3.2.5. Joints Parameters
3.2.6. Domain Settings Parameters
3.2.7. Solver Parameters
3.2.8. Geometries Parameters
3.2.9. Create and Edit Regions of Interest
3.2.10. Create and Apply Motion Frames
3.2.11. Create and Modify Material Compositions
3.2.12. Particle Sets
3.2.13. Point Clouds
3.2.14. Adding and Editing Inlets and Outlets
3.2.15. Collect (or Reject) Contacts Data
3.2.16. Set or Modify Fluid and/or Air Flow Properties
3.2.17. Define External Coupling Options
3.2.18. Duplicate a Data Panel Item
3.2.19. Remove Multiple Items from the Data Panel
3.2.20. Set Up Parameters When Restarting a Simulation
3.3. Saving a Simulation Project
3.3.1. Save a New Project
3.3.2. Save a Copy of a Project
3.3.3. Save an Archive of the Project
3.3.4. Save an Image of a Window
3.3.5. Save a New Simulation Project
3.3.6. Save an Exact Copy of the Simulation Project; Including the Simulation Results
3.3.7. Save a Copy of Only the Simulation Settings; Not the Simulation Results
3.3.8. Save a Copy of a Partially Processed Simulation for Restart Purposes
3.3.9. Save Over the Current Simulation Project
3.3.10. Save Custom Properties and Curves into projects
3.3.11. Save an Image of the Rocky Window
3.4. Verifying the Simulation Summary
3.4.1. About the Simulation Summary
3.4.2. Use the Simulation Summary Dialog to Verify Key Simulation Criteria
3.4.3. Use the Solver Summary Tab to Verify Key Simulation Criteria
3.4.4. Use the Solver Summary Tab to Verify the Simulation Version
3.5. Changing the Setup After Processing
3.6. Deleting the Simulation Results while keeping the setup
3.6.1. To delete the results of a simulation (but keep the setup):
3.7. Discovering Rocky Embedded Modules
3.7.1. Boundary Collision Statistics Module
3.7.2. Contacts Energy Spectra Module
3.7.3. Contacts Overlap Monitor Module
3.7.4. CFD Coupling Particle Statistics Module
3.7.5. Inter-group Collision Statistics Module
3.7.6. Inter-particle Collision Statistics Module
3.7.7. Intra-particle Collision Statistics Module
3.7.8. Multibody Dynamics FMU Coupling Module
3.7.9. Joint Statistics Module
3.7.10. About the Particle Instantaneous Energies Module
3.7.11. Particles Energy Spectra Module
3.7.12. SPH Mass Flow Rate Module
3.7.13. SPH Boundary Interaction Statistics Module
3.7.14. SPH Density Monitor Module
3.7.15. SPH HTC Calculator Module
3.7.16. SPH-DEM Interaction Statistics Module
4. Processing a Simulation
4.1. Starting a Simulation
4.1.1. About Starting a Simulation
4.1.2. Start Processing a Simulation from the Beginning
4.1.3. Resume Processing a Stopped Simulation
4.2. Stopping a Simulation
4.2.1. About Stopping a Simulation
4.2.2. Stop a Simulation from Processing
4.3. Extending the Duration of an In-Process or Completed Simulation
4.3.1. About Extending the Duration of an In-Process or Completed Simulation
4.3.2. Extend the Duration of an In-Process or Completed Simulation
4.4. Processing Multiple Simulations In Succession
4.4.1. About Processing Multiple Simulations In Succession
4.4.2. Open the Rocky Scheduler Program
4.4.2.1. To open the Rocky Scheduler Program [Windows]:
4.4.2.2. To open the Rocky Schedule Program [Linux]:
4.4.3. Add a New Resource to the Rocky Scheduler
4.4.4. Remove a Resource from the Rocky Scheduler
4.4.5. Process Multiple Simulation Projects In Succession
5. Analyzing a Simulation
5.1. Use Properties and Curves
5.1.1. About Properties
5.1.1.1. Limiting and Displaying Properties
5.1.1.2. Calculating Properties
5.1.1.3. Viewing Properties
5.1.1.4. Definitions of Default Rocky Properties
5.1.2. About Curves
5.1.2.1. How Curves are Calculated
5.1.2.2. About Displaying Curves
5.1.2.3. About Curves for Imported Geometries and Motion Frames
5.1.2.4. Definitions of Rocky Curves
5.1.3. About Customizing Properties or Curves
5.1.3.1. Custom Properties or Curves Parameter Definitions
5.1.4. About Customizing Eulerian Statistics Properties
5.1.5. About SPH Eulerian Solution
5.1.6. About Adding and Editing Time Statistics Properties
5.1.6.1. Applying Time Statistics Properties
5.1.6.2. Time Statistics Properties and Eulerian Statistics
5.1.6.3. Time Statistics Properties Parameter Definitions
5.1.7. About Meshed Particles Upscaling
5.1.7.1. About Upscaled Particles (Default Setting)
5.1.7.2. About Particles with Upscaling Disabled
5.1.8. Change or Remove an Existing Custom Property on the Properties or Curves Tab
5.1.9. Add a New Custom Property on the Properties or Curves Tab
5.1.10. Add a Particle Property to a Eulerian Statistics User Process
5.1.11. Remove a Custom Particle Property for a Eulerian Statistics User Process
5.1.12. Add a Time Statistics Property
5.1.13. Edit or Remove a Time Statistics Property
5.2. Create and Modify a 3D View Window
5.2.1. About 3D View Windows
5.2.2. View Geometries, Particles, Points, and Fluids in 3D
5.2.3. Change a 3D View Window
5.2.3.1. Using the Mouse, Keyboard, or Toolbar to Change the View
5.2.3.2. Using the Window Editors Panel to Change a 3D View
5.2.3.3. Using the Coloring Tab to Change a 3D View
5.2.4. Save a View with Custom Cameras
5.2.4.1. About the Custom Presets Toolbar
5.2.4.2. Save Custom Camera Settings for a View
5.2.4.3. Apply a Custom Camera Preset to a View
5.2.4.4. Modify or Remove an Existing Custom Camera Preset
5.3. View and Save Simulation Statistics
5.3.1. View an Individual Statistic
5.3.1.1. About Viewing an Individual Statistic
5.3.1.2. View an Individual Statistic
5.3.2. Graph (Plot or Histogram) a Data Set Within Rocky
5.3.2.1. Graphing (Plot or Histogram) a Data Set Within Rocky
5.3.2.2. Changing the Appearance of a Graph (Plot or Histogram)
5.3.3. Export Data and Images Out of Rocky
5.3.3.1. About Exporting Data and Images Out of Rocky
5.3.3.2. About Collecting and then Exporting Geometry Loads Data for Later FEM Analysis
5.3.3.3. Save a Snapshot of the Rocky Window
5.3.3.4. Export Data into a CSV File
5.3.3.5. Copy an Image or Data Set to the Clipboard
5.3.3.6. Export Boundary Forces for FEM Analysis
5.4. Create and Save an Animation
5.4.1. About Creating and Saving an Animation
5.4.2. Set up an Animation
5.4.2.1. Transition Tips
5.4.3. Use the View in the Window to Change the Qualities of a Key Frame
5.4.4. Use the View in the Key Frame to Edit the Qualities of that Key Frame
5.4.5. Edit the Settings and Key Frames Included in an Already Set-Up Animation
5.4.6. Save an Already Set-Up Animation as an AVI
5.4.7. Save a Static Image of Each Individual Frame in an Animation
5.5. Filter Views and Data with User Processes
5.5.1. Creating a User Process
5.5.2. About Particles User Processes
5.5.3. About Particle <-> Contact User Processes
5.5.4. Analyze Data within a Defined Shape
5.5.4.1. About the Cube User Process
5.5.4.2. About the Cylinder User Process
5.5.4.3. About the Polyhedron (Envelope) User Process
5.5.4.4. About the Surface User Process
5.5.4.5. Analyze Data within a Cube
5.5.4.6. Analyze Data within a Cylinder
5.5.4.7. Analyze Data within a Custom Shape by using the Polyhedron (Envelope) User Process
5.5.5. Analyze Data with a Clip or Cut Plane
5.5.5.1. About the Plane User Process
5.5.5.2. Analyze Data with a Clip Plane
5.5.5.3. Analyze Data with a Cut Plane
5.5.6. Analyze Data by Property Type
5.5.6.1. About the Filter User Process
5.5.6.2. Analyze Data with the Filter User Process
5.5.7. Analyze the Particles Trajectory
5.5.7.1. About the Particles Trajectory User Process
5.5.7.2. Analyze Data with the Particles Trajectory User Process
5.5.8. Inspect an Individual Cell
5.5.8.1. About the Cell Inspector
5.5.8.2. Inspect an Individual Cell (Triangle, Block, or Node) for an Entity
5.5.9. Duplicate a User Process
5.5.9.1. To duplicate a User Process:
5.5.10. Export User Process Geometry Triangles to an STL File
5.5.10.1. To export User Process geometry triangles to an STL file:
5.5.11. Analyze Particles within a Time Selection
5.5.11.1. About the Particles Time Selection User Process
5.5.11.2. Analyze Data with the Particles Time Selection User Process
5.5.12. Divide a Cube or Cylinder User Process into Many Analysis Blocks
5.5.12.1. About Eulerian Statistics
5.5.12.2. Divide a Cube or Cylinder User Process into Many Analysis Blocks
5.5.13. Retain Particle Data Calculated within a User Process by Using Particle Calculations
5.5.13.1. About Particles Calculations
5.5.13.2. About Tagging Calculation
5.5.13.3. Apply Particles Calculations to a Particles User Process Selection
5.5.13.4. Apply Tagging or Divisions Tagging to a Particles User Process Selection
5.5.14. Analyze Contacts from a Sub-Set of Particles
5.5.14.1. Usage Examples
5.5.14.2. Particle to Contact Parameters
5.5.14.3. Create a Particle to Contact User Process
5.5.15. Analyze Particles from a Sub-Set of Contacts
5.5.15.1. Usage Examples
5.5.15.2. Contact to Particle Parameters
5.5.15.3. Create a Contact to Particle User Process
5.5.16. Surface User Process
5.6. Change the Current Output by Using the Time Toolbar
5.6.1. About the Time Toolbar
5.6.1.1. Previewing Motions Using the Time Toolbar
5.6.2. Use the Time Toolbar to Change the Current Output
5.6.3. Limit Output Values by a Specific Time Range
5.7. Monitor Analyses Statuses by Using the Progress Panel
5.7.1. About the Progress Panel
5.7.2. Stop an Active Process
6. Getting Help and Support
6.1. Getting Help and Support
6.1.1. Submit a Support Request
6.1.2. Include a Simulation Project in a Support Request
6.1.2.1. To include a copy of your simulation project in a support request:
6.1.3. Archive a Simulation Project
6.1.3.1. To archive a simulation project:
6.1.4. Report a Software Bug
6.1.5. Verify Your Rocky License Status
6.1.6. Tips for Using Rocky Help
6.1.6.1. Tips for Using the Contents Tab
6.1.6.2. Tips for Using the Search Tab
6.1.6.3. Tips for Searching within Topics
6.1.6.4. Tips for Saving Help Content
6.1.6.5. Tips for Increasing the Text Size
6.1.6.6. Tips for Accessing Panels in Help
6.1.6.7. More information about Qt Assistant
6.2. Remove Rocky
6.2.1. To remove Rocky [Windows]
6.2.2. To remove Rocky [Linux]:
7. Appendices
7.1. Appendix A: Particle Shape Examples
7.2. Appendix B: ASCII Printable Characters
7.3. Appendix F: Save Geometries as XGL, STL, or DXF Files
7.3.1. Use Ansys SpaceClaim 2022 R2 to Save Geometries to STL Files
7.4. Appendix G: Perform Tasks from the Command Line or Journal
7.4.1. About Using Commands
7.4.2. Known Limitations
7.4.2.1. Scripts that Require the Rocky UI to be Open
7.4.2.2. Scripts that use matplotlib
7.4.3. Common Commands
7.4.4. Use the Command Line to Process a Simulation
7.4.5. Use the Command Line to Play a Script
7.4.6. Use a Journal to Run Fluent and Export Transient 1-Way Results
8. Troubleshooting
8.1. What kind of problems are you having?
8.2. Troubleshooting Simulation Setup Problems
8.2.1. I cannot change my import scale
8.2.2. I cannot change the setup parameters
8.2.3. I cannot find PrePost Scripting documentation
8.2.3.1. PrePost scripting Manual
8.2.3.2. Python Shell
8.2.4. I cannot find Solver SDK documentation
8.2.5. I cannot get Rocky to couple with my CFD program
8.2.6. I am having difficulty properly calibrating sticky, wet, or cohesive particles
8.2.7. I do not know how to simulate magnetic forces
8.2.8. I need help simulating an HPGR
8.2.9. I cannot find the upper limit for importing custom particles shapes
8.2.10. I entered an invalid variable or value and Rocky accepted it
8.2.11. I briefly see long numbers when pasting in copied values
8.2.12. My particle size is too large for my periodic domain
8.2.13. Parts of my particle disappear or appear cut off
8.2.14. Rocky does not list my Ansys version when I try to set up 2-Way Fluent Coupling
8.2.14.1. Order Rocky Follows When Looking for Ansys Versions
8.2.14.2. Possible Solutions
8.2.15. I cannot find the Rocky component in Workbench
8.2.16. I get "reference" errors in my Motion Frames when I open an older project
8.2.16.1. To solve these errors:
8.2.17. I cannot find the Forces for FEM Analysis checkbox
8.2.18. I get an "Unsupported Particle" error when I open an older project
8.2.19. I cannot find Particle Collision Statistics
8.2.20. I cannot find Particle Size Scale Factor
8.2.21. I cannot find the Leeds Adhesion Force model
8.2.22. I cannot find the Inlet Start and Stop Times
8.2.23. I cannot find the Movements Tab for my older simulation projects
8.2.24. I cannot figure out how to set the Parent Reference for a Motion Frame
8.2.25. I get "Displacement" errors in my Motion Frames when I open an older project
8.2.25.1. To solve these errors:
8.2.26. My "Air Viscosity" units changed
8.2.27. I cannot enter an input variable or mathematical function into a text field
8.2.28. I cannot find the Velocity Dependent Adhesive Force model
8.2.29. I cannot find the Torque Law setting for 1-Way Constant
8.2.30. I cannot find the Output Frequency parameter
8.2.31. I cannot find the Loading N-Steps parameter
8.2.32. I cannot find the Set Contact Detection Neighboring Distance parameter
8.2.33. I cannot find the Export Solution to Rocky item in Fluent
8.2.34. I cannot find the Maximum Volume Fraction Target parameter for 2-Way Fluent
8.3. Troubleshooting Simulation Processing Problems
8.3.1. Troubleshooting Common Processing Errors
8.3.1.1. I get a "runtime" or "system resource" error when I try processing my simulation
8.3.1.2. I get a "No Solver license available" message when I run the Rocky Scheduler but the status says "License Ok"
8.3.1.3. I get a "Failed to write the log" message while processing my simulation
8.3.1.4. I get a "CPU" or "GPU" error message when I start processing my simulation
8.3.1.5. I got a message saying concave particles are not allowed in my Rocky version
8.3.1.6. I get an "Error simulating" or "Simulation error" message when I resume or start processing my simulation
8.3.1.7. I get a "Simulation setup failed" message when I start processing my simulation
8.3.1.8. I get warnings or errors on my Simulation Log Panel
8.3.1.9. I get an "Error copying memory from device to host" message when I try processing my simulation
8.3.1.10. I get a "Particles composed of Multiple Elements can't have size defined" error when I try processing my simulation
8.3.1.11. I get a scripting error when I attempt to run the simulation in batch mode
8.3.1.12. I get a "Server returned a fault exception" error when running a script in batch mode
8.3.2. My simulation is taking too long to process
8.3.3. I set parameters for my simulation but I cannot process it
8.3.4. I get unusual results when I process my simulation
8.3.5. I am processing my simulation but no output files are being created
8.3.6. My particles are flowing too quickly
8.3.7. Particles are going through the walls of my geometry
8.3.7.1. Periodic Cartesian Domain Issues
8.3.7.2. Particle Velocity Issues
8.3.7.3. Rolling Resistance Issues
8.3.7.4. Geometry Thickness Issues
8.3.8. No particles appear when I process the simulation
8.3.9. Particles stopped flowing before my simulation was done processing
8.3.10. I cannot find a batch mode for processing
8.3.11. I want to use a Pascal-based GPU card instead of the recommended CUDA-based one
8.3.12. I cannot find where to set the number of cores for CPU processing
8.3.13. My GPU card is not being recognized as CUDA compatible
8.3.14. A fiber or other particle shape disappeared from my simulation during processing
8.3.15. I cannot resume processing my older simulation in the latest version of Rocky
8.3.16. My inlet stopped injecting particles for a long time and then later resumed it
8.3.17. My Volumetric Inlet isn't working right
8.3.17.1. Fewer particles were injected than estimated on the Info tab
8.3.17.2. Only a few (or no) particles were injected
8.3.17.3. No particles were injected
8.3.18. I cannot change my setup parameters during processing
8.3.19. My particle's height increases after each collision
8.4. Troubleshooting Simulation Analysis Problems
8.4.1. I cannot find the zoom, pan, or tilt options on the toolbar
8.4.2. I cannot see the data or statistics
8.4.3. I cannot view my previous output files
8.4.4. I cannot remove the colored box around my 1-Way LBM or User Process selection
8.4.5. I cannot get a time counter to appear on my simulation
8.4.6. I cannot get my company logo to appear on my simulation
8.4.7. I cannot find the minimize, restore down, and close buttons for my maximized Rocky window
8.4.8. I do not understand how power is calculated
8.4.9. I want to analyze Property information for only one of my Particle sets
8.4.9.1. To create a Property User Process that limits by Particle Group:
8.4.10. I do not understand how my Particle set names map to the Particle Group value numbers
8.4.10.1. To view the legend for the Particle Groups Property:
8.4.11. I cannot find the Particle Name nor Particle Input Property
8.4.12. I cannot find some Properties or Curves in this version of Rocky
8.4.12.1. Changes Prior to v4.5.0
8.4.12.2. Changes Prior to v4.4.0
8.4.13. Parts of my geometries and particles disappear when I rotate my 3D View
8.4.14. I cannot display or plot a particular property
8.4.14.1. Tensor Properties
8.4.14.2. Vector Properties
8.4.14.3. Space Plots
8.4.15. My old script no longer works
8.4.16. I still want to use my old macros
8.4.17. My trajectory lines are outside my periodic domain
8.4.18. I have large discrepancies in my Intra-particle Collisions Statistics Frequency values
8.4.19. I cannot find the directional properties for Solid Implicit Force
8.5. Troubleshooting Rocky Licensing and File Problems
8.5.1. Troubleshooting Common Licensing or File Errors
8.5.1.1. Rocky says I have "No Solver License" when I process my simulation but my license status is "OK"
8.5.1.2. My Rocky license Status says "No license for feature"
8.5.1.3. I get a "Links removed" message when I save my project for restart purposes
8.5.1.4. I get a "No Solver license available" message when I run the Rocky Scheduler but the status says "License Ok"
8.5.1.5. Rocky says my project file is "locked"
8.5.1.6. I reinstalled Rocky but I am still seeing errors
8.5.2. Rocky says I have lost the connection with the license server
8.5.3. My Rocky license will not let me open a project from the File directory
8.5.4. I cannot find the import project functionality
8.5.5. I cannot open my older simulation file in the latest version of Rocky
8.5.6. I made a copy of my older simulation project but Rocky will not open it
Glossary