Updating the Wiki-pages for FEM equations, solvers, BCs
Moderator: bernd
Forum rules
and Helpful information for the FEM forum
and Helpful information for the FEM forum
-
- Posts: 991
- Joined: Wed Mar 27, 2019 10:45 am
Re: Updating the Wiki-pages for FEM equations, solvers, BCs
I have started filling in the pages for FEM MaterialFluid and FEM ConstraintInitialFlowVelocity.
Since these are my first entries in a wiki ever, I'm reluctant to remove the tags on the pages. Is someone curating that or should I do it if I feel i've done a good job?
Since these are my first entries in a wiki ever, I'm reluctant to remove the tags on the pages. Is someone curating that or should I do it if I feel i've done a good job?
Re: Updating the Wiki-pages for FEM equations, solvers, BCs
I am just learning, but find quite a few WiKi pages hard to follow. Some are outdated, some are out stepped.
-
- Posts: 991
- Joined: Wed Mar 27, 2019 10:45 am
Re: Updating the Wiki-pages for FEM equations, solvers, BCs
Hello gents,
I have taken the liberty of filling in the following wiki pages that were until now empty. These are my first wiki entries, so I may have made mistakes specifically with the indexing flags.
If you have comments don't hesitate. If you want to butcher them, don't hesitate.
https://wiki.freecadweb.org/FEM_MaterialFluid
https://wiki.freecadweb.org/FEM_Constra ... owVelocity
https://wiki.freecadweb.org/FEM_ConstraintFlowVelocity
https://wiki.freecadweb.org/FEM_SolverElmer
I intend to move forward more or less with anything Elmer related.
@bernd i still can't really touch https://wiki.freecadweb.org/FEM_ConstraintFluidBoundary because I don't really understand what it is currently doing. Despite you trying to explain to me earlier. I feel like it is currently obsolete but I cannot be sure. Please bring enlightenment upon me.
Cheers,
J.
I have taken the liberty of filling in the following wiki pages that were until now empty. These are my first wiki entries, so I may have made mistakes specifically with the indexing flags.
If you have comments don't hesitate. If you want to butcher them, don't hesitate.
https://wiki.freecadweb.org/FEM_MaterialFluid
https://wiki.freecadweb.org/FEM_Constra ... owVelocity
https://wiki.freecadweb.org/FEM_ConstraintFlowVelocity
https://wiki.freecadweb.org/FEM_SolverElmer
I intend to move forward more or less with anything Elmer related.
@bernd i still can't really touch https://wiki.freecadweb.org/FEM_ConstraintFluidBoundary because I don't really understand what it is currently doing. Despite you trying to explain to me earlier. I feel like it is currently obsolete but I cannot be sure. Please bring enlightenment upon me.
Cheers,
J.
Re: Updating the Wiki-pages for FEM equations, solvers, BCs
They are fine. Ugly documentation is better than no documentation. The pages can be improved over time.RatonLaveur wrote: ↑Wed May 27, 2020 10:57 pm I have taken the liberty of filling in the following wiki pages that were until now empty. These are my first wiki entries, so I may have made mistakes specifically with the indexing flags. ...
One suggestion, we normally distinguish between KEYs and Buttons that you press. KEYs you press on the keyboard, and Buttons you press on the graphical interface, including the toolbars.
So I'd change this
Code: Select all
{{KEY|[[Image:FEM_MaterialFluid.png|32px]] FluidMaterial}}
Code: Select all
{{Button|[[Image:FEM_MaterialFluid.svg|16px]] [[FEM MaterialFluid|Material fluid]]}}
And the text inside the button should be a link to the corresponding command, so that the reader can go to that documentation page as well. Of course, this doesn't apply to simple buttons like {{Button|OK}}.
Always add the important information to your posts if you need help. Also see Tutorials and Video tutorials.
To support the documentation effort, and code development, your donation is appreciated: liberapay.com/FreeCAD.
To support the documentation effort, and code development, your donation is appreciated: liberapay.com/FreeCAD.
-
- Posts: 991
- Joined: Wed Mar 27, 2019 10:45 am
Re: Updating the Wiki-pages for FEM equations, solvers, BCs
Thanks that's very good feedback!
I'll make then purrty over time, i just wanted to get the ball rolling.
I'll make then purrty over time, i just wanted to get the ball rolling.
-
- Posts: 991
- Joined: Wed Mar 27, 2019 10:45 am
Re: Updating the Wiki-pages for FEM equations, solvers, BCs
I updated the Wiki pages for the pages in question with your kind propositions. Ugly...maybe (gee thanks ) but I like to think they are useful.vocx wrote: ↑Thu May 28, 2020 2:59 am
They are fine. Ugly documentation is better than no documentation. The pages can be improved over time.
One suggestion, we normally distinguish between KEYs and Buttons that you press. KEYs you press on the keyboard, and Buttons you press on the graphical interface, including the toolbars.
I now need to continue my Elmer quest by going into the different cases and equations and creating the page for them.
bernd I'm sorry to ping you so willy nilly, but I still have a lot of trouble with https://wiki.freecadweb.org/FEM_ConstraintFluidBoundary
I have yet to find a use case for this, and it is right in the middle of the other "more functional" (according to my limited understanding) functions. Thus I feel like it distracts quite a lot.
Re: Updating the Wiki-pages for FEM equations, solvers, BCs
Don't know if @Bernd react soon see: https://forum.freecadweb.org/viewtopic. ... 10#p406891
Re: Updating the Wiki-pages for FEM equations, solvers, BCs
A tip when editing wiki pages:
When referencing dropdown menu commands use
instead of
When referencing dropdown menu commands use
Code: Select all
{{MenuCommand|Edit → Preferences → FEM → Elmer}}
Code: Select all
'''Edit''' → '''Preferences''' → '''FEM''' → '''Elmer'''
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
-
- Posts: 991
- Joined: Wed Mar 27, 2019 10:45 am
Re: Updating the Wiki-pages for FEM equations, solvers, BCs
Fantastic! Super happy for him. Hope you enjoy your vacations bernd! And thanks for the heads up JeeBee.Jee-Bee wrote: ↑Wed Jun 10, 2020 3:55 pm Don't know if @Bernd react soon see: https://forum.freecadweb.org/viewtopic. ... 10#p406891
Yessss! Here i go polish my little uglies...i had copied existing pages. So at least thanks to you Kunda, maybe my pages will have some of the Good Wikiing Practice displayed.Kunda1 wrote: ↑Wed Jun 10, 2020 4:11 pm A tip when editing wiki pages:
When referencing dropdown menu commands useinstead ofCode: Select all
{{MenuCommand|Edit → Preferences → FEM → Elmer}}
Code: Select all
'''Edit''' → '''Preferences''' → '''FEM''' → '''Elmer'''
Re: Updating the Wiki-pages for FEM equations, solvers, BCs
RatonLaveur wrote: ↑Wed Jun 10, 2020 2:29 pmhttps://github.com/FreeCAD/FreeCAD/comm ... undary.cpp implemented by Qing Feng xia. I do not know if it is implemented in any solver?vocx wrote: ↑Thu May 28, 2020 2:59 ambernd I'm sorry to ping you so willy nilly, but I still have a lot of trouble with https://wiki.freecadweb.org/FEM_ConstraintFluidBoundary
I have yet to find a use case for this, and it is right in the middle of the other "more functional" (according to my limited understanding) functions. Thus I feel like it distracts quite a lot.