Skip to content

AD for TMOP_WorstCaseUntangleOptimizer_Metric #4836

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

AD for TMOP_WorstCaseUntangleOptimizer_Metric #4836

wants to merge 10 commits into from

Conversation

kmittal2
Copy link
Member

@kmittal2 kmittal2 commented Apr 29, 2025 •
edited by tzanio
Loading

Adds AD for TMOP_WorstCaseUntangleOptimizer_Metric. virtual functions cannot be templated so this requires some boilerplate code. Currently only mu_4, mu_14, and mu_66 are supported.

PR Author Editor Reviewers Assignment Approval Merge
#4836 @kmittal2 @tzanio @bslazarov + @vladotomov + @SchmidtMat 4/30/25 ⌛due 5/14/25 ⌛due 5/21/25
PR Checklist
  • Code builds.
  • Code passes make style.
  • Update CHANGELOG:
    • Is this a new feature users need to be aware of? New or updated example or miniapp?
    • Does it make sense to create a new section in the CHANGELOG to group with other related features?
  • Update INSTALL:
    • Had a new optional library been added? If so, what range of versions of this library are required? (Make sure the external library is compatible with our BSD license, e.g. it is not licensed under GPL!)
    • Have the version ranges for any required or optional libraries changed?
    • Does make or cmake have a new target?
    • Did the requirements or the installation process change? (rare)
  • Update continuous integration server configurations if necessary (e.g. with new version requirements for each of MFEM's dependencies)
    • .github
    • .appveyor.yml
  • Update .gitignore:
    • Check if make distclean; git status shows any files that were generated from the source by the project (not an IDE) but we don't want to track in the repository.
    • Add new patterns (just for the new files above) and re-run the above test.
  • New examples:
    • All sample runs at the top of the example source file work.
    • Update examples/makefile:
      • Add the example code to the appropriate SEQ_EXAMPLES and PAR_EXAMPLES variables.
      • Add any files generated by it to the clean target.
      • Add the example binary and any files generated by it to the top-level .gitignore file.
    • Update examples/CMakeLists.txt:
      • Add the example code to the ALL_EXE_SRCS variable.
      • Make sure THIS_TEST_OPTIONS is set correctly for the new example.
    • List the new example in doc/CodeDocumentation.dox.
    • If new examples directory (e.g.examples/pumi), list it in doc/CodeDocumentation.conf.in
    • Companion pull request for documentation in mfem/web repo:
      • Update or add example-specific documentation, see e.g. the src/examples.md.
      • Add the description, labels and screenshots in src/examples.md and src/img.
      • In examples.md, list the example under the appropriate categories, add new categories if necessary.
      • Add a short description of the example in the "Extensive Examples" section of features.md.
  • New miniapps:
    • All sample runs at the top of the miniapp source file work.
    • Update top-level makefile and makefile in corresponding miniapp directory.
    • Add the miniapp binary and any files generated by it to the top-level .gitignore file.
    • Update CMake build system:
      • Update the CMakeLists.txt file in the miniapps directory, if the new miniapp is in a new directory.
      • Add/update the CMakeLists.txt file in the new miniapp directory.
      • Consider adding a new test for the new miniapp.
    • List the new miniapp in doc/CodeDocumentation.dox
    • If new miniapps directory (e.g.miniapps/nurbs), add it to MINIAPP_SUBDIRS in the makefile.
    • If new miniapps directory (e.g.miniapps/nurbs), list it in doc/CodeDocumentation.conf.in
    • Companion pull request for documentation in mfem/web repo:
      • Update or add miniapp-specific documentation, see e.g. the src/meshing.md and src/electromagnetics.md files.
      • Add the description, labels and screenshots in src/examples.md and src/img.
      • The miniapps go at the end of the page, and are usually listed only under a specific "Application (PDE)" category.
      • Add a short description of the miniapp in the "Extensive Examples" section of features.md.
  • New capability:
    • All new public, protected, and private classes, methods, data members, and functions have full Doxygen-style documentation in source comments. Documentation should include descriptions of member data, function arguments and return values, template parameters, and prerequisites for calling new functions.
    • Pointer arguments and return values must specify whether ownership is being transferred or lent with the call.
    • Any new functions should include descriptions of their intended use e.g. for internal use only, user-facing, etc., along with references to example code whenever possible/appropriate.
    • Consider adding new sample runs in existing examples to highlight the new capability.
    • Consider saving cool simulation pictures with the new capability in the Confluence gallery (LLNL only) or submitting them, via pull request, to the gallery section of the mfem/web repo.
    • If this is a major new feature, consider mentioning it in the short summary inside README (rare).
    • List major new classes in doc/CodeDocumentation.dox (rare).
  • Update this checklist, if the new pull request affects it.
  • Run make unittest to make sure all unit tests pass.
  • Run the tests in tests/scripts.
  • (LLNL only) After merging:
    • Update internal tests to include the new features.

@kmittal2 kmittal2 added WIP Work in Progress TMOP labels Apr 29, 2025
@kmittal2 kmittal2 changed the title [WIP] AD for TMOP_WorstCaseUntangleOptimizer_Metric AD for TMOP_WorstCaseUntangleOptimizer_Metric Apr 29, 2025
@kmittal2 kmittal2 added ready-for-review and removed WIP Work in Progress labels Apr 29, 2025
@tzanio tzanio requested a review from Copilot April 30, 2025 15:53
@tzanio
Copy link
Member

tzanio commented Apr 30, 2025

This PR is now under review (see the table in the PR description). To help with the review process, please do not force push to the branch.

@github-project-automation github-project-automation bot moved this to Review Now in Pull Requests Apr 30, 2025
@tzanio tzanio added this to the mfem-4.9 milestone Apr 30, 2025
Copilot
Copilot AI reviewed Apr 30, 2025
View reviewed changes
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds automatic differentiation (AD) support for the TMOP_WorstCaseUntangleOptimizer_Metric by introducing new AD hook functions and updating several metric classes to support AD-based computations. Key changes include:

  • Addition of AD hook virtual functions (EvalW_AD1, EvalW_AD2) in the base TMOP_QualityMetric class and their overrides in derived classes.
  • Implementation of AD-based functions (including helper templates and specializations) in fem/tmop.cpp ensuring support for metrics mu_4, mu_14, and mu_66.
  • Minor comment updates in miniapps/meshing to reflect consistent command line usage.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
miniapps/meshing/pmesh-optimizer.cpp Updated comment to match consistent command line arguments.
miniapps/meshing/mesh-optimizer.cpp Updated comment to match consistent command line arguments.
fem/tmop.hpp Added AD hook functions and type definitions for automatic differentiation.
fem/tmop.cpp Implemented AD-based metric functions and helper templates/specializations.
Comments suppressed due to low confidence (1)

fem/tmop.cpp:220

  • Consider adding parentheses around the subtraction in the conditional expression (i.e., use (alpha*min_detT - detT_ep) < 0.0) to improve clarity.
auto val1 = alpha*min_detT-detT_ep < 0.0 ? (alpha*min_detT-detT_ep)*one : zero;

@kmittal2 @Copilot
Update fem/tmop.cpp
076ad69 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

@bslazarov bslazarov Awaiting requested review from bslazarov

@SchmidtMat SchmidtMat Awaiting requested review from SchmidtMat

@vladotomov vladotomov Awaiting requested review from vladotomov

At least 1 approving review is required to merge this pull request.

Assignees

@tzanio tzanio

@vladotomov vladotomov

@bslazarov bslazarov

@SchmidtMat SchmidtMat

Labels
in-review new baseline TMOP
Projects
Pull Requests
Status: Review Now
Milestone
mfem-4.9
Development

Successfully merging this pull request may close these issues.
5 participants
@kmittal2 @tzanio @vladotomov @bslazarov @SchmidtMat