FEM documentation missing on the Wiki

About the development of the FEM module/workbench.

Moderator: bernd

User avatar
Kunda1
Posts: 9202
Joined: Thu Jan 05, 2017 9:03 pm

FEM documentation missing on the Wiki

Postby Kunda1 » Tue Feb 21, 2017 12:28 pm

In issue #2017 there are several FEM wiki pages listed missing from FC wiki:

FEM Analysis - https://freecadweb.org/wiki/FEM_Analysis (missing 'shortcuts' and 'introduced in')
FEM BeamSection - https://freecadweb.org/wiki/FEM_BeamSection :!:
FEM CalculiX - https://www.freecadweb.org/wiki/FEM_CalculiX (missing several sections + Introoduced in)
FEM ClippingPlaneAdd - https://www.freecadweb.org/wiki/FEM_ClippingPlaneAdd (missing several sections + Introoduced in)
FEM ClippingPlaneRemoveAll - https://www.freecadweb.org/wiki/FEM_Cli ... eRemoveAll (missing several sections + Introoduced in)
FEM Concrete - https://www.freecadweb.org/wiki/FEM_Concrete
FEM ConstraintBearing - https://freecadweb.org/wiki/FEM_ConstraintBearing :arrow_right::arrow_right::red_circle::red_circle:
FEM ConstraintBodyHeatSource - https://www.freecadweb.org/wiki/FEM_Con ... HeatSource (missing several sections + Introoduced in)
FEM ConstraintContact - https://freecadweb.org/wiki/FEM_ConstraintContact (missing several sections + Introoduced in)
FEM ConstraintDisplacement - https://freecadweb.org/wiki/FEM_ConstraintDisplacement (missing several sections + Introoduced in)
FEM ConstraintElectrostaticPotential - https://www.freecadweb.org/wiki/FEM_Con ... cPotential (missing several sections + Introduced in)
FEM ConstraintFixed - https://freecadweb.org/wiki/FEM_ConstraintFixed (missing several sections + Introoduced in)
FEM ConstraintFlowVelocity - https://www.freecadweb.org/wiki/FEM_Con ... owVelocity (missing several sections + Introduced in)
FEM ConstraintFluidBoundary - https://www.freecadweb.org/wiki/FEM_Con ... idBoundary (missing several sections)
FEM ConstraintForce - https://freecadweb.org/wiki/FEM_ConstraintForce :!:
FEM ConstraintGear - https://freecadweb.org/wiki/FEM_ConstraintGear :!:
FEM ConstraintHeatflux - https://freecadweb.org/wiki/FEM_ConstraintHeatflux (missing Limitations + Introduced in)
FEM ConstraintInitialFlowVelocity - https://www.freecadweb.org/wiki/FEM_Con ... owVelocity (missing several sections)
FEM ConstraintInitialTemperature - https://freecadweb.org/wiki/FEM_Constra ... emperature (missing several sections + Introoduced in)
FEM ConstraintPlaneRotation - https://freecadweb.org/wiki/FEM_ConstraintPlaneRotation (missing several sections + Introoduced in)
FEM ConstraintPressure - https://freecadweb.org/wiki/FEM_ConstraintPressure (missing several sections + Introoduced in)
FEM ConstraintPulley - https://freecadweb.org/wiki/FEM_ConstraintPulley :!:
FEM ConstraintSelfWeight - https://freecadweb.org/wiki/FEM_ConstraintSelfWeight (missing several sections + Introoduced in)
FEM ConstraintTemperature - https://freecadweb.org/wiki/FEM_ConstraintTemperature (missing several sections + Introoduced in)
FEM ConstraintTransform - https://freecadweb.org/wiki/FEM_ConstraintTransform (missing several sections)
FEM ControlSolver - https://freecadweb.org/wiki/FEM_ControlSolver :!:
FEM CreateNodesSet - https://freecadweb.org/wiki/FEM_CreateNodesSet :!:
FEM Element_Types - https://www.freecadweb.org/wiki/FEM_Element_Types (missing templates?)
FEM ElementFluid1D - https://www.freecadweb.org/wiki/FEM_ ElementFluid1D
FEM ElementGeometry1D - https://www.freecadweb.org/wiki/FEM_ElementGeometry1D (missing several sections)
FEM ElementGeometry2D - https://www.freecadweb.org/wiki/FEM_ElementGeometry2D (missing Scripting + Introduced in)
FEM ElementRotation1D - https://www.freecadweb.org/wiki/FEM_ElementRotation1D (missing several sections + Introoduced in)
FEM EquationElasticity - https://www.freecadweb.org/wiki/FEM_EquationElasticity (missing several sections + Introoduced in)
FEM EquationElectrostatic - https://www.freecadweb.org/wiki/FEM_Equ ... ctrostatic (missing several sections + Introoduced in)
FEM EquationFlow - https://www.freecadweb.org/wiki/FEM_EquationFlow (missing several sections + Introoduced in)
FEM EquationFluxsolver - https://www.freecadweb.org/wiki/FEM_EquationFluxsolver (missing several sections + Introoduced in)
FEM EquationHeat - https://www.freecadweb.org/wiki/FEM_EquationHeat (missing several sections + Introoduced in)
FEM FemMesh2Mesh - https://freecadweb.org/wiki/FEM_FemMesh2Mesh 8-)
FEM Install - https://www.freecadweb.org/wiki/FEM_Install
FEM MaterialFluid - https://www.freecadweb.org/wiki/FEM_MaterialFluid (missing several sections + Introoduced in)
FEM MaterialMechanicalNonlinear - https://freecadweb.org/wiki/FEM_Materia ... lNonlinear (missing several sections + Introoduced in)
FEM MaterialReinforced - https://www.freecadweb.org/wiki/FEM_MaterialReinforced (missing several sections + Introoduced in)
FEM MaterialSolid - https://www.freecadweb.org/wiki/FEM_MaterialSolid (missing several sections + Introoduced in)
FEM Mesh - https://www.freecadweb.org/wiki/FEM_Mesh
FEM Mesh CalculiX - https://www.freecadweb.org/wiki/FEM_Mesh_CalculiX (missing several sections + Introoduced in)
FEM MeshBoundaryLayer - https://www.freecadweb.org/wiki/FEM_MeshBoundaryLayer
FEM MeshClear - https://www.freecadweb.org/wiki/FEM_MeshClear (missing several sections + Introoduced in)
FEM MeshGmshFromShape - https://www.freecadweb.org/wiki/FEM_MeshGmshFromShape (missing several sections + Introoduced in)
FEM MeshGroup - https://www.freecadweb.org/wiki/FEM_MeshGroup (missing several sections + Introoduced in)
FEM MeshNetgenFromShape - https://www.freecadweb.org/wiki/FEM_MeshNetgenFromShape (missing several sections + Introoduced in)
FEM MeshFromShape - https://freecadweb.org/wiki/FEM_MeshFromShape :!:
FEM MeshPrintInfo - https://www.freecadweb.org/wiki/FEM_MeshPrintInfo (missing several sections + Introoduced in)
FEM MeshRegion - https://www.freecadweb.org/wiki/FEM_MeshRegion (missing several sections + Introoduced in)
FEM Module - https://www.freecadweb.org/wiki/FEM_Module
FEM PostApplyChanges - https://www.freecadweb.org/wiki/FEM_PostApplyChanges (missing several sections + Introoduced in)
FEM PostCreateClipFilter - https://www.freecadweb.org/wiki/FEM_Pos ... ClipFilter (missing several sections + Introoduced in)
FEM PostCreateCutFilter - https://www.freecadweb.org/wiki/FEM_PostCreateCutFilter (missing several sections + Introoduced in)
FEM PostCreateDataAlongLineFilter - https://www.freecadweb.org/wiki/FEM_Pos ... LineFilter (missing several sections + Introoduced in)
FEM PostCreateDataAtPointFilter - https://www.freecadweb.org/wiki/FEM_Pos ... ointFilter (missing several sections + Introoduced in)
FEM PostCreateFunctions - https://www.freecadweb.org/wiki/FEM_PostCreateFunctions (missing several sections + Introoduced in)
FEM PostCreateLinearizedStressesFilter - https://www.freecadweb.org/wiki/FEM_Pos ... ssesFilter (missing several sections + Introoduced in)
FEM PostCreateScalarClipFilter - https://www.freecadweb.org/wiki/FEM_Pos ... ClipFilter (missing several sections + Introoduced in)
FEM PostCreateWarpVectorFilter - https://www.freecadweb.org/wiki/FEM_Pos ... ctorFilter (missing several sections + Introoduced in)
FEM PostPipelineFromResult - https://www.freecadweb.org/wiki/FEM_Pos ... FromResult (missing several sections + Introoduced in)
FEM Preferences - https://www.freecadweb.org/wiki/FEM_Preferences
FEM project - https://www.freecadweb.org/wiki/FEM_project
FEM ResultShow - https://www.freecadweb.org/wiki/FEM_ResultShow (missing several sections + Introoduced in)
FEM ResultsPurge - https://www.freecadweb.org/wiki/FEM_ResultsPurge (missing several sections + Introoduced in)
FEM Solver - https://www.freecadweb.org/wiki/FEM_Solver
FEM SolverCalculiX - https://www.freecadweb.org/wiki/FEM_SolverCalculiX (missing several sections + Introoduced in)
FEM SolverCalculixCxxtools - https://www.freecadweb.org/wiki/FEM_Sol ... ixCxxtools
FEM SolverControl - https://www.freecadweb.org/wiki/FEM_SolverControl (missing several sections + Introoduced in)
FEM SolverElmer - https://www.freecadweb.org/wiki/FEM_SolverElmer (missing several sections + Introoduced in)
FEM SolverRun - https://www.freecadweb.org/wiki/FEM_SolverRun (missing several sections + Introoduced in)
FEM SolverZ88 - https://www.freecadweb.org/wiki/FEM_SolverZ88 (missing several sections + Introoduced in)

