diff --git a/docs_sphinx/developer.rst b/docs_sphinx/developer.rst index 5e9de61..65e2dc8 100644 --- a/docs_sphinx/developer.rst +++ b/docs_sphinx/developer.rst @@ -1,2 +1,21 @@ Developer Guide -=============== \ No newline at end of file +=============== + +========================= +Class Diagram of user API +========================= + +The following graphic shows the class diagram of the user API. The FTCS and +BTCS functionalities are externally outsourced and not visible to the user. + +.. image:: images/class_diagram.svg + :width: 2000 + :alt: Class diagram for the user API + +==================================================== +Activity Diagram for run routine in simulation class +==================================================== + +.. 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 diff --git a/docs_sphinx/images/activity_diagram_run.svg b/docs_sphinx/images/activity_diagram_run.svg new file mode 100644 index 0000000..4f67009 --- /dev/null +++ b/docs_sphinx/images/activity_diagram_run.svg @@ -0,0 +1,4 @@ + + + +
execute run
execute run
Call FTCS routine
Call FTCS routine
Call BTCS routine
Call BTCS routine
[FTCS method]
[FTCS method]
[BTCS method]
[BTCS method]
[i<iterations]
[i<iterations]
[maximum
iterations reached]
[maximum...
[i<iterations]
[i<iterations]
[maximum
iterations reached]
[maximum...Text is not SVG - cannot display \ No newline at end of file diff --git a/docs_sphinx/images/class_diagram.svg b/docs_sphinx/images/class_diagram.svg new file mode 100644 index 0000000..3392a01 --- /dev/null +++ b/docs_sphinx/images/class_diagram.svg @@ -0,0 +1,4 @@ + + + +
Grid
Grid
- dim:int
- col:int
- row:int
- domain_col: int
- domain_row: int
- delta_col: double
- delta_row: double
- dim:int...
+ Grid(col: int)
+ Grid(row: int, col: int)
+ setConcentrations(concentrations: MatrixXd)
+ getConcentrations(): MatrixXd
+ setAlpha(alpha: MatrixXd)
+ setAlpha(alpha_x: MatrixXd, alpha_y: MatrixXd)
+ getAlphaX(): MatrixXd
+ getAlphaY(): MatrixXd
+ getDim(): int
+ getRow(): int
+ getCol(): int
+ setDomain(domain_col: int)
+ setDomain(domain_row: int, domain_col: int)
+ getDeltaCol(): double
+ getDeltaRow(): double
+ Grid(col: int)...
Boundary
Boundary
- grid: Grid
- type: BC_TYPE
- left: VectorXd
- right: VectorXd
- top: VectorXd
- bottom: VectorXd
- grid: Grid...
+ Boundary(grid: Grid, type: BC_TYPE)
+ getBoundaryConditionType(): BC_TYPE
+ setBoundaryConditionValue(side: BC_SIDE, value: VectorXd)
+ getBoundaryConditionValue(): VectorXd
+ Boundary(grid: Grid, type: BC_TYPE)...
Simulation
Simulation
- timestep: double
- iterations: int
- csv_output: CSV_OUTPUT
- grid: GRID
- bc: Boundary
- approach: APPROACH
- timestep: double...
+ Simulation(grid: Grid, bc: Boundary, approach: APPROACH
+ setOutputCSV(csv_output: CSV_OUTPUT)
+ setTimestep(timestep: double)
+ getTimestep(): double
+ setIterations(iterations: int)
+ getIterations(): int
+ printConcentrationsConsole()
+ printConcentrationsCSV(ident: string, appendMode: bool)
+ run()
+ Simulation(grid: Grid, bc: Boundary, approach: APPROACH...
FTCS
FTCS
BTCS
BTCS
functionalities
functionalities
TUG API
TUG API
BoundaryElement
BoundaryElement
- type: BC_TYPE
- value: double
- type: BC_TYPE...
+ BoundaryElement()
+ BoundaryElement(value: double)
+ setType(type: BC_TYPE)
+ setValue(value: double)
+ getType(): BC_TYPE
+ getValue(): double
+ BoundaryElement()...Text is not SVG - cannot display \ No newline at end of file diff --git a/docs_sphinx/images/tug_logo.svg b/docs_sphinx/images/tug_logo.svg new file mode 100644 index 0000000..aa2c860 --- /dev/null +++ b/docs_sphinx/images/tug_logo.svg @@ -0,0 +1,2629 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +