Skip to content

Commit

Permalink
Merge pull request #339 from danrosen25/doc/nuopc_attingest
Browse files Browse the repository at this point in the history
Clarify NUOPC_CompAttributeIngest documentation
  • Loading branch information
theurich authored Dec 20, 2024
2 parents 6724eff + 63eb6a2 commit c9c3763
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion src/addon/NUOPC/src/NUOPC_Comp.F90
Original file line number Diff line number Diff line change
Expand Up @@ -1610,7 +1610,10 @@ subroutine NUOPC_GridCompAttributeIng(comp, freeFormat, addFlag, rc)
! Important: Attributes ingested by this method are stored as type character
! strings, and must be accessed accordingly. Conversion from string into a
! different data type, e.g. {\tt integer} or {\tt real}, is the user's
! responsibility.
! responsibility. This method does not support value lists. Attribute values
! ingested by this method must not contain whitespace within the value. If
! whitespace is found within the value the attribute will not be added to
! the comp.
!
! If {\tt addFlag} is {\tt .false.} (default), an error will be returned if
! an attribute is to be ingested that was not previously added to the
Expand Down Expand Up @@ -1644,6 +1647,20 @@ subroutine NUOPC_GridCompAttributeIng(comp, freeFormat, addFlag, rc)
! specifies a user-level Attribute, which is not part of the pre-defined
! Attributes of any of the standard NUOPC component kinds.
!
! Currently, whitespace is not supported in the attribute value and
! the following attributeName fails to be added.
!
! \begin{verbatim}
! attributeName = attributeValue1 attributeValue2 attributedValue3
! \end{verbatim}
!
! If a list is needed then a comma can be used as a delimiter. The
! attribute value list must then be parsed in user code.
!
! \begin{verbatim}
! attributeName = attributeValue1,attributeValue2,attributedValue3
! \end{verbatim}
!
!EOP
!-----------------------------------------------------------------------------
character(ESMF_MAXSTR) :: name
Expand Down

0 comments on commit c9c3763

Please sign in to comment.