Cvode Integrator Class
Definition
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.3
public sealed class CvodeIntegrator : OdeIntegrator
- Inheritance
- Object → ManagedIterativeAlgorithm<Vector<Double>, Double, SolutionReport<Vector<Double>, Double>> → ManagedIterativeAlgorithm<Vector<Double>> → OdeIntegrator → CvodeIntegrator
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.
Constructors
Cvode | Constructs a new CvodeIntegrator object, suitable for integrating non-stiff systems of ordinary differential equations. |
Cvode | Constructs a new CvodeIntegrator object. |
Properties
Absolute |
Gets or sets the absolute tolerance used in the
convergence test.
(Inherited from OdeIntegrator) |
Convergence |
Gets the collection of convergence tests for the algorithm.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
Current |
Gets the current value of the time parameter.
(Inherited from OdeIntegrator) |
Current |
Gets the current value of the unknowns.
(Inherited from OdeIntegrator) |
Differential |
Gets or sets a function that should be integrated.
(Inherited from OdeIntegrator) |
Estimated |
Gets a value indicating the size of the absolute
error of the result.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
Evaluations |
Gets the number of evaluations needed to execute the algorithm.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
Event | Gets the function that is called when a special event occurs. |
Has |
Indicates whether the degree of parallelism is a property that is shared
across instances.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
Initial |
Gets or sets the initial time value.
(Inherited from OdeIntegrator) |
Initial |
Gets or sets the initial time value.
(Inherited from OdeIntegrator) |
Initial |
Gets or sets the initial value.
(Inherited from OdeIntegrator) |
Iterations |
Gets the number of iterations needed by the
algorithm to reach the desired accuracy.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
Max |
Gets or sets the maximum degree of parallelism enabled by this instance.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
Max |
Gets or sets the maximum number of evaluations during the calculation.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
Max | Gets or sets the maximum number of iterations
to use when approximating the roots of the target
function.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
Max |
Gets or sets the maximum step size.
(Inherited from OdeIntegrator) |
Min |
Gets or sets the minimum iterations that have to be performed.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
Min |
Gets or sets the minimum step size.
(Inherited from OdeIntegrator) |
Parallel |
Gets or sets the configuration for the parallel behavior of the algorithm.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
Relative |
Gets or sets the relative tolerance used in the
convergence test.
(Inherited from OdeIntegrator) |
Result |
Gets the result of an algorithm after it has executed.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
Solution |
Gets the result of an algorithm after it has executed.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
Status |
Gets the AlgorithmStatus following
an execution of the algorithm.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
Step |
Gets or sets the step size used in the last step.
(Inherited from OdeIntegrator) |
Throw |
Gets or sets whether to throw an
exception when the algorithm fails to converge.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |
Methods
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
Get | Serves as the default hash function. (Inherited from Object) |
Get | Gets the Type of the current instance. (Inherited from Object) |
Integrate |
Performs the numerical integration up to a specified time value.
(Inherited from OdeIntegrator) |
Integrate |
Performs multiple steps of the numerical integration at least as far as the specified final time.
(Inherited from OdeIntegrator) |
Integrate |
Performs one step of the numerical integration in the direction of the final time.
(Inherited from OdeIntegrator) |
Restart() |
Resets the integrator so the next integration will start from the initial conditions.
(Inherited from OdeIntegrator) |
Restart( |
Resets the integrator so the next integration will start from the specified initial conditions.
(Inherited from OdeIntegrator) |
Set | Sets the function that computes the Jacobian of a stiff system. |
Set | Initializes a root finding problem to be solved during the integration of the system of ordinary differential equations. |
Set | Sets the absolute and relative tolerances for the integration. |
Set | Sets the absolute and relative tolerances for the integration. |
ToString | Returns a string that represents the current object. (Inherited from Object) |