GENESIS: Documentation

Related Documentation:

• Add Component to DeveloperPackage
• Add Feature to SSP
• Add SWIG Binding to Heccer
• chemesis-3-log
• Create Heccer Test
• Extend GENESIS Functionality
• Extend Model Container
• Extend Model Container (Details)
• Integrating with the G-Shell

Create and Add Solver Object to GENESIS 3

This developer guide gives an example of how to add a new simulation object and integrate this new Component with GENESIS. As an example we implement the pulsegen object of GENESIS 2 that, for simplicity, we will embed as a new component in the Experiment package.

Creating Source Files

First we create the following source files for the new object in the correct places in Experiment:

These source files will be filled in with the functionality of the GENESIS 2 pulsegen object.

Implementation

Declarations

Data Structure

To keep track of all the data for the new object we define a struct(ure) which contains all of our variables. This structure is set up in the header file experiment/pulsegen.h:

Functions

Keeping in mind that the new object is going to be used by a simulation, we need appropriate functions for interaction with the scheduler. The most important functions are: creation and set up of the object’s run-time instance, performing the actions during a single simulation step, and freeing the memory allocated by the object during its lifetime.

• Creation and Set up of a new Pulse Generator:

  struct simobj_PulseGen * PulseGenNew(char *pcName);

• Add a solved variable to the Pulse Generator:

  int PulseGenAddVariable(struct simobj_PulseGen *ppg, void *pvOutput);

• Set data fields for the Pulse Generator:

  int PulseGenSetFields      (         struct simobj_PulseGen *ppg,         double dLevel1,         double dWidth1,         double dDelay1,         double dLevel2,         double dWidth2,         double dDelay2,         double dBaseLevel,         int iTriggerMode      );

• Reset the Pulse Generator:

  int PulseGenReset(struct simobj_PulseGen *ppg);

• Perform a Step of a Simulation:

  int PulseGenSingleStep(struct simobj_PulseGen *ppg, double dTime);

• Freeing Memory after the Simulation has Finished:

  int PulseGenFinish(struct simobj_PulseGen *ppg);

Add New Object to Make Targets

Before compiling the new simulation object you must add your source files to targets of the Experiment package Makefile.am.

• In libexperiment_a_SOURCES add:

  pulsegen.c

• In nobase_include_HEADERS add:

  experiment/pulsegen.h

The new simulation object will be compiled into the Experiment library when a make is performed.