Tutorials
FEM tutorial - https://www.freecadweb.org/wiki/FEM_tutorial
FEM Tutorial Python - https://www.freecadweb.org/wiki/FEM_Tutorial_Python
Add FEM Constraint Tutorial - https://www.freecadweb.org/wiki/Add_FEM ... t_Tutorial
Extend FEM Module - https://www.freecadweb.org/wiki/Extend_FEM_Module
FEM Shear of a Composite Block - https://www.freecadweb.org/wiki/FEM_She ... site_Block
FEM CalculiX Cantilever 3D - https://www.freecadweb.org/wiki/FEM_Cal ... tilever_3D
Transient FEM analysis - https://www.freecadweb.org/wiki/Transient_FEM_analysis
Add FEM Equation Tutorial - https://www.freecadweb.org/wiki/Add_FEM ... n_Tutorial

FEM PurgeResults - https://freecadweb.org/wiki/FEM_PurgeResults :!:
FEM RunSolver - https://freecadweb.org/wiki/FEM_RunSolver :!:
FEM ShellThickness - https://freecadweb.org/wiki/FEM_ShellThickness :!:
FEM ResultShow- https://freecadweb.org/wiki/FEM_ResultShow (missing several sections)

Legend
:!: = Doesn't exist
:arrow_right: = page exists
:arrow_right::arrow_right: = page exists + GuiCommand template
:arrow_right::arrow_right::arrow_right: = page exists + GuiCommand Template + DocNav Template
:arrow_right::arrow_right::arrow_right::arrow_right: = page exists + has templates + is categorized + has scripting section
:checkered_flag: = Page complete
:red_circle: = incomplete section

