Skip to content

Commit

Permalink
Task93 uml for pyMGM (#102)
Browse files Browse the repository at this point in the history
* combined versions

* removed unneeded coarsen diagram

* copy over to begin pyMGM diagram

* edits for pyMGM

* add pymgm diagram png

* add returned data in mgm2D
  • Loading branch information
WorkGitAccount authored Apr 21, 2024
1 parent 4c38bfe commit 7fb269b
Show file tree
Hide file tree
Showing 6 changed files with 87 additions and 90 deletions.
Binary file modified docs/ClassDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 11 additions & 2 deletions docs/ClassDiagram.txt
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,10 @@ class constructor_m {

class PcCoarsen2D_cpp {
vector < Point2d > inputPoints
WeightedSampleElimination object
vector < Point2d > outputPoints
WeightedSampleElimination< Point2d, double, 2, int > wse
float area
float d_max
outputpoints = wse.Eliminate
Nc = outputPoints.size
xc < outputPoints.x, outputPoints.y>
Expand Down Expand Up @@ -112,6 +115,10 @@ class cyVector_h{
}

class cySampleElim_h {
alpha
beta
gamma
tiling
bounds
weightLimiting
TilePoint
Expand All @@ -121,6 +128,7 @@ class cySampleElim_h {
+SetWeightLimiting()
+GetParameters()
+GetMaxPoissonDiskRadius()
+DoEliminate()

}

Expand Down Expand Up @@ -188,7 +196,8 @@ gallery_m -d-> DriverScript_m : 2. return sanitized data
DriverScript_m -r-> mgm2D_m : 3. Build mgm2D object\n with gallery data
mgm2D_m -u-|> mgm_m : implements
mgm2D_m -r-> constructor_m : 4. call constructor
constructor_m -r-> PcCoarsen2D_cpp : 5. calls PcCoarsen2D
constructor_m -r-> PcCoarsen2D_cpp : 5. Matlab Mex binding \n input/output \n calls cyPackage
PcCoarsen2D_cpp -d-> constructor_m
PcCoarsen2D_cpp -r-> cySampleElim_h : 6. call wse constructor(), Eliminate()
cySampleElim_h -r-> cyCore_h
cySampleElim_h -d-> cyHeap_h : 7. Coarsening algorithm \n uses priority queue \n of nearest neighbors
Expand Down
Binary file removed docs/CoarsenDiagram.png
Binary file not shown.
88 changes: 0 additions & 88 deletions docs/CoarsenDiagram.txt

This file was deleted.

Binary file added docs/pyMGMClassDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
76 changes: 76 additions & 0 deletions docs/pyMGMClassDiagram.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
@startuml

abstract class mgm_py {
+solve()
+afun()
+standalone()
+multilevel()
}

class mgm2D_py {
Lh
x
domArea
stencilSize
LevelsData < interpolator<> , restrictor<> , PointClouds<> >
uh
relres
iters
resvec
+init()
+constructor()
+buildInterpOp()
+plot()
}

class sqrpoisson {
Lh
x
domVol
fh
uexact
}

class Demo_py {

}



class PcCoarsen2D_cpp {
vector < Point2d > inputPoints
vector < Point2d > outputPoints
Nc = outputPoints.size

+Coarsen()
}



class cyCodeBase_cpp {
Point Cloud
Heap
+WeightedSampleElimination()


}


class polynomialBasis2D_py {

}



Demo_py -u-> sqrpoisson : Create Sample Data
Demo_py -r-> mgm2D_py : Build mgm2D object\n with sqrpoisson input data
mgm2D_py -u-|> mgm_py : inherits
mgm2D_py -r-> PcCoarsen2D_cpp : pyBind linking to C++
PcCoarsen2D_cpp -r-> cyCodeBase_cpp : call cyCodeBase \n to coarsen levels
mgm2D_py --> polynomialBasis2D_py





@enduml

0 comments on commit 7fb269b

Please sign in to comment.