dynamo.pl.plot_separatrix
- dynamo.pl.plot_separatrix(vecfld, x_range, y_range, t, noise=1e-06, lw=3, vecfld_dict=None, background=None, save_show_or_return='return', save_kwargs={}, ax=None)[source]
Plot separatrix on phase portrait.
- Parameters:
vecfld (
VectorField2D
) – an instance of the VectorField2D class which presumably has fixed points computed and stored.x_range (
Union
[_SupportsArray
[dtype
],_NestedSequence
[_SupportsArray
[dtype
]],bool
,int
,float
,complex
,str
,bytes
,_NestedSequence
[Union
[bool
,int
,float
,complex
,str
,bytes
]]]) – the range of values for x-axis.y_range (
Union
[_SupportsArray
[dtype
],_NestedSequence
[_SupportsArray
[dtype
]],bool
,int
,float
,complex
,str
,bytes
,_NestedSequence
[Union
[bool
,int
,float
,complex
,str
,bytes
]]]) – the range of values for y-axis.t (
Union
[_SupportsArray
[dtype
],_NestedSequence
[_SupportsArray
[dtype
]],bool
,int
,float
,complex
,str
,bytes
,_NestedSequence
[Union
[bool
,int
,float
,complex
,str
,bytes
]]]) – the time points for trajectory.noise (
float
) – a small noise added to steady states for drawing the separatrix. Defaults to 1e-6.lw (
float
) – the line width of the trajectory. Defaults to 3.vecfld_dict (
Optional
[Dict
[str
,Any
]]) – a dict with entries to create a VectorField2D instance. Defaults to None.background (
Optional
[str
]) – the background color of the plot. Defaults to None.save_show_or_return (
Literal
['save'
,'show'
,'return'
]) – whether to save, show, or return the generated figure. Defaults to “return”.save_kwargs (
Dict
[str
,Any
]) – a dictionary that will be passed to the save_fig function. By default, it is an empty dictionary and the save_fig function will use the {“path”: None, “prefix”: ‘plot_separatrix’, “dpi”: None, “ext”: ‘pdf’, “transparent”: True, “close”: True, “verbose”: True} as its parameters. Otherwise, you can provide a dictionary that properly modify those keys according to your needs. Defaults to {}.ax (
Optional
[Axes
]) – the axis on which to make the plot. Defaults to None.
- Return type:
- Returns:
None would be returned by default. If save_show_or_return is set to be ‘return’, the Axes of the generated figure would get returned.