R/RcppExports.R

In sundialr: An Interface to 'SUNDIALS' Ordinary Differential Equation (ODE) Solvers

# Generated by using Rcpp::compileAttributes() -> do not edit by hand
# Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393

#'cvode
#'
#' CVODE solver to solve stiff ODEs
#'@param time_vector time vector
#'@param IC Initial Conditions
#'@param input_function Right Hand Side function of ODEs
#'@param Parameters Parameters input to ODEs
#'@param reltolerance Relative Tolerance (a scalar, default value  = 1e-04)
#'@param abstolerance Absolute Tolerance (a scalar or vector with length equal to ydot (dy/dx), default = 1e-04)
#'@returns A data frame. First column is the time-vector, the other columns are values of y in order they are provided.
#'@example /inst/examples/cv_Roberts_dns.r
cvode <- function(time_vector, IC, input_function, Parameters, reltolerance = 0.0001, abstolerance = 0.0001) {
    .Call('_sundialr_cvode', PACKAGE = 'sundialr', time_vector, IC, input_function, Parameters, reltolerance, abstolerance)
}

#' cvodes
#'
#' CVODES solver to solve ODEs and calculate sensitivities
#'@param time_vector time vector
#'@param IC Initial Conditions
#'@param input_function Right Hand Side function of ODEs
#'@param Parameters Parameters input to ODEs
#'@param reltolerance Relative Tolerance (a scalar, default value  = 1e-04)
#'@param abstolerance Absolute Tolerance (a scalar or vector with length equal to ydot, default = 1e-04)
#'@param SensType Sensitivity Type - allowed values are Staggered (default)", "STG" (for Staggered) or "SIM" (for Simultaneous)
#'@param ErrCon Error Control - allowed values are TRUE or FALSE (default)
#'@returns A data frame. First column is the time-vector, the next y * p columns are sensitivities of y1 w.r.t all parameters, then y2 w.r.t all parameters etc. y is the state vector, p is the parameter vector
#'@example /inst/examples/cvs_Roberts_dns.r
cvodes <- function(time_vector, IC, input_function, Parameters, reltolerance = 0.0001, abstolerance = 0.0001, SensType = "STG", ErrCon = 'F') {
    .Call('_sundialr_cvodes', PACKAGE = 'sundialr', time_vector, IC, input_function, Parameters, reltolerance, abstolerance, SensType, ErrCon)
}

#'cvsolve
#'
#'CVSOLVE solver to solve stiff ODEs with discontinuties
#'@param time_vector time vector
#'@param IC Initial Conditions
#'@param input_function Right Hand Side function of ODEs
#'@param Parameters Parameters input to ODEs
#'@param Events Discontinuities in the solution (a DataFrame, default value is NULL)
#'@param reltolerance Relative Tolerance (a scalar, default value  = 1e-04)
#'@param abstolerance Absolute Tolerance (a scalar or vector with length equal to ydot, default = 1e-04)
#'@returns A data frame. First column is the time-vector, the other columns are values of y in order they are provided.
#'@example /inst/examples/cvsolve_1D.r
cvsolve <- function(time_vector, IC, input_function, Parameters, Events = NULL, reltolerance = 0.0001, abstolerance = 0.0001) {
    .Call('_sundialr_cvsolve', PACKAGE = 'sundialr', time_vector, IC, input_function, Parameters, Events, reltolerance, abstolerance)
}

#'ida
#'
#' IDA solver to solve stiff DAEs
#'@param time_vector time vector
#'@param IC Initial Value of y
#'@param IRes Inital Value of ydot
#'@param input_function Right Hand Side function of DAEs
#'@param Parameters Parameters input to ODEs
#'@param reltolerance Relative Tolerance (a scalar, default value  = 1e-04)
#'@param abstolerance Absolute Tolerance (a scalar or vector with length equal to ydot, default = 1e-04)
#'@returns A data frame. First column is the time-vector, the other columns are values of y in order they are provided.
ida <- function(time_vector, IC, IRes, input_function, Parameters, reltolerance = 0.0001, abstolerance = 0.0001) {
    .Call('_sundialr_ida', PACKAGE = 'sundialr', time_vector, IC, IRes, input_function, Parameters, reltolerance, abstolerance)
}