CharacteristicsOfCanon and SimpleBlockX4

CharacteristicsOfCanon.md

@@ -0,0 +1,32 @@
+# Characteristics of a Canonical Geometry
+
+_Canonical geometries should contain all aspects of the workflow so that
+through the creation of the geometries one encounters all methods and
+considerations necessary to create functional models._
+
+### Basic Models
+
+  * __Simple Model__
+    - Show workflow in a model without complications.
+    - Introduce issues arising from Cubit/Trelis.
+    - Show basic functionality of Cubit/Trelis such as imprinting/merging, assigning materials, and meshing.
+
+  * __Simple Model with Geometric issues__
+    - Go through workflow with a model with geometric complications that are still easy to understand/visualize.
+    - Show basic functionality of SpaceClaim by fixing geometric issues.
+      * Overlaps
+      * Unnecessary details to be removed
+      * Small gaps
+      * Curve coincident to surface
+
+  * __Radial model__
+    - Go through workflow with some applicability, could be a basis to build further complex models
+    - Exemplifies curvilinear CAD issues
+    - Introduces reflecting boundaries
+
+### Auxiliary, Difficult Models (Further design considerations)
+
+* MELCOR geometry (flows that split and recombine)
+* Toroidal geometry with thin walls that may lose particles
+* A radial slice where one encounters boundary conditions
+* Implementation of reflecting boundaries

ComplexAssembly.md

