Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clean up and document coupler fields #339

Closed
2 tasks
Tracked by #358
LenkaNovak opened this issue Jun 28, 2023 · 0 comments · Fixed by #644
Closed
2 tasks
Tracked by #358

clean up and document coupler fields #339

LenkaNovak opened this issue Jun 28, 2023 · 0 comments · Fixed by #644
Assignees
Labels
🍃 leaf Issue coupled to a PR

Comments

@LenkaNovak
Copy link
Collaborator

LenkaNovak commented Jun 28, 2023

We need to ensure that all coupler fields have sensible names, which are documented in our docs.

To make use of the coupler as easy as possible for component models, we should make sure that the documentation explicitly outlines the interface we require, including functions and quantities required to run with our setup.

closed by #644 (see PR for To Do/Content lists)

To be done in separate PRs (to limit scope)

  • component model files: rename to model.jl, combine bucket_init and bucket_utils -> bucket.jl
  • separate surfacestub, componentmodel sim
    • move surfacestub to separate file outside of Interfacer.jl?
    • include from Interfacer.jl so it's still in that module
    • same for FieldExchanger.jl
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🍃 leaf Issue coupled to a PR
Projects
None yet
2 participants