Skip to content

Commit 65e4da0

Browse files
baagaard-usgsbaagaard-usgs
committed
DOCS: Add fault implementation class diagram.
1 parent fd37b90 commit 65e4da0

25 files changed

+6088
-2547
lines changed

‎docs/Makefile.am‎

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -742,36 +742,39 @@ dist_noinst_DATA = \
742742
developer/ides/vs-code.md \
743743
developer/ides/index.md \
744744
developer/index.md \
745-
developer/implementation/figs/classdiagram_output.png \
746-
developer/implementation/figs/classdiagram_material.tex \
745+
developer/implementation/figs/classdiagram_output.tex \
747746
developer/implementation/figs/classdiagram_output.pdf \
747+
developer/implementation/figs/classdiagram_output.svg \
748+
developer/implementation/figs/classdiagram_material.tex \
749+
developer/implementation/figs/classdiagram_material.pdf \
750+
developer/implementation/figs/classdiagram_material.svg \
751+
developer/implementation/figs/classdiagram_pylithapp.tex \
748752
developer/implementation/figs/classdiagram_pylithapp.pdf \
749-
developer/implementation/figs/classdiagram_mesher.tex \
750-
developer/implementation/figs/classdiagram_physics_fem.png \
751-
developer/implementation/figs/classdiagram_problem.tex \
753+
developer/implementation/figs/classdiagram_pylithapp.svg \
754+
developer/implementation/figs/classdiagram_mesher.pdf \
752755
developer/implementation/figs/classdiagram_mesher.svg \
756+
developer/implementation/figs/classdiagram_mesher.tex \
757+
developer/implementation/figs/classdiagram_physics_fem.tex \
753758
developer/implementation/figs/classdiagram_physics_fem.pdf \
754-
developer/implementation/figs/classdiagram_pylithapp.png \
759+
developer/implementation/figs/classdiagram_physics_fem.svg \
760+
developer/implementation/figs/classdiagram_problem.tex \
755761
developer/implementation/figs/classdiagram_problem.pdf \
756-
developer/implementation/figs/classdiagram_physics_fem.tex \
757-
developer/implementation/figs/classdiagram_mesher.pdf \
758-
developer/implementation/figs/classdiagram_problem.png \
759-
developer/implementation/figs/classdiagram_pylithapp.tex \
760-
developer/implementation/figs/classdiagram_output.tex \
761-
developer/implementation/figs/classdiagram_material.png \
762-
developer/implementation/figs/classdiagram_material.pdf \
763-
developer/implementation/figs/classdiagram_solution.png \
764-
developer/implementation/figs/meshtopology.pdf \
765-
developer/implementation/figs/classdiagram_bc.tex \
762+
developer/implementation/figs/classdiagram_problem.svg \
766763
developer/implementation/figs/classdiagram_solution.pdf \
767-
developer/implementation/figs/meshtopology.png \
764+
developer/implementation/figs/classdiagram_solution.svg \
765+
developer/implementation/figs/classdiagram_bc.tex \
766+
developer/implementation/figs/classdiagram_bc.pdf \
767+
developer/implementation/figs/classdiagram_bc.svg \
768+
developer/implementation/figs/classdiagram_fault.tex \
769+
developer/implementation/figs/classdiagram_fault.pdf \
770+
developer/implementation/figs/classdiagram_fault.svg \
771+
developer/implementation/figs/meshtopology.pdf \
772+
developer/implementation/figs/meshtopology.svg \
768773
developer/implementation/figs/material_auxiliarylayout.tex \
769774
developer/implementation/figs/material_auxiliarylayout.pdf \
770775
developer/implementation/figs/umlstyle.tex \
771-
developer/implementation/figs/material_auxiliarylayout.png \
776+
developer/implementation/figs/material_auxiliarylayout.svg \
772777
developer/implementation/figs/classdiagram_solution.tex \
773-
developer/implementation/figs/classdiagram_bc.png \
774-
developer/implementation/figs/classdiagram_bc.pdf \
775778
developer/implementation/figs/meshtopology.tex \
776779
developer/implementation/petsc-fem.md \
777780
developer/implementation/index.md \

‎docs/developer/debugging/fields.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ In addition to using the debugger to inspect code and variables, it is often hel
44
Turning on this type of output is usually done by activating debug journals via command line arguments.
55

66
Viewing a field will print the subfield metadata, the layout of the field, and the field values.
7-
See {ref}`sec-developer-petsc-section` for how to interpret the layout of a field.
7+
See {ref}`sec-developer-pylith-field` for how to interpret the layout of a field.
88

