Skip to content
Module for FreeCAD intended to use with DualSPHysics fluid simulator.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea
.vscode
ds_modules
dualsphysics/bin
images
installer Commenting and refactor pass. Jul 18, 2018
.gitignore
CONTRIBUTING.md
DesignSPHysics.FCMacro Build for China training day Oct 3, 2017
DesignSPHysics.py Adds some changes in help texts Dec 3, 2018
LICENSE
README.md Merges develop. Version 0.5.1811-08 Nov 8, 2018
build-release.bat
build-release.sh Commenting and refactor pass. Jul 18, 2018
default-config.json
pylintrc

README.md

DesignSPHysics

DesignSPHysics is a software module built into FreeCAD that provides a Graphical User Interface for DualSPHysics.

It is under development since September 2016 and in Beta stage.

Check the Official Webpage for downloads and more information.

Screenshot

Description

DesignSPHysics enables the user to create cases with solids and fluids and exports it to a DualSPHysics compatbile format. In addition, it does the hard work for the user, generating the case automatically, simulating, and post-processing, all inside FreeCAD.

It includes support for pre-processing with GenCase, simulation with DualSPHysics and post-processign with several tools of the DualSPHysics package.

In the future the code will be modular, so integration with different SPH solvers can be used. Right now it's optimized to be used with DualSPHysics 4.X

It is developed as a FreeCAD module with a macro bootstrapper, in Python 2.7, using the QT libraries via PySide.

Installation instructions

To install DesignSPHysics you have 2 options: Using an installer (release version) or using a development build (git)

Installing a release version

To install a release version go to the download section of the official webpage and download the appropriate binary.

Execute the installer (installer.exe on Windows and installer on GNU/Linux) to open the installer. Then press install and it will copy the needed scripts in FreeCAD's macro default folder.

It can also be done manually, unpackage release-windows.zip or release-linux.tar.gz, choose 'resource' folder and rename the folder to 'DesignSPHysics'. Then copy the folder to the Mod folder of the FreeCAD installation directory.

By default, for example, in Windows, it is located in %appdata%/FreeCAD/Mod or in Linux in ~/.FreeCAD/Mod

Next open the folder and copy the file DesignSPHysics.FCMacro into the FreeCAD macro directory (%appdata%/FreeCAD/Macro on Windows; ~/.FreeCAD/Macro on GNU/Linux).

Installing a develompent build

Clone this repository and rename the folder to 'DesignSPHysics'. Then copy the folder to the Mod folder of the FreeCAD installation directory.

By default, for example, in Windows, it is located in %appdata%/FreeCAD/Mod or in Linux in ~/.FreeCAD/Mod

Then copy the file DesignSPHysics.FCMacro of this repository into the FreeCAD macro directory (%appdata%/FreeCAD/Macro on Windows; ~/.FreeCAD/Macro on GNU/Linux)

Where to get help

You can check the DesignSPHysics Wiki to get help. Also, you can post an issue here on GitHub or send an email to any of the people found in the CONTRIBUTING file.

Contributing

Please check the CONTRIBUTING file to view information about how to contribute to the project and how it is structured.

Copyright and License

Copyright (C) 2017 - Andrés Vieira (anvieiravazquez@gmail.com) EPHYSLAB Environmental Physics Laboratory, Universidade de Vigo EPHYTECH Environmental Physics Technologies

This file is part of DesignSPHysics.

DesignSPHysics is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

DesignSPHysics is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with DesignSPHysics. If not, see http://www.gnu.org/licenses/.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.