Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Register
  • Sign in
  • dumux-preCICE dumux-preCICE
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
  • Issues 13
    • Issues 13
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 2
    • Merge requests 2
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Container Registry
  • Monitor
    • Monitor
    • Metrics
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • dumux-appl
  • dumux-preCICEdumux-preCICE
  • Issues
  • #7
Closed
Open
Issue created May 03, 2019 by Alexander Jaust@ajaustMaintainer

Add documentation

The code needs more documentation. This also depends on the status of #6.

  • Document the class PreciceAdapter (doxygen or similar) see !23 (merged)
  • Document how the code has to be used. Maybe use mkdocs?
  • Document installation process (see #24 (closed))
  • Add documentation of CouplingManager and explain what "reverse" means in this context. Do we have a better name than "reverse"? See also !8 (merged)
  • Add some documentation about tests. Currently we use preCICE 1.6.1, but we should migrate to preCICE v2 soon
    • Current release of DuMuX + preCICE
    • Current development of DuMuX + preCICE
    • Code has been migrated to preCICE v2
Edited May 17, 2022 by Alexander Jaust
Assignee
Assign to
Time tracking