{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Raises": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Yields": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Methods": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Returns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Implicit method based on backward-differentiation formulas." } ] } ], "title": [], "level": 0, "target": null }, "Receives": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Warnings": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Attributes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "n", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Number of equations." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "status", "annotation": "string", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Current status of the solver: 'running', 'finished' or 'failed'." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "t_bound", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Boundary time." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "direction", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Integration direction: +1 or -1." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "t", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Current time." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "y", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Current state." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "t_old", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Previous time. None if no steps were made yet." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "step_size", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Size of the last successful step. None if no steps were made yet." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "nfev", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Number of evaluations of the right-hand side." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "njev", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Number of evaluations of the Jacobian." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "nlu", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Number of LU decompositions." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "fun", "annotation": "callable", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Right-hand side of the system: the time derivative of the state " }, { "__type": "InlineCode", "__tag": 4051, "value": "y" }, { "__type": "Text", "__tag": 4046, "value": " at time " }, { "__type": "InlineCode", "__tag": 4051, "value": "t" }, { "__type": "Text", "__tag": 4046, "value": ". The calling signature is " }, { "__type": "InlineCode", "__tag": 4051, "value": "fun(t, y)" }, { "__type": "Text", "__tag": 4046, "value": ", where " }, { "__type": "InlineCode", "__tag": 4051, "value": "t" }, { "__type": "Text", "__tag": 4046, "value": " is a scalar and " }, { "__type": "InlineCode", "__tag": 4051, "value": "y" }, { "__type": "Text", "__tag": 4046, "value": " is an ndarray with " }, { "__type": "InlineCode", "__tag": 4051, "value": "len(y) = len(y0)" }, { "__type": "Text", "__tag": 4046, "value": ". " }, { "__type": "InlineCode", "__tag": 4051, "value": "fun" }, { "__type": "Text", "__tag": 4046, "value": " must return an array of the same shape as " }, { "__type": "InlineCode", "__tag": 4051, "value": "y" }, { "__type": "Text", "__tag": 4046, "value": ". See " }, { "__type": "ParamRef", "__tag": 4071, "name": "vectorized" }, { "__type": "Text", "__tag": 4046, "value": " for more information." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "t0", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Initial time." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "y0", "annotation": "array_like, shape (n,)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Initial state." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "t_bound", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Boundary time - the integration won't continue beyond it. It also determines the direction of the integration." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "first_step", "annotation": "float or None, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Initial step size. Default is " }, { "__type": "InlineCode", "__tag": 4051, "value": "None" }, { "__type": "Text", "__tag": 4046, "value": " which means that the algorithm should choose." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "max_step", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Maximum allowed step size. Default is np.inf, i.e., the step size is not bounded and determined solely by the solver." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "rtol, atol", "annotation": "float and array_like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Relative and absolute tolerances. The solver keeps the local error estimates less than " }, { "__type": "InlineCode", "__tag": 4051, "value": "atol + rtol * abs(y)" }, { "__type": "Text", "__tag": 4046, "value": ". Here " }, { "__type": "ParamRef", "__tag": 4071, "name": "rtol" }, { "__type": "Text", "__tag": 4046, "value": " controls a relative accuracy (number of correct digits), while " }, { "__type": "ParamRef", "__tag": 4071, "name": "atol" }, { "__type": "Text", "__tag": 4046, "value": " controls absolute accuracy (number of correct decimal places). To achieve the desired " }, { "__type": "ParamRef", "__tag": 4071, "name": "rtol" }, { "__type": "Text", "__tag": 4046, "value": ", set " }, { "__type": "ParamRef", "__tag": 4071, "name": "atol" }, { "__type": "Text", "__tag": 4046, "value": " to be smaller than the smallest value that can be expected from " }, { "__type": "InlineCode", "__tag": 4051, "value": "rtol * abs(y)" }, { "__type": "Text", "__tag": 4046, "value": " so that " }, { "__type": "ParamRef", "__tag": 4071, "name": "rtol" }, { "__type": "Text", "__tag": 4046, "value": " dominates the allowable error. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "atol" }, { "__type": "Text", "__tag": 4046, "value": " is larger than " }, { "__type": "InlineCode", "__tag": 4051, "value": "rtol * abs(y)" }, { "__type": "Text", "__tag": 4046, "value": " the number of correct digits is not guaranteed. Conversely, to achieve the desired " }, { "__type": "ParamRef", "__tag": 4071, "name": "atol" }, { "__type": "Text", "__tag": 4046, "value": " set " }, { "__type": "ParamRef", "__tag": 4071, "name": "rtol" }, { "__type": "Text", "__tag": 4046, "value": " such that " }, { "__type": "InlineCode", "__tag": 4051, "value": "rtol * abs(y)" }, { "__type": "Text", "__tag": 4046, "value": " is always smaller than " }, { "__type": "ParamRef", "__tag": 4071, "name": "atol" }, { "__type": "Text", "__tag": 4046, "value": ". If components of y have different scales, it might be beneficial to set different " }, { "__type": "ParamRef", "__tag": 4071, "name": "atol" }, { "__type": "Text", "__tag": 4046, "value": " values for different components by passing array_like with shape (n,) for " }, { "__type": "ParamRef", "__tag": 4071, "name": "atol" }, { "__type": "Text", "__tag": 4046, "value": ". Default values are 1e-3 for " }, { "__type": "ParamRef", "__tag": 4071, "name": "rtol" }, { "__type": "Text", "__tag": 4046, "value": " and 1e-6 for " }, { "__type": "ParamRef", "__tag": 4071, "name": "atol" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "jac", "annotation": "{None, array_like, sparse_matrix, callable}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Jacobian matrix of the right-hand side of the system with respect to y, required by this method. The Jacobian matrix has shape (n, n) and its element (i, j) is equal to " }, { "__type": "InlineCode", "__tag": 4051, "value": "d f_i / d y_j" }, { "__type": "Text", "__tag": 4046, "value": ". There are three ways to define the Jacobian:" } ] }, { "__type": "Blockquote", "__tag": 4059, "children": [ { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If array_like or sparse_matrix, the Jacobian is assumed to be constant." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If callable, the Jacobian is assumed to depend on both t and y; it will be called as " }, { "__type": "InlineCode", "__tag": 4051, "value": "jac(t, y)" }, { "__type": "Text", "__tag": 4046, "value": " as necessary. For the 'Radau' and 'BDF' methods, the return value might be a sparse matrix." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If None (default), the Jacobian will be approximated by finite differences." } ] } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "It is generally recommended to provide the Jacobian rather than relying on a finite-difference approximation." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "jac_sparsity", "annotation": "{None, array_like, sparse matrix}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Defines a sparsity structure of the Jacobian matrix for a finite-difference approximation. Its shape must be (n, n). This argument is ignored if " }, { "__type": "ParamRef", "__tag": 4071, "name": "jac" }, { "__type": "Text", "__tag": 4046, "value": " is not " }, { "__type": "InlineRole", "__tag": 4003, "value": "None", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ". If the Jacobian has only few non-zero elements in " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "each" } ] }, { "__type": "Text", "__tag": 4046, "value": " row, providing the sparsity structure will greatly speed up the computations " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "4" }, { "__type": "Text", "__tag": 4046, "value": ". A zero entry means that a corresponding element in the Jacobian is always zero. If None (default), the Jacobian is assumed to be dense." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "vectorized", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether " }, { "__type": "ParamRef", "__tag": 4071, "name": "fun" }, { "__type": "Text", "__tag": 4046, "value": " can be called in a vectorized fashion. Default is False." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "InlineCode", "__tag": 4051, "value": "vectorized" }, { "__type": "Text", "__tag": 4046, "value": " is False, " }, { "__type": "ParamRef", "__tag": 4071, "name": "fun" }, { "__type": "Text", "__tag": 4046, "value": " will always be called with " }, { "__type": "InlineCode", "__tag": 4051, "value": "y" }, { "__type": "Text", "__tag": 4046, "value": " of shape " }, { "__type": "InlineCode", "__tag": 4051, "value": "(n,)" }, { "__type": "Text", "__tag": 4046, "value": ", where " }, { "__type": "InlineCode", "__tag": 4051, "value": "n = len(y0)" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "InlineCode", "__tag": 4051, "value": "vectorized" }, { "__type": "Text", "__tag": 4046, "value": " is True, " }, { "__type": "ParamRef", "__tag": 4071, "name": "fun" }, { "__type": "Text", "__tag": 4046, "value": " may be called with " }, { "__type": "InlineCode", "__tag": 4051, "value": "y" }, { "__type": "Text", "__tag": 4046, "value": " of shape " }, { "__type": "InlineCode", "__tag": 4051, "value": "(n, k)" }, { "__type": "Text", "__tag": 4046, "value": ", where " }, { "__type": "InlineCode", "__tag": 4051, "value": "k" }, { "__type": "Text", "__tag": 4046, "value": " is an integer. In this case, " }, { "__type": "ParamRef", "__tag": 4071, "name": "fun" }, { "__type": "Text", "__tag": 4046, "value": " must behave such that " }, { "__type": "InlineCode", "__tag": 4051, "value": "fun(t, y)[:, i] == fun(t, y[:, i])" }, { "__type": "Text", "__tag": 4046, "value": " (i.e. each column of the returned array is the time derivative of the state corresponding with a column of " }, { "__type": "InlineCode", "__tag": 4051, "value": "y" }, { "__type": "Text", "__tag": 4046, "value": ")." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Setting " }, { "__type": "InlineCode", "__tag": 4051, "value": "vectorized=True" }, { "__type": "Text", "__tag": 4046, "value": " allows for faster finite difference approximation of the Jacobian by this method, but may result in slower execution overall in some circumstances (e.g. small " }, { "__type": "InlineCode", "__tag": 4051, "value": "len(y0)" }, { "__type": "Text", "__tag": 4046, "value": ")." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This is a variable order method with the order varying automatically from 1 to 5. The general framework of the BDF algorithm is described in " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "1" }, { "__type": "Text", "__tag": 4046, "value": ". This class implements a quasi-constant step size as explained in " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "2" }, { "__type": "Text", "__tag": 4046, "value": ". The error estimation strategy for the constant-step BDF is derived in " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "3" }, { "__type": "Text", "__tag": 4046, "value": ". An accuracy enhancement using modified formulas (NDF) " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "2" }, { "__type": "Text", "__tag": 4046, "value": " is also implemented." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Can be applied in the complex domain." } ] } ], "title": [], "level": 0, "target": null }, "Other Parameters": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null } }, "_ordered_sections": [ "Summary", "Extended Summary", "Parameters", "Attributes", "Methods", "Returns", "Yields", "Receives", "Other Parameters", "Raises", "Warns", "Warnings", "Notes" ], "item_file": "/scipy/integrate/_ivp/bdf.py", "item_line": 72, "item_type": "class", "aliases": [ "scipy.integrate.BDF" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "fun", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "t0", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "y0", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "t_bound", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "max_step", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "inf" }, { "__type": "SigParam", "__tag": 4030, "name": "rtol", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0.001" }, { "__type": "SigParam", "__tag": 4030, "name": "atol", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "1e-06" }, { "__type": "SigParam", "__tag": 4030, "name": "jac", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "jac_sparsity", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "vectorized", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "first_step", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "extraneous", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "VAR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "BDF" }, "references": [ ".. [1] G. D. Byrne, A. C. Hindmarsh, \"A Polyalgorithm for the Numerical", " Solution of Ordinary Differential Equations\", ACM Transactions on", " Mathematical Software, Vol. 1, No. 1, pp. 71-96, March 1975.", ".. [2] L. F. Shampine, M. W. Reichelt, \"THE MATLAB ODE SUITE\", SIAM J. SCI.", " COMPUTE., Vol. 18, No. 1, pp. 1-22, January 1997.", ".. [3] E. Hairer, G. Wanner, \"Solving Ordinary Differential Equations I:", " Nonstiff Problems\", Sec. III.2.", ".. [4] A. Curtis, M. J. D. Powell, and J. Reid, \"On the estimation of", " sparse Jacobian matrices\", Journal of the Institute of Mathematics", " and its Applications, 13, pp. 117-120, 1974." ], "qa": "scipy.integrate._ivp.bdf:BDF", "arbitrary": [], "local_refs": [ "atol", "direction", "first_step", "fun", "jac", "jac_sparsity", "max_step", "n", "nfev", "njev", "nlu", "rtol", "status", "step_size", "t", "t0", "t_bound", "t_old", "vectorized", "y", "y0" ] }