search

prisms-center / phaseField

PRISMS-PF: An Open-Source Phase-Field Modeling Framework
https://prisms-center.github.io/phaseField/
Other
220 stars 119 forks source link

Add a "Tips" section to the manual #135

Open stvdwtt opened 5 years ago

stvdwtt commented 5 years ago

Right now the manual is pretty descriptive -- this parameter does this, this parameter does that.

It would be beneficial to add another section that has a list of norms and tips for performance (and maybe readability). This could cover things like how to interact with tensors (#133) and a warning about the scaling implications of using too many subdivisions.

stvdwtt commented 5 years ago

From a conversation with Patrick Brewick: Currently the manual is good for telling someone how to tweak an existing application to suit their needs. However, it isn't as helpful for someone starting with an entirely new set of governing equations.

I think a "Tips" section of the manual has a role to play here, although this could also require a dedicated section.

landinjm commented 2 months ago

In a similar vein, we can add a document that contains common debugging errors and ways to fix them (FAQ). It would also be good to link to pfhub's document on phase-field.

A good practices for coding / using PRISMS might also be helpful.