Extreme Optimization™: Complexity made simple.

Math and Statistics
Libraries for .NET

  • Home
  • Features
    • Math Library
    • Vector and Matrix Library
    • Statistics Library
    • Performance
    • Usability
  • Documentation
    • Introduction
    • Math Library User's Guide
    • Vector and Matrix Library User's Guide
    • Data Analysis Library User's Guide
    • Statistics Library User's Guide
    • Reference
  • Resources
    • Downloads
    • QuickStart Samples
    • Sample Applications
    • Frequently Asked Questions
    • Technical Support
  • Blog
  • Order
  • Company
    • About us
    • Testimonials
    • Customers
    • Press Releases
    • Careers
    • Partners
    • Contact us
Introduction
Deployment Guide
Nuget packages
Configuration
Using Parallelism
Expand Mathematics Library User's GuideMathematics Library User's Guide
Expand Vector and Matrix Library User's GuideVector and Matrix Library User's Guide
Expand Data Analysis Library User's GuideData Analysis Library User's Guide
Expand Statistics Library User's GuideStatistics Library User's Guide
Expand Data Access Library User's GuideData Access Library User's Guide
Expand ReferenceReference
  • Extreme Optimization
    • Features
    • Solutions
    • Documentation
    • QuickStart Samples
    • Sample Applications
    • Downloads
    • Technical Support
    • Download trial
    • How to buy
    • Blog
    • Company
    • Resources
  • Documentation
    • Introduction
    • Deployment Guide
    • Nuget packages
    • Configuration
    • Using Parallelism
    • Mathematics Library User's Guide
    • Vector and Matrix Library User's Guide
    • Data Analysis Library User's Guide
    • Statistics Library User's Guide
    • Data Access Library User's Guide
    • Reference
  • Reference
    • Extreme
    • Extreme.Collections
    • Extreme.Data
    • Extreme.Data.Json
    • Extreme.Data.Matlab
    • Extreme.Data.R
    • Extreme.Data.Stata
    • Extreme.Data.Text
    • Extreme.DataAnalysis
    • Extreme.DataAnalysis.Linq
    • Extreme.DataAnalysis.Models
    • Extreme.Mathematics
    • Extreme.Mathematics.Algorithms
    • Extreme.Mathematics.Calculus
    • Extreme.Mathematics.Calculus.OrdinaryDifferentialEquations
    • Extreme.Mathematics.Curves
    • Extreme.Mathematics.Curves.Nonlinear
    • Extreme.Mathematics.Distributed
    • Extreme.Mathematics.EquationSolvers
    • Extreme.Mathematics.Generic
    • Extreme.Mathematics.LinearAlgebra
    • Extreme.Mathematics.LinearAlgebra.Implementation
    • Extreme.Mathematics.LinearAlgebra.IterativeSolvers
    • Extreme.Mathematics.LinearAlgebra.IterativeSolvers.Preconditioners
    • Extreme.Mathematics.Optimization
    • Extreme.Mathematics.Optimization.LineSearches
    • Extreme.Mathematics.Random
    • Extreme.Mathematics.SignalProcessing
    • Extreme.Providers
    • Extreme.Providers.InteropServices
    • Extreme.Statistics
    • Extreme.Statistics.Distributions
    • Extreme.Statistics.Multivariate
    • Extreme.Statistics.Tests
    • Extreme.Statistics.TimeSeriesAnalysis
  • Extreme.Mathematics.Calculus.OrdinaryDifferentialEquations
    • ClassicRungeKuttaIntegrator Class
    • CvodeIntegrator Class
    • DifferentialFunction Delegate
    • DifferentialJacobianFunction Delegate
    • OdeIntegrator Class
    • OdeIntegrator.OdeIntegrationTask Enumeration
    • OdeKind Enumeration
    • RungeKuttaDormandPrince Class
    • RungeKuttaFehlbergIntegrator Class
  • CvodeIntegrator Class
    • CvodeIntegrator Constructors
    • Properties
    • Methods

CvodeIntegrator Class

Extreme Optimization Numerical Libraries for .NET Professional
Represents an integrator that uses an adaptive Adams-Bashforth/Adams-Moulton algorithm for non-stiff systems and Backwards Differentiation Formulas (BDF) for stiff systems.
Inheritance Hierarchy

SystemObject
  Extreme.Mathematics.AlgorithmsManagedIterativeAlgorithmVectorDouble, Double, SolutionReportVectorDouble, Double
    Extreme.Mathematics.AlgorithmsManagedIterativeAlgorithmVectorDouble
      Extreme.Mathematics.Calculus.OrdinaryDifferentialEquationsOdeIntegrator
        Extreme.Mathematics.Calculus.OrdinaryDifferentialEquationsCvodeIntegrator

Namespace:  Extreme.Mathematics.Calculus.OrdinaryDifferentialEquations
Assembly:  Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.1
Syntax

C#
VB
C++
F#
Copy
public sealed class CvodeIntegrator : OdeIntegrator
Public NotInheritable Class CvodeIntegrator
	Inherits OdeIntegrator
public ref class CvodeIntegrator sealed : public OdeIntegrator
[<SealedAttribute>]
type CvodeIntegrator =  
    class
        inherit OdeIntegrator
    end

