From 09cf1aaf713c7d0dc0f7ea9f39041c05359b5f33 Mon Sep 17 00:00:00 2001
From: Magne Sjaastad <magne.sjaastad@ceetronsolutions.com>
Date: Thu, 12 Oct 2017 11:33:43 +0200
Subject: [PATCH] Documentation : Add class diagram for well paths and
 simulation wells

---
 doc/well_geometry_classes.plantuml | 54 ++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 doc/well_geometry_classes.plantuml

diff --git a/doc/well_geometry_classes.plantuml b/doc/well_geometry_classes.plantuml
new file mode 100644
index 0000000000..936295453b
--- /dev/null
+++ b/doc/well_geometry_classes.plantuml
@@ -0,0 +1,54 @@
+@startuml
+
+class RimView
+class RimOilField
+class RimEclipseCaseCollection
+class RimCase
+class RimWellPath
+class RimWellPathCollection
+
+RimProject *--> RimOilField
+
+RimOilField *--> RimWellPathCollection
+RimOilField *--> RimEclipseCaseCollection
+RimEclipseCaseCollection *--> "n" RimEclipseCase
+
+RimWellPathCollection *--> "n" RimWellPath
+RimEclipseWellCollection *--> "n" RimEclipseWell
+
+
+RimView <|-- RimEclipseView
+
+RimCase <|-- RimEclipseCase 
+
+RimEclipseCase *--> "n" RimEclipseView
+
+RimEclipseView *-> RimEclipseWellCollection
+
+
+
+class RigWellPath {
+    std::vector<cvf::Vec3d>     m_wellPathPoints;
+    std::vector<double>         m_measuredDepths;
+}
+
+class RimWellPath {
+	Represents reference to a file containing points along a curve
+	for the center line of the physical well path
+}
+RimWellPath *-> RigWellPath
+
+
+class RimEclipseWell {
+	Represents a collection of cubes the simulation
+	well passes through
+}
+
+class RigSimulationWellCenterLineCalculator {
+	Can compute a RigWellPath based on a RigSingleWellResultsData
+}
+
+RigSimulationWellCenterLineCalculator ...> RigWellPath
+RigSimulationWellCenterLineCalculator ...> RigSingleWellResultsData
+
+@enduml