plugins Directory Reference

Detailed Description

Plugin system

Prerequisites

First, you need to install the musica Python package for the musica command to be available. To do so, run the following command in the root directory of the project:

pip install .[cli]

Install cmake and one of the following C/C++ compilers:

• GNU GCC (tested on 11.4.0)
• LLVM Clang (not tested)
• Microsoft Visual C++ (MSVC) (tested on 19.37.32822)

Then, use the musica plugin make command to compile the plugins:

musica plugin make elastic.cpp changhicher.cpp --working_directory=plugin --build=build

This will compile the elastic.cpp and changhicher.cpp plugins to dynamic libraries in the plugin directory using cmake as the build system. Type musica plugin make --help for more information about the command. After compiling the plugins, you can use the built plugins in your simulations:

#include <unordered_map>
#include <string>
 
#include "micromechanical/models.hpp"
#include "micromechanical/contacts/contacts.hpp"
 
using namespace micromechanical;
using namespace micromechanical::contacts;
 
std::unordered_map<std::string, double> props = {{"kt0", 32.0}, {"R", 2.5}};
auto *contact = ContactLawRegistry<double>::create("elastic.dll", props);
auto *model = MicromechanicalRegistry<double>::create("changhicher.dll", ContactLawType::Elastic, props);

Create plugins for micromechanical models

A plugin for a micromechanical model is a .cpp file that contains a function named micromechanical_model that returns a pointer to a MicromechanicalBase object. The function must have the following signature:

#include "micromechanical/core/micromechanical.hpp"
 
using namespace micromechanical::core;
 
extern "C" MicromechanicalBase<double>* micromechanical_model(ContactLawBase<double>* contact,
                                                              const std::unordered_map<std::string, double>& props = {},
                                                              double npv = 1e9,
                                                              double radius = 0.65e-3) {
    // Define the micromechanical model
}

Create plugins for contact laws

A plugin for a contact law is a .cpp file that contains a function named micromechanical_contact that returns a pointer to a ContactLawBase object. The function must have the following signature:

#include "micromechanical/core/contactlaw.hpp"
 
#include <unordered_map>
#include <string>
 
using namespace micromechanical::core;
 
extern "C" ContactLawBase<double>* micromechanical_contact(const std::unordered_map<std::string, double>& props) {
    // Define the contact law
}