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

Feature helmholtz dataset #3

Closed
wants to merge 116 commits into from
Closed

Conversation

JakobEliasWagner
Copy link
Owner

@JakobEliasWagner JakobEliasWagner commented Jan 9, 2024

Add Helmholtz Dataset Generation Feature

Summary:

This pull request adds a new feature for generating datasets for sonic crystals using the Helmholtz equation. Additionally, it implements comprehensive methods for evaluating the performance and testing of these simulations.

Details:

1. Dataset Generation:

  • Purpose: The new dataset generation module provides tools to create custom datasets for simulating various configurations of sonic crystals.
  • Implementation:
    • Users can specify parameters like crystal structure, shape, and material properties of the sonic crystal structure.

2. Testing:

  • Purpose: Robust testing to ensure reliability and correctness of the new features.
  • Implementation:
    • Integration of unit tests in tests/ directory.
    • Tests cover a range of scenarios, including edge cases for dataset generation.
    • Tests evaluate the performance of the algorithm and compares them to the results by Elford et al. "Matryoshka locally resonant sonic crystal".

3. Documentation:

  • Comprehensive documentation is added, detailing the usage of the new features, along with examples in the standalone/ directory.

Checks:

  • Code compiles without errors.
    • Input Files can be used to generate descriptions of the domain.
    • The domain can be meshed using descriptions of the domain.
    • The mesh can be used to generate solutions of the domain.
    • Performance metrics are included.
    • Add comprehensive tests.
  • Fix CI/CD pipeline
    • add fenicsx container to pipeline
    • run correct tests in container
  • All new features are covered with unit tests.
  • Tests pass locally and on CI server.
  • Performance metrics meet the expected thresholds.
  • Documentation is complete and understandable.

@JakobEliasWagner JakobEliasWagner deleted the feature-helmholtz-dataset branch February 19, 2024 16:41
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.

1 participant