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.
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.

Welcome
What's New
New features and enhancements available in EDEM.
Release Notes
This document contains information about the EDEM release, such as key features and enhancements, bug fixes, and known issues.
About EDEM
EDEM is a high-performance simulation software for bulk and granular materials.
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 Contact 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.
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 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.
  - Register Geometries for Motion
    Geometries in EDEM are easily identifiable by their readable names. However, to maintain computational performance during simulation using the Multi Body Dynamics Coupling Interface, Geometries are identified by an unique integer ID. The method also registers the coupling for control using the Coupling Interface.
  - Retrieve the Position of a Geometry
    You can retrieve the position of a Geometry from EDEM at any point in a coupled code when EDEM is not executing a simulation using the getGeometryPosition method.
  - Set Geometry Motion
    Three groups of parameters related to setting a Geometry motion using the setGeometryMotion method are available.
  - Deform Geometries
    The EDEM Coupling Interface can deform a Geometry by setting or offsetting the Geometry nodes' local or global positions.
  - Retrieve Material Forces Acting on Geometries
    You can retrieve the summed material force and torque acting on the specified Geometry using the getGeometryForces method.
  - Set Point of Action on a Geometry
    The point of action of a Geometry is set to the same value as its center of mass.
  - Perform Multi-step Simulation
    The EDEM Coupling Interface supports multiple Time Steps. You can simulate multiple Time Steps in EDEM between data exchanges when using the Multi Body Dynamics Coupling Interface.
  - Interpolate Geometry Motion
    You can implement Geometry motion over multiple Time Steps using the setGeometryMotion method.
  - Change the size of Geometry Velocity Vectors
    The Geometry Velocity vectors widget in the Analyst's Model to enable you to increase or decrease the size of the vectors.
  - Force Averaging
    The average force is updated in the custom property at every EDEM Time Step.
- 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.

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.

Its primary function is to allow users to perform simulations with programmatic control of Geometry motions and Physics, allowing implementation of complex motions, rigid body Physics, or coupling with advanced Multi Body dynamics codes.

The following diagram represents the Multi Body Dynamics Coupling Interface data interaction with EDEM.

The Multi Body Dynamics Coupling Interface allows the exchange of contact forces and equipment motion between EDEM and a coupled code. The coupled code can retrieve bulk material forces resulting from contact with the equipment surfaces calculated in EDEM and return equipment kinematics.

The simplicity of the data exchange method between EDEM and coupled Multi Body dynamics code allows for the rapid development of rigid body dynamics for inclusion in DEM simulations. The control over EDEM simulations offered by the interface is also suitable for coupling and co-simulation with third-party Multi Body dynamics software such as LMS Virtual Lab Motion, Matlab Simulink, and MSC Adams. Through coupling with MBD software, modeling can be extended to contain a wide range of components including hydraulic control systems, motors and interconnected equipment Geometries.

Initiate the Coupling Interface

The Coupling Interface has a series of initiation flags. These flags allow you to predefine what functionality the coupling script will use. The current list of flags can be found in the CCouplingFeatureFlags class in ApiTypes.h. Older coupling codes written prior to this functionality will run without the flags being defined. However, they will not benefit from the performance improvement.