diff --git a/docs/conf.py b/docs/conf.py index 4889090..71008c6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -36,12 +36,15 @@ ("Default Implicit Galerkin (custom types)", ) ]), + ("Full Demos", + [ + ("Shallow Water Eq", ) + ]), + ("Github Page", []), # these are here just to make the menu bar spaced better ("", []), - ("", []), - ("", []), # ("Shallow Water Eq.", # [ @@ -52,12 +55,6 @@ # #("End-to-end LSPG example", ) # ]) - # # demos - # ("Demos", #("Full Examples", - # [ - # ("Example1", ) - # ]), - # ('Classes', 'annotated', []), # ('Namespaces', 'namespaces', []) ] diff --git a/docs/html/advancers_8md.html b/docs/html/advancers_8md.html index b2f3f3b..b5596d4 100644 --- a/docs/html/advancers_8md.html +++ b/docs/html/advancers_8md.html @@ -56,12 +56,16 @@
  • Default Implicit Galerkin (custom types)
    • +
  • + Full Demos +
      +
    1. Shallow Water Eq
      2. +
    +
  • Github Page
    • -
    • -
    • -
      +
        2. diff --git a/docs/html/annotated.html b/docs/html/annotated.html index beec9e8..b3ff9a7 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/dir_208d2690607c4e3d3fabfa1d18673d36.html b/docs/html/dir_208d2690607c4e3d3fabfa1d18673d36.html index 0b0dcc9..e525ffe 100644 --- a/docs/html/dir_208d2690607c4e3d3fabfa1d18673d36.html +++ b/docs/html/dir_208d2690607c4e3d3fabfa1d18673d36.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. @@ -99,6 +103,8 @@

        Directories

        directory solvers_nonlinear/
        +
        directory swe/
        +
        directory utils/
        diff --git a/docs/html/dir_4708a13a89458f6d0cd5a4a9a3b52825.html b/docs/html/dir_4708a13a89458f6d0cd5a4a9a3b52825.html index 5188e53..8e26276 100644 --- a/docs/html/dir_4708a13a89458f6d0cd5a4a9a3b52825.html +++ b/docs/html/dir_4708a13a89458f6d0cd5a4a9a3b52825.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/dir_4cccaec18f48de5ad93eff32399233b5.html b/docs/html/dir_4cccaec18f48de5ad93eff32399233b5.html index fba21be..776d825 100644 --- a/docs/html/dir_4cccaec18f48de5ad93eff32399233b5.html +++ b/docs/html/dir_4cccaec18f48de5ad93eff32399233b5.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/dir_6a89a6e57a3601fc15116e5484f781e5.html b/docs/html/dir_6a89a6e57a3601fc15116e5484f781e5.html index e6cfe74..483f9bd 100644 --- a/docs/html/dir_6a89a6e57a3601fc15116e5484f781e5.html +++ b/docs/html/dir_6a89a6e57a3601fc15116e5484f781e5.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/dir_7727e9f4b0e1be84717ab35bab219223.html b/docs/html/dir_7727e9f4b0e1be84717ab35bab219223.html new file mode 100644 index 0000000..005e449 --- /dev/null +++ b/docs/html/dir_7727e9f4b0e1be84717ab35bab219223.html @@ -0,0 +1,136 @@ + + + + + pages/swe/ directory | Pressio|C++ Tutorials + + + + + + + +
        +
        +
        +
        +
        +

        + pages/swe/ directory +

        +

        +
        +
        +
        +
        + + + +
        + + diff --git a/docs/html/dir_dfdc6e3fe3dd83592e3200d32aae2cb7.html b/docs/html/dir_dfdc6e3fe3dd83592e3200d32aae2cb7.html index 3bdb4d9..8aebc76 100644 --- a/docs/html/dir_dfdc6e3fe3dd83592e3200d32aae2cb7.html +++ b/docs/html/dir_dfdc6e3fe3dd83592e3200d32aae2cb7.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/files.html b/docs/html/files.html index 3be40f4..20d6763 100644 --- a/docs/html/files.html +++ b/docs/html/files.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. @@ -83,10 +87,12 @@

        Files

      2. dir ode
      3. dir rom
      4. dir solvers_nonlinear
        5. +
      5. dir swe
      6. dir utils
      7. file main.md
        8. +
      8. file main.md
      9. file advancers.md
      10. file steppers_tutorial1.md
      11. file steppers_tutorial2.md
        12. diff --git a/docs/html/galerkin__default__explicit_8md.html b/docs/html/galerkin__default__explicit_8md.html index 98d5845..38000b1 100644 --- a/docs/html/galerkin__default__explicit_8md.html +++ b/docs/html/galerkin__default__explicit_8md.html @@ -56,12 +56,16 @@
      12. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/galerkin__default__explicit__custom__types_8md.html b/docs/html/galerkin__default__explicit__custom__types_8md.html index fd674ee..42fd343 100644 --- a/docs/html/galerkin__default__explicit__custom__types_8md.html +++ b/docs/html/galerkin__default__explicit__custom__types_8md.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/galerkin__default__implicit_8md.html b/docs/html/galerkin__default__implicit_8md.html index 4f28415..12f1c86 100644 --- a/docs/html/galerkin__default__implicit_8md.html +++ b/docs/html/galerkin__default__implicit_8md.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/galerkin__default__implicit__custom__types_8md.html b/docs/html/galerkin__default__implicit__custom__types_8md.html index e8ac9b7..78c5236 100644 --- a/docs/html/galerkin__default__implicit__custom__types_8md.html +++ b/docs/html/galerkin__default__implicit__custom__types_8md.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/index.html b/docs/html/index.html index 1de948d..e89acb8 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. @@ -78,11 +82,11 @@

        Pressio C++ Tutorials

        -

        This website contains the tutorials covering the pressio C++ library.

        Disclaimer: this is still work-in-progress, some coverage might be missing. We plan to improve this over time.

        Building

        All you need CMake > 3.18.0 and a C++14 compliant compiler.

        git clone --recursive git@github.com:Pressio/pressio-tutorials.git
+
        Tutorials suite covering the pressio C++ library.
        Build and Run
        All you need CMake > 3.18.0 and a C++14 compliant compiler.
        git clone --recursive git@github.com:Pressio/pressio-tutorials.git
 export CXX=<path-to-your-CXX-compiler>
 cd pressio-tutorials && mkdir build && cd build
 cmake -DCMAKE_BUILD_TYPE=Release ..
-make -j4
        Individual executables for all tutorials are built inside the build subdirectory.
        License and Citation
        The BSD-3 license is available here.
        We are working on publishing this. Our arXiv preprint at: https://arxiv.org/abs/2003.07798
        Questions?
        Find us on Slack: https://pressioteam.slack.com or open an issue on github.
        
+make -j4

        Individual executables for all tutorials are built inside the build subdirectory.

        Disclaimer

        This is still work-in-progress, some coverage might be missing. We are actively working on adding more. If you don't find something, you can temporarily look at C++ tests subdirectory, which contains tests for everything. These tests are readable, but are obviously not formatted in a tutorial fashion.

        License and Citation

        The BSD-3 license is available here.

        We are working on publishing this. Our arXiv preprint at: https://arxiv.org/abs/2003.07798

        Questions?

        Find us on Slack: https://pressioteam.slack.com or open an issue on github.

        diff --git a/docs/html/logger_8md.html b/docs/html/logger_8md.html index 2669cb7..04ff8e9 100644 --- a/docs/html/logger_8md.html +++ b/docs/html/logger_8md.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/main_8md.html b/docs/html/main_8md.html index 40cbd60..bd3cb46 100644 --- a/docs/html/main_8md.html +++ b/docs/html/main_8md.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/md_pages_ode_advancers.html b/docs/html/md_pages_ode_advancers.html index 7d9d4e3..bca6298 100644 --- a/docs/html/md_pages_ode_advancers.html +++ b/docs/html/md_pages_ode_advancers.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. @@ -121,7 +125,7 @@

        void aComplicatedMethod(std::vector<ScalarType> & state){ // do something } -};

        advance_n_times

        {
+};

        advance_n_times

        {
   /*
     time-step is fixed
    */
@@ -182,7 +186,7 @@ 
        
   std::cout << "Final state: ["
         << state[0] << " " << state[1] << " " << state[2] << "] "
         << std::endl;
-}

        advance_n_times_and_observe

        {
+}

        advance_n_times_and_observe

        {
   /*
     time-step is fixed, user passes an observer to monitor state
    */
@@ -197,7 +201,7 @@ 
        
 
   MyObserver monitor;
   pode::advance_n_steps_and_observe(stepper, state, start_time, dt, num_steps, monitor);
-}

        Similarly works for the other cases accepting the time step setter, etc.

        advance_to_target_time

        This always needs a functor to set the time step.

        {
+}

        Similarly works for the other cases accepting the time step setter, etc.

        advance_to_target_time

        This always needs a functor to set the time step.

        {
   /*
     time-step is provided
    */
@@ -223,7 +227,7 @@ 
        
   };
 
   pode::advance_to_target_time(stepper, state, start_time, final_time, dt_setter);
-}

        advance_to_target_time_and_observe

        This is like above, but you also need to pass an obsever.

        +}

        advance_to_target_time_and_observe

        This is like above, but you also need to pass an obsever.

        diff --git a/docs/html/md_pages_ode_steppers_tutorial1.html b/docs/html/md_pages_ode_steppers_tutorial1.html index c700976..e40ffd3 100644 --- a/docs/html/md_pages_ode_steppers_tutorial1.html +++ b/docs/html/md_pages_ode_steppers_tutorial1.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)

      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. @@ -127,9 +131,9 @@

        - is time.

        Include

        #include "pressio/ode_advancers.hpp"
