diff --git a/docs_sphinx/developer.rst b/docs_sphinx/developer.rst index 65e2dc8..5ea766b 100644 --- a/docs_sphinx/developer.rst +++ b/docs_sphinx/developer.rst @@ -16,6 +16,23 @@ BTCS functionalities are externally outsourced and not visible to the user. Activity Diagram for run routine in simulation class ==================================================== +The following activity diagram represents the actions when the run method is called within the simulation class. +For better distinction, the activities of the calculation methods FTCS and BTCS are shown in two separate activity diagrams. + .. image:: images/activity_diagram_run.svg :width: 2000 - :alt: Activity diagram for the run method in the simulation class \ No newline at end of file + :alt: Activity diagram for the run method in the simulation class + + +**Activity Diagram for FTCS method** + +.. image:: images/activity_diagram_FTCS.svg + :width: 400 + :alt: Activity diagram for the FTCS method + + +**Activity Diagram for BTCS method** + +.. image:: images/activity_diagram_BTCS.svg + :width: 400 + :alt: Activity diagram for the BTCS method diff --git a/docs_sphinx/images/activity_diagram_BTCS.svg b/docs_sphinx/images/activity_diagram_BTCS.svg new file mode 100644 index 0000000..a0ebabc --- /dev/null +++ b/docs_sphinx/images/activity_diagram_BTCS.svg @@ -0,0 +1,4 @@ + + + +
Create coefficient matrix for t+1/2
Create coefficie...
execute BTCS
execute BTCS
Create solution vector for t+1/2
Create solution...
Solve linear system
Solve linear sys...
Update concentration matrix
Update concentra...
Create coefficient matrix for t+1
Create coefficie...
Create solution vector for t+1
Create solution...
Solve linear system
Solve linear sys...
Update concentration matrix
Update concentra...
Transpose and swap matrices
Transpose and sw...
...
...
...
...
[2D case]
[2D case]
[1D case]
[1D case]
Create coefficient matrix for t+1/2
Create coefficie...
Create solution vector for t+1/2
Create solution...
Solve linear system
Solve linear sys...
Update concentration matrix
Update concentra...
Create coefficient matrix for t+1
Create coefficie...
Create solution vector for t+1
Create solution...
Solve linear system
Solve linear sys...
Update concentration matrix
Update concentra...
Transpose and swap matrices
Transpose and sw...
openMP
openMP
Text is not SVG - cannot display
\ No newline at end of file diff --git a/docs_sphinx/images/activity_diagram_FTCS.svg b/docs_sphinx/images/activity_diagram_FTCS.svg new file mode 100644 index 0000000..3f4a9d2 --- /dev/null +++ b/docs_sphinx/images/activity_diagram_FTCS.svg @@ -0,0 +1,4 @@ + + + +
execute FTCS
execute FTCS
[1D case]
[1D case]
[2D case]
[2D case]
Calculate values for inner cells
Calculate values...
Calculate values for boundaries without corners
Calculate values...
Calculate values for corner boundaries
Calculate values...
Calculate values for inner cells
Calculate values...
Calculate values for boundaries without corners
Calculate values...
Calculate values for corner boundaries
Calculate values...
...
...
...
...
openMP
openMP
Text is not SVG - cannot display
\ No newline at end of file