This page contains a feature refence for DSPH for FreeCAD. Here you can found an extensive feature description and usage for the software.

Each section is documented as a tutorial. This document is updated to the version 0.10a, so if you are using a higher version expect changes.

For installing FreeCAD is recommended to check out the Installation page. It contains information on the way to install DualSPHysics for FreeCAD in Microsoft Windows and GNU/Linux.

To execute DSPH for FreeCAD you need to have it installed and your FreeCAD version shoud be 0.16 or higher.

First of all, open FreeCAD. You should see an start page with no projects opened. Click on the 'Execute Macro' button to open a dialog.

In the dialog that appears, select DSPH.py and press 'Execute'.

DualSPHysics will load and when a side panel appears, you're ready to go.

The first time you execute DSPH for FreeCAD you'll see a warning informing you that some of the executables are not correct. This happens because DSPH for FreeCAD needs to use GenCase, DualSPHysics and PartVTK, and you need to provide this binaries for your own.

Click the 'Setup Plugin' button at the right toolbar (by default) to open a Setup dialog, in which you can set the path to the needed binaries.

Click the '…' button in each section to select the right binary file. If a file is not correct, DSPH for FreeCAD should spawn a warning dialog.

Once you set the 3 binaries, push Ok and the information will be saved on disk, so the next time you execute DSPH for FreeCAD you'll not need to do this again.

Creating a case opens a FreeCAD Document specifically modified to work with this software. Note that creating a new FreeCAD document with the 'File' menu will not create a correct DSPH-compatible file.

To create a case just press 'New Case' in the right side of the screen (by default). An default setting will be opened in FreeCAD. You will see a 'DSPH_Case' in the object tree, with only one element inside: 'Case_Limits'. This object will represent the boundaries of the case simulation, and everything outside that volume will be ignored.

That's it! You have a new case created.

A DSPH case has 2 main variable definition: A Case constants and execution parameters. This section covers the constant definition.

To define de constants of the open case, click the 'Define Constants' button in the right side of the screen (by default). A window will pop with a lot of data.

Each field of the constants definition can be edited, but by default, all data will be filled with optimal values.