+ is time.
        Include
        #include "pressio/ode_advancers.hpp"
 #include "pressio/ode_steppers_explicit.hpp"
-#include <Eigen/Core>
        Problem class
        template<class scalar_t>
+#include <Eigen/Core>
        Problem class
        template<class scalar_t>
 struct MySystem{
   using scalar_type   = scalar_t;
   using state_type    = Eigen::Matrix<scalar_t,-1,1>;
@@ -149,7 +153,7 @@ 
        
   velocity_type createVelocity() const{
     return velocity_type(3);
   };
-};
        Main
        int main(int argc, char *argv[])
+};
        Main
        int main(int argc, char *argv[])
 {
   pressio::log::initialize(pressio::logto::terminal);
 
@@ -183,7 +187,7 @@ 
        
 
   pressio::log::finalize();
   return 0;
-}
        Full Code
        The full code is available here.
        
+}

        Full Code

        The full code is available here.

        diff --git a/docs/html/md_pages_ode_steppers_tutorial2.html b/docs/html/md_pages_ode_steppers_tutorial2.html index 431864f..7da11ef 100644 --- a/docs/html/md_pages_ode_steppers_tutorial2.html +++ b/docs/html/md_pages_ode_steppers_tutorial2.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)

      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. @@ -78,7 +82,7 @@

        Explicit Time Integration for Arbitrary Types

        -

        Custom Vector Class

        Suppose that you have an application that uses a custom vector class as follows:

        template<class ScalarType>
+
        Custom Vector Class
        Suppose that you have an application that uses a custom vector class as follows:
        template<class ScalarType>
 struct CustomVector
 {
   using value_type = ScalarType;
@@ -99,7 +103,7 @@ 
        
 
 private:
   std::vector<ScalarType> d_ = {};
-};
        This custom vector class is very simple but the key point is that the CustomVector is unknown to Pressio. You can replace CustomVector with any type that fits your needs.
        Problem Class
        Here, we want to integrate in time the same system of ODEs shown in tutorial1, but with the problem implemented using the CustomVector class as follows:
        struct MySystem
+};
        This custom vector class is very simple but the key point is that the CustomVector is unknown to Pressio. You can replace CustomVector with any type that fits your needs.
        Problem Class
        Here, we want to integrate in time the same system of ODEs shown in tutorial1, but with the problem implemented using the CustomVector class as follows:
        struct MySystem
 {
   using scalar_type   = double;
   using state_type    = CustomVector<scalar_type>;
@@ -119,7 +123,7 @@ 
        
   velocity_type createVelocity() const{
     return velocity_type(3);
   };
-};
        Specialize trait and ops
        Because we are working with custom data types, we need to provide the necessary operations to do the algebra that pressio needs. This is done as follows:
        namespace pressio{
+};
        Specialize trait and ops
        Because we are working with custom data types, we need to provide the necessary operations to do the algebra that pressio needs. This is done as follows:
        namespace pressio{
 
 template<class T> struct Traits<CustomVector<T>>{
   using scalar_type = typename CustomVector<T>::value_type;
@@ -166,7 +170,7 @@ 
        
     v[i] = a*v[i] + b*v1[i] + c*v2[i] + d*v3[i] + e*v4[i];
   }
 }
-}} //end namespace pressio::ops
        Main
        int main(int argc, char *argv[])
+}} //end namespace pressio::ops
        Main
        int main(int argc, char *argv[])
 {
   pressio::log::initialize(pressio::logto::terminal);
 
@@ -196,7 +200,7 @@ 
        
         << std::endl;
 
   pressio::log::finalize();
-  return 0;
        Full Code
        The full code is available here.
        
+  return 0;

        Full Code

        The full code is available here.

        diff --git a/docs/html/md_pages_ode_steppers_tutorial3.html b/docs/html/md_pages_ode_steppers_tutorial3.html index 61697eb..0ed878c 100644 --- a/docs/html/md_pages_ode_steppers_tutorial3.html +++ b/docs/html/md_pages_ode_steppers_tutorial3.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. @@ -78,7 +82,7 @@

        Implicit Time Integration for Known Types

        -

        Problem

        ...

        +

        Problem

        ...

        diff --git a/docs/html/md_pages_ode_steppers_tutorial4.html b/docs/html/md_pages_ode_steppers_tutorial4.html index c0ab56c..2304c2b 100644 --- a/docs/html/md_pages_ode_steppers_tutorial4.html +++ b/docs/html/md_pages_ode_steppers_tutorial4.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. @@ -78,7 +82,7 @@

        Implicit Time Integration for Custom Types

        -

        Problem

        ...

        +

        Problem

        ...

        diff --git a/docs/html/md_pages_rom_galerkin_default_explicit.html b/docs/html/md_pages_rom_galerkin_default_explicit.html index b282684..2849402 100644 --- a/docs/html/md_pages_rom_galerkin_default_explicit.html +++ b/docs/html/md_pages_rom_galerkin_default_explicit.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/md_pages_rom_galerkin_default_explicit_custom_types.html b/docs/html/md_pages_rom_galerkin_default_explicit_custom_types.html index f6f3ac9..a740211 100644 --- a/docs/html/md_pages_rom_galerkin_default_explicit_custom_types.html +++ b/docs/html/md_pages_rom_galerkin_default_explicit_custom_types.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. @@ -78,7 +82,7 @@

        Default Galerkin with Explicit Time Integration for Custom Types

        -

        Custom Data Class

        Suppose that you have an application that uses arbitrary types. For the sake of this tutorial, let's define these to be:

        template<class ScalarType>
+
        Custom Data Class
        Suppose that you have an application that uses arbitrary types. For the sake of this tutorial, let's define these to be:
        template<class ScalarType>
 struct CustomVector
 {
   using value_type = ScalarType;
@@ -123,7 +127,7 @@ 
        
   std::size_t num_rows_ = {};
   std::size_t num_cols_ = {};
   std::vector<ScalarType> d_ = {};
-};
        Specialize trait and ops
        Because we are working with custom data types, we need to provide the necessary operations to do the algebra that pressio needs. This is done via specialization as follows:
        namespace pressio{
+};
        Specialize trait and ops
        Because we are working with custom data types, we need to provide the necessary operations to do the algebra that pressio needs. This is done via specialization as follows:
        namespace pressio{
 
 template<class ScalarType>
 struct Traits<CustomVector<ScalarType>>{
@@ -252,7 +256,7 @@ 
        
   }
 }
 
-}}//end namespace pressio::ops
        Main
        #include "pressio/rom_galerkin.hpp"
+}}//end namespace pressio::ops
        Main
        #include "pressio/rom_galerkin.hpp"
 
 struct TrivialFomOnlyVelocityCustomTypes
 {
diff --git a/docs/html/md_pages_rom_galerkin_default_implicit.html b/docs/html/md_pages_rom_galerkin_default_implicit.html
index 497d638..e54b7d8 100644
--- a/docs/html/md_pages_rom_galerkin_default_implicit.html
+++ b/docs/html/md_pages_rom_galerkin_default_implicit.html
@@ -56,12 +56,16 @@
                 
      2. Default Implicit Galerkin (custom types)
        3.
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/md_pages_rom_galerkin_default_implicit_custom_types.html b/docs/html/md_pages_rom_galerkin_default_implicit_custom_types.html index 35bd0bb..5db29e6 100644 --- a/docs/html/md_pages_rom_galerkin_default_implicit_custom_types.html +++ b/docs/html/md_pages_rom_galerkin_default_implicit_custom_types.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/md_pages_rom_tutorial_lin_dec.html b/docs/html/md_pages_rom_tutorial_lin_dec.html index f9f0a53..f375489 100644 --- a/docs/html/md_pages_rom_tutorial_lin_dec.html +++ b/docs/html/md_pages_rom_tutorial_lin_dec.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/md_pages_rom_tutorial_lin_dec_custom_types.html b/docs/html/md_pages_rom_tutorial_lin_dec_custom_types.html index b9dc5aa..69de248 100644 --- a/docs/html/md_pages_rom_tutorial_lin_dec_custom_types.html +++ b/docs/html/md_pages_rom_tutorial_lin_dec_custom_types.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/md_pages_solvers_nonlinear_tutorial_0.html b/docs/html/md_pages_solvers_nonlinear_tutorial_0.html index 058324e..ae52dbc 100644 --- a/docs/html/md_pages_solvers_nonlinear_tutorial_0.html +++ b/docs/html/md_pages_solvers_nonlinear_tutorial_0.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/md_pages_solvers_nonlinear_tutorial_1.html b/docs/html/md_pages_solvers_nonlinear_tutorial_1.html index b134cd1..3b51efd 100644 --- a/docs/html/md_pages_solvers_nonlinear_tutorial_1.html +++ b/docs/html/md_pages_solvers_nonlinear_tutorial_1.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. @@ -78,9 +82,9 @@

        Newton-Raphson with Known Types

        -

        Include

        #include "pressio/solvers_linear.hpp"
+
        Include
        #include "pressio/solvers_linear.hpp"
 #include "pressio/solvers_nonlinear.hpp"
-#include <Eigen/Core>
        Problem class
        struct MySystem
+#include <Eigen/Core>
        Problem class
        struct MySystem
 {
   using scalar_type = double;
   using state_type = Eigen::VectorXd;
@@ -108,7 +112,7 @@ 
        
     jac.coeffRef(1, 0) = -1.0;
     jac.coeffRef(1, 1) = 3.0*x(1)*x(1);
   }
-};
        Main
        int main()
