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

Support for custom interpolation procedure using FindPointsGSLIB. #4270

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

Conversation

kmittal2
Copy link
Member

@kmittal2 kmittal2 commented Apr 25, 2024

PR Author Editor Reviewers Assignment Approval Merge
#4270 @kmittal2 @tzanio @vladotomov + @SchmidtMat 5/11/24 ⌛due 5/25/24 ⌛due 6/1/24
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 ready-for-review and removed WIP Work in Progress labels May 10, 2024
@kmittal2 kmittal2 changed the title [WIP] Support for custom interpolation procedure using FindPointsGSLIB. Support for custom interpolation procedure using FindPointsGSLIB. May 10, 2024
@tzanio
Copy link
Member

tzanio commented May 11, 2024

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.

* For custom interpolation (e.g., evaluating strain rate tensor), we provide
* functions that use gslib to send element index and corresponding
* reference-space coordinates for each point to the mpi rank that the element
* is located on. Then, interpolation can be done locally by the user before
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
* is located on. Then, interpolation can be done locally by the user before
* is located on. Then, custom interpolation can be defined locally by the user before

virtual void SendElementsAndCoordinatesToOwningMPIRanks();
/// Send interpolated values back to the mpi-ranks #recv_proc that had sent
/// the element indices and corresponding reference-space coordinates.
virtual Vector SendInterpolatedValuesBack(Vector &int_vals, int vdim,
Copy link
Member

Choose a reason for hiding this comment

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

Comment how the int_vals should be structured. And shouldn't it be const?

Copy link
Member

Choose a reason for hiding this comment

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

Both Send... functions send and receive at the same time, maybe Distribute... is a better name.

virtual const Array<unsigned int> &GetReceivedElem() const
{ return recv_elem; }
/// Get reference coords received due to SendCoordinatesToOwningMPIRanks().
virtual const Vector &GetReceivedReferencePosition() const
Copy link
Member

@vladotomov vladotomov Jun 1, 2024

Choose a reason for hiding this comment

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

Comment how the returned Vector is arranged.

we need a mechanism to first send element indices and reference-space
coordinates to the mpi-ranks where each point is found. Then the custom
interpolation can be done locally by the user before sending the
interpolated values back to the mpi-ranks that the query originated from.
Copy link
Member

Choose a reason for hiding this comment

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

It would help to describe briefly the usual calling sequence:

FindPoints(...)
SendElementsAndCoordinatesToOwningMPIRanks()
Get...
Get...
...some computation...
SendInterpolatedValuesBack()

/// Upon receiving, the information is stored locally in
/// #recv_elem and #recv_ref (ordered by vdim). Use corresponding getters
/// \ref GetReceivedElem and \ref GetReceivedReferencePosition.
virtual void SendElementsAndCoordinatesToOwningMPIRanks();
Copy link
Member

@vladotomov vladotomov Jun 1, 2024

Choose a reason for hiding this comment

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

In this case the received values are stored as internal vectors and access through const getters. The other function returns a non-const Vector. Not sure why it's different, might be good to unify the setup of the received vectors (I'd do them all as temporary if you don't need to store them internally).

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.

None yet

4 participants