forked from BlueQuartzSoftware/simplnx
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
FILTERS: Adding MeshIO reader and writers. (BlueQuartzSoftware#1009)
Signed-off-by: Joey Kleingers <[email protected]>
- Loading branch information
1 parent
cd44742
commit e575c49
Showing
19 changed files
with
1,392 additions
and
7 deletions.
There are no files selected for viewing
This file contains 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
39 changes: 39 additions & 0 deletions
39
wrapping/python/plugins/NXDataAnalysisToolkit/docs/ReadMeshFileFilter.md
This file contains 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,39 @@ | ||
# MeshIO: Read Mesh File | ||
|
||
## Group (Subgroup) | ||
Core (IO/Read) | ||
|
||
## Description | ||
The `ReadMeshFile` filter uses the Python MeshIO library to read a mesh file into a simplnx geometry. | ||
|
||
The following mesh formats are supported by this filter: | ||
+ Abaqus (.inp) | ||
+ Ansys (.msh) | ||
+ Gmsh (.msh) | ||
+ Med (.med) | ||
+ TetGen (.node/.ele) | ||
+ VTK (.vtu) | ||
|
||
*NOTE*: This filter makes the assumption (for cell and point data stored inside the mesh file) that the first element in the numpy shape list is the only tuple dimension, and every other shape list element is part of the component dimensions! | ||
|
||
## Parameters | ||
|
||
### Input Parameters | ||
- **`Input File`** (str): The path to the input mesh file. | ||
|
||
### Created Parameters | ||
- **`Created Geometry`** (nx.DataPath): The path to the geometry that will be created. | ||
- **`Vertex Attribute Matrix Name`** (str): The name of the vertex attribute matrix that will be created inside the geometry. | ||
- **`Cell Attribute Matrix Name`** (str): The name of the cell attribute matrix that will be created inside the geometry. | ||
- **`Vertex Array Name`** (str): The name of the vertex array that will be created inside the geometry. | ||
- **`Cell Array Name`** (str): The name of the cell array that will be created inside the geometry. | ||
|
||
## Example Pipelines | ||
|
||
## License & Copyright | ||
|
||
Please see the description file distributed with this **Plugin** | ||
|
||
## DREAM3D-NX Help | ||
|
||
If you need help, need to file a bug report or want to request a new feature, please head over to the [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) GItHub site where the community of DREAM3D-NX users can help answer your questions. |
27 changes: 27 additions & 0 deletions
27
wrapping/python/plugins/NXDataAnalysisToolkit/docs/WriteAbaqusFileFilter.md
This file contains 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,27 @@ | ||
# MeshIO: Write Abaqus File | ||
|
||
## Group (Subgroup) | ||
Core (IO/Read) | ||
|
||
## Description | ||
The `WriteAbaqusFile` filter uses the Python MeshIO library to write a simplnx geometry to an Abaqus .inp file. | ||
|
||
*Note*: This filter does not support writing cell data or point data to the mesh file. | ||
|
||
## Parameters | ||
|
||
### Input Parameters | ||
- **`Input Geometry`** (nx.DataPath): Specifies the complete path to the input geometry. | ||
|
||
### Output Parameters | ||
- **`Output File`** (str): The path to the output .inp file. | ||
|
||
## Example Pipelines | ||
|
||
## License & Copyright | ||
|
||
Please see the description file distributed with this **Plugin** | ||
|
||
## DREAM3D-NX Help | ||
|
||
If you need help, need to file a bug report or want to request a new feature, please head over to the [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) GItHub site where the community of DREAM3D-NX users can help answer your questions. |
27 changes: 27 additions & 0 deletions
27
wrapping/python/plugins/NXDataAnalysisToolkit/docs/WriteAnsysFileFilter.md
This file contains 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,27 @@ | ||
# MeshIO: Write Ansys File | ||
|
||
## Group (Subgroup) | ||
Core (IO/Read) | ||
|
||
## Description | ||
The `WriteAnsysFile` filter uses the Python MeshIO library to write a simplnx geometry to an Ansys .msh file. | ||
|
||
*Note*: This filter does not support writing cell data or point data to the mesh file. | ||
|
||
## Parameters | ||
|
||
### Input Parameters | ||
- **`Input Geometry`** (nx.DataPath): Specifies the complete path to the input geometry. | ||
|
||
### Output Parameters | ||
- **`Output File`** (str): The path to the output .msh file. | ||
|
||
## Example Pipelines | ||
|
||
## License & Copyright | ||
|
||
Please see the description file distributed with this **Plugin** | ||
|
||
## DREAM3D-NX Help | ||
|
||
If you need help, need to file a bug report or want to request a new feature, please head over to the [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) GItHub site where the community of DREAM3D-NX users can help answer your questions. |
27 changes: 27 additions & 0 deletions
27
wrapping/python/plugins/NXDataAnalysisToolkit/docs/WriteGmshFileFilter.md
This file contains 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,27 @@ | ||
# MeshIO: Write Gmsh File | ||
|
||
## Group (Subgroup) | ||
Core (IO/Read) | ||
|
||
## Description | ||
The `WriteGmshFile` filter uses the Python MeshIO library to write a simplnx geometry to a Gmsh .msh file. | ||
|
||
## Parameters | ||
|
||
### Input Parameters | ||
- **`Input Geometry`** (nx.DataPath): Specifies the complete path to the input geometry. | ||
- **`Cell Data Arrays To Write`** (List[nx.DataPath]): List of DataPaths to the cell data arrays to include in the output mesh file. | ||
- **`Point Data Arrays To Write`** (List[nx.DataPath]): List of DataPaths to the point data arrays to include in the output mesh file. | ||
|
||
### Output Parameters | ||
- **`Output File`** (str): The path to the output .msh file. | ||
|
||
## Example Pipelines | ||
|
||
## License & Copyright | ||
|
||
Please see the description file distributed with this **Plugin** | ||
|
||
## DREAM3D-NX Help | ||
|
||
If you need help, need to file a bug report or want to request a new feature, please head over to the [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) GItHub site where the community of DREAM3D-NX users can help answer your questions. |
27 changes: 27 additions & 0 deletions
27
wrapping/python/plugins/NXDataAnalysisToolkit/docs/WriteMedFileFilter.md
This file contains 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,27 @@ | ||
# MeshIO: Write Med File | ||
|
||
## Group (Subgroup) | ||
Core (IO/Read) | ||
|
||
## Description | ||
The `WriteMedFile` filter uses the Python MeshIO library to write a simplnx geometry to a Med .med file. | ||
|
||
## Parameters | ||
|
||
### Input Parameters | ||
- **`Input Geometry`** (nx.DataPath): Specifies the complete path to the input geometry. | ||
- **`Cell Data Arrays To Write`** (List[nx.DataPath]): List of DataPaths to the cell data arrays to include in the output mesh file. | ||
- **`Point Data Arrays To Write`** (List[nx.DataPath]): List of DataPaths to the point data arrays to include in the output mesh file. | ||
|
||
### Output Parameters | ||
- **`Output File`** (str): The path to the output .med file. | ||
|
||
## Example Pipelines | ||
|
||
## License & Copyright | ||
|
||
Please see the description file distributed with this **Plugin** | ||
|
||
## DREAM3D-NX Help | ||
|
||
If you need help, need to file a bug report or want to request a new feature, please head over to the [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) GItHub site where the community of DREAM3D-NX users can help answer your questions. |
29 changes: 29 additions & 0 deletions
29
wrapping/python/plugins/NXDataAnalysisToolkit/docs/WriteTetGenFileFilter.md
This file contains 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,29 @@ | ||
# MeshIO: Write TetGen File | ||
|
||
## Group (Subgroup) | ||
Core (IO/Read) | ||
|
||
## Description | ||
The `WriteTetGenFile` filter uses the Python MeshIO library to write a simplnx tetrahedral geometry to TetGen .node and .ele files. | ||
|
||
*Note*: Either .node or .ele can be chosen as the output file; the one that is not chosen will also be automatically created. | ||
|
||
## Parameters | ||
|
||
### Input Parameters | ||
- **`Input Geometry`** (nx.DataPath): Specifies the complete path to the input geometry. | ||
- **`Cell Data Arrays To Write`** (List[nx.DataPath]): List of DataPaths to the cell data arrays to include in the output mesh file. | ||
- **`Point Data Arrays To Write`** (List[nx.DataPath]): List of DataPaths to the point data arrays to include in the output mesh file. | ||
|
||
### Output Parameters | ||
- **`Output File`** (str): The path to the output .node/.ele file. Regardless of which extension is chosen as the output file, both .node and .ele files will be written to the chosen location with the chosen file name. | ||
|
||
## Example Pipelines | ||
|
||
## License & Copyright | ||
|
||
Please see the description file distributed with this **Plugin** | ||
|
||
## DREAM3D-NX Help | ||
|
||
If you need help, need to file a bug report or want to request a new feature, please head over to the [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) GItHub site where the community of DREAM3D-NX users can help answer your questions. |
30 changes: 30 additions & 0 deletions
30
wrapping/python/plugins/NXDataAnalysisToolkit/docs/WriteVtuFileFilter.md
This file contains 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,30 @@ | ||
# MeshIO: Write Vtu File | ||
|
||
## Group (Subgroup) | ||
Core (IO/Read) | ||
|
||
## Description | ||
The `WriteVtuFile` filter uses the Python MeshIO library to write a simplnx geometry to a VTK .vtu file. | ||
|
||
The output file can also be compressed if the user chooses LZMA or ZLIB as the Output Compression Type. | ||
|
||
## Parameters | ||
|
||
### Input Parameters | ||
- **`Input Geometry`** (nx.DataPath): Specifies the complete path to the input geometry. | ||
- **`Cell Data Arrays To Write`** (List[nx.DataPath]): List of DataPaths to the cell data arrays to include in the output mesh file. | ||
- **`Point Data Arrays To Write`** (List[nx.DataPath]): List of DataPaths to the point data arrays to include in the output mesh file. | ||
|
||
### Output Parameters | ||
- **`Output File`** (str): The path to the output .vtu file. | ||
- **`Output Compression Type`** (int): The compression type to use when writing the output file. The choices are Uncompressed, LZMA, and ZLIB. | ||
|
||
## Example Pipelines | ||
|
||
## License & Copyright | ||
|
||
Please see the description file distributed with this **Plugin** | ||
|
||
## DREAM3D-NX Help | ||
|
||
If you need help, need to file a bug report or want to request a new feature, please head over to the [DREAM3DNX-Issues](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues) GItHub site where the community of DREAM3D-NX users can help answer your questions. |
This file contains 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.