Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Re-reorganize the examples #26

Open
jwpeterson opened this Issue · 9 comments

4 participants

@jwpeterson
Owner

The last example reorganization was well-intentioned, but now we are slowly making our way into exactly the position we were in before: does anyone know what miscellaneous_ex1--8 (after Ben's recent branch merges) are off the top of their head? I didn't think so...

My current suggestion for re-reorganizing them derives from the following axioms:

1.) Naming examples with numbers implies a sequential ordering
2.) Examples cannot (easily) be maintained in sequential order; and not all examples logically fall into a step-by-step sequence
3.) Nested directory structures are limiting and arbitrary (think gmail labels vs. folders)

So I propose we do the following:

1.) Come up with a relatively short, but informative, name (which does not have a number) for every example
2.) Put each one in a separate subdirectory of the examples/ directory (like they were before)
3.) Come up with a set of "tags" for each example which can be placed in the comments, and will allow people to search for an example (via grep) that is relevant to them.

For example (bad pun, I know):
introduction_ex1 -> read_write_mesh
introduction_ex2 -> intro_to_equation_systems
introduction_ex3 -> simple_poisson
introduction_ex4 -> advanced_poisson (*the previous example could probably just be dropped?)
introduction_ex5 -> runtime_quadrature_selection (again, maybe get rid of this one?)

adaptivity_ex1 -> 1D_reaction_diffusion_amr
adaptivity_ex2 -> unsteady_convection_diffusion_amr

etc.

Please let me know your thoughts...

@benkirk
Owner
@roystgnr
Owner
@jwpeterson
Owner
@benkirk
Owner

I'll broaden this too, I'd like to turn at least a good subset of the examples into proper regression tests, what with gold standard results and all...

We've got a utility differ that we've been using for some PECOS apps that could/should get moved into libMesh and maintained there...

@roystgnr
Owner
@benkirk
Owner
@roystgnr
Owner
@friedmud
Owner

Let me make a suggestion on naming:

introduction/ex00_reading_a_mesh
introduction/ex01_1d_simple_system
introduction/ex02_2d_simple_system
introduction/ex03_adaptivity

That way they are numbered but also named so that you can tell what it's doing. We use something pretty close to this for MOOSE examples and it has worked well.

Derek

@jwpeterson
Owner
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.