horizontal_dimension vs. horizontal_loop_extent, assumed-size arrays

NCAR / ccpp-doc

Technical Documentation for the Common Community Physics Package (CCPP)

0 stars 33 forks source link

horizontal_dimension vs. horizontal_loop_extent, assumed-size arrays #45

Closed climbfuji closed 3 years ago

climbfuji commented 3 years ago

Add documentation for using horizontal_dimension and horizontal_loop_extent for schemes and host models. Correct bugs in DDT metadata and aux2d/aux3d metadata in listings.
Add instructions for using assumed-size array declarations.
Add loop_max to ccpp_type (introduced by PR https://github.com/NCAR/ccpp-framework/pull/376).
Remove old/invalid text.

climbfuji commented 3 years ago

@JulieSchramm Thanks for the review, of course, double ticks. Why should it be consistent with the usual markdown single ticks??? Please check again, I think I addressed all your comments.

JulieSchramm commented 3 years ago

Thanks for the fixes. There are no more warnings about the section levels! The html build looks great. The double tickmarks in RST is the usage for "verbatim", and the single tickmarks are usually used for links.

climbfuji commented 3 years ago

Thanks, @JulieSchramm - if you wait for a bit, I'll have a few more updates/corrections and the other text I was supposed to write (assumed-size arrays) ready as part of this PR.

JulieSchramm commented 3 years ago

@climbfuji I will wait for your other updates.

climbfuji commented 3 years ago

@JulieSchramm how can I use Fortran code blocks within one item in an itemized list? This doesn't work:

* It is preferable to use assumed-size array declarations for input/output variables for CCPP schemes, i.e. instead of

.. code-block:: fortran

   real(kind=kind_phys), dimension(is:ie,ks:ke), intent(inout) :: foo

  one should use

.. code-block:: fortran

   real(kind=kind_phys), dimension(:,:), intent(inout) :: foo

  This allows the compiler to perform bounds checking and detect errors that otherwise may go unnoticed. Warning: Fortran assumes that the lower bound of assumed-size arrays is ``1``. If ``foo`` has different lower bounds ``is`` and ``ks``, then these must be specified explicitly:

.. code-block:: fortran

   real(kind=kind_phys), dimension(is:,ks:), intent(inout) :: foo

JulieSchramm commented 3 years ago

Indentation:

It is preferable to use assumed-size array declarations for input/output variables for CCPP schemes, i.e. instead of

.. code-block:: fortran

real(kind=kind_phys), dimension(is:ie,ks:ke), intent(inout) :: foo

one should use

.. code-block:: fortran

real(kind=kind_phys), dimension(:,:), intent(inout) :: foo

This allows the compiler to perform bounds checking and detect errors that otherwise may go unnoticed. Warning: Fortran assumes that the lower bound of assumed-size arrays is 1. If foo has different lower bounds is and ks, then these must be specified explicitly:

.. code-block:: fortran

real(kind=kind_phys), dimension(is:,ks:), intent(inout) :: foo

climbfuji commented 3 years ago

Use:

.. warning:: Fortran assumes that...

This will make a nice red box around the text that will scare the user into complacency.

Thanks! Take another look, please.