[petsc-dev] Documenting types of examples

Smith, Barry F. bsmith at mcs.anl.gov
Fri May 31 09:36:06 CDT 2019


   Cool stuff. 

   This is kind of weird

ex18.c
single
single
single
single

   I guess that example has no help string?

> On May 31, 2019, at 8:35 AM, Patrick Sanan via petsc-dev <petsc-dev at mcs.anl.gov> wrote:
> 
> I guess right now it's just tags which can be of the form tag^sub-tag, and you're only allowed to look up one tag at a time (by scrolling through that html page). Not ideal but pretty low-maintenance?
> 
> Am Fr., 31. Mai 2019 um 15:15 Uhr schrieb Matthew Knepley <knepley at gmail.com>:
> On Fri, May 31, 2019 at 9:11 AM Patrick Sanan <patrick.sanan at gmail.com> wrote:
> We only removed the Concepts from the man pages. The Concepts in the examples should remain, and are compiled as usual here : https://www.mcs.anl.gov/petsc/petsc-dev/docs/manualpages/help.html
> 
> Does that suffice for what you'd like to add?
> 
> I think so.
> 
> Although right now the hierarchical organization is nonsensical. Why would there be a "Laplacian" under KSP, and also
> at the top level? It should just be tags, like email, so a user can select the set of tags they are looking for.
> 
>    Matt
>  
> Am Fr., 31. Mai 2019 um 15:08 Uhr schrieb Matthew Knepley <knepley at gmail.com>:
> How should we document the types of examples we have, now that we removed Concepts?
> For example, I would like it to be easy to see that I have FEM examples for
> 
>   - Poisson
>   - p-Laplacian
>   - Linear elasticity
>   - Large deformation elasticity
>   - Stokes
>   - variable-viscosity Stokes
>   - Heat equation
>   - Navier-Stokes
> 
> Where would someone see this? Clearly, we want similar lists for other examples.
> 
>   Thanks,
> 
>     Matt
> 
> -- 
> What most experimenters take for granted before they begin their experiments is infinitely more interesting than any results to which their experiments lead.
> -- Norbert Wiener
> 
> https://www.cse.buffalo.edu/~knepley/
> 
> 
> -- 
> What most experimenters take for granted before they begin their experiments is infinitely more interesting than any results to which their experiments lead.
> -- Norbert Wiener
> 
> https://www.cse.buffalo.edu/~knepley/



More information about the petsc-dev mailing list