Subsections
34 Appendix A: Master List of Constants
This flag is documented in section 26.2.1.
This flag is documented in section 19.2.1.
34.3 ESMC_DECOMP
DESCRIPTION:
Indicates how DistGrid elements are decomposed over DEs.
The type of this flag is:
type(ESMC_Decomp_Flag)
The valid values are:
- ESMC_DECOMP_BALANCED
- Decompose elements as balanced as possible across DEs. The maximum
difference in number of elements per DE is 1, with the extra elements on
the lower DEs.
- ESMC_DECOMP_CYCLIC
- Decompose elements cyclically across DEs.
- ESMC_DECOMP_RESTFIRST
- Divide elements over DEs. Assign the rest of this division to the first
DE.
- ESMC_DECOMP_RESTLAST
- Divide elements over DEs. Assign the rest of this division to the last DE.
- ESMC_DECOMP_SYMMEDGEMAX
- Decompose elements across the DEs in a symmetric fashion. Start with the
maximum number of elements at the two edge DEs, and assign a decending
number of elements to the DEs as the center of the decomposition is
approached from both sides.
subsection(ESMC_ExtrapMethod_Flag)
DESCRIPTION:
Specify which extrapolation method to use on unmapped destination points after
regridding.
The type of this flag is:
type(ESMC_ExtrapMethod_Flag)
The valid values are:
- ESMC_EXTRAPMETHOD_NONE
- Indicates that no extrapolation should be done.
- ESMC_EXTRAPMETHOD_NEAREST_STOD
- Inverse distance weighted average.
Here the value of a destination point is the weighted average of the
closest N source points. The weight is the reciprocal of the distance of
the source point from the destination point raised to a power P. All the
weights contributing to one destination point are normalized so that they
sum to 1.0. The user can choose N and P when using this method, but
defaults are also provided.
- ESMC_EXTRAPMETHOD_NEAREST_IDAVG
- Nearest source to destination.
Here each destination point is mapped to the closest source point. A given
source point may go to multiple destination points, but no destination
point will receive input from more than one source point.
This flag is documented in section 19.2.6.
subsection(ESMC_FileMode_Flag)
DESCRIPTION:
Specify which mode to use when writing a weight file.
The type of this flag is:
type(ESMC_FileMode_Flag)
The valid values are:
- ESMC_FILEMODE_BASIC
- Indicates that only the factorList and factorIndexList should be written.
- ESMC_FILEMODE_WITHAUX
- Indicates that grid center coordinates should also be written.
This flag is documented in section 19.2.2.
This flag is documented in section 19.2.3.
34.7 ESMC_INDEX
DESCRIPTION:
Indicates whether index is local (per DE) or global (per object).
The type of this flag is:
type(ESMC_IndexFlag)
The valid values are:
- ESMC_INDEX_DELOCAL
- Indicates that DE-local index space starts at lower bound 1 for each DE.
- ESMC_INDEX_GLOBAL
- Indicates that global indices are used. This means that DE-local index
space starts at the global lower bound for each DE.
- ESMC_INDEX_USER
- Indicates that the DE-local index bounds are explicitly set by the user.
34.8 ESMC_LINETYPE
DESCRIPTION:
This argument allows the user to select the path of the
line which connects two points on the surface of a sphere.
This in turn controls the path along which distances are calculated and the
shape of the edges that make up a cell.
The type of this flag is:
type(ESMC_LineType_Flag)
The valid values are:
- ESMC_LINETYPE_CART
- Cartesian line. When this option is specified distances are calculated in a
straight line through the 3D Cartesian space in which the sphere is
embedded. Cells are approximated by 3D planes bounded by 3D Cartesian lines
between their corner vertices.
When calculating regrid weights, this line type is currently the default for
the following regrid methods: ESMC_REGRIDMETHOD_BILINEAR,
ESMC_REGRIDMETHOD_PATCH, ESMC_REGRIDMETHOD_NEAREST_STOD, and
ESMC_REGRIDMETHOD_NEAREST_DTOS.
- ESMC_LINETYPE_GREAT_CIRCLE
- Great circle line. When this option is specified distances are calculated
along a great circle path (the shortest distance between two points on a
sphere surface). Cells are bounded by great circle paths between their
corner vertices. When calculating regrid weights, this line type is
currently the default for the following regrid method:
ESMC_REGRIDMETHOD_CONSERVE.
This flag is documented in section 31.2.1.
This flag is documented in section 31.2.2.
This flag is documented in section 20.2.1.
34.12 ESMF_METHOD
DESCRIPTION:
Specify standard ESMF Component method.
The type of this flag is:
type(ESMF_Method_Flag)
The valid values are:
- ESMF_METHOD_FINALIZE
- Finalize method.
- ESMF_METHOD_INITIALIZE
- Initialize method.
- ESMF_METHOD_READRESTART
- ReadRestart method.
- ESMF_METHOD_RUN
- Run method.
- ESMF_METHOD_WRITERESTART
- WriteRestart method.
This flag is documented in section 19.2.4.
34.14 ESMC_REDUCE
DESCRIPTION:
Indicates reduce operation.
The type of this flag is:
type(ESMC_Reduce_Flag)
The valid values are:
- ESMC_REDUCE_SUM
- Use arithmetic sum to add all data elements.
- ESMC_REDUCE_MIN
- Determine the minimum of all data elements.
- ESMC_REDUCE_MAX
- Determine the maximum of all data elements.
34.15 ESMC_REGION
DESCRIPTION:
Specifies various regions in the data layout of an Array or Field object.
The type of this flag is:
type(ESMC_Region_Flag)
The valid values are:
- ESMC_REGION_TOTAL
- Total allocated memory.
- ESMC_REGION_SELECT
- Region of operation-specific elements.
- ESMC_REGION_EMPTY
- The empty region contains no elements.
This flag is documented in section 16.2.1.
This flag is documented in section 19.2.5.
34.18 ESMC_TYPEKIND
DESCRIPTION:
Named constants used to indicate type and kind combinations supported by the
overloaded ESMC interfaces. The corresponding Fortran kind-parameter constants
are described in the ESMF_TYPEKIND section of Appendices of the ESMF Fortran
reference manual.
The type of these named constants is:
type(ESMC_TypeKind_Flag)
The named constants are:
- ESMC_TYPEKIND_I1
- Indicates 1 byte integer.
(Only available if ESMF was built with
ESMF_NO_INTEGER_1_BYTE = FALSE. This is not the default.)
- ESMC_TYPEKIND_I2
- Indicates 2 byte integer.
(Only available if ESMF was built with
ESMF_NO_INTEGER_2_BYTE = FALSE. This is not the default.)
- ESMC_TYPEKIND_I4
- Indicates 4 byte integer.
- ESMC_TYPEKIND_I8
- Indicates 8 byte integer.
- ESMC_TYPEKIND_R4
- Indicates 4 byte real.
- ESMC_TYPEKIND_R8
- Indicates 8 byte real.
34.19 ESMC_UNMAPPEDACTION
DESCRIPTION:
Indicates what action to take with respect to unmapped destination points
and the entries of the sparse matrix that correspond to these points.
The type of this flag is:
type(ESMC_UnmappedAction_Flag)
The valid values are:
- ESMC_UNMAPPEDACTION_ERROR
- An error is issued when there exist destination points in a regridding
operation that are not mapped by corresponding source points.
- ESMC_UNMAPPEDACTION_IGNORE
- Destination points which do not have corresponding source points are
ignored and zeros are used for the entries of the sparse matrix
that is generated.
The schematic below shows the Unified Modeling Language (UML) notation
for the class diagrams presented in this Reference Manual. For
more on UML, see references such as The Unified Modeling Language
Reference Manual, Rumbaugh et al, [3].
36 Appendix C: ESMF Error Return Codes
The tables below show the possible error return codes for Fortran and
C methods.
esmf_support@ucar.edu
