Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add 3D orthogonal structure mesh type for mesh generators. #1091

Merged
merged 3 commits into from
Jul 22, 2021

Conversation

RyanWollaeger
Copy link
Contributor

@RyanWollaeger RyanWollaeger commented Jul 21, 2021

Background

  • The X3D parser supports parsing 3D meshes, but there is no generator for X3D files of 3D meshes in Draco.
  • x3d_generator supports 3D file output, so what is needed is a 3D mesh type in mesh_types.py

Purpose of Pull Request

  • Add a simple orthogonal structured mesh type, to generate corresponding unstructured data.

Description of changes

  • Add orth_3d_mesh class to mesh_types.py.
  • Add orth_3d_mesh as an option to x3d_generator.py.
  • Test 1-cell result of orth_3d_mesh in X3D parser unit test.

Status

@codecov
Copy link

codecov bot commented Jul 21, 2021

Codecov Report

Merging #1091 (171b589) into develop (bccfce4) will increase coverage by 0.0%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           develop   #1091   +/-   ##
=======================================
  Coverage     88.7%   88.7%           
=======================================
  Files          374     374           
  Lines        18591   18592    +1     
=======================================
+ Hits         16495   16496    +1     
  Misses        2096    2096           

@RyanWollaeger
Copy link
Contributor Author

Sorry - forgot to run flake8 on this before submitting - will do so shortly.

+ Add orth_3d_mesh class to mesh_types.py.
+ Add orth_3d_mesh as an option to x3d_generator.py.
+ Test 1-cell result of orth_3d_mesh in X3D parser unit test.
@RyanWollaeger
Copy link
Contributor Author

I should probably add a comment on how to use the x3d_generator script, e.g.:

To create X3D files for a 4x4x4 3D orthogonal structured mesh on domain (x,y,z) in [0,1]x[0,2]x[0,4]:

$ ./x3d_generator.py --mesh_type orth_3d_mesh --num_per_dim 4 4 4 --bnd_per_dim 0 1 0 2 0 4

@KineticTheory
Copy link
Collaborator

I should probably add a comment on how to use the x3d_generator script, e.g.:

To create X3D files for a 4x4x4 3D orthogonal structured mesh on domain (x,y,z) in [0,1]x[0,2]x[0,4]:

$ ./x3d_generator.py --mesh_type orth_3d_mesh --num_per_dim 4 4 4 --bnd_per_dim 0 1 0 2 0 4

Can you add this to a README.md file in the python subdirectory?

@RyanWollaeger
Copy link
Contributor Author

I should probably add a comment on how to use the x3d_generator script, e.g.:

To create X3D files for a 4x4x4 3D orthogonal structured mesh on domain (x,y,z) in [0,1]x[0,2]x[0,4]:

$ ./x3d_generator.py --mesh_type orth_3d_mesh --num_per_dim 4 4 4 --bnd_per_dim 0 1 0 2 0 4

Can you add this to a README.md file in the python subdirectory?

Good idea - will do!

@KineticTheory
Copy link
Collaborator

The markup linter flagged a couple issues with the README.md. Those should be easy to fix.

@RyanWollaeger
Copy link
Contributor Author

The markup linter flagged a couple issues with the README.md. Those should be easy to fix.

Thanks @KineticTheory - just tried to fix these.

@RyanWollaeger
Copy link
Contributor Author

Sorry - I missed one linter error - fixing now.

@KineticTheory
Copy link
Collaborator

If those lint warnings are confusing, here's the scoop: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md

@KineticTheory
Copy link
Collaborator

This might be useful? https://dlaa.me/markdownlint/
I'm not sure if it uses the same rules that we have.

@RyanWollaeger
Copy link
Contributor Author

If those lint warnings are confusing, here's the scoop: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md

This is a useful reference - thank you!

@KineticTheory KineticTheory merged commit 6ba9e00 into lanl:develop Jul 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants