Skip to content

Commit 1bc4832

Browse files
margalvamargalva
authored
Description files for default templates (#285)
1 parent 3ca4357 commit 1bc4832

File tree

7 files changed

+291
-33
lines changed

7 files changed

+291
-33
lines changed

‎default_templates/comparison_report.json‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
"name": "Top",
2929
"report_type": "Layout:panel",
3030
"tags": "",
31-
"item_filter": "A|i_tags|cont|ReportType=Parametric;",
31+
"item_filter": "",
3232
"params": {
3333
"properties": {
3434
"TOCItem": "0"
@@ -148,7 +148,7 @@
148148
"name": "Physics",
149149
"report_type": "Layout:panel",
150150
"tags": "",
151-
"item_filter": "A|i_tags|cont|'Design Point'='Base DP';O|i_type|eq|table;O|i_name|eq|ModelsTableItem;A|i_tags|cont|'Design Point'='Base DP';O|i_type|eq|tree;O|i_name|eq|MaterialsTreeItem;A|i_tags|cont|'Design Point'='Base DP';O|i_name|eq|CellZonesTreeItem;A|i_tags|cont|'Design Point'='Base DP';O|i_name|eq|BoundaryZonesTreeItem;A|i_tags|cont|'Design Point'='Base DP';O|i_name|eq|ReferenceValuesTableItem;A|i_tags|cont|'Design Point'='Base DP';",
151+
"item_filter": "",
152152
"params": {
153153
"properties": {
154154
"TOCItem": "1",
@@ -281,7 +281,7 @@
281281
"name": "Parametric Plots",
282282
"report_type": "Layout:panel",
283283
"tags": "",
284-
"item_filter": "A|i_type|cont|table;A|i_name|cont|parametric_plot;",
284+
"item_filter": "",
285285
"params": {
286286
"properties": {
287287
"TOCItem": "1",
@@ -318,7 +318,7 @@
318318
"name": "Mesh",
319319
"report_type": "Layout:panel",
320320
"tags": "",
321-
"item_filter": "A|i_type|eq|image;A|i_name|cont|_mesh;",
321+
"item_filter": "",
322322
"params": {
323323
"properties": {
324324
"TOCItem": "1",
@@ -339,7 +339,7 @@
339339
"name": "MeshTabs",
340340
"report_type": "Layout:tabs",
341341
"tags": "",
342-
"item_filter": "A|i_type|eq|image;A|i_name|cont|_mesh;",
342+
"item_filter": "",
343343
"params": {
344344
"properties": {
345345
"TOCItem": "0",
@@ -402,7 +402,7 @@
402402
"name": "Contours",
403403
"report_type": "Layout:panel",
404404
"tags": "",
405-
"item_filter": "A|i_type|eq|image;A|i_name|cont|_contour;",
405+
"item_filter": "",
406406
"params": {
407407
"properties": {
408408
"TOCItem": "1",
@@ -423,7 +423,7 @@
423423
"name": "ContourTabs",
424424
"report_type": "Layout:tabs",
425425
"tags": "",
426-
"item_filter": "A|i_type|eq|image;A|i_name|cont|_contour;",
426+
"item_filter": "",
427427
"params": {
428428
"properties": {
429429
"TOCItem": "0",
@@ -486,7 +486,7 @@
486486
"name": "Pathlines",
487487
"report_type": "Layout:panel",
488488
"tags": "",
489-
"item_filter": "A|i_type|eq|image;A|i_name|cont|_pathline;",
489+
"item_filter": "",
490490
"params": {
491491
"properties": {
492492
"TOCItem": "1",
@@ -507,7 +507,7 @@
507507
"name": "PathlineTabs",
508508
"report_type": "Layout:tabs",
509509
"tags": "",
510-
"item_filter": "A|i_type|eq|image;A|i_name|cont|_pathline;",
510+
"item_filter": "",
511511
"params": {
512512
"properties": {
513513
"TOCItem": "0",
@@ -637,7 +637,7 @@
637637
"name": "Scenes",
638638
"report_type": "Layout:panel",
639639
"tags": "",
640-
"item_filter": "A|i_type|eq|image;A|i_name|cont|_scene;",
640+
"item_filter": "",
641641
"params": {
642642
"properties": {
643643
"TOCItem": "1",
@@ -658,7 +658,7 @@
658658
"name": "SceneTabs",
659659
"report_type": "Layout:tabs",
660660
"tags": "",
661-
"item_filter": "A|i_type|eq|image;A|i_name|cont|_scene;",
661+
"item_filter": "",
662662
"params": {
663663
"properties": {
664664
"TOCItem": "0",

‎default_templates/comparison_report.md‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Comparison report
2+
3+
Template for a report aggregating and comparing multiple simulations in the context of a parametric study. The user would be running multiple analysis of similar models / physics, and use this report template to visualize, compare and further analyze the results from all these design points into a single report.
4+
5+
## Structure of the report
6+
7+
The generated report will have the following structure:
8+
9+
```text
10+
Report
11+
├── Logo
12+
├── Title
13+
├── Header
14+
├── Table of Content
15+
├── Design Points Table
16+
├── Base Case Simulation Setup
17+
│ ├── Physics
18+
│ | ├── Models
19+
│ | ├── Material Properties
20+
│ | ├── Cell Zones Conditions
21+
│ | ├── Boundary Conditions
22+
│ | ├── Reference Values
23+
│ ├── Solver Settings
24+
├── Parametrics Plots
25+
│ ├── ParametricPlotTabs
26+
├── Mesh
27+
│ ├── Mesh slider
28+
│ ├── Mesh comparison
29+
├── Contours
30+
│ ├── Contours slider
31+
│ ├── Contours comparison
32+
├── Pathlines
33+
│ ├── Pathlines slider
34+
│ ├── Pathlines comparison
35+
├── XY Plots
36+
│ ├── Static Pressure
37+
├── Scenes
38+
│ ├── Scenes slider
39+
│ ├── Scenes comparison
40+
```
41+
42+
Note that the slide and comparison leafs (such as the Mesh slider and Mesh comparison) will display the same data in two different tabs, but in the slider case the images are collapsed into a single slider view, while in the comparison tab they are available side-by-side for quick comparison. The differences are set in the template properties.
43+
44+
Note that the "XY Plots" will do a merge of all tables coming from all design points to display the values all in a single plot for easier comparison between simulation results.
45+
46+
You can add or modify the structure of the report by adding / removing / modifying the corresponding report templates.
47+
48+
## Filters
49+
50+
Each report section is populated with items from the database that pass the aggregated filters. You can modify these filters to fit your database.
51+
52+
The report is written assuming that all data is tagged with a 'Design Point=DPX' tag that marks which design point each item refers to. Please adjust the filters accordingly if this isn't the case in you database.
53+
54+
At the top level, there is a filter for item tags containing the string 'Design Point' and 'ReportType=Parametric'.
55+
56+
The following tree displays the filter for each report leaf. This template mainly uses item names, types and tags to place them in the correct section.
57+
58+
```text
59+
Report -> Items with 'Design Point' and 'ReportType=Parametric' in the tag
60+
├── Logo -> Image itam with name "AnsysLogo" or "UserLogo"
61+
├── Title -> HTML item with name "ReportTitle"
62+
├── Header -> Table item with name "HeaderTableItem"
63+
├── Table of Content -> NO ITEMS HERE. Table of Content is automatically generated
64+
├── Design Points Table -> Table item with name "ParameterDesignPointsTable"
65+
├── Base Case Simulation Setup
66+
│ ├── Physics
67+
│ | ├── Models -> Table item with name "ModelsTableItem" and tags with "'Design Point'='Base DP'"
68+
│ | ├── Material Properties -> Tree item with name "MaterialsTreeItem" and tags with "'Design Point'='Base DP'"
69+
│ | ├── Cell Zones Conditions -> Tree item with name "CellZonesTreeItem" and tags with "'Design Point'='Base DP'"
70+
│ | ├── Boundary Conditions -> Tree item with name "BoundaryZonesTreeItem" and tags with "'Design Point'='Base DP'"
71+
│ | ├── Reference Values -> Tree item with name "ReferenceValuesTableItem" and tags with "'Design Point'='Base DP'"
72+
│ ├── Solver Settings -> Tree item with name "SolverSettingsTreeItem" and tags with "'Design Point'='Base DP'"
73+
├── Parametrics Plots
74+
│ ├── ParametricPlotTabs -> Table item with name that contains '_parametric_plot'
75+
├── Mesh
76+
│ ├── Mesh slider -> Image items with "_mesh" in the name
77+
│ ├── Mesh comparison -> Image items with "_mesh" in the name
78+
├── Contours
79+
│ ├── Contours slider -> Image items with "_contour" in the name
80+
│ ├── Contours comparison -> Image items with "_contour" in the name
81+
├── Pathlines
82+
│ ├── Pathlines slider -> Image items with "_pathline" in the name
83+
│ ├── Pathlines comparison -> Image items with "_pathline" in the name
84+
├── XY Plots -> Table items with "_xyplot" in the name
85+
│ ├── Static Pressure -> Items with "top-wall_xyplot" in the name
86+
├── Scenes
87+
│ ├── Scenes slider -> Image items with "_scene" in the name
88+
│ ├── Scenes comparison -> Image items with "_scene" in the name
89+
```

‎default_templates/generic_fea.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ Report
3737
│ ├── Summary
3838
│ ├── Recommendations
3939
├── Appendices
40-
│ ├── Appendix-A
41-
│ ├── Appendix-B
40+
├── Appendix-A
41+
├── Appendix-B
4242
```
4343

4444
You can add or modify the structure of the report by adding / removing / modifying the corresponding report templates.
@@ -82,8 +82,8 @@ Report -> item tag contains "projectA"
8282
│ ├── Summary -> item tags contain "session=summary"
8383
│ ├── Recommendations -> item tags contain "session=recommendations"
8484
├── Appendices -> item name contain "chapter=appendices"
85-
│ ├── Appendix-A -> item tags contain "session=appendixA"
86-
│ ├── Appendix-B -> item tags contain "session=appendixB"
85+
├── Appendix-A -> item tags contain "session=appendixA"
86+
├── Appendix-B -> item tags contain "session=appendixB"
8787
```
8888

8989

‎default_templates/pptx_export.json‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"Template_0": {
3-
"name": "Test_ppt",
3+
"name": "PPTX Export Report",
44
"report_type": "Layout:pptx",
55
"tags": "",
66
"item_filter": "",
@@ -101,7 +101,7 @@
101101
"name": "Geometry and Mesh_template_ppt",
102102
"report_type": "Layout:pptxslide",
103103
"tags": "",
104-
"item_filter": "A|i_type|eq|table;",
104+
"item_filter": "",
105105
"params": {
106106
"properties": {
107107
"source_slide": 5,
@@ -173,7 +173,7 @@
173173
"name": "Simulation Setup_template_ppt",
174174
"report_type": "Layout:pptxslide",
175175
"tags": "",
176-
"item_filter": "A|i_type|eq|table;",
176+
"item_filter": "",
177177
"params": {
178178
"properties": {
179179
"source_slide": 9,
@@ -193,7 +193,7 @@
193193
"name": "Physics_template_ppt",
194194
"report_type": "Layout:pptxslide",
195195
"tags": "",
196-
"item_filter": "A|i_type|eq|table;",
196+
"item_filter": "",
197197
"params": {
198198
"properties": {
199199
"source_slide": 10,
@@ -386,7 +386,7 @@
386386
"name": "Plots_template_ppt",
387387
"report_type": "Layout:pptxslide",
388388
"tags": "",
389-
"item_filter": "A|i_type|eq|table;A|i_name|cont|_plot;",
389+
"item_filter": "",
390390
"params": {
391391
"properties": {
392392
"source_slide": 21,
@@ -424,7 +424,7 @@
424424
"name": "Report Plots_template_ppt",
425425
"report_type": "Layout:pptxslide",
426426
"tags": "",
427-
"item_filter": "A|i_type|eq|table;A|i_name|cont|_plot;",
427+
"item_filter": "",
428428
"params": {
429429
"properties": {
430430
"source_slide": 23,
@@ -443,7 +443,7 @@
443443
"name": "Report Plots_child_template_ppt",
444444
"report_type": "Layout:pptxslide",
445445
"tags": "",
446-
"item_filter": "A|i_name|cont|_plot;",
446+
"item_filter": "A|i_type|eq|table;A|i_name|cont|_plot;",
447447
"params": {
448448
"properties": {
449449
"source_slide": 24,
@@ -461,7 +461,7 @@
461461
"name": "Mesh_template_ppt",
462462
"report_type": "Layout:pptxslide",
463463
"tags": "",
464-
"item_filter": "A|i_type|eq|image;A|i_name|cont|_mesh;",
464+
"item_filter": "",
465465
"params": {
466466
"properties": {
467467
"source_slide": 25,
@@ -480,7 +480,7 @@
480480
"name": "Mesh_child_template_ppt",
481481
"report_type": "Layout:pptxslide",
482482
"tags": "",
483-
"item_filter": "A|i_name|cont|_mesh;",
483+
"item_filter": "A|i_type|eq|image;A|i_name|cont|_mesh;",
484484
"params": {
485485
"properties": {
486486
"source_slide": 26,
@@ -497,7 +497,7 @@
497497
"name": "Pathlines_template_ppt",
498498
"report_type": "Layout:pptxslide",
499499
"tags": "",
500-
"item_filter": "A|i_type|eq|image;A|i_name|cont|_pathline;",
500+
"item_filter": "",
501501
"params": {
502502
"properties": {
503503
"source_slide": 31,
@@ -516,7 +516,7 @@
516516
"name": "Pathlines_child_template_ppt",
517517
"report_type": "Layout:pptxslide",
518518
"tags": "",
519-
"item_filter": "A|i_name|cont|_pathline;",
519+
"item_filter": "A|i_type|eq|image;A|i_name|cont|_pathline;",
520520
"params": {
521521
"properties": {
522522
"source_slide": 32,
@@ -533,7 +533,7 @@
533533
"name": "Contours_template_ppt",
534534
"report_type": "Layout:pptxslide",
535535
"tags": "",
536-
"item_filter": "A|i_type|eq|image;A|i_name|cont|_contour;",
536+
"item_filter": "",
537537
"params": {
538538
"properties": {
539539
"source_slide": 27,
@@ -552,7 +552,7 @@
552552
"name": "Contours_child_template_ppt",
553553
"report_type": "Layout:pptxslide",
554554
"tags": "",
555-
"item_filter": "A|i_name|cont|_contour;",
555+
"item_filter": "A|i_type|eq|image;A|i_name|cont|_contour;",
556556
"params": {
557557
"properties": {
558558
"source_slide": 28,

0 commit comments

Comments
 (0)