23.1.1. How to install Particle Solver in RecurDyn

Requirements for a particle solver to co-simulate with RecurDyn

To install the particle solver in RecurDyn, the 2 files are needed.

  • XML Configuration File: The XML configuration file provides RecurDyn with the information required for RecurDyn to use the particle solver. RecurDyn loads the XML configuration file when RecurDyn starts. The XML configuration file provides RecurDyn with the information it needs to allow it to display the particle solver in the RecurDyn/GUI and to find the SPI Coupling DLL file.

  • SPI Coupling DLL File: The SPI coupling DLL file acts as a communication channel between RecurDyn and the particle solver. RecurDyn loads the DLL file when a co-simulation starts. The SPI coupling DLL file implements the RecurDyn/SPI. RecurDyn calls the RecurDyn/SPI API functions in the DLL to communicate with the particle solver and control the co-simulation. The SPI coupling DLL can communicate with the particle solver using any method that the particle solver developer wants.

There are two methods below to use the particle solver using External SPI in RecurDyn. Particle solver can be use in External SPI by selecting one of the two methods, and the method using XML is recommended.

Particle solver installation using a XML Configuration File

For a particle solver to co-simulate with RecurDyn, RecurDyn requires that an XML configuration file to be placed in the folder:
<RecurDynInstallFolder>\Bin\Solver\CoSim\StdParticleInterface

NOTE

In the particle solver program, XML file is supported depending on the version, and the location of the files is as bellow.

Particleworks :

<ParticleworksInstallFolder>\share\recurdyn\Particleworks_V9R5.xml

EDEM :

<EDEMInstallFolder>\lib\EDEMV_1_1_0.xml

If the particle solver program is not installed in the default location, user need to change the <Path> information in the XML file to the dll location.

../_images/image00216.png

If the user sets the XML configuration file, the ribbon menu of External SPI is displayed.

  • The XML configuration file must contain the correct data for the particle solver.

  • The XML configuration file tells RecurDyn the SPI options that the particle solver supports and the name and location of the communicator DLL for the particle solver.

  • RecurDyn can recognize and use up to 3 independent particle solvers simultaneously. If more than 3 independent particle solvers have installed the required files to enable co-simulation, then RecurDyn choose 3 of them randomly from the installed particle solvers.

Setting the path of Particle solver using the Environment Variable

Under Windows, the Environment Variable for SPI can tell RD solver the location of the PS Coupling .DLL library file. But it is not recommended because if it is set, the path of the RD SPI Coupling DLL set in XML Configuration File is ignored, and this condition can cause mismatch between the options and the DLL.

  • Variable Key: SPI_PATH_[Name]

  • where [Name] is the same as the value of the <Name></Name> element in XML configuration file.

  • Value: <Coupling DLL library file Path>

  • The path of the Coupling .DLL Library file, including the complete file name.

  • The path must be absolute.

For example:

  • Name element in XML configuration file:

  • <Name>ParticleSolver</Name>

  • Environment Variable:

  • Variable Key: SPI_PATH_ParticleSolver

  • Value: C:\ParticleTest\ParticleSolverLibrary.dll

For Linux users, click here for how to install SPI.