|
| 1 | +# diffeq Examples |
| 2 | + |
| 3 | +This directory contains comprehensive examples demonstrating how to use the diffeq library for solving differential equations. |
| 4 | + |
| 5 | +## Example Programs |
| 6 | + |
| 7 | +### Core Integration Examples |
| 8 | + |
| 9 | +- **`working_integrators_demo.cpp`** - Demonstrates all working ODE integrators (RK4, RK23, RK45, BDF, LSODA) |
| 10 | +- **`rk4_integrator_usage.cpp`** - Basic RK4 integrator usage with various ODE systems |
| 11 | +- **`advanced_integrators_usage.cpp`** - Advanced integrator features and configurations |
| 12 | +- **`state_concept_usage.cpp`** - Shows how to use different state types (vectors, arrays, custom types) |
| 13 | + |
| 14 | +### Parallelism Examples |
| 15 | + |
| 16 | +- **`parallelism_usage_demo.cpp`** - Comprehensive parallelism features including: |
| 17 | + - Quick start parallel interface |
| 18 | + - Robotics control systems with real-time parallelism |
| 19 | + - Stochastic process research with GPU-accelerated Monte Carlo |
| 20 | + - Multi-hardware target benchmarking |
| 21 | +- **`standard_parallelism_demo.cpp`** - Standard library parallelism integration: |
| 22 | + - C++17/20 std::execution policies |
| 23 | + - OpenMP parallel loops |
| 24 | + - Intel TBB integration |
| 25 | + - Task-based async dispatchers |
| 26 | +- **`simple_standard_parallelism.cpp`** - Simplified parallel usage patterns |
| 27 | +- **`standard_parallelism_demo.cpp`** - Advanced standard parallelism features |
| 28 | +- **`simplified_parallel_usage.cpp`** - Easy-to-use parallel interfaces |
| 29 | +- **`test_advanced_parallelism.cpp`** - Testing advanced parallelism features |
| 30 | + |
| 31 | +### Advanced Features |
| 32 | + |
| 33 | +- **`interface_usage_demo.cpp`** - Integration interface examples: |
| 34 | + - Financial portfolio modeling with signal processing |
| 35 | + - Robotics control with real-time feedback |
| 36 | + - Scientific simulations with parameter updates |
| 37 | +- **`sde_usage_demo.cpp`** - Stochastic Differential Equation examples: |
| 38 | + - Black-Scholes financial models |
| 39 | + - Heston stochastic volatility |
| 40 | + - Noisy oscillator control systems |
| 41 | + - Stochastic Lotka-Volterra ecosystem models |
| 42 | +- **`advanced_gpu_async_demo.cpp`** - GPU acceleration with async processing |
| 43 | +- **`realtime_signal_processing.cpp`** - Real-time signal processing integration |
| 44 | + |
| 45 | +### Testing and Validation |
| 46 | + |
| 47 | +- **`quick_test.cpp`** - Quick validation tests |
| 48 | +- **`test_dop853.cpp`** - DOP853 integrator testing |
| 49 | +- **`test_rk4_only.cpp`** - RK4 integrator testing |
| 50 | +- **`sde_demo.cpp`** - Basic SDE demonstration |
| 51 | + |
| 52 | +## Building and Running Examples |
| 53 | + |
| 54 | +### Prerequisites |
| 55 | + |
| 56 | +- C++17 or later compiler |
| 57 | +- CMake or xmake build system |
| 58 | +- Optional: OpenMP, Intel TBB, CUDA for advanced parallelism examples |
| 59 | + |
| 60 | +### Building |
| 61 | + |
| 62 | +```bash |
| 63 | +# Using xmake (recommended) |
| 64 | +xmake |
| 65 | + |
| 66 | +# Or using CMake |
| 67 | +mkdir build && cd build |
| 68 | +cmake .. |
| 69 | +make |
| 70 | +``` |
| 71 | + |
| 72 | +### Running Examples |
| 73 | + |
| 74 | +```bash |
| 75 | +# Run a specific example |
| 76 | +./examples/working_integrators_demo |
| 77 | + |
| 78 | +# Run parallelism examples |
| 79 | +./examples/parallelism_usage_demo |
| 80 | +./examples/standard_parallelism_demo |
| 81 | + |
| 82 | +# Run SDE examples |
| 83 | +./examples/sde_usage_demo |
| 84 | + |
| 85 | +# Run interface examples |
| 86 | +./examples/interface_usage_demo |
| 87 | +``` |
| 88 | + |
| 89 | +## Example Categories |
| 90 | + |
| 91 | +### 1. Basic Usage |
| 92 | +Start with these examples to understand the fundamentals: |
| 93 | +- `working_integrators_demo.cpp` |
| 94 | +- `rk4_integrator_usage.cpp` |
| 95 | +- `state_concept_usage.cpp` |
| 96 | + |
| 97 | +### 2. Parallelism |
| 98 | +For performance-critical applications: |
| 99 | +- `parallelism_usage_demo.cpp` - Full-featured parallelism |
| 100 | +- `standard_parallelism_demo.cpp` - Standard library integration |
| 101 | +- `simple_standard_parallelism.cpp` - Easy parallel usage |
| 102 | + |
| 103 | +### 3. Advanced Features |
| 104 | +For complex applications: |
| 105 | +- `interface_usage_demo.cpp` - Signal processing and real-time integration |
| 106 | +- `sde_usage_demo.cpp` - Stochastic differential equations |
| 107 | +- `advanced_gpu_async_demo.cpp` - GPU acceleration |
| 108 | + |
| 109 | +### 4. Domain-Specific Examples |
| 110 | +- **Finance**: Black-Scholes, Heston models in `sde_usage_demo.cpp` |
| 111 | +- **Robotics**: Control systems in `parallelism_usage_demo.cpp` |
| 112 | +- **Scientific**: Chemical reactions, ecosystem models in `sde_usage_demo.cpp` |
| 113 | + |
| 114 | +## Key Features Demonstrated |
| 115 | + |
| 116 | +### Integration Methods |
| 117 | +- **ODE Solvers**: RK4, RK23, RK45, BDF, LSODA, DOP853 |
| 118 | +- **SDE Solvers**: Euler-Maruyama, Milstein, SRA1, SOSRA, SRIW1, SOSRI |
| 119 | +- **Adaptive Methods**: Automatic step size control |
| 120 | +- **Stiff Systems**: BDF and LSODA for stiff problems |
| 121 | + |
| 122 | +### Parallelism |
| 123 | +- **CPU Parallelism**: std::execution, OpenMP, Intel TBB |
| 124 | +- **GPU Acceleration**: CUDA, Thrust integration |
| 125 | +- **Async Processing**: Task-based parallel execution |
| 126 | +- **Real-time Control**: Low-latency parallel integration |
| 127 | + |
| 128 | +### Advanced Features |
| 129 | +- **Signal Processing**: Real-time event handling |
| 130 | +- **Parameter Sweeps**: Parallel parameter studies |
| 131 | +- **Multi-physics**: Coupled system integration |
| 132 | +- **Hardware Optimization**: Automatic backend selection |
| 133 | + |
| 134 | +## Best Practices |
| 135 | + |
| 136 | +1. **Start Simple**: Begin with `working_integrators_demo.cpp` to understand basic usage |
| 137 | +2. **Choose the Right Integrator**: Use RK45 for general problems, BDF for stiff systems |
| 138 | +3. **Leverage Parallelism**: Use parallel examples for performance-critical applications |
| 139 | +4. **Handle Real-time Requirements**: Use interface examples for systems with external signals |
| 140 | +5. **Validate Results**: Compare with analytical solutions when available |
| 141 | + |
| 142 | +## Troubleshooting |
| 143 | + |
| 144 | +### Common Issues |
| 145 | +- **Compilation Errors**: Ensure C++17 support and required libraries |
| 146 | +- **Performance Issues**: Check parallel backend availability |
| 147 | +- **Accuracy Problems**: Verify integrator choice and tolerances |
| 148 | +- **Memory Issues**: Use appropriate state types and batch sizes |
| 149 | + |
| 150 | +### Getting Help |
| 151 | +- Check the main library documentation |
| 152 | +- Review the test suite for usage patterns |
| 153 | +- Examine the source code for implementation details |
| 154 | + |
| 155 | +## Contributing |
| 156 | + |
| 157 | +When adding new examples: |
| 158 | +1. Follow the existing naming convention |
| 159 | +2. Include comprehensive comments |
| 160 | +3. Demonstrate realistic use cases |
| 161 | +4. Add to this README if appropriate |
| 162 | +5. Ensure the example compiles and runs correctly |
0 commit comments