Skip to content

Commit a929707

Browse files
committed
Outlined the solve page structure
1 parent b193878 commit a929707

File tree

3 files changed

+27
-10
lines changed

3 files changed

+27
-10
lines changed

docs/examples.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ Work in progress
99

1010
# Examples
1111

12-
Text
12+
## Quick Start
1313

14-
## Subtitle
14+
## Simple DAE
15+
16+
## Perovskite model
1517

16-
Text

docs/solve.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,28 @@ Work in progress
99

1010
# Solving DAE system
1111

12-
Text
12+
Once the DAE system is defined (see [Classes to define DAE system](classes.html)), we are ready to start solving it.
13+
Generally, there are two ways of calling the main `dae-cpp` solver from the program and start computation:
1314

14-
## Subtitle
15+
- Use the [`System`](#system-class) class, which serves as a wrapper for the lower-level [`daecpp::solve(...)`](#daecppsolve-function) function. The class [`System`](#system-class) contains the [Solver Options](solver-options.html) and [Solution Holder](solution-manager.html#solution-holder-class) objects. The latter is used to save the solution vector every time step. Both objects are public members of the [`System`](#system-class) class and can be accessed by the user. It's a very easy class to use (see [Quick Start example](quick-start.html)), but it does not allow the user to define a custom [Solution Manager](solution-manager.html).
16+
- Use the lower-level [`daecpp::solve(...)`](#daecppsolve-function) function directly, providing the user-defined [DAE system classes](#system-class), [Solver Options](solver-options.html), [Solution Manager](solution-manager.html), etc., as arguments. This is a more flexible approach (see [Simple DAE](https://github.com/dae-cpp/dae-cpp/blob/master/examples/simple_dae/simple_dae.cpp) example).
1517

16-
Text
18+
In this section, we consider both approaches to start the computation.
19+
20+
## `System` class
21+
22+
Serves as a wrapper for lower level [`daecpp::solve(...)`](#daecppsolve-function) function calls. Contains the [Solver Options](solver-options.html) and [Solution Holder](solution-manager.html#solution-holder-class) objects.
23+
24+
### `System` class public members
25+
26+
### `System` class constructor
27+
28+
### `System` class `solve(...)` method
29+
30+
### Example
31+
32+
## `daecpp::solve(...)` function
33+
34+
Integrates the system of DAEs.
35+
36+
### Example

docs/utilities.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,3 @@ TODO:
1313

1414
- [ ] Get solver version
1515
- [ ] Timer
16-
17-
## Subtitle
18-
19-
Text

0 commit comments

Comments
 (0)