+};
        Main
        int main()
 {
   namespace plog   = pressio::log;
   namespace pls    = pressio::linearsolvers;
@@ -140,7 +144,7 @@ 
        
 
   plog::finalize();
   return 0;
-}
        Full Code
        The full code is available TODO.
        
+}

        Full Code

        The full code is available TODO.

        diff --git a/docs/html/md_pages_solvers_nonlinear_tutorial_2.html b/docs/html/md_pages_solvers_nonlinear_tutorial_2.html index aef50c9..f10fc65 100644 --- a/docs/html/md_pages_solvers_nonlinear_tutorial_2.html +++ b/docs/html/md_pages_solvers_nonlinear_tutorial_2.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. @@ -78,7 +82,7 @@

        Newton-Raphson with Custom Types

        -

        Custom data types

        template<class ScalarType>
+
        Custom data types
        template<class ScalarType>
 struct CustomVector
 {
   using value_type = ScalarType;
@@ -123,7 +127,7 @@ 
        
   std::size_t num_rows_ = {};
   std::size_t num_cols_ = {};
   std::vector<ScalarType> d_ = {};
-};
        Problem class
        struct MySystem
+};
        Problem class
        struct MySystem
 {
   using scalar_type = double;
   using state_type = CustomVector<scalar_type>;
@@ -147,7 +151,7 @@ 
        
     J(1,0) = -1.0;
     J(1,1) = 3.0*x[1]*x[1];
   }
-};
        Specialize trait and ops
        Because we are working with custom data types, we need to provide the necessary operations to do the algebra that pressio needs. This is done via specialization as follows:
        namespace pressio{
+};
        Specialize trait and ops
        Because we are working with custom data types, we need to provide the necessary operations to do the algebra that pressio needs. This is done via specialization as follows:
        namespace pressio{
 template<class T> struct Traits<CustomVector<T>>{
   using scalar_type = double;
   using size_type = std::size_t;
@@ -188,7 +192,7 @@ 
        
   v[0] = v[0]*factor;
   v[1] = v[1]*factor;
 }
-}}//end namespace pressio::ops
        Custom Linear solver
        In this example, we use a custom linear solver.
        template<class ScalarType>
+}}//end namespace pressio::ops
        Custom Linear solver
        In this example, we use a custom linear solver.
        template<class ScalarType>
 struct LinearSolver{
   using matrix_type = CustomMatrix<ScalarType>;
 
@@ -205,7 +209,7 @@ 
        
     x[0] = (d*rhs[0]  - b*rhs[1])/det;
     x[1] = (-c*rhs[0] + a*rhs[1])/det;
   }
-};
        Main
        int main()
+};
        Main
        int main()
 {
   namespace plog   = pressio::log;
   namespace pnonls = pressio::nonlinearsolvers;
@@ -233,7 +237,7 @@ 
        
 
   plog::finalize();
   return 0;
-}
        Full Code
        The full code is available TODO.
        
+}

        Full Code

        The full code is available TODO.

        diff --git a/docs/html/md_pages_solvers_nonlinear_tutorial_3.html b/docs/html/md_pages_solvers_nonlinear_tutorial_3.html index 8439fe7..9a6e71d 100644 --- a/docs/html/md_pages_solvers_nonlinear_tutorial_3.html +++ b/docs/html/md_pages_solvers_nonlinear_tutorial_3.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. @@ -78,7 +82,7 @@

        Gauss-Newton via Normal Equations with Known Types

        -

        Problem class

        struct MyRosenbrockSystem
+
        Problem class
        struct MyRosenbrockSystem
 {
   using scalar_type = double;
   using state_type  = Eigen::VectorXd;
@@ -119,7 +123,7 @@ 
        
     JJ(4,1) = -1.;
     JJ(5,2) = -1.;
   }
-};
        Main
        int main()
+};
        Main
        int main()
 {
   namespace plog   = pressio::log;
   namespace pls    = pressio::linearsolvers;
@@ -152,7 +156,7 @@ 
        
 
   plog::finalize();
   return 0;
-}
        Full Code
        The full code is available TODO.
        
