diff --git a/README.md b/README.md index 83ed9e47bd334f36de3fea5f842c3c9dc685d251..54c9ab5ca9b650eafe14d21476c323bca24d1461 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,10 @@ - [ Neighbour Ordering Convention. ](#noc) - [ Inexistent Neighbour Convention. ](#inc) - [ MatrixElementCalculator. ](#mec) + - [ RK4Buffer. ](#rk4b) - [ Rk4Stepper. ](#rk4s) + - [ SystemParameters. ](#sysparams) + - [ System. ](#system) @@ -298,6 +301,7 @@ the individual functions correctly to accomodate the correct neighbours. other updates need to be taken care of. - Arguments: Force functional, Drum vector, Adjacency vector, time step, start time of current step +<a name="sysparams"></a> ### `SystemParameters` (system_parameters.hpp), holds system parameters 1. Template arguments - `coupler_t`: Coupler type @@ -307,6 +311,7 @@ the individual functions correctly to accomodate the correct neighbours. - `driver`: The driver_t object of the system - `adjacency_vector`: A `std::vector<std::vector<int> >` representing the adjacency vector +<a name="system"></a> ### `System` (system.hpp), holds all parts together 1. Template arguments - `value_t`: Scalar type