Skip to content

Commit

Permalink
Merge pull request #28284 from GregVernon/update-coreform-cubit-docs
Browse files Browse the repository at this point in the history
Update coreform cubit docs
  • Loading branch information
GiudGiud authored Aug 3, 2024
2 parents 59c6c91 + 5bc5399 commit 44c21b0
Show file tree
Hide file tree
Showing 14 changed files with 22 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Two methods can be used by this mesh generator to achieve the mesh cutting: the

The two methods have their own Cons and Pros, respectively, and are complementary to each other. The `CUT_ELEM_TRI` method keeps all the subdomain interfaces and even preserves the volume of the subdomains. However, it may lead to some small elements near the cutting line. On the other hand, the `MOV_NODE` method does not produce too fine elements but may deform the subdomain interfaces, hence not preserving relative subdomain volumes. Therefore, if only one subdomain is involved in the cutting, or all the cut subdomain interfaces are symmetric over the cutting line, the `MOV_NODE` method is preferred. On the other hand, if complex subdomain interfaces are involved in the cutting, the `CUT_ELEM_TRI` method is preferred.

The id of the new external boundary produced by the trimming can be assigned using [!param](/Mesh/XYMeshLineCutter/new_boundary_id). As either method creates TRI3 elements if there are QUAD4 elements crossed by the cutting line, and as EXODUS II format does not allow TRI3 and QUAD4 elements sharing the same subdomain id and name. The newly formed TRI3 subdomains' ids and names can be customized using [!param](/Mesh/XYMeshLineCutter/tri_elem_subdomain_name_suffix) and [!param](/Mesh/XYMeshLineCutter/tri_elem_subdomain_shift).
The id of the new external boundary produced by the trimming can be assigned using [!param](/Mesh/XYMeshLineCutter/new_boundary_id). As either method creates TRI3 elements if there are QUAD4 elements crossed by the cutting line, and as Exodus format does not allow TRI3 and QUAD4 elements sharing the same subdomain id and name. The newly formed TRI3 subdomains' ids and names can be customized using [!param](/Mesh/XYMeshLineCutter/tri_elem_subdomain_name_suffix) and [!param](/Mesh/XYMeshLineCutter/tri_elem_subdomain_shift).

## Example Syntax

Expand Down
2 changes: 1 addition & 1 deletion framework/src/outputs/Exodus.C
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Exodus::validParams()
params.set<unsigned int>("padding") = 3;

// Add description for the Exodus class
params.addClassDescription("Object for output data in the Exodus II format");
params.addClassDescription("Object for output data in the Exodus format");

