README
Project Home
The source codes for the OSCILATE (Oscillators’ nonlinear analysis through SymboliC ImpLementATion of the mEthod of multiple scales) project are hosted on GitHub.
Nonlinear systems considered
The OSCILATE project allows the application of the Method of Multiple Scales (MMS) to a nonlinear equation or systems of \(N\) coupled nonlinear equations of the form
The \(x_i(t)\) (\(i=0,...,N-1\)) are the oscillators’ coordinates,
is the vector containing all the oscillators’ coordinates (the \(^\intercal\) denotes the transpose), \(\omega_i\) are their natural frequencies, \(t\) is the time and \(\dot{(\bullet)} = \textrm{d}(\bullet)/\textrm{d}t\) denotes a time-derivative. The \(f_i\) are functions which can contain:
Weak linear terms in \(x_i,\; \dot{x}_i\), or \(\ddot{x}_i\).
Weak linear coupling terms involving \(x_j,\; \dot{x}_j\), or \(\ddot{x}_j\) with \(j \neq i\).
Weak nonlinear terms. Taylor expansions are performed to approximate nonlinear terms as polynomial nonlinearities.
Forcing terms:
Can be hard (appearing at leading order) or weak (small).
Primarily harmonic, e.g., \(F \cos(\omega t)\), where \(F\) and \(\omega\) are the forcing amplitude and frequency, respectively.
Modulated by any function (constant, linear, or nonlinear) to model parametric forcing (e.g., \(x_i(t) F \cos(\omega t)\)).
Internal resonance relations among oscillators can be specified in a second step by expressing the \(\omega_i\) as a function of a reference frequency. Detuning can also be introduced during this step.
Details on the Method of Multiple Scales are given in The Method of Multiple Scales.
Overview
The package associated to the OSCILATE project is called oscilate.
It is organised as follows:
oscilate
│ sympy_functions.py
│ __init__.py
│ __version__.py
│
└───MMS
dyn_sys.py
mms.py
steady_state.py
visualisation.py
__init__.py
oscilate.MMSmodule is the MMS solver. It is divided into four sub-modules:oscilate.MMS.dyn_syssub-module defines the dynamical system of interest,oscilate.MMS.mmssub-module applies the MMS to the dynamical system,oscilate.MMS.steady_statesub-module allows for a steady state analysis,oscilate.MMS.visualisationsub-module contains numerical evaluation and plotting functions,
oscilate.sympy_functionsmodule contains additional functions that are not directly related to the MMS but which are used inoscilate.MMS.
Solver
oscilate.MMS embeds 3 main classes:
oscilate.MMS.dyn_sys.Dynamical_system: the dynamical system consideredoscilate.MMS.mms.Multiple_scales_system: the system obtained after applying the MMS to the dynamical systemoscilate.MMS.steady_state.Steady_state: the MMS results evaluated at steady state and (if computed) the system’s response and its stability.
These classes are described in details in the Modules section of the documentation. A visual description of their connection with other classes is provided in Main module architecture.
Examples
Application examples are proposed in the documentation. They include:
The Duffing oscillator
Coupled Duffing oscillators
Coupled nonlinear oscillators with quadratic nonlinearities
Parametrically excited oscillators
Hard forcing of a Duffing oscillator
Subharmonic response of 2 coupled centrifugal pendulum modes
Outputs
Results are returned as SymPy expressions. They can be printed using \(\LaTeX\) if the code is ran in an appropriate interactive window. Here are possibilities:
SymPy expressions can also be printed as unformatted \(\LaTeX\) using
print(vlatex(the_expr))
Methods of oscilate.mms.MMS.Steady_state also allow to evaluate sympy results for given numerical values of system parameters and to plot them.
Citation
Please cite this package when using it. See the Citation section for details.
Installation guide
To install the oscilate package, refer to the Installation guide section.
Disclaimer
This code is provided as-is and has been tested on a limited number of nonlinear systems. Other test cases might trigger bugs or unexpected behavior that I am not yet aware of. If you encounter any issues, find a bug, or have suggestions for improvements, please feel free to:
Open an issue on the GitHub repository,
Propose a solution,
Contact me directly at [vincent.mahe@ec-nantes.fr].
Your feedback is highly appreciated!
Vincent MAHE
License
This project is licensed under the Apache License 2.0 – see the LICENSE file for details.