+}

        Full Code

        The full code is available TODO.

        diff --git a/docs/html/md_pages_solvers_nonlinear_tutorial_4.html b/docs/html/md_pages_solvers_nonlinear_tutorial_4.html index 1c81913..9587a90 100644 --- a/docs/html/md_pages_solvers_nonlinear_tutorial_4.html +++ b/docs/html/md_pages_solvers_nonlinear_tutorial_4.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/md_pages_swe_main.html b/docs/html/md_pages_swe_main.html new file mode 100644 index 0000000..ba2325d --- /dev/null +++ b/docs/html/md_pages_swe_main.html @@ -0,0 +1,400 @@ + + + + + Shallow Water Equations Demo | Pressio|C++ Tutorials + + + + + + + +
        +
        +
        +
        +
        +

        + Shallow Water Equations Demo +

        +

        We consider the shallow water equations (SWE) on the spatial domain + +$\Omega = [-\frac{L}{2},\frac{L}{2}] \times [-\frac{L}{2},\frac{L}{2}]$ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +:

        + +\[ \begin{split} &\frac{\partial h}{\partial t} + \frac{\partial}{\partial x }( h u) + \frac{\partial}{\partial y }( h v) = 0,\\ &\frac{\partial h u}{\partial t} + \frac{\partial}{\partial x} (h u^2 + \frac{1}{2} \mu_1 h^2) + \frac{\partial}{\partial y }( h u v) = \mu_3 hv,\\ &\frac{\partial h v}{\partial t} + \frac{\partial}{\partial x} (h u v) + \frac{\partial}{\partial y }( h v^2 + \frac{1}{2} \mu_1 h^2) = \mu_3 hu. \end{split} \] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

        In the above, + +$h : \Omega \rightarrow \mathbb{R}$ + + + + + + + + + + + + + + + + is the height of the water surface, + +$u : \Omega \rightarrow \mathbb{R}$ + + + + + + + + + + + + + + + + is the x-velocity, and + +$v : \Omega \rightarrow \mathbb{R}$ + + + + + + + + + + + + + + + + is the y-velocity. The system has three parameters:

        • + +$\mu_1$ + + + + + + + + + + is the gravity parameter
        • + +$\mu_2$ + + + + + + + + + + controls the magnitude of the initial pulse
        • + +$\mu_3$ + + + + + + + + + + controls the magnitude of the Coriolis forcing
        Image


        We are updating the code to use latest pressio, we will repost this soon.

        +
        +
        +
        +
        + + + +
        + + diff --git a/docs/html/md_pages_utils_logger.html b/docs/html/md_pages_utils_logger.html index ee308d7..3ebb14c 100644 --- a/docs/html/md_pages_utils_logger.html +++ b/docs/html/md_pages_utils_logger.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/modules.html b/docs/html/modules.html index 0456b7f..36293a9 100644 --- a/docs/html/modules.html +++ b/docs/html/modules.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/namespaces.html b/docs/html/namespaces.html index eef987e..4ec5ae3 100644 --- a/docs/html/namespaces.html +++ b/docs/html/namespaces.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/pages.html b/docs/html/pages.html index c08de74..fcb2b80 100644 --- a/docs/html/pages.html +++ b/docs/html/pages.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. @@ -93,6 +97,7 @@

        Pages

      2. Newton-Raphson with Custom Types
      3. Gauss-Newton via Normal Equations with Known Types
      4. Gauss-Newton via Normal Equations with Custom Types
        5. +
      5. Shallow Water Equations Demo
      6. Logging Library
        7. + +
        + + diff --git a/docs/html/swetut_f1.gif b/docs/html/swetut_f1.gif new file mode 100644 index 0000000..b80d1b0 Binary files /dev/null and b/docs/html/swetut_f1.gif differ diff --git a/docs/html/tutorial__0_8md.html b/docs/html/tutorial__0_8md.html index c3ed95a..c39c9c3 100644 --- a/docs/html/tutorial__0_8md.html +++ b/docs/html/tutorial__0_8md.html @@ -56,12 +56,16 @@
      7. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/tutorial__1_8md.html b/docs/html/tutorial__1_8md.html index 2303ead..6785d7f 100644 --- a/docs/html/tutorial__1_8md.html +++ b/docs/html/tutorial__1_8md.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/tutorial__2_8md.html b/docs/html/tutorial__2_8md.html index 8bc8277..9f11cbe 100644 --- a/docs/html/tutorial__2_8md.html +++ b/docs/html/tutorial__2_8md.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/tutorial__3_8md.html b/docs/html/tutorial__3_8md.html index 81ceeb8..e9456fb 100644 --- a/docs/html/tutorial__3_8md.html +++ b/docs/html/tutorial__3_8md.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/tutorial__4_8md.html b/docs/html/tutorial__4_8md.html index f8b801e..3acf039 100644 --- a/docs/html/tutorial__4_8md.html +++ b/docs/html/tutorial__4_8md.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/tutorial__lin__dec_8md.html b/docs/html/tutorial__lin__dec_8md.html index b2d600a..a8fb20a 100644 --- a/docs/html/tutorial__lin__dec_8md.html +++ b/docs/html/tutorial__lin__dec_8md.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/html/tutorial__lin__dec__custom__types_8md.html b/docs/html/tutorial__lin__dec__custom__types_8md.html index 64e62e2..7b0e617 100644 --- a/docs/html/tutorial__lin__dec__custom__types_8md.html +++ b/docs/html/tutorial__lin__dec__custom__types_8md.html @@ -56,12 +56,16 @@
      2. Default Implicit Galerkin (custom types)
      +
    1. + Full Demos +
        +
      1. Shallow Water Eq
        2. +
      +
    2. Github Page
      4. -
      5. -
    -
      +
        2. diff --git a/docs/img/swetut_f1.gif b/docs/img/swetut_f1.gif new file mode 100644 index 0000000..b80d1b0 Binary files /dev/null and b/docs/img/swetut_f1.gif differ diff --git a/docs/latex/index.tex b/docs/latex/index.tex index c382e42..b26ee4d 100644 --- a/docs/latex/index.tex +++ b/docs/latex/index.tex @@ -4,9 +4,7 @@ -This website contains the tutorials covering the \href{https://pressio.github.io/pressio/html/index.html}{\texttt{ pressio C++ library}}. - -Disclaimer\+: this is still work-\/in-\/progress, some coverage might be missing. We plan to improve this over time. \hypertarget{index_autotoc_md1}{}\doxysection{Building}\label{index_autotoc_md1} +Tutorials suite covering the \href{https://pressio.github.io/pressio/html/index.html}{\texttt{ pressio C++ library}}. \hypertarget{index_autotoc_md1}{}\doxysection{Build and Run}\label{index_autotoc_md1} All you need CMake $>$ 3.\+18.\+0 and a C++14 compliant compiler. @@ -20,12 +18,9 @@ \DoxyCodeLine{make -\/j4} \end{DoxyCode} - - - - -Individual executables for all tutorials are built inside the build subdirectory. \hypertarget{index_autotoc_md2}{}\doxysection{License and Citation}\label{index_autotoc_md2} + Individual executables for all tutorials are built inside the build subdirectory.\hypertarget{index_autotoc_md2}{}\doxysection{Disclaimer}\label{index_autotoc_md2} +This is still work-\/in-\/progress, some coverage might be missing. We are actively working on adding more. If you don\textquotesingle{}t find something, you can temporarily look at \href{https://github.com/Pressio/pressio/tree/main/tests}{\texttt{ C++ tests subdirectory}}, which contains tests for everything. These tests are readable, but are obviously not formatted in a tutorial fashion.\hypertarget{index_autotoc_md3}{}\doxysection{License and Citation}\label{index_autotoc_md3} The BSD-\/3 license is available \href{https://pressio.github.io/various/license/}{\texttt{ here}}. -We are working on publishing this. Our ar\+Xiv preprint at\+: \href{https://arxiv.org/abs/2003.07798}{\texttt{ https\+://arxiv.\+org/abs/2003.\+07798}}\hypertarget{index_autotoc_md3}{}\doxysection{Questions?}\label{index_autotoc_md3} +We are working on publishing this. Our ar\+Xiv preprint at\+: \href{https://arxiv.org/abs/2003.07798}{\texttt{ https\+://arxiv.\+org/abs/2003.\+07798}}\hypertarget{index_autotoc_md4}{}\doxysection{Questions?}\label{index_autotoc_md4} Find us on Slack\+: \href{https://pressioteam.slack.com}{\texttt{ https\+://pressioteam.\+slack.\+com}} or open an issue on \href{https://github.com/Pressio/pressio-tutorials}{\texttt{ github}}. \ No newline at end of file diff --git a/docs/latex/md_pages_ode_advancers.tex b/docs/latex/md_pages_ode_advancers.tex index 3904a7d..f64439d 100644 --- a/docs/latex/md_pages_ode_advancers.tex +++ b/docs/latex/md_pages_ode_advancers.tex @@ -48,7 +48,7 @@ \DoxyCodeLine{\};} \end{DoxyCode} -\hypertarget{md_pages_ode_advancers_autotoc_md5}{}\doxysection{advance\+\_\+n\+\_\+times}\label{md_pages_ode_advancers_autotoc_md5} +\hypertarget{md_pages_ode_advancers_autotoc_md6}{}\doxysection{advance\+\_\+n\+\_\+times}\label{md_pages_ode_advancers_autotoc_md6} \begin{DoxyCode}{0} \DoxyCodeLine{\{} @@ -129,7 +129,7 @@ \DoxyCodeLine{\}} \end{DoxyCode} -\hypertarget{md_pages_ode_advancers_autotoc_md6}{}\doxysection{advance\+\_\+n\+\_\+times\+\_\+and\+\_\+observe}\label{md_pages_ode_advancers_autotoc_md6} +\hypertarget{md_pages_ode_advancers_autotoc_md7}{}\doxysection{advance\+\_\+n\+\_\+times\+\_\+and\+\_\+observe}\label{md_pages_ode_advancers_autotoc_md7} \begin{DoxyCode}{0} \DoxyCodeLine{\{} @@ -152,7 +152,7 @@ \end{DoxyCode} -Similarly works for the other cases accepting the time step setter, etc.\hypertarget{md_pages_ode_advancers_autotoc_md7}{}\doxysection{advance\+\_\+to\+\_\+target\+\_\+time}\label{md_pages_ode_advancers_autotoc_md7} +Similarly works for the other cases accepting the time step setter, etc.\hypertarget{md_pages_ode_advancers_autotoc_md8}{}\doxysection{advance\+\_\+to\+\_\+target\+\_\+time}\label{md_pages_ode_advancers_autotoc_md8} This always needs a functor to set the time step. @@ -186,5 +186,5 @@ \DoxyCodeLine{\}} \end{DoxyCode} -\hypertarget{md_pages_ode_advancers_autotoc_md8}{}\doxysection{advance\+\_\+to\+\_\+target\+\_\+time\+\_\+and\+\_\+observe}\label{md_pages_ode_advancers_autotoc_md8} +\hypertarget{md_pages_ode_advancers_autotoc_md9}{}\doxysection{advance\+\_\+to\+\_\+target\+\_\+time\+\_\+and\+\_\+observe}\label{md_pages_ode_advancers_autotoc_md9} This is like above, but you also need to pass an obsever. \ No newline at end of file diff --git a/docs/latex/md_pages_ode_steppers_tutorial1.tex b/docs/latex/md_pages_ode_steppers_tutorial1.tex index 347fee4..029d5cc 100644 --- a/docs/latex/md_pages_ode_steppers_tutorial1.tex +++ b/docs/latex/md_pages_ode_steppers_tutorial1.tex @@ -3,7 +3,7 @@ \begin{DoxyParagraph}{} This tutorial demonstrates how to use the pressio/ode component to run explicit time integration for a system of ODEs that uses data types natively supported in pressio. By natively supported, we mean data types that pressio knows how to manipulate and perform computation on, and therefore the user does not need to provide any auxiliary information. Here, we use Eigen data types as an example, but the same code can be used for other natively supported types. \end{DoxyParagraph} -We demonstate how to integrate in time the following system of ODEs\+: \[ \frac{d \mathbf{y}}{d t} = 10 \mathbf{y} \] where $\mathbf{y} \in R^3$ is the state and $t$ is time.\hypertarget{md_pages_ode_steppers_tutorial1_autotoc_md10}{}\doxysection{Include}\label{md_pages_ode_steppers_tutorial1_autotoc_md10} +We demonstate how to integrate in time the following system of ODEs\+: \[ \frac{d \mathbf{y}}{d t} = 10 \mathbf{y} \] where $\mathbf{y} \in R^3$ is the state and $t$ is time.\hypertarget{md_pages_ode_steppers_tutorial1_autotoc_md11}{}\doxysection{Include}\label{md_pages_ode_steppers_tutorial1_autotoc_md11} \begin{DoxyCode}{0} \DoxyCodeLine{\textcolor{preprocessor}{\#include "{}pressio/ode\_advancers.hpp"{}}} @@ -11,7 +11,7 @@ \DoxyCodeLine{\textcolor{preprocessor}{\#include }} \end{DoxyCode} -\hypertarget{md_pages_ode_steppers_tutorial1_autotoc_md11}{}\doxysection{Problem class}\label{md_pages_ode_steppers_tutorial1_autotoc_md11} +\hypertarget{md_pages_ode_steppers_tutorial1_autotoc_md12}{}\doxysection{Problem class}\label{md_pages_ode_steppers_tutorial1_autotoc_md12} \begin{DoxyCode}{0} \DoxyCodeLine{\textcolor{keyword}{template}<\textcolor{keyword}{class} scalar\_t>} @@ -37,7 +37,7 @@ \DoxyCodeLine{\};} \end{DoxyCode} -\hypertarget{md_pages_ode_steppers_tutorial1_autotoc_md12}{}\doxysection{Main}\label{md_pages_ode_steppers_tutorial1_autotoc_md12} +\hypertarget{md_pages_ode_steppers_tutorial1_autotoc_md13}{}\doxysection{Main}\label{md_pages_ode_steppers_tutorial1_autotoc_md13} \begin{DoxyCode}{0} \DoxyCodeLine{\textcolor{keywordtype}{int} main(\textcolor{keywordtype}{int} argc, \textcolor{keywordtype}{char} *argv[])} @@ -77,5 +77,5 @@ \DoxyCodeLine{\}} \end{DoxyCode} -\hypertarget{md_pages_ode_steppers_tutorial1_autotoc_md13}{}\doxysection{Full Code}\label{md_pages_ode_steppers_tutorial1_autotoc_md13} +\hypertarget{md_pages_ode_steppers_tutorial1_autotoc_md14}{}\doxysection{Full Code}\label{md_pages_ode_steppers_tutorial1_autotoc_md14} The full code is available \href{https://github.com/Pressio/pressio-tutorials/blob/main/tutorials/ode_steppers_1.cc}{\texttt{ here}}. \ No newline at end of file diff --git a/docs/latex/md_pages_ode_steppers_tutorial2.tex b/docs/latex/md_pages_ode_steppers_tutorial2.tex index 3f76328..cbaf10e 100644 --- a/docs/latex/md_pages_ode_steppers_tutorial2.tex +++ b/docs/latex/md_pages_ode_steppers_tutorial2.tex @@ -3,7 +3,7 @@ \begin{DoxyParagraph}{} This tutorial demonstrates how to use the pressio/ode component to run explicit time integration for a system of ODEs based on custom types, i.\+e. data types that pressio does not know how to operate on. \end{DoxyParagraph} -\hypertarget{md_pages_ode_steppers_tutorial2_autotoc_md15}{}\doxysection{Custom Vector Class}\label{md_pages_ode_steppers_tutorial2_autotoc_md15} +\hypertarget{md_pages_ode_steppers_tutorial2_autotoc_md16}{}\doxysection{Custom Vector Class}\label{md_pages_ode_steppers_tutorial2_autotoc_md16} Suppose that you have an application that uses a custom vector class as follows\+: @@ -34,7 +34,7 @@ \end{DoxyCode} -This custom vector class is very simple but the key point is that the {\ttfamily Custom\+Vector} is unknown to Pressio. You can replace {\ttfamily Custom\+Vector} with any type that fits your needs.\hypertarget{md_pages_ode_steppers_tutorial2_autotoc_md16}{}\doxysection{Problem Class}\label{md_pages_ode_steppers_tutorial2_autotoc_md16} +This custom vector class is very simple but the key point is that the {\ttfamily Custom\+Vector} is unknown to Pressio. You can replace {\ttfamily Custom\+Vector} with any type that fits your needs.\hypertarget{md_pages_ode_steppers_tutorial2_autotoc_md17}{}\doxysection{Problem Class}\label{md_pages_ode_steppers_tutorial2_autotoc_md17} Here, we want to integrate in time the same system of ODEs shown in tutorial1, but with the problem implemented using the {\ttfamily Custom\+Vector} class as follows\+: @@ -62,7 +62,7 @@ \DoxyCodeLine{\};} \end{DoxyCode} -\hypertarget{md_pages_ode_steppers_tutorial2_autotoc_md17}{}\doxysection{Specialize trait and ops}\label{md_pages_ode_steppers_tutorial2_autotoc_md17} +\hypertarget{md_pages_ode_steppers_tutorial2_autotoc_md18}{}\doxysection{Specialize trait and ops}\label{md_pages_ode_steppers_tutorial2_autotoc_md18} Because we are working with custom data types, we need to provide the necessary operations to do the algebra that pressio needs. This is done as follows\+: @@ -117,7 +117,7 @@ \DoxyCodeLine{\}\} \textcolor{comment}{//end namespace pressio::ops}} \end{DoxyCode} -\hypertarget{md_pages_ode_steppers_tutorial2_autotoc_md18}{}\doxysection{Main}\label{md_pages_ode_steppers_tutorial2_autotoc_md18} +\hypertarget{md_pages_ode_steppers_tutorial2_autotoc_md19}{}\doxysection{Main}\label{md_pages_ode_steppers_tutorial2_autotoc_md19} \begin{DoxyCode}{0} \DoxyCodeLine{\textcolor{keywordtype}{int} main(\textcolor{keywordtype}{int} argc, \textcolor{keywordtype}{char} *argv[])} @@ -153,5 +153,5 @@ \DoxyCodeLine{ \textcolor{keywordflow}{return} 0;} \end{DoxyCode} -\hypertarget{md_pages_ode_steppers_tutorial2_autotoc_md19}{}\doxysection{Full Code}\label{md_pages_ode_steppers_tutorial2_autotoc_md19} +\hypertarget{md_pages_ode_steppers_tutorial2_autotoc_md20}{}\doxysection{Full Code}\label{md_pages_ode_steppers_tutorial2_autotoc_md20} The full code is available \href{https://github.com/Pressio/pressio-tutorials/blob/main/tutorials/ode_steppers_2.cc}{\texttt{ here}}. \ No newline at end of file diff --git a/docs/latex/md_pages_ode_steppers_tutorial3.tex b/docs/latex/md_pages_ode_steppers_tutorial3.tex index 9d929c6..64054f7 100644 --- a/docs/latex/md_pages_ode_steppers_tutorial3.tex +++ b/docs/latex/md_pages_ode_steppers_tutorial3.tex @@ -3,5 +3,5 @@ \begin{DoxyParagraph}{} Demonstrates how to use the {\ttfamily pressio/ode} to do implicit time integration for a system of ODEs that uses data types natively supported in pressio. \end{DoxyParagraph} -\hypertarget{md_pages_ode_steppers_tutorial3_autotoc_md21}{}\doxysection{Problem}\label{md_pages_ode_steppers_tutorial3_autotoc_md21} +\hypertarget{md_pages_ode_steppers_tutorial3_autotoc_md22}{}\doxysection{Problem}\label{md_pages_ode_steppers_tutorial3_autotoc_md22} ... \ No newline at end of file diff --git a/docs/latex/md_pages_ode_steppers_tutorial4.tex b/docs/latex/md_pages_ode_steppers_tutorial4.tex index 70fba96..db34c8a 100644 --- a/docs/latex/md_pages_ode_steppers_tutorial4.tex +++ b/docs/latex/md_pages_ode_steppers_tutorial4.tex @@ -3,5 +3,5 @@ \begin{DoxyParagraph}{} Demonstrates how to use the {\ttfamily pressio/ode} to do implicit time integration for a system of ODEs that uses custom data types. \end{DoxyParagraph} -\hypertarget{md_pages_ode_steppers_tutorial4_autotoc_md23}{}\doxysection{Problem}\label{md_pages_ode_steppers_tutorial4_autotoc_md23} +\hypertarget{md_pages_ode_steppers_tutorial4_autotoc_md24}{}\doxysection{Problem}\label{md_pages_ode_steppers_tutorial4_autotoc_md24} ... \ No newline at end of file diff --git a/docs/latex/md_pages_rom_galerkin_default_explicit_custom_types.tex b/docs/latex/md_pages_rom_galerkin_default_explicit_custom_types.tex index 7684a7b..26d50f3 100644 --- a/docs/latex/md_pages_rom_galerkin_default_explicit_custom_types.tex +++ b/docs/latex/md_pages_rom_galerkin_default_explicit_custom_types.tex @@ -3,7 +3,7 @@ \begin{DoxyParagraph}{} This tutorial demonstrates how to \end{DoxyParagraph} -\hypertarget{md_pages_rom_galerkin_default_explicit_custom_types_autotoc_md26}{}\doxysection{Custom Data Class}\label{md_pages_rom_galerkin_default_explicit_custom_types_autotoc_md26} +\hypertarget{md_pages_rom_galerkin_default_explicit_custom_types_autotoc_md27}{}\doxysection{Custom Data Class}\label{md_pages_rom_galerkin_default_explicit_custom_types_autotoc_md27} Suppose that you have an application that uses arbitrary types. For the sake of this tutorial, let\textquotesingle{}s define these to be\+: @@ -56,7 +56,7 @@ \DoxyCodeLine{\};} \end{DoxyCode} -\hypertarget{md_pages_rom_galerkin_default_explicit_custom_types_autotoc_md27}{}\doxysection{Specialize trait and ops}\label{md_pages_rom_galerkin_default_explicit_custom_types_autotoc_md27} +\hypertarget{md_pages_rom_galerkin_default_explicit_custom_types_autotoc_md28}{}\doxysection{Specialize trait and ops}\label{md_pages_rom_galerkin_default_explicit_custom_types_autotoc_md28} Because we are working with custom data types, we need to provide the necessary operations to do the algebra that pressio needs. This is done via specialization as follows\+: \begin{DoxyCode}{0} \DoxyCodeLine{\textcolor{keyword}{namespace }pressio\{} @@ -191,7 +191,7 @@ \DoxyCodeLine{\}\}\textcolor{comment}{//end namespace pressio::ops}} \end{DoxyCode} -\hypertarget{md_pages_rom_galerkin_default_explicit_custom_types_autotoc_md28}{}\doxysection{Main}\label{md_pages_rom_galerkin_default_explicit_custom_types_autotoc_md28} +\hypertarget{md_pages_rom_galerkin_default_explicit_custom_types_autotoc_md29}{}\doxysection{Main}\label{md_pages_rom_galerkin_default_explicit_custom_types_autotoc_md29} \begin{DoxyCode}{0} \DoxyCodeLine{\textcolor{preprocessor}{\#include "{}pressio/rom\_galerkin.hpp"{}}} diff --git a/docs/latex/md_pages_solvers_nonlinear_tutorial_1.tex b/docs/latex/md_pages_solvers_nonlinear_tutorial_1.tex index 7e89661..eb0ddb8 100644 --- a/docs/latex/md_pages_solvers_nonlinear_tutorial_1.tex +++ b/docs/latex/md_pages_solvers_nonlinear_tutorial_1.tex @@ -3,7 +3,7 @@ \begin{DoxyParagraph}{} This tutorial demonstrates how to use the Newton-\/\+Raphson solver from {\ttfamily pressio/solvers\+\_\+nonlinear} using data types natively supported in pressio. Here, we use Eigen data types, but a similar code can be used for other natively supported types. \end{DoxyParagraph} -\hypertarget{md_pages_solvers_nonlinear_tutorial_1_autotoc_md35}{}\doxysection{Include}\label{md_pages_solvers_nonlinear_tutorial_1_autotoc_md35} +\hypertarget{md_pages_solvers_nonlinear_tutorial_1_autotoc_md36}{}\doxysection{Include}\label{md_pages_solvers_nonlinear_tutorial_1_autotoc_md36} \begin{DoxyCode}{0} \DoxyCodeLine{\textcolor{preprocessor}{\#include "{}pressio/solvers\_linear.hpp"{}}} @@ -11,7 +11,7 @@ \DoxyCodeLine{\textcolor{preprocessor}{\#include }} \end{DoxyCode} -\hypertarget{md_pages_solvers_nonlinear_tutorial_1_autotoc_md36}{}\doxysection{Problem class}\label{md_pages_solvers_nonlinear_tutorial_1_autotoc_md36} +\hypertarget{md_pages_solvers_nonlinear_tutorial_1_autotoc_md37}{}\doxysection{Problem class}\label{md_pages_solvers_nonlinear_tutorial_1_autotoc_md37} \begin{DoxyCode}{0} \DoxyCodeLine{\textcolor{keyword}{struct }MySystem} @@ -45,7 +45,7 @@ \DoxyCodeLine{\};} \end{DoxyCode} -\hypertarget{md_pages_solvers_nonlinear_tutorial_1_autotoc_md37}{}\doxysection{Main}\label{md_pages_solvers_nonlinear_tutorial_1_autotoc_md37} +\hypertarget{md_pages_solvers_nonlinear_tutorial_1_autotoc_md38}{}\doxysection{Main}\label{md_pages_solvers_nonlinear_tutorial_1_autotoc_md38} \begin{DoxyCode}{0} \DoxyCodeLine{\textcolor{keywordtype}{int} main()} @@ -83,5 +83,5 @@ \DoxyCodeLine{\}} \end{DoxyCode} -\hypertarget{md_pages_solvers_nonlinear_tutorial_1_autotoc_md38}{}\doxysection{Full Code}\label{md_pages_solvers_nonlinear_tutorial_1_autotoc_md38} +\hypertarget{md_pages_solvers_nonlinear_tutorial_1_autotoc_md39}{}\doxysection{Full Code}\label{md_pages_solvers_nonlinear_tutorial_1_autotoc_md39} The full code is available TODO. \ No newline at end of file diff --git a/docs/latex/md_pages_solvers_nonlinear_tutorial_2.tex b/docs/latex/md_pages_solvers_nonlinear_tutorial_2.tex index b86b65e..e99d6ec 100644 --- a/docs/latex/md_pages_solvers_nonlinear_tutorial_2.tex +++ b/docs/latex/md_pages_solvers_nonlinear_tutorial_2.tex @@ -3,7 +3,7 @@ \begin{DoxyParagraph}{} This tutorial demonstrates how to use the Newton-\/\+Raphson solver from pressio/solvers\+\_\+nonlinear using custom data types. \end{DoxyParagraph} -\hypertarget{md_pages_solvers_nonlinear_tutorial_2_autotoc_md40}{}\doxysection{Custom data types}\label{md_pages_solvers_nonlinear_tutorial_2_autotoc_md40} +\hypertarget{md_pages_solvers_nonlinear_tutorial_2_autotoc_md41}{}\doxysection{Custom data types}\label{md_pages_solvers_nonlinear_tutorial_2_autotoc_md41} \begin{DoxyCode}{0} \DoxyCodeLine{\textcolor{keyword}{template}<\textcolor{keyword}{class} ScalarType>} @@ -54,7 +54,7 @@ \DoxyCodeLine{\};} \end{DoxyCode} -\hypertarget{md_pages_solvers_nonlinear_tutorial_2_autotoc_md41}{}\doxysection{Problem class}\label{md_pages_solvers_nonlinear_tutorial_2_autotoc_md41} +\hypertarget{md_pages_solvers_nonlinear_tutorial_2_autotoc_md42}{}\doxysection{Problem class}\label{md_pages_solvers_nonlinear_tutorial_2_autotoc_md42} \begin{DoxyCode}{0} \DoxyCodeLine{\textcolor{keyword}{struct }MySystem} @@ -84,7 +84,7 @@ \DoxyCodeLine{\};} \end{DoxyCode} -\hypertarget{md_pages_solvers_nonlinear_tutorial_2_autotoc_md42}{}\doxysection{Specialize trait and ops}\label{md_pages_solvers_nonlinear_tutorial_2_autotoc_md42} +\hypertarget{md_pages_solvers_nonlinear_tutorial_2_autotoc_md43}{}\doxysection{Specialize trait and ops}\label{md_pages_solvers_nonlinear_tutorial_2_autotoc_md43} Because we are working with custom data types, we need to provide the necessary operations to do the algebra that pressio needs. This is done via specialization as follows\+: @@ -133,7 +133,7 @@ \DoxyCodeLine{\}\}\textcolor{comment}{//end namespace pressio::ops}} \end{DoxyCode} -\hypertarget{md_pages_solvers_nonlinear_tutorial_2_autotoc_md43}{}\doxysection{Custom Linear solver}\label{md_pages_solvers_nonlinear_tutorial_2_autotoc_md43} +\hypertarget{md_pages_solvers_nonlinear_tutorial_2_autotoc_md44}{}\doxysection{Custom Linear solver}\label{md_pages_solvers_nonlinear_tutorial_2_autotoc_md44} In this example, we use a custom linear solver. @@ -158,7 +158,7 @@ \DoxyCodeLine{\};} \end{DoxyCode} -\hypertarget{md_pages_solvers_nonlinear_tutorial_2_autotoc_md44}{}\doxysection{Main}\label{md_pages_solvers_nonlinear_tutorial_2_autotoc_md44} +\hypertarget{md_pages_solvers_nonlinear_tutorial_2_autotoc_md45}{}\doxysection{Main}\label{md_pages_solvers_nonlinear_tutorial_2_autotoc_md45} \begin{DoxyCode}{0} \DoxyCodeLine{\textcolor{keywordtype}{int} main()} @@ -192,5 +192,5 @@ \DoxyCodeLine{\}} \end{DoxyCode} -\hypertarget{md_pages_solvers_nonlinear_tutorial_2_autotoc_md45}{}\doxysection{Full Code}\label{md_pages_solvers_nonlinear_tutorial_2_autotoc_md45} +\hypertarget{md_pages_solvers_nonlinear_tutorial_2_autotoc_md46}{}\doxysection{Full Code}\label{md_pages_solvers_nonlinear_tutorial_2_autotoc_md46} The full code is available TODO. \ No newline at end of file diff --git a/docs/latex/md_pages_solvers_nonlinear_tutorial_3.tex b/docs/latex/md_pages_solvers_nonlinear_tutorial_3.tex index 07e2809..e74df94 100644 --- a/docs/latex/md_pages_solvers_nonlinear_tutorial_3.tex +++ b/docs/latex/md_pages_solvers_nonlinear_tutorial_3.tex @@ -3,7 +3,7 @@ \begin{DoxyParagraph}{} This tutorial demonstrates how to use the normal-\/equations-\/based Gauss-\/\+Newton solver from {\ttfamily pressio/solvers\+\_\+nonlinear} using data types natively supported in pressio. Here, we use Eigen data types, but a similar code can be used for other natively supported types. \end{DoxyParagraph} -\hypertarget{md_pages_solvers_nonlinear_tutorial_3_autotoc_md47}{}\doxysection{Problem class}\label{md_pages_solvers_nonlinear_tutorial_3_autotoc_md47} +\hypertarget{md_pages_solvers_nonlinear_tutorial_3_autotoc_md48}{}\doxysection{Problem class}\label{md_pages_solvers_nonlinear_tutorial_3_autotoc_md48} \begin{DoxyCode}{0} \DoxyCodeLine{\textcolor{keyword}{struct }MyRosenbrockSystem} @@ -50,7 +50,7 @@ \DoxyCodeLine{\};} \end{DoxyCode} -\hypertarget{md_pages_solvers_nonlinear_tutorial_3_autotoc_md48}{}\doxysection{Main}\label{md_pages_solvers_nonlinear_tutorial_3_autotoc_md48} +\hypertarget{md_pages_solvers_nonlinear_tutorial_3_autotoc_md49}{}\doxysection{Main}\label{md_pages_solvers_nonlinear_tutorial_3_autotoc_md49} \begin{DoxyCode}{0} \DoxyCodeLine{\textcolor{keywordtype}{int} main()} @@ -89,5 +89,5 @@ \DoxyCodeLine{\}} \end{DoxyCode} -\hypertarget{md_pages_solvers_nonlinear_tutorial_3_autotoc_md49}{}\doxysection{Full Code}\label{md_pages_solvers_nonlinear_tutorial_3_autotoc_md49} +\hypertarget{md_pages_solvers_nonlinear_tutorial_3_autotoc_md50}{}\doxysection{Full Code}\label{md_pages_solvers_nonlinear_tutorial_3_autotoc_md50} The full code is available TODO. \ No newline at end of file diff --git a/docs/latex/md_pages_swe_main.tex b/docs/latex/md_pages_swe_main.tex new file mode 100644 index 0000000..4a3143d --- /dev/null +++ b/docs/latex/md_pages_swe_main.tex @@ -0,0 +1,17 @@ +We consider the shallow water equations (SWE) on the spatial domain $\Omega = [-\frac{L}{2},\frac{L}{2}] \times [-\frac{L}{2},\frac{L}{2}]$\+: \[ \begin{split} &\frac{\partial h}{\partial t} + \frac{\partial}{\partial x }( h u) + \frac{\partial}{\partial y }( h v) = 0,\\ &\frac{\partial h u}{\partial t} + \frac{\partial}{\partial x} (h u^2 + \frac{1}{2} \mu_1 h^2) + \frac{\partial}{\partial y }( h u v) = \mu_3 hv,\\ &\frac{\partial h v}{\partial t} + \frac{\partial}{\partial x} (h u v) + \frac{\partial}{\partial y }( h v^2 + \frac{1}{2} \mu_1 h^2) = \mu_3 hu. \end{split} \] + +In the above, $h : \Omega \rightarrow \mathbb{R}$ is the height of the water surface, $u : \Omega \rightarrow \mathbb{R}$ is the x-\/velocity, and $v : \Omega \rightarrow \mathbb{R}$ is the y-\/velocity. The system has three parameters\+: +\begin{DoxyItemize} +\item $\mu_1$ is the gravity parameter +\item $\mu_2$ controls the magnitude of the initial pulse +\item $\mu_3$ controls the magnitude of the Coriolis forcing +\end{DoxyItemize} + + + +~\newline + + + + +We are updating the code to use latest pressio, we will repost this soon. \ No newline at end of file diff --git a/docs/latex/refman.tex b/docs/latex/refman.tex index 9abee48..118c905 100644 --- a/docs/latex/refman.tex +++ b/docs/latex/refman.tex @@ -237,6 +237,10 @@ \chapter{Gauss-\/\+Newton via Normal Equations with Custom Types} \label{md_pages_solvers_nonlinear_tutorial_4} \Hypertarget{md_pages_solvers_nonlinear_tutorial_4} \input{md_pages_solvers_nonlinear_tutorial_4} +\chapter{Shallow Water Equations Demo} +\label{md_pages_swe_main} +\Hypertarget{md_pages_swe_main} +\input{md_pages_swe_main} \chapter{Logging Library} \label{md_pages_utils_logger} \Hypertarget{md_pages_utils_logger} diff --git a/docs/m.math.cache b/docs/m.math.cache index 289788c..ffd62a1 100644 Binary files a/docs/m.math.cache and b/docs/m.math.cache differ diff --git a/docs/pages/main.md b/docs/pages/main.md index 7ef268b..773dd83 100644 --- a/docs/pages/main.md +++ b/docs/pages/main.md @@ -5,17 +5,13 @@ @m_class{m-frame m-default} @parblock -This website contains the tutorials -covering the [pressio C++ library](https://pressio.github.io/pressio/html/index.html). - -Disclaimer: this is still work-in-progress, some coverage might be missing. -We plan to improve this over time. +Tutorials suite covering the [pressio C++ library](https://pressio.github.io/pressio/html/index.html). @endparblock -## Building +## Build and Run -@m_class{m-note m-warning} +@m_class{m-note m-info} @parblock All you need CMake > 3.18.0 and a C++14 compliant compiler. @@ -28,13 +24,16 @@ cd pressio-tutorials && mkdir build && cd build cmake -DCMAKE_BUILD_TYPE=Release .. make -j4 ``` +Individual executables for all tutorials are built inside the build subdirectory. -@m_class{m-note m-info} -@parblock -Individual executables for all tutorials are built inside the build subdirectory. -@endparblock +## Disclaimer +This is still work-in-progress, some coverage might be missing. +We are actively working on adding more. +If you don't find something, you can temporarily look at [C++ tests subdirectory](https://github.com/Pressio/pressio/tree/main/tests), +which contains tests for everything. These tests are readable, +but are obviously not formatted in a tutorial fashion. ## License and Citation The BSD-3 license is available [here](https://pressio.github.io/various/license/). diff --git a/docs/pages/swe/main.md b/docs/pages/swe/main.md new file mode 100644 index 0000000..9c72826 --- /dev/null +++ b/docs/pages/swe/main.md @@ -0,0 +1,57 @@ + +# Shallow Water Equations Demo + +We consider the shallow water equations (SWE) on the spatial domain +@f$\Omega = [-\frac{L}{2},\frac{L}{2}] \times [-\frac{L}{2},\frac{L}{2}]@f$: +@f[ +\begin{split} +&\frac{\partial h}{\partial t} + \frac{\partial}{\partial x }( h u) + \frac{\partial}{\partial y }( h v) = 0,\\ +&\frac{\partial h u}{\partial t} + \frac{\partial}{\partial x} (h u^2 + \frac{1}{2} \mu_1 h^2) + \frac{\partial}{\partial y }( h u v) = \mu_3 hv,\\ +&\frac{\partial h v}{\partial t} + \frac{\partial}{\partial x} (h u v) + \frac{\partial}{\partial y }( h v^2 + \frac{1}{2} \mu_1 h^2) = \mu_3 hu. +\end{split} +@f] + +In the above, @f$h : \Omega \rightarrow \mathbb{R}@f$ is the height of the water surface, +@f$u : \Omega \rightarrow \mathbb{R}@f$ is the x-velocity, and @f$v : \Omega \rightarrow \mathbb{R}@f$ is the y-velocity. +The system has three parameters: +* @f$\mu_1@f$ is the gravity parameter +* @f$\mu_2@f$ controls the magnitude of the initial pulse +* @f$\mu_3@f$ controls the magnitude of the Coriolis forcing + +@image html swetut_f1.gif width=90% + + +
        + +@m_class{m-note m-warning} + +@parblock +We are updating the code to use latest pressio, we will repost this soon. +@endparblock + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/xml/dir_208d2690607c4e3d3fabfa1d18673d36.xml b/docs/xml/dir_208d2690607c4e3d3fabfa1d18673d36.xml index cde5db2..7159977 100644 --- a/docs/xml/dir_208d2690607c4e3d3fabfa1d18673d36.xml +++ b/docs/xml/dir_208d2690607c4e3d3fabfa1d18673d36.xml @@ -5,6 +5,7 @@ pages/ode pages/rom pages/solvers_nonlinear + pages/swe pages/utils diff --git a/docs/xml/dir_7727e9f4b0e1be84717ab35bab219223.xml b/docs/xml/dir_7727e9f4b0e1be84717ab35bab219223.xml new file mode 100644 index 0000000..f8b3324 --- /dev/null +++ b/docs/xml/dir_7727e9f4b0e1be84717ab35bab219223.xml @@ -0,0 +1,11 @@ + + + + pages/swe + + + + + + + diff --git a/docs/xml/index.xml b/docs/xml/index.xml index 55d5520..bc15cea 100644 --- a/docs/xml/index.xml +++ b/docs/xml/index.xml @@ -2,6 +2,8 @@ main.md + main.md + advancers.md steppers_tutorial1.md @@ -68,6 +70,8 @@ md_pages_solvers_nonlinear_tutorial_4 + md_pages_swe_main + md_pages_utils_logger pages/ode @@ -78,6 +82,8 @@ pages/solvers_nonlinear + pages/swe + pages/utils index diff --git a/docs/xml/indexpage.xml b/docs/xml/indexpage.xml index 3d9f597..7b32878 100644 --- a/docs/xml/indexpage.xml +++ b/docs/xml/indexpage.xml @@ -8,12 +8,11 @@ -This website contains the tutorials covering the pressio C++ library. -Disclaimer: this is still work-in-progress, some coverage might be missing. We plan to improve this over time. +Tutorials suite covering the pressio C++ library. -Building - +Build and Run + All you need CMake > 3.18.0 and a C++14 compliant compiler. gitclone--recursivegit@github.com:Pressio/pressio-tutorials.git @@ -21,17 +20,18 @@ cdpressio-tutorials&&mkdirbuild&&cdbuild cmake-DCMAKE_BUILD_TYPE=Release.. make-j4 - - -Individual executables for all tutorials are built inside the build subdirectory. - + Individual executables for all tutorials are built inside the build subdirectory. +Disclaimer +This is still work-in-progress, some coverage might be missing. We are actively working on adding more. If you don't find something, you can temporarily look at C++ tests subdirectory, which contains tests for everything. These tests are readable, but are obviously not formatted in a tutorial fashion. + + License and Citation The BSD-3 license is available here. We are working on publishing this. Our arXiv preprint at: https://arxiv.org/abs/2003.07798 - + Questions? Find us on Slack: https://pressioteam.slack.com or open an issue on github. diff --git a/docs/xml/md_pages_ode_advancers.xml b/docs/xml/md_pages_ode_advancers.xml index 9e5d85e..3dd1f06 100644 --- a/docs/xml/md_pages_ode_advancers.xml +++ b/docs/xml/md_pages_ode_advancers.xml @@ -52,7 +52,7 @@ } }; - + advance_n_times { /* @@ -122,7 +122,7 @@ } - + advance_n_times_and_observe { /* @@ -143,7 +143,7 @@ Similarly works for the other cases accepting the time step setter, etc. - + advance_to_target_time This always needs a functor to set the time step. { @@ -175,7 +175,7 @@ } - + advance_to_target_time_and_observe This is like above, but you also need to pass an obsever. diff --git a/docs/xml/md_pages_ode_steppers_tutorial1.xml b/docs/xml/md_pages_ode_steppers_tutorial1.xml index 025aa1d..9ceba09 100644 --- a/docs/xml/md_pages_ode_steppers_tutorial1.xml +++ b/docs/xml/md_pages_ode_steppers_tutorial1.xml @@ -10,14 +10,14 @@ This tutorial demonstrates how to use the pressio/ode component to run explicit time integration for a system of ODEs that uses data types natively supported in pressio. By natively supported, we mean data types that pressio knows how to manipulate and perform computation on, and therefore the user does not need to provide any auxiliary information. Here, we use Eigen data types as an example, but the same code can be used for other natively supported types. We demonstate how to integrate in time the following system of ODEs: \[ \frac{d \mathbf{y}}{d t} = 10 \mathbf{y} \] where $\mathbf{y} \in R^3$ is the state and $t$ is time. - + Include #include"pressio/ode_advancers.hpp" #include"pressio/ode_steppers_explicit.hpp" #include<Eigen/Core> - + Problem class template<classscalar_t> structMySystem{ @@ -42,7 +42,7 @@ We demonstate how to integrate in time the following system of ODEs: }; - + Main intmain(intargc,char*argv[]) { @@ -81,7 +81,7 @@ We demonstate how to integrate in time the following system of ODEs: } - + Full Code The full code is available here. diff --git a/docs/xml/md_pages_ode_steppers_tutorial2.xml b/docs/xml/md_pages_ode_steppers_tutorial2.xml index bfb2eef..cb5fd34 100644 --- a/docs/xml/md_pages_ode_steppers_tutorial2.xml +++ b/docs/xml/md_pages_ode_steppers_tutorial2.xml @@ -10,7 +10,7 @@ This tutorial demonstrates how to use the pressio/ode component to run explicit time integration for a system of ODEs based on custom types, i.e. data types that pressio does not know how to operate on. - + Custom Vector Class Suppose that you have an application that uses a custom vector class as follows: template<classScalarType> @@ -38,7 +38,7 @@ This custom vector class is very simple but the key point is that the CustomVector is unknown to Pressio. You can replace CustomVector with any type that fits your needs. - + Problem Class Here, we want to integrate in time the same system of ODEs shown in tutorial1, but with the problem implemented using the CustomVector class as follows: structMySystem @@ -64,7 +64,7 @@ }; - + Specialize trait and ops Because we are working with custom data types, we need to provide the necessary operations to do the algebra that pressio needs. This is done as follows: namespacepressio{ @@ -117,7 +117,7 @@ }}//endnamespacepressio::ops - + Main intmain(intargc,char*argv[]) { @@ -152,7 +152,7 @@ return0; - + Full Code The full code is available here. diff --git a/docs/xml/md_pages_ode_steppers_tutorial3.xml b/docs/xml/md_pages_ode_steppers_tutorial3.xml index d82a286..5d65003 100644 --- a/docs/xml/md_pages_ode_steppers_tutorial3.xml +++ b/docs/xml/md_pages_ode_steppers_tutorial3.xml @@ -10,7 +10,7 @@ Demonstrates how to use the pressio/ode to do implicit time integration for a system of ODEs that uses data types natively supported in pressio. - + Problem ... diff --git a/docs/xml/md_pages_ode_steppers_tutorial4.xml b/docs/xml/md_pages_ode_steppers_tutorial4.xml index 368adee..1ac86c3 100644 --- a/docs/xml/md_pages_ode_steppers_tutorial4.xml +++ b/docs/xml/md_pages_ode_steppers_tutorial4.xml @@ -10,7 +10,7 @@ Demonstrates how to use the pressio/ode to do implicit time integration for a system of ODEs that uses custom data types. - + Problem ... diff --git a/docs/xml/md_pages_rom_galerkin_default_explicit_custom_types.xml b/docs/xml/md_pages_rom_galerkin_default_explicit_custom_types.xml index 57f4884..aa29a45 100644 --- a/docs/xml/md_pages_rom_galerkin_default_explicit_custom_types.xml +++ b/docs/xml/md_pages_rom_galerkin_default_explicit_custom_types.xml @@ -10,7 +10,7 @@ This tutorial demonstrates how to - + Custom Data Class Suppose that you have an application that uses arbitrary types. For the sake of this tutorial, let's define these to be: template<classScalarType> @@ -61,7 +61,7 @@ }; - + Specialize trait and ops Because we are working with custom data types, we need to provide the necessary operations to do the algebra that pressio needs. This is done via specialization as follows: namespacepressio{ @@ -195,7 +195,7 @@ }}//endnamespacepressio::ops - + Main #include"pressio/rom_galerkin.hpp" diff --git a/docs/xml/md_pages_solvers_nonlinear_tutorial_1.xml b/docs/xml/md_pages_solvers_nonlinear_tutorial_1.xml index ec295ea..5105abe 100644 --- a/docs/xml/md_pages_solvers_nonlinear_tutorial_1.xml +++ b/docs/xml/md_pages_solvers_nonlinear_tutorial_1.xml @@ -10,14 +10,14 @@ This tutorial demonstrates how to use the Newton-Raphson solver from pressio/solvers_nonlinear using data types natively supported in pressio. Here, we use Eigen data types, but a similar code can be used for other natively supported types. - + Include #include"pressio/solvers_linear.hpp" #include"pressio/solvers_nonlinear.hpp" #include<Eigen/Core> - + Problem class structMySystem { @@ -50,7 +50,7 @@ }; - + Main intmain() { @@ -87,7 +87,7 @@ } - + Full Code The full code is available TODO. diff --git a/docs/xml/md_pages_solvers_nonlinear_tutorial_2.xml b/docs/xml/md_pages_solvers_nonlinear_tutorial_2.xml index 7acb90d..1566216 100644 --- a/docs/xml/md_pages_solvers_nonlinear_tutorial_2.xml +++ b/docs/xml/md_pages_solvers_nonlinear_tutorial_2.xml @@ -10,7 +10,7 @@ This tutorial demonstrates how to use the Newton-Raphson solver from pressio/solvers_nonlinear using custom data types. - + Custom data types template<classScalarType> structCustomVector @@ -60,7 +60,7 @@ }; - + Problem class structMySystem { @@ -89,7 +89,7 @@ }; - + Specialize trait and ops Because we are working with custom data types, we need to provide the necessary operations to do the algebra that pressio needs. This is done via specialization as follows: namespacepressio{ @@ -136,7 +136,7 @@ }}//endnamespacepressio::ops - + Custom Linear solver In this example, we use a custom linear solver. template<classScalarType> @@ -159,7 +159,7 @@ }; - + Main intmain() { @@ -192,7 +192,7 @@ } - + Full Code The full code is available TODO. diff --git a/docs/xml/md_pages_solvers_nonlinear_tutorial_3.xml b/docs/xml/md_pages_solvers_nonlinear_tutorial_3.xml index e099788..b148ee0 100644 --- a/docs/xml/md_pages_solvers_nonlinear_tutorial_3.xml +++ b/docs/xml/md_pages_solvers_nonlinear_tutorial_3.xml @@ -10,7 +10,7 @@ This tutorial demonstrates how to use the normal-equations-based Gauss-Newton solver from pressio/solvers_nonlinear using data types natively supported in pressio. Here, we use Eigen data types, but a similar code can be used for other natively supported types. - + Problem class structMyRosenbrockSystem { @@ -56,7 +56,7 @@ }; - + Main intmain() { @@ -94,7 +94,7 @@ } - + Full Code The full code is available TODO. diff --git a/docs/xml/md_pages_swe_main.xml b/docs/xml/md_pages_swe_main.xml new file mode 100644 index 0000000..619e9e7 --- /dev/null +++ b/docs/xml/md_pages_swe_main.xml @@ -0,0 +1,26 @@ + + + + md_pages_swe_main + Shallow Water Equations Demo + + + +We consider the shallow water equations (SWE) on the spatial domain $\Omega = [-\frac{L}{2},\frac{L}{2}] \times [-\frac{L}{2},\frac{L}{2}]$: \[ \begin{split} &\frac{\partial h}{\partial t} + \frac{\partial}{\partial x }( h u) + \frac{\partial}{\partial y }( h v) = 0,\\ &\frac{\partial h u}{\partial t} + \frac{\partial}{\partial x} (h u^2 + \frac{1}{2} \mu_1 h^2) + \frac{\partial}{\partial y }( h u v) = \mu_3 hv,\\ &\frac{\partial h v}{\partial t} + \frac{\partial}{\partial x} (h u v) + \frac{\partial}{\partial y }( h v^2 + \frac{1}{2} \mu_1 h^2) = \mu_3 hu. \end{split} \] +In the above, $h : \Omega \rightarrow \mathbb{R}$ is the height of the water surface, $u : \Omega \rightarrow \mathbb{R}$ is the x-velocity, and $v : \Omega \rightarrow \mathbb{R}$ is the y-velocity. The system has three parameters: +$\mu_1$ is the gravity parameter +$\mu_2$ controls the magnitude of the initial pulse +$\mu_3$ controls the magnitude of the Coriolis forcing + + + + + + + +We are updating the code to use latest pressio, we will repost this soon. + + + + + diff --git a/docs/xml/swe_2main_8md.xml b/docs/xml/swe_2main_8md.xml new file mode 100644 index 0000000..7f8f43c --- /dev/null +++ b/docs/xml/swe_2main_8md.xml @@ -0,0 +1,11 @@ + + + + main.md + + + + + + + diff --git a/docs/xml/swetut_f1.gif b/docs/xml/swetut_f1.gif new file mode 100644 index 0000000..b80d1b0 Binary files /dev/null and b/docs/xml/swetut_f1.gif differ diff --git a/tpls/pressio b/tpls/pressio index 2870f2d..049b7be 160000 --- a/tpls/pressio +++ b/tpls/pressio @@ -1 +1 @@ -Subproject commit 2870f2d4a5a7539d17308f558f1bfcee654036f3 +Subproject commit 049b7bec173d635f8d35ad40ae56e1d7559263e0