99
```{code-block} console
1010
---

‎docs/developer/implementation/figs/classdiagram_bc.png‎

-97.5 KB
Binary file not shown.

‎docs/developer/implementation/figs/classdiagram_bc.svg‎

Lines changed: 470 additions & 0 deletions
Loading

‎docs/developer/implementation/figs/classdiagram_fault.pdf‎

10.9 KB
Binary file not shown.

‎docs/developer/implementation/figs/classdiagram_fault.svg‎

Lines changed: 554 additions & 0 deletions
Loading

‎docs/developer/implementation/figs/classdiagram_fault.tex‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
\documentclass[crop,tikz]{standalone}
2+
\usepackage[none]{hyphenat}
3+
\usepackage{helvet}
4+
\usepackage{calc}
5+
\renewcommand{\familydefault}{phv}
6+
7+
\usepackage{tikz}
8+
9+
\begin{document}
10+
\usetikzlibrary{positioning,arrows,shapes,calc}
11+
\input{../../../tikz-styles/figcolors}
12+
\input{umlstyle}
13+
14+
\begin{tikzpicture}[node distance=10em, line width=1.5pt]
15+
16+
\node (pyre-component) [abstract-class] {\umlemptyclass{PyreComponent}};
17+
18+
\node (physics) [abstract-class] at ($(pyre-component.south)-(0,4em)$) {\umlemptyclass{Physics}};
19+
20+
\node (fault) [abstract-class] at ($(physics.south)-(0,4em)$) {\umlemptyclass{FaultCohesive}};
21+
22+
\node (fault-kin) [concrete-class] at ($(fault.south)-(0,4em)$) {\umlclass{FaultCohesiveKin}{
23+
eq\_rupture
24+
}};
25+
26+
\node (fault-impulses) [concrete-class] at ($(fault-kin.south)-(0,1ex)$) {\umlemptyclass{FaultCohesiveImpulses}};
27+
28+
29+
\node (generic-component) [abstract-class, anchor=west] at ($(pyre-component.east)+(12em,0)$) {\umlemptyclass{GenericComponent}};
30+
31+
\node (kinsrc) [abstract-class] at ($(generic-component.south)-(6em,4em)$) {\umlemptyclass{KinSrc}};
32+
33+
\node (kinsrc-step) [concrete-class] at ($(kinsrc.south)-(0,4em)$) {\umlemptyclass{KinSrcStep}};
34+
\node (kinsrc-constrate) [concrete-class] at ($(kinsrc-step.south)-(0,1ex)$) {\umlemptyclass{KinSrcConstRate}};
35+
\node (kinsrc-ramp) [concrete-class] at ($(kinsrc-constrate.south)-(0,1ex)$) {\umlemptyclass{KinSrcRamp}};
36+
\node (kinsrc-brune) [concrete-class] at ($(kinsrc-ramp.south)-(0,1ex)$) {\umlemptyclass{KinSrcBrune}};
37+
\node (kinsrc-liucos) [concrete-class] at ($(kinsrc-brune.south)-(0,1ex)$) {\umlemptyclass{KinSrcLiuCos}};
38+
\node (kinsrc-time-history) [concrete-class] at ($(kinsrc-liucos.south)-(0,1ex)$) {\umlemptyclass{KinSrcTimeHistory}};
39+
40+
\node (field-factory) [abstract-class, anchor=west] at ($(kinsrc.east)+(4em,0)$) {\umlemptyclass{FieldFactory}};
41+
42+
\node (auxiliary-factory) [abstract-class] at ($(field-factory.south)-(0,4em)$) {\umlemptyclass{AuxiliaryFactory}};
43+
44+
\node (auxiliary-factory-fault) [concrete-class] at ($(auxiliary-factory.south)-(0,4em)$) {\umlemptyclass{AuxiliaryFactoryFault}};
45+
46+
% Relationships
47+
\draw[inherit] (physics) -- (pyre-component);
48+
\draw[inherit] (fault) -- (physics);
49+
\draw[inherit] (fault-kin) -- (fault);
50+
51+
\draw[inherit] (kinsrc) -- (generic-component);
52+
\draw[inherit] (kinsrc-step) -- (kinsrc);
53+
54+
\draw[aggregate] (fault.east) -- (auxiliary-factory-fault.west);
55+
56+
\draw[aggregate] ($(fault-kin.east)-(0,1.0ex)$) -- (kinsrc.west);
57+
58+
\draw[inherit] (field-factory) -- (generic-component);
59+
\draw[inherit] (auxiliary-factory) -- (field-factory);
60+
\draw[inherit] (auxiliary-factory-fault) -- (auxiliary-factory);
61+
62+
63+
\end{tikzpicture}
64+
65+
\end{document}

‎docs/developer/implementation/figs/classdiagram_material.png‎

-156 KB
Binary file not shown.

0 commit comments

Comments
 (0)