Posting them in this thread as an FYI and an open invitation for anyone to work on them.
Cheers!

Related Forum Threads
Arch Wiki Pages - https://forum.freecadweb.org/viewtopic.php?f=23&t=42500
Draft Wiki Pages - https://forum.freecadweb.org/viewtopic.php?f=23&t=42501
FEM Wiki Pages - https://forum.freecadweb.org/viewtopic.php?f=18&t=20823
Path Wiki Pages - https://forum.freecadweb.org/viewtopic.php?f=15&t=42498
Sketcher Wiki Pages - https://forum.freecadweb.org/viewtopic. ... 2&p=360968
Last edited by Kunda1 on Tue Jan 14, 2020 12:04 am, edited 1 time in total.
Alone you go faster. Together we go farther
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
User avatar
bernd
Posts: 11090
Joined: Sun Sep 08, 2013 8:07 pm
Location: Zürich, Switzerland

Re: FEM documentation missing on the Wiki

Postby bernd » Tue Feb 21, 2017 5:05 pm

Few of them exists allready. Check the links on page FEM_Module For example Fem_ConstraintFixed On the documentation they are all writen exact the way the commands from FreeCAD source code file https://github.com/FreeCAD/FreeCAD/blob ... h.cpp#L139 are used.
User avatar
Kunda1
Posts: 9202
Joined: Thu Jan 05, 2017 9:03 pm

Re: FEM documentation missing on the Wiki

Postby Kunda1 » Tue Feb 21, 2017 7:05 pm

bernd wrote:Few of them exists allready. Check the links on page FEM_Module For example Fem_ConstraintFixed On the documentation they are all writen exact the way the commands from FreeCAD source code file https://github.com/FreeCAD/FreeCAD/blob ... h.cpp#L139 are used.
See https://forum.freecadweb.org/viewtopic. ... 61#p161161
Alone you go faster. Together we go farther
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
User avatar
Kunda1
Posts: 9202
Joined: Thu Jan 05, 2017 9:03 pm

Re: FEM documentation missing on the Wiki

Postby Kunda1 » Tue Feb 21, 2017 7:35 pm

Also many of the FEM wiki pages are missing:
Alone you go faster. Together we go farther
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
User avatar
bernd
Posts: 11090
Joined: Sun Sep 08, 2013 8:07 pm
Location: Zürich, Switzerland

Re: FEM documentation missing on the Wiki

Postby bernd » Wed Feb 22, 2017 5:32 pm

Kunda1 wrote:Also many of the FEM wiki pages are missing:
links point to Draft wiki pages :?:
User avatar
Kunda1
Posts: 9202
Joined: Thu Jan 05, 2017 9:03 pm

