A skeleton of the user’s main program

The following is a skeleton of the user’s main program (or calling program) for the integration of an ODE IVP using the ERKStep module. Most of the steps are independent of the NVECTOR implementation used. For the steps that are not, refer to §9 for the specific name of the function to be called or macro to be referenced.

  1. Initialize parallel or multi-threaded environment, if appropriate.

    For example, call MPI_Init to initialize MPI if used, or set num_threads, the number of threads to use within the threaded vector functions, if used.

  2. Create the SUNDIALS simulation context object.

    Call SUNContext_Create() to allocate the SUNContext object.

  3. Set problem dimensions, etc.

    This generally includes the problem size, N, and may include the local vector length Nlocal.


    The variables N and Nlocal should be of type sunindextype.

  4. Set vector of initial values

    To set the vector y0 of initial values, use the appropriate functions defined by the particular NVECTOR implementation.

    For native SUNDIALS vector implementations (except the CUDA and RAJA based ones), use a call of the form

    y0 = N_VMake_***(..., ydata);

    if the sunrealtype array ydata containing the initial values of \(y\) already exists. Otherwise, create a new vector by making a call of the form

    y0 = N_VNew_***(...);

    and then set its elements by accessing the underlying data where it is located with a call of the form

    ydata = N_VGetArrayPointer_***(y0);

    For details on each of SUNDIALS’ provided vector implementations, see the corresponding sections in §9 for details.

  5. Create ERKStep object

    Call arkode_mem = ERKStepCreate(...) to create the ERKStep memory block. ERKStepCreate() returns a void* pointer to this memory structure. See § for details.

  6. Specify integration tolerances

    Call ERKStepSStolerances() or ERKStepSVtolerances() to specify either a scalar relative tolerance and scalar absolute tolerance, or a scalar relative tolerance and a vector of absolute tolerances, respectively. Alternatively, call ERKStepWFtolerances() to specify a function which sets directly the weights used in evaluating WRMS vector norms. See § for details.

  7. Set optional inputs

    Call ERKStepSet* functions to change any optional inputs that control the behavior of ERKStep from their default values. See § for details.

  8. Specify rootfinding problem

    Optionally, call ERKStepRootInit() to initialize a rootfinding problem to be solved during the integration of the ODE system. See § for general details, and § for relevant optional input calls.

  9. Advance solution in time

    For each point at which output is desired, call

    ier = ERKStepEvolve(arkode_mem, tout, yout, &tret, itask);

    Here, itask specifies the return mode. The vector yout (which can be the same as the vector y0 above) will contain \(y(t_\text{out})\). See § for details.

  10. Get optional outputs

    Call ERKStepGet* functions to obtain optional output. See § for details.

  11. Deallocate memory for solution vector

    Upon completion of the integration, deallocate memory for the vector y (or yout) by calling the NVECTOR destructor function:

  12. Free solver memory

    Call ERKStepFree() to free the memory allocated for the ERKStep module.

  13. Finalize MPI, if used

    Call MPI_Finalize to terminate MPI.