C++ Class Diagrams #147
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,285 @@ | ||
| compilation_database_dir: build | ||
| output_directory: docs/diagrams/puml | ||
| diagrams: | ||
| timeintegration: | ||
| type: class | ||
| generate_method_arguments: full | ||
| generate_packages: false | ||
| glob: | ||
| - core/**/*.cpp | ||
| - physics/**/*.cpp | ||
| relative_to: src | ||
| package_type: directory | ||
| include: | ||
| paths: | ||
| - core | ||
| - physics | ||
| elements: | ||
| - RKmethod | ||
| - ButcherTableau | ||
| - DynamicEquation | ||
| - RungeKuttaStepper | ||
| - "RungeKuttaStepper##RungeKuttaStageExecutor" | ||
| - Stepper | ||
| - TimeSolver | ||
| - Relaxer | ||
| exclude: | ||
| namespaces: | ||
| - std | ||
| plantuml: | ||
| before: | ||
| - '!theme vibrant' | ||
| - 'left to right direction' | ||
| - 'package Legend {' | ||
| - ' class Class' | ||
| - ' abstract class Abstract' | ||
| - ' enum Enum' | ||
| - ' class Visibility {' | ||
| - ' +public field' | ||
| - ' +public method()' | ||
| - ' -private field' | ||
| - ' -private method()' | ||
| - ' #protected field' | ||
| - ' }' | ||
| - ' Class -[hidden]-> Extension' | ||
| - ' Abstract -[hidden]-> Extension' | ||
| - ' Enum -[hidden]-> Extension' | ||
| - ' Visibility <|-- Extension : Extension' | ||
| - ' Visibility o-- Aggregation : Aggregation' | ||
| - ' Visibility +.. Nested : Nested' | ||
| - ' Visibility --> Dependency : Dependency' | ||
| - ' Visibility ..> WeakDependency : Weak dependency' | ||
| - '}' | ||
|
|
||
| magnetics: | ||
| type: class | ||
| generate_method_arguments: full | ||
| generate_packages: false | ||
| glob: | ||
| - core/**/*.cpp | ||
| - physics/**/*.cpp | ||
| relative_to: src | ||
| package_type: directory | ||
| include: | ||
| paths: | ||
| - core | ||
| - physics | ||
| elements: | ||
| - Altermagnet | ||
| - Antiferromagnet | ||
| - DmiTensor | ||
| - CuDmiTensor | ||
| - Ferromagnet | ||
| - HostMagnet | ||
| - Magnet | ||
| - Minimizer | ||
| - MumaxWorld | ||
| - NcAfm | ||
| - BoundaryTraction | ||
| - CuBoundaryTraction | ||
| exclude: | ||
| namespaces: | ||
| - std | ||
| plantuml: | ||
| before: | ||
| - '!theme vibrant' | ||
| - 'left to right direction' | ||
| - 'package Legend {' | ||
| - ' class Class' | ||
| - ' class Visibility {' | ||
| - ' +public field' | ||
| - ' +public method()' | ||
| - ' -private field' | ||
| - ' -private method()' | ||
| - ' }' | ||
| - ' Class -[hidden]-> Extension' | ||
| - ' Visibility <|-- Extension : Extension' | ||
| - ' Visibility o-- Aggregation : Aggregation' | ||
| - ' Visibility --> Dependency : Dependency' | ||
| - ' Visibility ..> WeakDependency : Weak dependency' | ||
| - '}' | ||
|
|
||
| quantities: | ||
| type: class | ||
| generate_method_arguments: full | ||
| generate_packages: false | ||
| glob: | ||
| - core/**/*.cpp | ||
| - physics/**/*.cpp | ||
| relative_to: src | ||
| package_type: directory | ||
| include: | ||
| paths: | ||
| - core | ||
| - physics | ||
| elements: | ||
| - "DynamicParameter<T>" | ||
| - Field | ||
| - CuField | ||
| - FieldQuantity | ||
| - InterParameter | ||
| - Parameter | ||
| - CuParameter | ||
| - VectorParameter | ||
| - CuVectorParameter | ||
| - ScalarQuantity | ||
| - Variable | ||
| - NormalizedVariable | ||
| - "ScalarQuantityEvaluator<T>" | ||
| - "FieldQuantityEvaluator<T>" | ||
| exclude: | ||
| namespaces: | ||
| - std | ||
| plantuml: | ||
| before: | ||
| - '!theme vibrant' | ||
| - 'left to right direction' | ||
| - 'package Legend {' | ||
| - ' class Class' | ||
| - ' abstract class Abstract' | ||
| - ' class Template <T>' | ||
| - ' class Visibility {' | ||
| - ' +public method()' | ||
| - ' -private field' | ||
| - ' -private method()' | ||
| - ' #protected field' | ||
| - ' #protected method()' | ||
| - ' }' | ||
| - ' Class -[hidden]-> Extension' | ||
| - ' Abstract -[hidden]-> Extension' | ||
| - ' Template -[hidden]-> Extension' | ||
| - ' Visibility <|-- Extension : Extension' | ||
| - ' Visibility o-- Aggregation : Aggregation' | ||
| - ' Visibility --> Dependency : Dependency' | ||
| - ' Visibility ..> WeakDependency : Weak dependency' | ||
| - '}' | ||
|
|
||
| strayfield: | ||
| type: class | ||
| generate_method_arguments: full | ||
| generate_packages: false | ||
| glob: | ||
| - physics/**/*.cpp | ||
| relative_to: src | ||
| package_type: directory | ||
| include: | ||
| paths: | ||
| - core | ||
| - physics | ||
| elements: | ||
| - StrayFieldExecutor | ||
| - StrayField | ||
| - StrayFieldBruteExecutor | ||
| - StrayFieldFFTExecutor | ||
| - StrayFieldKernel | ||
| exclude: | ||
| namespaces: | ||
| - std | ||
| plantuml: | ||
| before: | ||
| - '!theme vibrant' | ||
| - 'left to right direction' | ||
| - 'package Legend {' | ||
| - ' class Class' | ||
| - ' abstract class Abstract' | ||
| - ' class Visibility {' | ||
| - ' +public method()' | ||
| - ' -private field' | ||
| - ' #protected field' | ||
| - ' #protected method()' | ||
| - ' }' | ||
| - ' Class -[hidden]-> Extension' | ||
| - ' Abstract -[hidden]-> Extension' | ||
| - ' Visibility <|-- Extension : Extension' | ||
| - ' Visibility o-- Aggregation : Aggregation' | ||
| - '}' | ||
|
|
||
| domain: | ||
| type: class | ||
| generate_method_arguments: full | ||
| generate_packages: false | ||
| glob: | ||
| - core/**/*.cpp | ||
| - physics/**/*.cpp | ||
| relative_to: src | ||
| package_type: directory | ||
| include: | ||
| paths: | ||
| - core | ||
| - physics | ||
| elements: | ||
| - Grid | ||
| - System | ||
| - CuSystem | ||
| - World | ||
| exclude: | ||
| namespaces: | ||
| - std | ||
| plantuml: | ||
| before: | ||
| - '!theme vibrant' | ||
| - 'left to right direction' | ||
| - 'package Legend {' | ||
| - ' class Class' | ||
| - ' class Visibility {' | ||
| - ' +public method()' | ||
| - ' -private field' | ||
| - ' #protected field' | ||
| - ' }' | ||
| - ' Class -[hidden]-> Dependency' | ||
| - ' Visibility o-- Aggregation : Aggregation' | ||
| - ' Visibility --> Dependency : Dependency' | ||
| - '}' | ||
|
|
||
| utilities: | ||
| type: class | ||
| generate_method_arguments: full | ||
| generate_packages: false | ||
| glob: | ||
| - core/**/*.cpp | ||
| - physics/**/*.cpp | ||
| - linsolver/**/*.cpp | ||
| - bindings/wrap_mfm.cpp | ||
| relative_to: src | ||
| package_type: directory | ||
| include: | ||
| paths: | ||
| - core | ||
| - physics | ||
| - linsolver | ||
| elements: | ||
| - VoronoiTessellator | ||
| - Center | ||
| - Tile | ||
| - Int3Hash | ||
| - MFM | ||
| - PoissonSystem | ||
| - LinSolver | ||
| - "LinSolver##Stepper" | ||
| - LinearSystem | ||
| - "LinearSystem##CuData" | ||
| exclude: | ||
| namespaces: | ||
| - std | ||
| plantuml: | ||
| before: | ||
| - '!theme vibrant' | ||
| - 'left to right direction' | ||
| - 'package Legend {' | ||
| - ' class Class' | ||
| - ' abstract class Abstract' | ||
| - ' class Visibility {' | ||
| - ' +public field' | ||
| - ' +public method()' | ||
| - ' -private field' | ||
| - ' -private method()' | ||
| - ' #protected method()' | ||
| - ' }' | ||
| - ' Class -[hidden]-> WeakDependency' | ||
| - ' Abstract -[hidden]-> WeakDependency' | ||
| - ' Visibility o-- Aggregation : Aggregation' | ||
| - ' Visibility +.. Nested : Nested' | ||
| - ' Visibility --> Dependency : Dependency' | ||
| - ' Visibility ..> WeakDependency : Weak dependency' | ||
| - '}' | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,3 +15,4 @@ cu*_*.dll | |
| docs/_build/* | ||
| !docs/_build/html/ | ||
| !docs/_build/html/** | ||
| docs/diagrams/puml | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just checking, these are generated files, but are themselves not needed by the website?