{ "__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": "Base class for ODE solvers." } ] } ], "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 the system's rhs evaluations." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "njev", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Number of the Jacobian evaluations." } ] } ] }, { "__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": "vectorized", "annotation": "bool", "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 methods 'Radau' and 'BDF', but will result in slower execution for other methods. It can also result in slower overall execution for 'Radau' and 'BDF' in some circumstances (e.g. small " }, { "__type": "InlineCode", "__tag": 4051, "value": "len(y0)" }, { "__type": "Text", "__tag": 4046, "value": ")." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "support_complex", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether integration in a complex domain should be supported. Generally determined by a derived solver class capabilities. Default is False." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "In order to implement a new solver you need to follow the guidelines:" } ] }, { "__type": "Blockquote", "__tag": 4059, "children": [ { "__type": "BulletList", "__tag": 4053, "ordered": true, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A constructor must accept parameters presented in the base class (listed below) along with any other parameters specific to a solver." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A constructor must accept arbitrary extraneous arguments " }, { "__type": "InlineCode", "__tag": 4051, "value": "**extraneous" }, { "__type": "Text", "__tag": 4046, "value": ", but warn that these arguments are irrelevant using " }, { "__type": "CrossRef", "__tag": 4002, "value": "common.warn_extraneous", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.integrate._ivp.common:warn_extraneous" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " function. Do not pass these arguments to the base class." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A solver must implement a private method " }, { "__type": "InlineRole", "__tag": 4003, "value": "_step_impl(self)", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " which propagates a solver one step further. It must return tuple " }, { "__type": "InlineCode", "__tag": 4051, "value": "(success, message)" }, { "__type": "Text", "__tag": 4046, "value": ", where " }, { "__type": "InlineCode", "__tag": 4051, "value": "success" }, { "__type": "Text", "__tag": 4046, "value": " is a boolean indicating whether a step was successful, and " }, { "__type": "InlineCode", "__tag": 4051, "value": "message" }, { "__type": "Text", "__tag": 4046, "value": " is a string containing description of a failure if a step failed or None otherwise." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A solver must implement a private method " }, { "__type": "InlineRole", "__tag": 4003, "value": "_dense_output_impl(self)", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", which returns a " }, { "__type": "CrossRef", "__tag": 4002, "value": "DenseOutput", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.integrate._ivp.base:DenseOutput" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " object covering the last successful step." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A solver must have attributes listed below in Attributes section. Note that " }, { "__type": "InlineCode", "__tag": 4051, "value": "t_old" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "step_size" }, { "__type": "Text", "__tag": 4046, "value": " are updated automatically." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Use " }, { "__type": "InlineRole", "__tag": 4003, "value": "fun(self, t, y)", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " method for the system rhs evaluation, this way the number of function evaluations (" }, { "__type": "CrossRef", "__tag": 4002, "value": "nfev", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "nfev" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": ") will be tracked automatically." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For convenience, a base class provides " }, { "__type": "InlineRole", "__tag": 4003, "value": "fun_single(self, t, y)", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineRole", "__tag": 4003, "value": "fun_vectorized(self, t, y)", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for evaluating the rhs in non-vectorized and vectorized fashions respectively (regardless of how " }, { "__type": "ParamRef", "__tag": 4071, "name": "fun" }, { "__type": "Text", "__tag": 4046, "value": " from the constructor is implemented). These calls don't increment " }, { "__type": "CrossRef", "__tag": 4002, "value": "nfev", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "nfev" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If a solver uses a Jacobian matrix and LU decompositions, it should track the number of Jacobian evaluations (" }, { "__type": "CrossRef", "__tag": 4002, "value": "njev", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "njev" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": ") and the number of LU decompositions (" }, { "__type": "CrossRef", "__tag": 4002, "value": "nlu", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "nlu" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": ")." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "By convention, the function evaluations used to compute a finite difference approximation of the Jacobian should not be counted in " }, { "__type": "CrossRef", "__tag": 4002, "value": "nfev", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "nfev" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": ", thus use " }, { "__type": "InlineRole", "__tag": 4003, "value": "fun_single(self, t, y)", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "InlineRole", "__tag": 4003, "value": "fun_vectorized(self, t, y)", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " when computing a finite difference approximation of the Jacobian." } ] } ] } ] } ] } ], "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/base.py", "item_line": 29, "item_type": "class", "aliases": [ "scipy.integrate.OdeSolver" ], "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": "vectorized", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "support_complex", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "OdeSolver" }, "references": null, "qa": "scipy.integrate._ivp.base:OdeSolver", "arbitrary": [], "local_refs": [ "direction", "fun", "n", "nfev", "njev", "nlu", "status", "step_size", "support_complex", "t", "t0", "t_bound", "t_old", "vectorized", "y", "y0" ] }