mfem / web Goto Github PK

Leftover from mfem-4.6. Lets complete this soon.

This came up during the MFEM AWS tutorial today.

We also need docs for the new Examples 34 and 35. [done in #232]

These new examples are being added with mfem/mfem#1989.

As part of a recent discussion with @pazner on the mfem slack channel, it sounds like there may be a handful of limitations of periodic meshes in mfem that do not seem to be currently communicated in https://mfem.org/howto/periodic-boundaries/ . Concretely, if the mechanism of enforcing periodicity in mfem is just a 1-to-1 correspondence between nodes on periodic faces then it may not work correctly in general for:

• vector-valued H1 spaces (e.g. rotational symmetry like in the torus example on the web page)
• Hcurl (due to sign / orientation discrepancies, especially with triangular faces of cubic or higher order in 3D)
• Hdiv (due to sign)

I'm hoping to find out more information on the potential limitations above (the signedness problem for Hcurl/Hdiv could likely be resolved easily if not already, but the orientation mismatch might be more involved). Has anyone successfully simulated elasticity or E&M problems with periodic meshes, especially with more interesting symmetries than just translation?

Also, the webpage does not indicate if the discretization is expected to be conforming along the periodic boundaries (I'm guessing this is a requirement, given the discussion above). If so, does this impose restrictions on mesh refinement (adaptive, uniform)?

• Document GradientIntegrator in https://mfem.org/bilininteg/

Showing the Doxygen documentation inside a frame is great, but currently the bottom of the page is cut off, see e.g. the bottom of the main page

which should look like this:

Can we adjust dox.md to show the full page?

• Mention ParaView support in src/features.md
• Update example 5 and 9 descriptions in src/examples.md to match the mfem code
• Any additional updates for the high-order support?

The auto differentiation miniapp (added by mfem/mfem#2383) needs website documentation.

At the workshop someone asked how to do this a small example of setting up a composite error estimator would be a useful HowTo article.

After merging mfem/mfem#1392

See for example 6f1be7b.

See for example 6f1be7b.

libROM webpage ( www.librom.net ) uses MFEM webpage template.

Add documentation for the Remhos miniapp, similar to the one for Laghos?

See mfem/mfem#822 (review)

Update https://mfem.org/mesh-formats and/or add a HowTo article on the mesh formats we support.

See mfem/mfem#2450 (comment)

The documentation for VectorFEBoundaryTangentLFIntegrator in https://mfem.org/lininteg/ states that it supports 2D and 3D domains but this is not correct. The integrator itself contains an MFEM_VERIFY restricting its use to 2D elements on the boundary of a 3D domain.

Note: this was noticed as part of issue mfem/mfem#4114

Add a page listing MFEM-based projects, applications and tools.

Include a picture, short paragraph and links, see for example https://computing.llnl.gov/projects/sundials/uses-sundials and https://ceed.exascaleproject.org/gslib/.

Apps/projects/tools to consider:

• BLAST
• LiDO
• Serac
• Cardioid
• libROM
• VisIt
• RF-SciDAC
• PECOS
• FASTMath
• xSDK
• CEED
• OpenParEM
• Rodin
• MVox
• Mathias Davids: 1, 2, 3, 4
• Simmetrix
• OpenSim
• Coreform
• Relogic

There have been several recent preprints (with arxiv versions) that will be good to mention on the publication page:

• "Uniform Subspace Correction Preconditioners for Discontinuous Galerkin Methods with hp-Refinemenet"
• "hr−adaptivity for nonconforming high-order meshes with the target matrix optimization paradigm"
• ...

See mfem/mfem#1127 (review)

I recently set up a new laptop, then cloned my fork of this repo and started following the README instructions: https://github.com/mfem/web/blob/master/README.md. Specifically these commands:

1. pip install --upgrade --user mkdocs==1.0.4
2. pip install --upgrade --user Markdown==2.6.8
3. pip install --upgrade --user PyYAML==3.13
4. pip install --upgrade --user futures==3.3.0

Questions and/or suggested changes:

• I didn't need to run the fourth command in order to get mkdocs serve or mkdocs build to work. I still haven't run it. Is futures necessary? If so, why?
• Both the specified mkdocs and markdown versions are old. Other repos I work on use mkdocs 1.1 and markdown 3.3.4. When switching to this one and back, I had to up/downgrade until I got tired of it and installed mkdocs 1.1 and markdown 3.3.4 here to see if they would work. The site seems to build fine locally with these newer versions (including the dynamic /examples dropdowns), so perhaps the first two commands could be updated. Or must the respective versions 1.0.4 and 2.6.8 be enforced? If so, why?

(I don't know why these issues didn't come up on my old laptop, where I had been contributing to this repo since 2019. Maybe these are my problems and not the repo's problems! If you want the README updated according to anything in this issue, I'd be happy to do it.)

Following the merge of mfem/mfem#1047, we should probably update the documentation for the templated HPC code, https://mfem.org/tperformance, to mention the intrinsics. (That documentation can actually be updated more substantially)

Do we want to mention the support for SLEPc at https://mfem.org/features/ and https://mfem.org/examples/ ?

See mfem/mfem#2757

See for example 6f1be7b.

At the workshop we received a request for a HowTo article on setting up and using restart capabilities with the DataCollection object.

Document miniapps from mfem/mfem#1462

• See https://github.com/mfem/web/blob/master/README.md and update if something is missing
• Add also to src/meshing.md and maybe src/features.md

Can we add brief instructions for GPU builds on our https://mfem.org/building/ page?

Maybe add it to the Interpolation Miniapps section in https://github.com/mfem/web/blob/master/src/examples.md?

Consider also mentioning in https://github.com/mfem/web/blob/master/src/features.md.

Document the work in mfem/mfem#2040

From mfem/mfem#2824 (comment):

the doxygen comment for GetElementTransformation(int) and other similar methods can be be improved to clarify that the returned pointer points to an internal objects which is invalidated by other calls to the same method (with a different index) or by calls to some other methods.

Should we document the various Coefficient classes in https://mfem.org/fem/?

Similar to the updated https://glvis.org/

Similar to Navier

After the merge of mfem/mfem#1233, update the description of ex9 in https://mfem.org/examples/ to also include implicit integrators.

See e.g. the Navier miniapp documentation in src/examples.md

cc: @chakshinglee

Document the new integrators from mfem/mfem#1460 in https://mfem.org/lininteg/.

The web page "GPU support in MFEM" should be updated with the new mfem::forall

Pages that are not in the top-level menu (either primary or secondary dropdown) can lose a little context without navigational cues.

Example: Documentation > HowTo Articles > Parallel Element Numbering. To get back to the HowTo list (i.e., the parent of this page), I would have to know to go back to the top nav and select Documentation > HowTo Articles. I can't get back to the parent directly, and it's not active in the nav dropdown.

Breadcrumbs could be one solution. The bootstrap CSS files have a breadcrumbs style already defined. Another idea is to insert a "Back to HowTo Articles" link (or similar) on these pages, though contributors would have to remember to do that manually if it's not built in. Alternatively, I wonder if the right-side nav within a page (where the page's headings are listed) could be modified to include a link back to the parent page.

I don't have enough practice with mkdocs sites to know the correct logic. My initial attempts to modify content.html failed: capture breadcrumb from page title, link it to page URL, loop through a URL by its slashes to see if it has parents, add those to the breadcrumb string, etc.

(Side note: This site has many pages where the parent is Home and/or where they are only navigable from a link on another page. For instance, I got to https://mfem.org/mesh-format-v1.0/ via Documentation > Mesh Formats > MFEM's mesh formats page. For something like that, a breadcrumb to Home isn't helpful. Or I could ask, why isn't that page under Mesh Formats in the directory? Same with Documentation > Getting Started > Parallel Tutorial. But I like having things in directories and have zero insight into site analytics. Perhaps users aren't as confused as I think they might be. In any case, in the near term, I think the biggest user impact would be to focus on the non-Doxygen pages under Documentation. At minimum the HowTo pages.)

No rush, but probably be good to document this in examples.md as well as on its own page?

• Update /workshop/ with
  • Presenters' slides
  • Links to presentation videos (YouTube) @hauten
  • Link to contest winners on /gallery/
• Update /gallery/ with contest submissions, noting which are the winners
• Update /news/ with link to forthcoming computing.llnl.gov article @hauten

From mfem/mfem#2550:

Mixing together several discretizations, i.e. H1 and L2, requires either implementation of the two versions of LinearFormIntegrator::AssembleRHSElementVect, or a single version with FaceElementTransformations. The documentation does not provide any guidance how the different versions are used in the code. The method with FaceElementTransformations is more general and can be used with H1 and L2 fields.

See mfem/mfem#2688 (comment)