search

idaholab / moose

Multiphysics Object Oriented Simulation Environment
https://www.mooseframework.org
GNU Lesser General Public License v2.1
1.76k stars 1.05k forks source link

Documentation for MultiAppNearestNodeTransfer is suboptimal #18025

Open WilkAndy opened 3 years ago

WilkAndy commented 3 years ago

Reason

The documentation and the class name suggest this Transfer is only for nearest nodes, but it works for elemental (constant monomial) variables too, and perhaps other types too.

Design

More precisely specify what can be transferred with this Transfer, and what it does (eg, is it nearest node, or nearest qp, or something else?). I'm requesting that @aeslaughter do this, because i don't actually know what this Transfer is capable of - the code is rather complicated - so i'm sure i'll muck up the documentation.

Impact

Clarity for users

WilkAndy commented 3 years ago

@fdkong , i think you've got a list of transfer documentation to improve. If so, could you add this issue, please?

fdkong commented 3 years ago

Thanks @WilkAndy I will add this when I am working on other ones.