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

Rename VTKFile to VTKGridFile #1014

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Rename VTKFile to VTKGridFile #1014

wants to merge 3 commits into from

Conversation

KnutAM
Copy link
Member

@KnutAM KnutAM commented Jul 3, 2024

xref #1004

Does not solve #1004, but as pointed out by @termi-official, it is clear that having Ferrite.VTKFile (concrete type, wrapper of WriteVTK.DatasetFile) being something different than WriteVTK.VTKFile (abstract supertype of most WriteVTK filetypes) can be very confusing.

@KnutAM KnutAM added this to the v1.0.0 milestone Jul 3, 2024
Copy link

codecov bot commented Jul 3, 2024

Codecov Report

Attention: Patch coverage is 88.23529% with 2 lines in your changes missing coverage. Please review.

Project coverage is 93.17%. Comparing base (2c8b751) to head (ccfc1b5).

Files Patch % Lines
src/deprecations.jl 0.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1014      +/-   ##
==========================================
- Coverage   93.20%   93.17%   -0.04%     
==========================================
  Files          38       38              
  Lines        5816     5818       +2     
==========================================
  Hits         5421     5421              
- Misses        395      397       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -427,8 +427,8 @@ more discussion).
omitting type piracy, ([#835][github-835]) implemented `isequal` and `hash` for `BoundaryIndex` datatypes.

- **VTK export**: Ferrite no longer extends methods from `WriteVTK.jl`, instead the new types
`VTKFile` and `VTKFileCollection` should be used instead. New methods exists for writing to
a `VTKFile`, e.g. `write_solution`, `write_cell_data`, `write_node_data`, and `write_projection`.
`VTKGridFile` and `VTKFileCollection` should be used instead. New methods exists for writing to
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`VTKGridFile` and `VTKFileCollection` should be used instead. New methods exists for writing to
`VTKGridFile` and `VTKCollectionFile` should be used instead. New methods exists for writing to

for symmetry?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See suggestion to remove completely here: #1015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants