CharacteristicsOfCanon and SimpleBlockX4 #2
Conversation
Tutorial for simple 4x cubes. These steps show the user the correct formats to use and how to do simple operations in Trelis to prepare the volumes for analysis.
| ### In ANSYS SpaceClaim | ||
| _SpaceClaim is useful for cleaning models that have small gaps, overlaps, edge contacts, and unnecessary geometric detail. For all of these edits one must work closely with the creator of the model/experiment to determine which | ||
| complications are important to the end result and which are able to be changed. More general SpaceClaim tutorials/support can be found_ [here](http://www.spaceclaim.com/en/Support/Tutorials/Essentials.aspx). | ||
| 1. Open ErrorBlocks.sat by clicking file, open, and then sorting by .sat type files. |
There was a problem hiding this comment.
| 1. Open ErrorBlocks.sat by clicking file, open, and then sorting by .sat type files. | |
| 1. Open `ErrorBlocks.sat` by clicking file, open, and then sorting by .sat type files. |
There was a problem hiding this comment.
I only reviewed SimpleBlockx4. I have a lot of suggestions here for wording and some questions (sprinkled throughout), many of which I believe will also be applicable to the other tutorial as well but I didn't give that one a thorough review.
One major note is that where you talk about "void" or "vacuum" volumes, you actually should be referring to the implicit complement. I make a comment on SimpleBlockX4.md as to why this is. I didn't mark every location that this is listed incorrect, so be sure to look for all those locations.
The instructions are also written as a list of bullets, but really these should probably listed as numerical steps. Some bullets are clear steps while others a just notes/information about what is happening. I would suggest identifying which are actual steps and clearly labeling/numbering them and then wrapping up the notes about each step into those labeled steps (if that makes sense?). Right now it just appears to be every new sentence is a new bullet.
I think these instructions could also benefit from a lot of pictures to show what the geometry should look like at various steps when you are adding/removing volumes as well as pictures of buttons that appear in the GUI.
| #### Description of Final Product | ||
|
|
||
| * Four cubes/bricks created in any general CAD software | ||
| * Explicitly created void volume and graveyard volume example in Cubit/Trelis. |
There was a problem hiding this comment.
Is this the "implicit complement" rather than "void"?
| ### 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. Create four solid bricks/cubes with edges of length 100cm that are separated by 50 cm |
There was a problem hiding this comment.
is the idea that the surfaces of the cubes should be coincident? Perhaps a picture of the intended output would help.
| ### In ANSYS SpaceClaim | ||
| _SpaceClaim is useful for cleaning models that have overlaps, surface conflicts, | ||
| edge contacts, and small gaps. These are further explained in the error blocks example._ | ||
| 1. Since the model intrinsically has no conflicts or errors there are no |
There was a problem hiding this comment.
Probably doesn't need numbered since there is only one item.
| * Introduce the workflow with an assembly that does not have any geometric issues. | ||
| * Work through important processes on an example that is easy to visualize and understand. | ||
|
|
||
| ## Procedure Overview |
There was a problem hiding this comment.
Is the idea of this "procedure" that the user would go through all the sections ("initial cad program", "spaceclaim", and "cubit/trelis"? Or are they supposed to just go to the one section for the tool they are using?
|
|
||
| 1. Import the .sat file into Trelis/Cubit | ||
| * Can be imported using the GUI with __File -> Import__. Select the file through file explorer and open. There are further options to select from. For descriptions of these options you can click on the question box on the bottom left, but they will not affect the outcome of this particular import. | ||
| * In the command line the simple form of the command is `import acis [filepath]` This command can be appended with further commands that can be found in __Help -> Geometry -> Importing -> Importing ACIS files__. These qualifiers correspond with the options given when importing files through the GUI. One important qualifier to include is `[attributes_on]`. |
There was a problem hiding this comment.
| * In the command line the simple form of the command is `import acis [filepath]` This command can be appended with further commands that can be found in __Help -> Geometry -> Importing -> Importing ACIS files__. These qualifiers correspond with the options given when importing files through the GUI. One important qualifier to include is `[attributes_on]`. | |
| * In the command line the simple form of the command is `import acis [filepath]`. This command can be appended with further commands that can be found in __Help -> Geometry -> Importing -> Importing ACIS files__. These qualifiers correspond with the options given when importing files through the GUI. One important qualifier to include is `[attributes_on]`. |
There was a problem hiding this comment.
Isn't there also a command line version to getting help that doesn't require the GUI?
| * Note that one could select smaller subsets of volumes and mesh each at different levels of coarseness. This may be useful if some volumes require more/less precision than others. | ||
| 2. Mesh files with tetmesh | ||
| * In the command panel directly to the right of the "Intervals" action select the "Mesh" action. Type `all` into the box under "Select Volumes" or click the box and hold the control key while selecting all of the cubes. Then select "Tetmesh" from the dropdown menu under "Select Meshing Scheme" and click mesh. | ||
| * To mesh through command line you must set the mesh scheme to Tetmesh and then mesh separately. To set the scheme to Tetmesh type "`volume all scheme tetmesh` then after that command is complete simply type "mesh volume all" and the cubes will be successfully meshed with Tetmesh. |
| * In the command panel directly to the right of the "Intervals" action select the "Mesh" action. Type `all` into the box under "Select Volumes" or click the box and hold the control key while selecting all of the cubes. Then select "Tetmesh" from the dropdown menu under "Select Meshing Scheme" and click mesh. | ||
| * To mesh through command line you must set the mesh scheme to Tetmesh and then mesh separately. To set the scheme to Tetmesh type "`volume all scheme tetmesh` then after that command is complete simply type "mesh volume all" and the cubes will be successfully meshed with Tetmesh. | ||
| * You may want to explore how the options for this action affect the final mesh, but default settings are fine for our purposes. Now all surfaces are described by triangular meshes that will be used during analysis. | ||
| 3. Follow the steps laid out in the link listed in this description. |
| * 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` |
There was a problem hiding this comment.
make sure the " and ` are in the correct locations
| #### Exporting file to .h5m format | ||
| _This plugin translates the CAD file to something that can be analyzed 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. |
There was a problem hiding this comment.
installation has to occur before you can open trelis/cubit. the way this is written would make it seem like I can install the plugin while working in trelis and then use it. One has to reopen trelis to be able to use it. So either a section on making sure the plugin is installed should be moved first in the trelis portion of the tutorial. Or note here that if the plugin is not installed, the file should be saved, exited, and reopened.
| 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/SimpleBlockX4.h5m"` will create the part as a .h5m with default settings in the Desktop. |
There was a problem hiding this comment.
| * For this part `export dagmc "Desktop/SimpleBlockX4.h5m"` will create the part as a .h5m with default settings in the Desktop. | |
| * For this part `export dagmc "~/Desktop/SimpleBlockX4.h5m"` will create the part as a .h5m with default settings in the Desktop. |
Add markdown files for Complex and ErrorBlocks2 documentation
|
There are some outstanding comments in this PR that should be addressed/discussed before merge. |
There was a problem hiding this comment.
I just reviewed the ErrorBlocks.md file only. Let me know when you want more review on the other sections. Most of my comments are just regarding the ordering of some sections and some clarification questions.
Let me know if you want to discuss some more in person about the implicit complement. I think there are a few points of clarification that can be made still.
I really like the structure of having tables in the ErrorBlocks file. That makes it easy to read/digest as a new user.
| #### Goals of Example | ||
|
|
||
| * Execute the workflow with a model that has geometric issues to be resolved in SpaceClaim. | ||
| * Work through important processes on an example that is easy to visualize and understand. | ||
| * Provide a general understanding of what issues could arise on more complex models. |
There was a problem hiding this comment.
It would probably make sense to put this before the procedure overview
| #### Goals of Example | ||
|
|
||
| * Execute the workflow with a model that has geometric issues to be resolved in SpaceClaim. | ||
| * Work through important processes on an example that is easy to visualize and understand. |
There was a problem hiding this comment.
What is the "important process" - do you mean "import" or "imprint"? Or by "important" do you mean the standard and basic necessary processes?
| _Any CAD engine should work for this process as long as it can export to a format importable by SpaceClaim or Cubit/Trelis._ | ||
|
|
||
|
|
||
| 1. Download the part titled "ErrorBlocks.sw" from this page and open in Solidworks. |
There was a problem hiding this comment.
"ErrorBlocks.sw" link to a file rather than stating it's on this page (can be hard for people to find otherwise).
| _Any CAD engine should work for this process as long as it can export to a format importable by SpaceClaim or Cubit/Trelis._ | ||
|
|
||
|
|
||
| 1. Download the part titled "ErrorBlocks.sw" from this page and open in Solidworks. |
There was a problem hiding this comment.
| 1. Download the part titled "ErrorBlocks.sw" from this page and open in Solidworks. | |
| 1. Download the part titled `ErrorBlocks.sw` from this page and open in Solidworks. | |
| <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. |
There was a problem hiding this comment.
Does "This step" refer to the whole section labeled "In Initial CAD Program" or just step 1 or step 2? Be more specific.
| 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 |
There was a problem hiding this comment.
| `group "mat:[assigned material number]/rho:[assigned density]" add | |
| `group "mat:[assigned material number or name]/rho:[assigned density]" add | |
I think whether it is a number or name is code dependent or dependent on how your materials are being handled?
| 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. |
There was a problem hiding this comment.
| 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. | |
| 2. The blocks will each be assigned a different material and then the implicit complement and the graveyard volumes will be assigned. These material assignments will depend on the material library you create/use for the project. | |
| 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` |
There was a problem hiding this comment.
volume 5 was deleted above? Also, I think you mean "implicit complement" here, not the void volume. See my note at the beginning of this section about how to assign materials to the implicit complement.
| * 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). |
There was a problem hiding this comment.
Note, plugin has to be installed prior to opening and doing all this stuff in cubit/trelis. If someone gets through all the imprint/merge steps and finds they need to install the plugin, they will have to exit and re-open. This section on installing the plugin may be better to have as a first step before they even open the program.
There was a problem hiding this comment.
(At least I think this is true, but maybe @gonuke can confirm/deny that behavior)
| #### 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. |
There was a problem hiding this comment.
I don't think you need to specify the line break
Original description did not accurately describe use of Trelis
|
I noticed a recent commit in this PR - are you planning to close this PR after splitting it in two or more? Or taking some files out of this PR and leaving this one smaller (as a mechanism of splitting it into more PRs)? |
Adding two preliminary files "CharacteristicsOfCanon.md" and "SimpleBlockX4.md". The former is the layout for the project while the latter is an example of the format the tutorials will use/are using and guides the user through the basic workflow with meshing in Trelis/Cubit.