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.

Sign up for GitHub

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

Clarify NUOPC_CompAttributeIngest documentation #339

Merged
merged 1 commit into from
Dec 20, 2024
Merged

Clarify NUOPC_CompAttributeIngest documentation #339

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion src/addon/NUOPC/src/NUOPC_Comp.F90
View file
Open in desktop
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