Re: FEM documentation missing on the Wiki

Postby Kunda1 » Wed Feb 22, 2017 7:17 pm

bernd wrote:
Kunda1 wrote:Also many of the FEM wiki pages are missing:
links point to Draft wiki pages :?:
I did that intentionally to show the template which is recommended as an example of an ideal complete documentation page.
Alone you go faster. Together we go farther
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
User avatar
Kunda1
Posts: 9202
Joined: Thu Jan 05, 2017 9:03 pm

Re: FEM documentation missing on the Wiki

Postby Kunda1 » Sat May 27, 2017 8:02 pm

Linked to issue #3052
Alone you go faster. Together we go farther
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
User avatar
Kunda1
Posts: 9202
Joined: Thu Jan 05, 2017 9:03 pm

Re: FEM documentation missing on the Wiki

Postby Kunda1 » Sat May 27, 2017 8:03 pm

@bernd do you mind pinning this thread so it gets better visibility?
Alone you go faster. Together we go farther
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
User avatar
bernd
Posts: 11090
Joined: Sun Sep 08, 2013 8:07 pm
Location: Zürich, Switzerland

Re: FEM documentation missing on the Wiki

Postby bernd » Sat May 27, 2017 9:08 pm

Kunda1 wrote:
Sat May 27, 2017 8:03 pm
@bernd do you mind pinning this thread so it gets better visibility?
How about this ?
User avatar
OakLD
Posts: 104
Joined: Fri Jan 12, 2018 7:38 pm
Location: Brno

Re: FEM documentation missing on the Wiki

Postby OakLD » Mon Mar 19, 2018 10:33 am

Kunda1 wrote:
Tue Feb 21, 2017 7:05 pm
bernd wrote:Few of them exists allready. Check the links on page FEM_Module For example Fem_ConstraintFixed On the documentation they are all writen exact the way the commands from FreeCAD source code file https://github.com/FreeCAD/FreeCAD/blob ... h.cpp#L139 are used.
Fem Analysis - https://freecadweb.org/wiki/Fem_Analysis 8-)
Fem BeamSection - https://freecadweb.org/wiki/Fem_BeamSection :!:
Fem ConstraintBearing - https://freecadweb.org/wiki/Fem_ConstraintBearing :!:
Fem ConstraintContact - https://freecadweb.org/wiki/Fem_ConstraintContact 8-)
Fem ConstraintDisplacement - https://freecadweb.org/wiki/Fem_ConstraintDisplacement 8-)
Fem ConstraintFixed - https://freecadweb.org/wiki/Fem_ConstraintFixed 8-)
Fem ConstraintForce - https://freecadweb.org/wiki/Fem_ConstraintForce :!:
Fem ConstraintGear - https://freecadweb.org/wiki/Fem_ConstraintGear :!:
Fem ConstraintHeatflux - https://freecadweb.org/wiki/Fem_ConstraintHeatflux 8-)
Fem ConstraintInitialTemperature - https://freecadweb.org/wiki/Fem_Constra ... emperature 8-)
Fem ConstraintPlaneRotation - https://freecadweb.org/wiki/Fem_ConstraintPlaneRotation 8-)
Fem ConstraintPressure - https://freecadweb.org/wiki/Fem_ConstraintPressure 8-)
Fem ConstraintPulley - https://freecadweb.org/wiki/Fem_ConstraintPulley :!:
Fem ConstraintTemperature - https://freecadweb.org/wiki/Fem_ConstraintTemperature 8-)
Fem ControlSolver - https://freecadweb.org/wiki/Fem_ControlSolver :!:
Fem CreateNodesSet - https://freecadweb.org/wiki/Fem_CreateNodesSet :!:
Fem FemMesh2Mesh - https://freecadweb.org/wiki/Fem_FemMesh2Mesh 8-)
Fem MechanicalMaterial - https://freecadweb.org/wiki/Fem_MechanicalMaterial 8-)
Fem MeshFromShape - https://freecadweb.org/wiki/Fem_MeshFromShape :!:
Fem PurgeResults - https://freecadweb.org/wiki/Fem_PurgeResults :!:
Fem RunSolver - https://freecadweb.org/wiki/Fem_RunSolver :!:
Fem ShellThickness - https://freecadweb.org/wiki/Fem_ShellThickness :!:
Fem ShowResult - https://freecadweb.org/wiki/Fem_ShowResult :!:
Fem SolverCalculix - https://freecadweb.org/wiki/Fem_SolverCalculix :!:
I've just noticed that some of the links point to a differnt WIKI from what is in FEM Workbench page and found out, that all those links are misisng "www." and most likely due to that they point out to a wrong destination. Some of the WIKIs are filled-in, but at a different location... Maybe the links were valid a year ago, but they're not now. Should I go throught them and post the up-to-date list here?
Regards,

Oak