system.qbk 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. [/============================================================================
  2. Boost.odeint
  3. Copyright 2011 Mario Mulansky
  4. Copyright 2011-2012 Karsten Ahnert
  5. Use, modification and distribution is subject to the Boost Software License,
  6. Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  7. http://www.boost.org/LICENSE_1_0.txt)
  8. =============================================================================/]
  9. [section System]
  10. [heading Description]
  11. The System concept models the algorithmic implementation of the rhs. of the ODE ['x' = f(x,t)].
  12. The only requirement for this concept is that it should be callable with a specific parameter syntax (see below).
  13. A System is typically implemented as a function or a functor.
  14. Systems fulfilling this concept are required by all Runge-Kutta steppers as well as the Bulirsch-Stoer steppers.
  15. However, symplectic and implicit steppers work with other system concepts, see __symplectic_system and __implicit_system.
  16. [heading Notation]
  17. [variablelist
  18. [[`System`] [A type that is a model of System]]
  19. [[`State`] [A type representing the state /x/ of the ODE]]
  20. [[`Deriv`] [A type representing the derivative /x'/ of the ODE]]
  21. [[`Time`] [A type representing the time]]
  22. [[`sys`] [An object of type `System`]]
  23. [[`x`] [Object of type `State`]]
  24. [[`dxdt`] [Object of type `Deriv`]]
  25. [[`t`] [Object of type `Time`]]
  26. ]
  27. [heading Valid expressions]
  28. [table
  29. [[Name] [Expression] [Type] [Semantics]]
  30. [[Calculate ['dx/dt := f(x,t)]] [`sys( x , dxdt , t )`] [`void`] [Calculates f(x,t), the result is stored into dxdt] ]
  31. ]
  32. [endsect]