Better documentation for Operator input/output types
Open
documentation
- Dominant language
- Julia
- Stars
- 117
- Forks
- 19
- Avg merge
- 3d 5h
- Merged PRs (30d)
- 36
Description
We should have a better documentation of the [operators](https://clima.github.io/ClimaCore.jl/dev/operators/) including information of what type of vectors they need for input/output arguments and boundary conditions, e.g., when you use the `SetDivergence` boundary type in a `DivergenceC2F` operator, you should feed it a scalar, because you are effectively setting out the operator's output type for that boundary, not the type of input for that operator on the boundary (i.e., a vector).
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.