From 63eb6a2b1f2efa91c5f34848d607c573d0067356 Mon Sep 17 00:00:00 2001 From: Daniel Rosen Date: Fri, 20 Dec 2024 09:16:44 -0600 Subject: [PATCH] Clarify NUOPC_CompAttributeIngest documentation * add note that whitespace delimited lists are not supported --- src/addon/NUOPC/src/NUOPC_Comp.F90 | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/src/addon/NUOPC/src/NUOPC_Comp.F90 b/src/addon/NUOPC/src/NUOPC_Comp.F90 index 71d02cd762..05f5637d0c 100644 --- a/src/addon/NUOPC/src/NUOPC_Comp.F90 +++ b/src/addon/NUOPC/src/NUOPC_Comp.F90 @@ -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 @@ -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