Home
Coupling Interface Programming Guide
The Coupling Interface Programming Guide provides an overview of how to use the EDEM Coupling Interface to couple with a generic CFD code and/or Multi Body dynamics codes.
Start and Stop the Coupling Server
By default, EDEM will launch with the Coupling Server stopped and requires you to start the server before a coupled simulation can proceed.

Welcome
What's New
This section provides an overview of the main new features in EDEM version 2026 and highlights key updates.
About EDEM
EDEM is a high-performance simulation software for bulk and granular materials.
Hardware Requirements
This section details the minimum system requirements and requisites for running EDEM.
Release Notes
This section contains information about the EDEM 2026 release, such as key features, enhancements, and bug fixes.
Tutorials
Start using EDEM with our interactive tutorials.
Get Started with EDEM
The EDEM user interface comprises three icons for each simulation component - Creator, Simulator, and Analyst.
EDEM Creator
EDEM Creator is the pre-processor for creating an EDEM simulation model, including setting up equipment and defining the generation of bulk materials.
EDEM Simulator
EDEM Simulator is a powerful solver used for fast and efficient simulations.
EDEM Analyst
EDEM Analyst is the post-processor used to analyze and visualize the results of your simulation.
EDEM Physics Models
A Contact Model describes how elements behave when they come into contact with each other.
EDEM Cal Utility
EDEM Cal is a utility which works with EDEM and is designed to assist in performing calibration.
EDEM Calibration Kits
The EDEM Calibration kits are a collection of EDEM models of standard bulk solids characterization tests commonly used for EDEM material model calibration.
GPU CUDA Guide
The EDEM CUDA GPU module uses the latest General Purpose Computing on Graphical Processing Units (GPU) technology.
Programming Guide
The EDEM Programming Guide describes the EDEM API.
Coupling Interface Programming Guide
The Coupling Interface Programming Guide provides an overview of how to use the EDEM Coupling Interface to couple with a generic CFD code and/or Multi Body dynamics codes.
- Enable and Run the Coupling Server
  The EDEM Coupling Server options are accessible from the top-right corner of the EDEM window.
- Start and Stop the Coupling Server
  By default, EDEM will launch with the Coupling Server stopped and requires you to start the server before a coupled simulation can proceed.
- Run a Python Application
  The EDEM install directory contains a coupling library. You must ensure that you have access to the library when running a Python application.
- Run a Compiled Application
  When running your compiled application, you must ensure that the EDEM libraries can be correctly picked up, You must add the location of the EDEM libraries to theLD_LIBRARY_PATH environment variable.
- Coupled EDEM-CFD Simulation
  EDEM integrates fluid drag forces and torques into the particle simulation on an individual particle level.
- The Multi Body Dynamics Coupling Interface
  The Multi Body Dynamics (MBD) Coupling Interface is a subset of features in the EDEM Coupling Interface specifically designed for coupling EDEM to Multi Body Dynamics packages.
- Design of Experiment-style Studies
  Design-Of-Experiment (DOE) style programs or parametric CAD packages allows equipment designs to evolve through co-simulation. This capability in the EDEM Coupling Interface also allows you to automatically create many simulations containing variations on Geometry or Geometry dynamics for running in batch mode.
- Compile Coupling Interface Code to an Executable
  You can compile simple user-written code into a stand-alone executable to work with the coupling interface.
EDEMpy
EDEMpy is a Python library for accessing EDEM data from .h5 files (the underlying EDEM file format). EDEMpy does not require prior knowledge of advanced programming.
EDEM Solver Capabilities
EDEM contains four solver engines.
Appendix
This section provides additional information about how to estimate simulation time, supported EDEM File types, attribute definitions, and so on.
EDEM Terminology
Definitions of terms used in EDEM.
References and Bibliography
This section cites the contributions made by various authors and sources that have been used as reference material for EDEM, and the specifics of how they have been applied can be found in the individual contact model sections.

Start and Stop the Coupling Server

By default, EDEM will launch with the Coupling Server stopped and requires you to start the server before a coupled simulation can proceed.

To start and stop the Coupling Server:

For running in batch mode or for further automating the process, you can launch EDEM with the Coupling Server already running by adding the ‘--cs’ switch to the command line.

The coupling will connect on a random port. If you want to specify the port used for the coupling, enter a value in the coupling box.
Note: To use user-specified ports, the coupling must be updated, and you must specify a port on the client side as well.

C++ Coupling

The flag –cs-port followed by a specific port will start the coupling server using this flag.
The ports will only allow connection on ports in the range of 32768 to 65535.
If both --cs and --cs-port are specified, --cs-port will take precedence.

Python Coupling

When connecting to the coupling using the command connectCoupling(), you can specify a port number.
If you do not specify a port number, a number between 0 and 32969 will be used.