// Flag for overwriting at each timestep
params.addParam<bool>("overwrite",
Expand Down
2 changes: 1 addition & 1 deletion framework/src/utils/PetscDMMoose.C
Original file line number Diff line number Diff line change
Expand Up @@ -1677,7 +1677,7 @@ DMSetUp_Moose_Pre(DM dm)
std::string bname = mesh.subdomain_name(bid);
if (!bname.length())
{
// Block names are currently implemented for Exodus II meshes
// Block names are currently implemented for Exodus meshes
// only, so we might have to make up our own block names and
// maintain our own mapping of block ids to names.
std::ostringstream ss;
Expand Down
6 changes: 4 additions & 2 deletions modules/doc/content/application_usage/mesh_block_type.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
## Creating a Mesh

- For complicated geometries, we generally use CUBIT from Sandia National Laboratories.
- CUBIT can be licensed from CSimSoft for a fee depending on the type of organization you work for.
- Cubit® is available for US government use only and requires proof of a current US government contract.
- If your work is not US government use, you can use [Coreform Cubit](https://coreform.com/coreform-cubit/), the commercial version of Cubit®, available through [Coreform](https://coreform.com/), which is available for purchase for any use, including academic and commercial.
- Coreform also provides a free non-commercial-use "[Coreform Cubit Learn](https://coreform.com/coreform-cubit-learn/)" license, fully-functional with a 50k element export limit.
- Other mesh generators can work as long as they output a file format that libMesh reads (next section).
- If you have a specific mesh format you like, we can take a look at adding support for it to libMesh.

Expand All @@ -15,7 +17,7 @@
| Extension | Description |
| :- | :- |
| .dat | [Tecplot ASCII file](https://people.sc.fsu.edu/~jburkardt/data/tec/tec.html) |
| .e, .exd | [Sandia's ExodusII format](https://nalu.readthedocs.io/en/latest/source/user/nalu_run/nalu_mesh.html) |
| .e, .exd | [Sandia's ExodusII format](https://sandialabs.github.io/seacas-docs/sphinx/html/index.html#exodus-library) |
| .fro | [ACDL's surface triangulation file](https://www.reviversoft.com/file-extensions/fro) |
| .gmv | [LANL's GMV (General Mesh Viewer) format](www.generalmeshviewer.com/) |
| .mat | [Matlab triangular ASCII file](https://www.reviversoft.com/file-extensions/mat) (read only) |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,9 @@ default solving method Preconditioned Jacobian Free Newton Krylov.

### Outputs

Here two types of outputs are enabled: output to the screen (console) and output to an Exodus II
Here two types of outputs are enabled: output to the screen (console) and output to an Exodus
file (exodus). Setting the "file_base" parameter is optional, in this example it forces the
output file to be named "out.e" ("e" is the extension used for the Exodus II format).
output file to be named "out.e" ("e" is the extension used for the Exodus format).

!listing examples/ex01_inputfile/ex01.i block=Outputs

Expand All @@ -105,7 +105,7 @@ make -j8
```

This will generate the results file, out.e, as shown in [example-1-results]. This file may be viewed using
Peacock or an external application that supports the Exodus II format (e.g., Paraview).
Peacock or an external application that supports the Exodus format (e.g., Paraview).


!media large_media/examples/ex01_results.png
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ make -j8
```

This will generate the results file, out.e, as shown in Figure 2. This file may be viewed using
Peacock or an external application that supports the Exodus II format (e.g., Paraview).
Peacock or an external application that supports the Exodus format (e.g., Paraview).

<br>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ make -j8
```

This will generate the results file, out.e, as shown in Figure 1 and 2. This file may be viewed
using Peacock or an external application that supports the Exodus II format (e.g., Paraview).
using Peacock or an external application that supports the Exodus format (e.g., Paraview).

!media large_media/examples/ex03_out_diffused.png
caption=Figure 1: example 3 Results, "diffused variable"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ make -j8
./ex20-opt -i ex20.i
```

This will generate the results file, ex2_out.e, as shown in Figure 1 and 2. This file may be viewed using Peacock or an external application that supports the Exodus II format (e.g., Paraview).
This will generate the results file, ex2_out.e, as shown in Figure 1 and 2. This file may be viewed using Peacock or an external application that supports the Exodus format (e.g., Paraview).

!media large_media/examples/ex20_out_4.png
caption=Figure 1 : Example 20 results after four time steps
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The [Reactor Module](modules/reactor/index.md) contains mesh generation objects

For more exotic geometries, [Reactor Module](modules/reactor/index.md) objects may be combined with the powerful [`XYDelaunayGenerator`](XYDelaunayGenerator.md) contained in the Mesh System or with [`FillBetweenPointVectorsTools`](FillBetweenPointVectorsTools.md).

Meshes generated by the [Reactor Module](modules/reactor/index.md) may be created in memory as part of a MOOSE physics application's input, or pre-generated and output as Exodus II files for later use in a physics application.
Meshes generated by the [Reactor Module](modules/reactor/index.md) may be created in memory as part of a MOOSE physics application's input, or pre-generated and output as Exodus files for later use in a physics application.

To cite the [Reactor Module](modules/reactor/index.md), please see the +Reactor+ entry in [citing.md].

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ We create a simple regular orthogonal mesh block using the
They can be chained together and MOOSE provides a multitude of generators to
create and modify meshes. A commonly used MeshGenerator is the
[`FileMeshGenerator`](FileMeshGenerator.md), it is used to load a mesh file
generated by third party software like Cubit of Gmsh (or sometimes even meshes
generated by third party software like Cubit or Gmsh (or sometimes even meshes
generated by MOOSE). MOOSE provides a shorthand for the `FileMeshGenerator`
through the [!param](/Mesh/FileMesh/file) parameter inside `[Mesh]`, e.g.

Expand All @@ -25,7 +25,7 @@ through the [!param](/Mesh/FileMesh/file) parameter inside `[Mesh]`, e.g.
```

MOOSE supports a [variety of mesh file formats](FileMeshGenerator.md); most
commonly used is the Exodus II format.
commonly used is the Exodus format.

### `Variables`

Expand Down Expand Up @@ -94,7 +94,7 @@ timestep of `1`.
### `Outputs`

We use the `exodus = true` shorthand to setup an output object of type `Exodus` to write
an Exodus II mesh and solution file to the disk. You can visualize these outputs using
an Exodus mesh and solution file to the disk. You can visualize these outputs using
[Paraview](https://www.paraview.org).

!listing modules/heat_transfer/tutorials/introduction/therm_step01.i block=Outputs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ through the [!param](/Mesh/FileMesh/file) parameter inside `[Mesh]`, e.g.
```

MOOSE supports a [variety of mesh file formats](FileMeshGenerator.md); most
commonly used is the Exodus II format.
commonly used is the Exodus format.

### SolidMechanics QuasiStatic Physics

Expand Down Expand Up @@ -72,7 +72,7 @@ timestep of `1`.
### `Outputs`

We use the `exodus = true` shorthand to setup an output object of type `Exodus` to write
an Exodus II mesh and solution file to the disk. You can visualize these outputs using
an Exodus mesh and solution file to the disk. You can visualize these outputs using
[Paraview](https://www.paraview.org).

## Questions
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Paraview Basics

Paraview can read a number of different file formats, including the Exodus II
Paraview can read a number of different file formats, including the Exodus
format, which is the primary output format for MOOSE.

## Paraview Workspace
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ See [command line usage](/command_line_usage.md) for more information.
# Output

Output can be in a number of different formats (see [/Outputs/index.md]), but
the most common is the Exodus II format. This can be viewed by a number of
the most common is the Exodus format. This can be viewed by a number of
different applications, including VisIt and Paraview. A basics tutorial for
Paraview can found [here](paraview_basics.md).
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ How it works, in a nutshell

- The [Reactor Module](modules/reactor/index.md) contains mesh generation objects which a user calls from the `[Mesh]` block of a MOOSE input file
- User constructs sequences of mesh generation objects to build custom Cartesian and hexagonal-based pins, assemblies, and cores
- Meshes may be created in memory or pre-generated/output as Exodus II files for later use
- Meshes may be created in memory or pre-generated/output as Exodus files for later use

!---

Expand Down

0 comments on commit 44c21b0

Please sign in to comment.