diff --git a/libs/numeric/odeint/doc/concepts.qbk b/libs/numeric/odeint/doc/concepts.qbk index 5692e2f5..94dea316 100644 --- a/libs/numeric/odeint/doc/concepts.qbk +++ b/libs/numeric/odeint/doc/concepts.qbk @@ -1,5 +1,6 @@ [section Concepts] +[include concepts/system.qbk] [include concepts/stepper.qbk] [include concepts/error_stepper.qbk] [include concepts/controlled_stepper.qbk] diff --git a/libs/numeric/odeint/doc/concepts/stepper.qbk b/libs/numeric/odeint/doc/concepts/stepper.qbk index 94cbec68..bc0c37c2 100644 --- a/libs/numeric/odeint/doc/concepts/stepper.qbk +++ b/libs/numeric/odeint/doc/concepts/stepper.qbk @@ -37,7 +37,7 @@ tba. * ''''''[*order_type]'''''' ''''''`Stepper::order_type`'''''' -''''''The type characterizing the order of the ODE, typically something like `unsigned short`.'''''' +''''''The type characterizing the order of the ODE, typically `unsigned short`.'''''' [endsect] @@ -59,7 +59,7 @@ tba. [section Valid expressions] [table - [[Name] [Expression] [Type] [Semantics]] + [[Name] [Expression] [Returns] [Semantics]] [[Get the order] [`stepper.order()`] [`Order`] [Returns the order of the stepper which is used for error calculation.] ] [[Do step in-place] [`stepper.do_step( sys , x , t , dt )`] [`void`] [Performs one step of step size `dt`. The newly obtained state is written in place in `x`.] ] [[Do step out-of-place] [`stepper.do_step( sys , in , t , out , dt )`] [`void`] [Performs one step. The newly obtained state is written to `out`] ] diff --git a/libs/numeric/odeint/doc/concepts/system.qbk b/libs/numeric/odeint/doc/concepts/system.qbk new file mode 100644 index 00000000..58609102 --- /dev/null +++ b/libs/numeric/odeint/doc/concepts/system.qbk @@ -0,0 +1,37 @@ +[section Concept system] + +Concept Sytem + +[section Description] + +The System concept models the algorithmic implementation of the rhs. of the ODE, that is ['f(x,t)]. +The only requirement for this concept is that it should be callable with a specific parameter syntax (see below). +A System is typically implemented as a function or a functor. + +[endsect] + +[section Notation] + +[variablelist + [[State] [A type that is the `state_type` of Stepper]] + [[Deriv] [A type that is the `deriv_type` of Stepper]] + [[Time] [A type that is the `time_type` of Stepper]] + [[sys] [An object that models System]] + [[x] [Object of type State]] + [[dxdt] [Object of type Deriv]] + [[t] [Object of type Time]] +] + +[endsect] + +[section Valid expressions] + +[table + [[Name] [Expression] [Returns] [Semantics]] + [[Calculate ['dx/dt := f(x,t)]] [`sys( x , dxdt , t )`] [`void`] [Calculates f(x,t), the result is stored into dxdt] ] +] + +[endsect] + + +[endsect] \ No newline at end of file diff --git a/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/concepts.html b/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/concepts.html index 0894c9ad..bf65ed58 100644 --- a/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/concepts.html +++ b/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/concepts.html @@ -3,7 +3,7 @@ Concepts - + @@ -13,9 +13,9 @@

-PrevUpHomeNext +PrevUpHomeNext
-
+
@@ -40,7 +40,7 @@
-PrevUpHomeNext +PrevUpHomeNext
diff --git a/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/extend_odeint.html b/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/extend_odeint.html index 4ac1a0cf..55ee480e 100644 --- a/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/extend_odeint.html +++ b/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/extend_odeint.html @@ -3,7 +3,7 @@ Extend odeint - + @@ -13,9 +13,9 @@

-PrevUpHomeNext +PrevUpHomeNext
-
+
@@ -38,7 +38,7 @@
-PrevUpHomeNext +PrevUpHomeNext
diff --git a/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/tutorial.html b/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/tutorial.html index 1f10b57a..262640f0 100644 --- a/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/tutorial.html +++ b/libs/numeric/odeint/doc/html/boost_sandbox_numeric_odeint/tutorial.html @@ -3,7 +3,7 @@ Tutorial - + @@ -13,9 +13,9 @@

-PrevUpHomeNext +PrevUpHomeNext
-
+
@@ -47,7 +47,7 @@
-PrevUpHomeNext +PrevUpHomeNext
diff --git a/libs/numeric/odeint/doc/html/index.html b/libs/numeric/odeint/doc/html/index.html index 2551329d..3960c852 100644 --- a/libs/numeric/odeint/doc/html/index.html +++ b/libs/numeric/odeint/doc/html/index.html @@ -3,15 +3,15 @@ Chapter 1. boost.sandbox.numeric.odeint - +

-
Next
-
+
Next
+

Chapter 1. boost.sandbox.numeric.odeint

@@ -22,8 +22,8 @@ Mario Mulansky
-
-

+

+

Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

@@ -107,10 +107,10 @@
- +

Last revised: May 14, 2011 at 16:09:52 GMT

Last revised: May 15, 2011 at 11:15:51 GMT


-
Next
+
Next