Next:
1 ESMF Overview
Up:
ESMC_crefdoc
Previous:
ESMC_crefdoc
Contents
1
ESMF Overview
1
What is the Earth System Modeling Framework?
2
The ESMF Reference Manual for C
3
How to Contact User Support and Find Additional Information
4
How to Submit Comments, Bug Reports, and Feature Requests
5
The ESMF Application Programming Interface
5
.
1
Standard Methods and Interface Rules
5
.
2
Deep and Shallow Classes
5
.
3
Aliases
5
.
4
Special Methods
5
.
5
The ESMF Data Hierarchy
5
.
6
ESMF Spatial Classes
5
.
7
ESMF Maps
5
.
8
ESMF Specification Classes
5
.
9
ESMF Utility Classes
6
Integrating ESMF into Applications
6
.
1
Using the ESMF Superstructure
6
.
2
Constants
7
Overall Rules and Behavior
7
.
1
Local and Global Views and Associated Conventions
7
.
2
Allocation Rules
7
.
3
Assignment, Equality, Copying and Comparing Objects
8
Overall Design and Implementation Notes
2
Command Line Tools
3
Superstructure
9
Overview of Superstructure
9
.
1
Superstructure Classes
9
.
2
Hierarchical Creation of Components
9
.
3
Sequential and Concurrent Execution of Components
9
.
4
Intra-Component Communication
9
.
5
Data Distribution and Scoping in Components
9
.
6
Performance
9
.
7
Object Model
10
Application Driver and Required ESMF Methods
10
.
1
Description
10
.
2
Required ESMF Methods
11
GridComp Class
11
.
1
Description
11
.
2
Class API
12
CplComp Class
12
.
1
Description
12
.
2
Class API
13
SciComp Class
13
.
1
Description
13
.
2
Class API
14
State Class
14
.
1
Description
14
.
2
Restrictions and Future Work
14
.
3
Class API
4
Infrastructure: Fields and Grids
15
Overview of Infrastructure Data Handling
15
.
1
Infrastructure Data Classes
15
.
2
Design and Implementation Notes
16
Field Class
16
.
1
Description
16
.
2
Constants
16
.
2
.
1
ESMC_REGRIDMETHOD
16
.
3
Use and Examples
16
.
3
.
1
Field create and destroy
16
.
4
Class API
17
Array Class
17
.
1
Description
17
.
2
Class API
18
ArraySpec Class
18
.
1
Description
18
.
2
Class API
19
Grid Class
19
.
1
Description
19
.
1
.
1
Grid Representation in ESMF
19
.
1
.
2
Supported Grids
19
.
1
.
3
Grid Topologies and Periodicity
19
.
1
.
4
Grid Distribution
19
.
1
.
5
Grid Coordinates
19
.
1
.
6
Coordinate Specification and Generation
19
.
1
.
7
Staggering
19
.
1
.
8
Masking
19
.
2
Constants
19
.
2
.
1
ESMC_COORDSYS
19
.
2
.
2
ESMC_GRIDITEM
19
.
2
.
3
ESMC_GRIDSTATUS
19
.
2
.
4
ESMC_POLEKIND
19
.
2
.
5
ESMC_STAGGERLOC
19
.
2
.
6
ESMC_FILEFORMAT
19
.
3
Restrictions and Future Work
19
.
4
Design and Implementation Notes
19
.
4
.
1
Grid Topology
19
.
5
Class API: General Grid Methods
20
Mesh Class
20
.
1
Description
20
.
1
.
1
Mesh Representation in ESMF
20
.
1
.
2
Supported Meshes
20
.
2
Constants
20
.
2
.
1
ESMC_MESHELEMTYPE
20
.
2
.
2
ESMF_FILEFORMAT
20
.
3
Class API
21
XGrid Class
21
.
1
Description
21
.
2
Restrictions and Future Work
21
.
2
.
1
Restrictions and Future Work
21
.
3
Design and Implementation Notes
21
.
4
Class API
22
DistGrid Class
22
.
1
Description
22
.
2
Class API
23
RouteHandle Class
23
.
1
Description
23
.
2
Use and Examples
23
.
3
Restrictions and Future Work
23
.
4
Design and Implementation Notes
23
.
5
Class API
5
Infrastructure: Utilities
24
Overview of Infrastructure Utility Classes
25
Time Manager Utility
25
.
1
Time Manager Classes
25
.
2
Calendar
25
.
3
Time Instants and TimeIntervals
25
.
4
Clocks
26
Calendar Class
26
.
1
Description
26
.
2
Constants
26
.
2
.
1
ESMC_CALKIND
26
.
3
Class API
27
Time Class
27
.
1
Description
27
.
2
Class API
28
TimeInterval Class
28
.
1
Description
28
.
2
Class API
29
Clock Class
29
.
1
Description
29
.
2
Class API
30
Config Class
30
.
1
Description
30
.
1
.
1
Package history
30
.
2
Class API
31
Log Class
31
.
1
Description
31
.
2
Constants
31
.
2
.
1
ESMC_LOGKIND
31
.
2
.
2
ESMC_LOGMSG
31
.
3
Class API
32
VM Class
32
.
1
Description
32
.
2
Class API
33
Profiling and Tracing
33
.
1
Description
33
.
1
.
1
Profiling
33
.
1
.
2
Tracing
33
.
2
Restrictions and Future Work
33
.
3
Class API
6
References
References
7
Appendices
34
Appendix A: Master List of Constants
34
.
1
ESMC_CALKIND
34
.
2
ESMC_COORDSYS
34
.
3
ESMC_DECOMP
34
.
4
ESMC_FILEFORMAT
34
.
5
ESMC_GRIDITEM
34
.
6
ESMC_GRIDSTATUS
34
.
7
ESMC_INDEX
34
.
8
ESMC_LINETYPE
34
.
9
ESMC_LOGKIND
34
.
10
ESMC_LOGMSG
34
.
11
ESMC_MESHELEMTYPE
34
.
12
ESMF_METHOD
34
.
13
ESMC_POLEKIND
34
.
14
ESMC_REDUCE
34
.
15
ESMC_REGION
34
.
16
ESMC_REGRIDMETHOD
34
.
17
ESMC_STAGGERLOC
34
.
18
ESMC_TYPEKIND
34
.
19
ESMC_UNMAPPEDACTION
35
Appendix B: A Brief Introduction to UML
36
Appendix C: ESMF Error Return Codes
esmf_support@ucar.edu
