Simulate with complex geometries and complex physics
InstallationGuide
Installation of MESHFREE
Short URL to this page: https://meshfree.pages.fraunhofer.de/docu/install
0. Get Help if necessary
If you get stuck somewhere along this guide, please contact our Support team.
We recommend, using the latest beta version as described below.
1. System Requirements
We recommend the usage of a Linux-based system (real or virtual machine). Our executables are currently compiled on
| Linux | Windows |
|---|---|
The Rocky Linux executables are compatible with the corresponding Red Hat Enterprise Linux versions. |
|
Please note that MESHFREE is a command line tool.
We assume at least a low level of familiarity with either a bash (Linux) or cmd (Windows) shell.
2. Download
Download an appropriate MESHFREE executable archive (*.sh, *.exe).
We generally recommend using the latest beta version.
See Download page for details.
In addition, download an appropriate version of LicenseManager_FlexLM. See Section 5 below for details about license management with FlexLM.
3. Extract Archive
The archives are self-extracting. Execute the appropriate one for your given operating system to extract.
| Linux | Windows |
|---|---|
Open a chmod +x <path_to_archive>/meshfree_<version>.sh
The <path_to_archive>/meshfree_<version>.sh --include-subdir --prefix=<install_dir> |
You may need to unblock the installer first. In the right-click-menu,
choose The installer opens a pop-up that leads you through the installation. To start, double click or run <path_to_archive>\meshfree_<version>.exe
|
Take note of the "target directory" for use in later steps as <install_dir>. |
Take note of the "Destination Folder" for use in later steps as <install_dir>. |
4. Test Installation
An MPI installation is shipped along with MESHFREE. To test this:
| Linux | Windows |
|---|---|
| Open a cd <install_dir>/bin |
Open a cd <install_dir>\bin |
| then call source ../mpi/env/vars.sh
mpiexec -np 2 ./test_mpi
| then call ..\mpi\env\vars.bat
mpiexec -np 2 .\test_mpi.exe |
An output like this should be printed to the screen: Hello World from process 0 of 2 on <hostname>
Hello World from process 1 of 2 on <hostname> |
|
Finally, check a full call to MESHFREE ./meshfree.x --version |
Finally, check a full call to MESHFREE meshfree.exe --version |
5. Prepare License
Please check what type of license you have, see also LicenseVariants.
5.1 Local License File
If you have been provided with a local license file, that is, a
*.lic without a USE_SERVER line,
you can use this directly in MESHFREE, without the need for a license server.
This is usually the case for user locked licenses and short term test licenses.
Make sure to save the file somewhere that all MESHFREE users have access to.
| Linux | Windows |
|---|---|
| Make sure the file is readable for all users chmod ugo+r <license_file>
Set the following environment variable export MESHFREE_LICENSE_FILE=<license_file>
You can check the validity of the license with MESHFREE via |
Make sure that the file is available to all users. Set the following environment variable to the file set MESHFREE_LICENSE_FILE=<license_file>
You can check the validity of the license with MESHFREE via |
5.2 License Manager FlexNet Publisher (FlexLM)
The licensing tools can be downloaded together with the MESHFREE executables
from the directory LicenseManager_FlexLM.
There are an up to date license manager (lmgrd), utility tool (lmutil) and the vendor demon (meshfree) for both, Linux and Windows.
See Download page for details.
To be able to provide you with a floating license file, we need to know
-
the HostID of the server that you want to run the FlexLM license manager on.
This can be obtained via the output of "lmutil lmhostid". -
the IP range on which MESHFREE is allowed to run and checkout licenses from that server.
Your IT admins most likely already know this data if you are using FlexLM for other software.
| Linux | Windows |
|---|---|
If you (or your IT) are already running a FlexNet Publisher license manager with version v11.19.6.0 or newer,
you should only need to add the vendor demon
| |
|
On self administered systems,
save the license file with ending ./lmgrd -z -c <license_file>
Keep this shell running, maybe minimized, while you simulate with MESHFREE. |
On self administered systems,
save the license file with ending lmgrd.exe -z -c <license_file>
Keep this shell running, maybe minimized, while you simulate with MESHFREE. |
Once the license server is running, set the following environment variable according to the server and port export MESHFREE_LICENSE_FILE=<port>@<server>
for example export MESHFREE_LICENSE_FILE=61613@localhost
You can check the validity of the license with MESHFREE via |
Once the license server is running, set the following environment variable according to the server and port set MESHFREE_LICENSE_FILE=<port>@<server>
for example set MESHFREE_LICENSE_FILE=61613@localhost
You can check the validity of the license with MESHFREE via |
For full details on FlexLM, please refer to the official FlexNet Publisher License Administration Guide.
Note: FlexNet Publisher saves previously encountered licensing information in
~/.flexlmrc under Linux or in the Windows registry
and checks those for valid licenses as well.
5.3 Optional: Add application licenses to job scheduler
If you have a limited number of floating licenses for MESHFREE and you are using a job scheduler on your cluster, it is possible to set this limit in your scheduler as a license resource. That way, you can schedule additional jobs beyond the floating limit and these jobs will wait until a license becomes available. The limit needs to be set by your system administrator.
- PBS: See section "4.3.5 Requesting Application Licenses" in the PBS User's Guide and section "5.14.6 Supplying Application Licenses" in the PBS Administrator's Guide.
- Slurm: See section "Local Licenses" in Slurm Licenses Guide.
6. Simulate with MESHFREE
| Linux | Windows |
|---|---|
Open a source <install_dir>/mpi/env/vars.sh
at least once in the shell you want to run MESHFREE in. Set the licensing environment variable export MESHFREE_LICENSE_FILE=<license_file_or_server> |
Open a <install_dir>\mpi\env\vars.bat
at least once in the shell you want to run MESHFREE in. Set the licensing environment variable set MESHFREE_LICENSE_FILE=<license_file_or_server> |
Then, switch to a MESHFREE working directory, containing a USER_common_variables.dat, common_variables.dat, etc., cd <working_directory> |
|
and start MESHFREE mpiexec -np <np> <install_dir>/bin/meshfree.x
|
and start MESHFREE mpiexec -np <np> <install_dir>\bin\meshfree.exe
|
where |
|
7. Uninstall
| Linux | Windows |
|---|---|
Just delete the whole package directory rm -rf <install_dir>/
|
Uninstall via the Windows menu in <install_dir>\Uninstall.exe
|
8. Recommended Pre- and Postprocessing Tools
MESHFREE QuickTools
The source code for these tools is available at MESHFREE QuickTools for you to compile yourself. They require Qt version 4 or 5. We do not provide compiled executables for these tools.
-
QuickEdit: Dedicated editor for MESHFREE input files with documentation suppport.
-
QuickMonitor: Monitor MESHFREE INTEGRATION results during a simulation.
-
QuickView: View the current MESHFREE point cloud during a simulation.
ParaView
To analyze the simulation results in detail, we recommend downloading and installing the open source tool ParaView. A brief introduction to ParaView as well as useful features for analyzing MESHFREE results can be found in 10_ParaviewForMESHFREE.pdf and Postprocessing.