The CvodeIntegrator type exposes the following members.

Constructors

  NameDescription
Public methodCvodeIntegrator
Constructs a new CvodeIntegrator object, suitable for integrating non-stiff systems of ordinary differential equations.
Public methodCvodeIntegrator(OdeKind)
Constructs a new CvodeIntegrator object.
Top
Properties

  NameDescription
Public propertyAbsoluteTolerance
Gets or sets the absolute tolerance used in the convergence test.
(Inherited from OdeIntegrator.)
Public propertyConvergenceTests
Gets the collection of convergence tests for the algorithm.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyCurrentTime
Gets the current value of the time parameter.
(Inherited from OdeIntegrator.)
Public propertyCurrentValue
Gets the current value of the unknowns.
(Inherited from OdeIntegrator.)
Public propertyDifferentialFunction
Gets or sets a function that should be integrated.
(Inherited from OdeIntegrator.)
Public propertyEstimatedError
Gets a value indicating the size of the absolute error of the result.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyEvaluationsNeeded
Gets the number of evaluations needed to execute the algorithm.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyEventFunction
Gets the function that is called when a special event occurs.
Public propertyHasSharedDegreeOfParallelism
Indicates whether the degree of parallelism is a property that is shared across instances.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyInitialStepsize
Gets or sets the initial time value.
(Inherited from OdeIntegrator.)
Public propertyInitialTime
Gets or sets the initial time value.
(Inherited from OdeIntegrator.)
Public propertyInitialValue
Gets or sets the initial value.
(Inherited from OdeIntegrator.)
Public propertyIterationsNeeded
Gets the number of iterations needed by the algorithm to reach the desired accuracy.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyMaxDegreeOfParallelism
Gets or sets the maximum degree of parallelism enabled by this instance.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyMaxEvaluations
Gets or sets the maximum number of evaluations during the calculation.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyMaxIterations
Gets or sets the maximum number of iterations to use when approximating the roots of the target function.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyMaxStepSize
Gets or sets the maximum step size.
(Inherited from OdeIntegrator.)
Public propertyMinIterations
Gets or sets the minimum iterations that have to be performed.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyMinStepSize
Gets or sets the minimum step size.
(Inherited from OdeIntegrator.)
Public propertyParallelOptions
Gets or sets the configuration for the parallel behavior of the algorithm.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyRelativeTolerance
Gets or sets the relative tolerance used in the convergence test.
(Inherited from OdeIntegrator.)
Public propertyResult
Gets the result of an algorithm after it has executed.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertySolutionReport
Gets the result of an algorithm after it has executed.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyStatus
Gets the AlgorithmStatus following an execution of the algorithm.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Public propertyStepSize
Gets or sets the step size used in the last step.
(Inherited from OdeIntegrator.)
Public propertyThrowExceptionOnFailure
Gets or sets a value indicating whether to throw an exception when the algorithm fails to converge.
(Inherited from ManagedIterativeAlgorithmT, TError, TReport.)
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIntegrate
Performs the numerical integration up to a specified time value.
(Inherited from OdeIntegrator.)
Public methodIntegrateMultipleSteps
Performs multiple steps of the numerical integration at least as far as the specified final time.
(Inherited from OdeIntegrator.)
Public methodIntegrateSingleStep
Performs one step of the numerical integration in the direction of the final time.
(Inherited from OdeIntegrator.)
Public methodRestart
Resets the integrator so the next integration will start from the initial conditions.
(Inherited from OdeIntegrator.)
Public methodRestart(Double, VectorDouble)
Resets the integrator so the next integration will start from the specified initial conditions.
(Inherited from OdeIntegrator.)
Public methodSetDenseJacobian
Sets the function that computes the Jacobian of a stiff system.
Public methodSetEventFunction
Initializes a root finding problem to be solved during the integration of the system of ordinary differential equations.
Public methodSetTolerances(Double, VectorDouble)
Sets the absolute and relative tolerances for the integration.
Public methodSetTolerances(Double, Double)
Sets the absolute and relative tolerances for the integration.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

Use the CvodeIntegrator class to integrate any system of ordinary differential equations using an adaptive algorithm that works on well-behaved and stiff systems.

The system of differential equations is defined using a DifferentialFunction delegate. This is a delegate that takes one real argument (the time value), and two vector arguments (the current value and the current derivative). The last argument is passed by reference and must also be returned.

To set up an integration, set the DifferentialFunction property equal to the object that defines the system. Set the InitialTime and InitialValue properties to the initial time value and function values, respectively.

To perform the actual integration, call the Integrate(Double) method with the desired final time. This method returns the function value at the final time. You can call this method multiple times to get function values at intermediate positions.

See Also

Reference

Extreme.Mathematics.Calculus.OrdinaryDifferentialEquations Namespace

Copyright (c) 2004-2021 ExoAnalytics Inc.

Send comments on this topic to support@extremeoptimization.com

Copyright © 2004-2021, Extreme Optimization. All rights reserved.
Extreme Optimization, Complexity made simple, M#, and M Sharp are trademarks of ExoAnalytics Inc.
Microsoft, Visual C#, Visual Basic, Visual Studio, Visual Studio.NET, and the Optimized for Visual Studio logo
are registered trademarks of Microsoft Corporation.