@@ -0,0 +1,134 @@
+# Complex Assembly
+
+#### Procedure Overview
+
+  * A section of FNSF built from .sat file
+  * Void volume (with creation example in both Cubit/Trelis and Solidworks)
+  * Exported as a .h5m file
+
+
+#### Goals of Example
+
+  * Provide a general understanding of what issues could arise on complex models.
+  * Apply the general process to a complex model that has real applicability.
+
+## Procedure
+
+#### In Initial CAD program
+_Any CAD engine should work for this process as long as it can export to a
+format importable by SpaceClaim or Cubit/Trelis. The preferred format is ACIS (.sat)_
+  1. Download the part titled "FullSectionFNSF.sw" from this page and open in Solidworks.
+  2. Export the assembly/part to ACIS format (.sat file extension)
+    * ACIS format 22 is preferred (default for Solidworks)
+    * Use save or export feature and select ACIS (.sat) format
+
+<details><summary> Notes </summary><p>
+- The preferred format is ACIS (.sat). Note that multiple file types could be used, but there is anecdotal evidence that suggests .sat files work the best for this process. Otherwise formats such as STEP and STL are also able to be imported to Trelis/Cubit.
+<br/>
+- This step is unnecessary unless you want to explore the model in Solidworks or learn how to save file as .sat.
+<br/>
+- To skip this step download the ACIS file titled "FullSectionFNSF.sat" and move onto ANSYS SpaceClaim section.
+</p>
+</details>
+
+#### In ANSYS SpaceClaim
+_SpaceClaim is useful for cleaning models that have overlaps, surface conflicts, edge contacts, and small gaps._
+
+  1. Open FullSectionFNSF.sat by clicking file, open, and then sorting by .sat type files.
+  2. Try to identify all basic issues with the model through which particles could be lost during analysis.
+
+  <details><p><summary>Descriptions of Basic Issues </summary>
+  Gaps: when particles encounter gaps they may lose track of which volume they are in and be lost. In this model there is one obvious gap, but for real models gaps are only an issue when the gap is around 10^-6 units (cm). In many cases small gaps can also be fixed by the imprint/merge step in Trelis/Cubit.
+  <br/><br/>
+  Overlaps: when particles encounter overlaps between two volumes they may not be able to determine which volume they are in and be lost.
+  <br/><br/>
+  Edge contacts: there is a possibility that when two volumes are only in contact on a single edge it can cause an issue with surface definitions.
+  <br/><br/>
+  Unnecessary Detail: all details in the CAD model are included in the meshing process and in the final analysis and small details can greatly increase the amount of computation necessary. The physical threads included in this model are one example. This issue is a problem of optimization and depends on the computing power available as well as the level of detail necessary.
+  </p></details>
+
+  <br/>
+
+      * Visually:
+        - Find one possible example of each type of basic issue.
+      * With SpaceClaim tools:
+        - To identify gaps navigate from __Prepare -> Clearance -> Detect__. In this case to find the gap enter a maximum distance of `1cm` in the Find Options box. The gap will be highlighted in red.
+        - To identify interference navigate from  __Prepare -> Interference -> Remove.__ There are technically two volumes of interference and both will be highlighted in red.
+        - The __Imprint__ tool highlights any coincident edges or faces within the part and can make it easier to find edge contacts as well as overlaps. This tool can be found by going __Prepare -> Analysis -> Imprint__.
+        - There are no built-in tools in SpaceClaim to generally identify unnecessary details.
+
+
+  ### In Cubit/Trelis
+  _Cubit and Trelis are basically the same CAD software with Trelis being the commercial version. They are most useful for the meshing of geometries and assigning materials to volumes._
+
+  | Steps  | Graphic User Interface  | In Command Line  |
+  |---|---|---|
+  | __Import the .sat file into Trelis/Cubit__  | - Can be imported using the GUI with __File -> Import__. <br/></br> - Select the file through file explorer and open. <br/></br> - One important qualifier to include is `[attributes_on]`. | - In the command line the simple form of the command is `import acis [filepath]` <br/></br> - This command can be appended with further commands that can be found by typing `help import acis`. <br/></br> - These qualifiers correspond with the options given when importing files through the GUI. <br/></br> - One important qualifier to include is `[attributes_on]`.  |
+  | __How to save progress for the file as ACIS__  | - Click on file, export, and select the file destination and name. <br/></br> - Make sure that it is being exported as ACIS (.sat) and press ok to save.  | - In command line type `export acis [filepath] overwrite`.  |
+  | __Make sure units/distances are correct and if not, fix them__  | - A distance within the model of "X units" should have a metric distance of "X centimeters". <br/></br> - To check this click on a surface/line with a known metric value and then navigate to the properties page and check the surface area or curve length. <br/></br> - On the Command Panel click on __Geometry (leftmost option) -> Volume -> Transform -> Scale (from dropdown menu) -> Enter Scale Factor -> Apply__ | - A distance within the model of "X units" should have a metric distance of "X centimeters". <br/></br> - To check this in the command line the general form is `list [entity name and number] geom`. For example to check the geometry of volume 1 enter `list Volume 1 geom`. <br/></br> - In command line enter `vol all scale [Scale Factor]`. For example parts from solidworks would require `vol all scale 0.1` to convert the units to centimeters. |
+  | __Inspect models and resolve overlapping volumes__ | - On the Command Panel click on __Geometry (leftmost option) -> Volume -> Modify -> Heal (from dropdown menu) -> check Autoheal -> Apply__ <br/></br> - There are many options within the modify dropdown menu, but none are as robust as SpaceClaim|- In command line one can fix overlaps by typing `validate vol all` and then `healer autoheal [problem vols]`. <br/></br> - This should work to detect overlaps, but is not as robust as SpaceClaim. |
+
+  <details><p><summary>Notes</summary>
+  - A more general DAGMC based tutorial for Cubit/Trelis basics can be found at https://svalinn.github.io/DAGMC/usersguide/trelis_basics.html.
+  <br/></br>
+  - "Command Panel" and "Command Line" are necessary for GUI and command line methods respectively. To enable these select View and switch "Command Line" and/or "Command Panel" to visible.
+  <br/></br>
+  - Scale will most likely be off by a factor of 10. For example models from Solidworks will most likely be increased by 10x or 100cm to 1000 units, but this scaling changes based on the initial CAD program. You must scale every entity down or up by that factor to match units to cm.
+  </p></details>
+
+  #### Creation of Void/Vacuum Volume and Graveyard
+
+  _A method (implicit compliment) is implemented automatically during a DAG-MCNP5 run that creates a void volume in all spaces without geometry. This means that while one could explicitly create void volumes, it is often not necessary._
+  <br/></br>
+  _The vacuum and graveyard volumes are not part of the model being analyzed, but play a role in the final analysis. When particles move freely through the vacuum volume and stop once they reach the graveyard volume._
+
+  | Steps  | In Graphic User Interface  | In Command Line  |
+  |---|---|---|
+  | __Create a cube large enough to envelop all other volumes.__  | - Select __Geometry -> Volume -> Create__ and select __Brick__ from the drop down menu. <br/></br> - Type 500 in each dimension box __(width, height, depth)__ and press __Apply__ to create the block.  | - The general form is `create [shape] [dimensions based on shape]`. </br> - For a simple cube 500x500x500 you can enter `create brick x 500`.  |
+  | __Create another slightly larger cube to be used for graveyard.__  | - In command panel create another brick in the same way as part 1, using 750 as the new dimension in each dimension box.  | - Enter `create brick x 750`  |
+  | __Center volumes within the larger cubes.__  | To move the blocks in command panel select __Geometry -> Volume -> Transform__ and select __Move__ from the drop down menu. <br/></br> - Type "5 6" into the __Volume ID(s)__ box. Then __Select Method -> Distance__ and type 100 into the __X Distance__ box. _This distance/direction may vary._  | - General form is `move vol [volume ids] [axis] [distance along axis]` <br/></br> - Enter `move vol 5 6 x 100`.  |
+  | __Hollow out large cubes to match functionality.__  | - Select __Geometry -> Volume -> Boolean__ and select __Subtract__ from the dropdown menu. <br/></br> - Select volume 6 as volume A and volume 5 as volume B. Check __Keep Originals__ and click __Apply__. <br/></br> - You can then delete volume 6 by selecting __Geometry -> Volume -> Delete__ and typing 6 into the __Volume ID(s)__ box and clicking apply. <br/></br> - Select __Geometry -> Volume -> Boolean__ and select __Subtract__ from the dropdown menu. Select volume 5 as volume A and volumes 1,2,3, and 4 as volume B. Again make sure to check __Keep Originals__ and click __Apply__. <br/></br> - Then use the delete action to delete volume 5.  | - Enter `subtract vol 5 from 6 keep` <br/></br> - Enter `delete vol 6` to get rid of the original large box. <br/></br> - Enter `subtract vol 1 2 3 4 from 5 keep` or `subtract vol 1 to 4 from 5 keep`. <br/></br> - Enter `delete vol 5`. |
+
+  <details><p><summary>Notes</summary>
+  - These volumes could also be created in another CAD program and then assigned a material in the exact same way, but this is an example of how to create these volumes in Trelis and Cubit.
+  <br/></br>
+  - Most likely the volumes will be slightly off centered in the x direction, but the larger bricks will be centered with one another. This may vary based on the initial CAD program.
+  <br/></br>
+  - To see the blocks better you can select the wireframe option in the top toolbar. It is directly to the right of the undo arrow on the toolbar. Also you can click on the axis on the bottom left of the volume viewing area to get a straight on (x,y) view.
+  </p></details>
+
+  #### Imprinting and Merging Volumes in Cubit/Trelis
+  _Imprinting and Merging surfaces accelerates the DAGMC process by combining surfaces._
+
+  1. Imprint and Merge all shared surfaces in the model.
+    * In command panel select __Geometry -> Volume -> Imprint Merge__ and select __Imprint and Merge__ from the dropdown menu. Then type "all" into the __Volume ID(s)__ box and click __Apply__.
+    * In command line type `imprint volume all` and then enter. Then type `merge volume all`.
+    * _Now all surfaces that previously overlapped have been merged into one surface shared by both volumes._
+
+<details><p><summary>Notes</summary>
+- The default tolerated distance for imprinting/merging surfaces is 5.0e-4 units.
+<br/>
+- Combining surfaces cuts two surfaces and two sets of tetrahedron mesh areas down to one, decreasing computational power required as well as eliminating possible errors where particles exist simultaneously in two surfaces.
+</p></details>
+
+#### Assigning Materials in Cubit/Trelis
+_Most commands for this section are best implemented through the command line. More general instructions can
+be found_ [here](http://svalinn.github.io/DAGMC/usersguide/codes/dag-mcnp.html).
+
+  1. The general command for assigning Materials/Densities in Cubit/Trelis
+    `group "mat:[assigned material number]/rho:[assigned density]" add
+    vol [volume numbers]` where the density is in [atoms/barn-cm] for positive values and [g/cc] for negative values.
+  2. The blocks will be given two different materials and then the void and the graveyard volumes will be assigned. These material assignments will depend on the material library you create/use for the project.
+      * To assign one block to the first material use `group "mat:1/rho:0.0223" add vol 1`
+      * To assign the rest of the blocks to the second material use `group "mat:2/rho:0.03" add vol 2 to 4`
+      * To assign the void volume to vacuum use `group "mat:Vacuum" add vol 5`
+      * Finally to assign the graveyard volume use `group "mat:Graveyard" add vol 6`
+
+#### Exporting file to .h5m format
+_This plugin translates the CAD file to something that can be used by DAGMC. Instructions as to how to install this plugin can be found_ [here](https://svalinn.github.io/DAGMC/install/plugin.html).
+
+  1. Once the plugin is correctly installed you should receive the message `Loaded Svalinn plugin`, line break, `DAGMC export command available` in the command line.
+  2. Once all issues are resolved in the model, export the file as .h5m, this command must be executed through the command line.
+      * The general form of the export command is `export dagmc "<filename>" [options]`. To see the options available enter `help export dagmc` into the command line.
+      * The filename should include the filepath after the working directory so that it designates where the file ought to be saved after export.
+      * For this part `export dagmc "Desktop/ErrorBlocks.h5m"` will create the part as a .h5m with default settings in the Desktop.