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 Special Methods
5.4 The ESMF Data Hierarchy
5.5 ESMF Spatial Classes
5.6 ESMF Maps
5.7 ESMF Specification Classes
5.8 ESMF Utility Classes
6 Overall Rules and Behavior
6.1 Local and Global Views and Associated Conventions
6.2 Allocation Rules
6.3 Assignment, Equality, Copying and Comparing Objects
7 Integrating ESMF into Applications
7.1 Using the ESMF Superstructure
2 Applications
8 ESMF_Info
8.1 Description
9 ESMF_RegridWeightGen
9.1 Description
9.2 Usage
9.3 Examples
9.4 SCRIP Grid File Format
9.5 ESMF Unstructured Grid File Format
9.6 CF Convention GRIDSPEC File Format
9.7 CF Convention UGRID File Format
9.8 Regrid Interpolation Weight File Format
3 Superstructure
10 Overview of Superstructure
10.1 Superstructure Classes
10.2 Hierarchical Creation of Components
10.3 Sequential and Concurrent Execution of Components
10.4 Intra-Component Communication
10.5 Data Distribution and Scoping in Components
10.6 Performance
10.7 Object Model
11 Application Driver and Required ESMF Methods
11.1 Description
11.2 Required ESMF Methods
11.2.1 ESMC_Initialize - Initialize the ESMF Framework
11.2.2 ESMC_Finalize - Finanalize the ESMF Framework
12 GridComp Class
12.1 Description
12.2 Class API
12.2.1 ESMC_GridCompCreate - Create a Gridded Component
12.2.2 ESMC_GridCompDestroy - Destroy a Gridded Component
12.2.3 ESMC_GridCompFinalize - Finalize a Gridded Component
12.2.4 ESMC_GridCompGetInternalState - Get the Internal State of a Gridded Component
12.2.5 ESMC_GridCompInitialize - Initialize a Gridded Component
12.2.6 ESMC_GridCompPrint - Print the contents of a GridComp
12.2.7 ESMC_GridCompRun - Run a Gridded Component
12.2.8 ESMC_GridCompSetEntryPoint - Set user routine as entry point for standard Component method
12.2.9 ESMC_GridCompSetInternalState - Set the Internal State of a Gridded Component
12.2.10 ESMC_GridCompSetServices - Call user routine to register GridComp methods
13 CplComp Class
13.1 Description
13.2 Class API
13.2.1 ESMC_CplCompCreate - Create a Coupler Component
13.2.2 ESMC_CplCompDestroy - Destroy a Coupler Component
13.2.3 ESMC_CplCompFinalize - Finalize a Coupler Component
13.2.4 ESMC_CplCompGetInternalState - Get the internal State of a Coupler Component
13.2.5 ESMC_CplCompInitialize - Initialize a Coupler Component
13.2.6 ESMC_CplCompPrint - Print a Coupler Component
13.2.7 ESMC_CplCompRun - Run a Coupler Component
13.2.8 ESMC_CplCompSetEntryPoint - Set the Entry point of a Coupler Component
13.2.9 ESMC_CplCompSetInternalState - Set the internal State of a Coupler Component
13.2.10 ESMC_CplCompSetServices - Destroy a Coupler Component
14 State Class
14.1 Description
14.2 Restrictions and Future Work
14.3 Class API
14.3.1 ESMC_StateAddArray - Add an Array object to a State
14.3.2 ESMC_StateAddField - Add a Field object to a State
14.3.3 ESMC_StateCreate - Create an Array
14.3.4 ESMC_StateDestroy - Destroy a State
14.3.5 ESMC_StateGetArray - Obtains an Array object from a State
14.3.6 ESMC_StateGetField - Obtains a Field object from a State
14.3.7 ESMC_StatePrint - Print the contents of a State
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.1.1 Field create and destroy
16.2 Class API
16.2.1 ESMC_FieldCreateGridArraySpec - Create a Field from Grid and ArraySpec
16.2.2 ESMC_FieldCreateGridTypeKind - Create a Field from Grid and typekind
16.2.3 ESMC_FieldCreateMeshArraySpec - Create a Field from Mesh and ArraySpec
16.2.4 ESMC_FieldCreateMeshTypeKind - Create a Field from Mesh and typekind
16.2.5 ESMC_FieldDestroy - Destroy a Field
16.2.6 ESMC_FieldGetArray - Get the internal Array stored in the Field
16.2.7 ESMC_FieldGetMesh - Get the internal Mesh stored in the Field
16.2.8 ESMC_FieldGetPtr - Get the internal Fortran data pointer stored in the Field
16.2.9 ESMC_FieldPrint - Print the internal information of a Field
16.2.10 ESMC_FieldRegridGetArea - Get the area of the cells used for
16.2.11 ESMC_FieldRegridStore - Precompute a Field regridding operation and return a RouteHandle
16.2.12 ESMC_FieldRegrid - Compute a regridding operation
16.2.13 ESMC_FieldRegridRelease - Free resources used by a regridding operation
17 Array Class
17.1 Description
17.2 Class API
17.2.1 ESMC_ArrayCreate - Create an Array
17.2.2 ESMC_ArrayDestroy - Destroy an Array
17.2.3 ESMC_ArrayGetName - Get the name of an Array
17.2.4 ESMC_ArrayGetPtr - Get pointer to Array data.
17.2.5 ESMC_ArrayPrint - Print an Array
18 ArraySpec Class
18.1 Description
18.2 Class API
18.2.1 ESMC_ArraySpecGet - Get values from an ArraySpec
18.2.2 ESMC_ArraySpecSet - Set values for an ArraySpec
19 Mesh Class
19.1 Description
19.1.1 Mesh Representation in ESMF
19.1.2 Supported Meshes
19.2 Constants
19.2.1 ESMC_MESHELEMTYPE
19.3 Class API
19.3.1 ESMC_MeshAddElements - Add elements to a Mesh
19.3.2 ESMC_MeshAddNodes - Add nodes to a Mesh
19.3.3 ESMC_MeshCreate - Create a Mesh as a 3 step process
19.3.4 ESMC_MeshDestroy - Destroy a Mesh
19.3.5 ESMC_MeshFreeMemory - Remove a Mesh and its memory
19.3.6 ESMC_MeshGetLocalElementCount - Get the number of elements in a Mesh on the current PET
19.3.7 ESMC_MeshGetLocalNodeCount - Get the number of nodes in a Mesh on the current PET
19.3.8 ESMC_MeshGetOwnedElementCount - Get the number of elements in a Mesh owned by the current PET
19.3.9 ESMC_MeshGetOwnedNodeCount - Get the number of nodes in a Mesh owned by the current PET
20 DistGrid Class
20.1 Description
20.2 Class API
20.2.1 ESMC_DistGridCreate - Create a DistGrid
20.2.2 ESMC_DistGridDestroy - Destroy a DistGrid
20.2.3 ESMC_DistGridPrint - Print a DistGrid
5 Infrastructure: Utilities
21 Overview of Infrastructure Utility Classes
22 Time Manager Utility
22.1 Time Manager Classes
22.2 Calendar
22.3 Time Instants and TimeIntervals
22.4 Clocks
23 Calendar Class
23.1 Description
23.2 Constants
23.2.1 ESMC_CALKIND
23.3 Class API
23.3.1 ESMC_CalendarCreate - Create a Calendar
23.3.2 ESMC_CalendarDestroy - Destroy a Calendar
23.3.3 ESMC_CalendarPrint - Print a Calendar
24 Time Class
24.1 Description
24.2 Class API
24.2.1 ESMC_TimeGet - Get a Time value
24.2.2 ESMC_TimePrint - Print a Time
24.2.3 ESMC_TimeSet - Initialize or set a Time
25 TimeInterval Class
25.1 Description
25.2 Class API
25.2.1 ESMC_TimeIntervalGet - Get a TimeInterval value
25.2.2 ESMC_TimeIntervalPrint - Print a TimeInterval
25.2.3 ESMC_TimeIntervalSet - Initialize or set a TimeInterval
26 Clock Class
26.1 Description
26.2 Class API
26.2.1 ESMC_ClockAdvance - Advance a Clock's current time by one time step
26.2.2 ESMC_ClockCreate - Create a Clock
26.2.3 ESMC_ClockDestroy - Destroy a Clock
26.2.4 ESMC_ClockGet - Get a Clock's properties
26.2.5 ESMC_ClockPrint - Print the contents of a Clock
27 Config Class
27.1 Description
27.1.1 Package history
27.2 Class API
27.2.1 ESMC_ConfigCreate - Create a Config object
27.2.2 ESMC_ConfigDestroy - Destroy a Config object
27.2.3 ESMC_ConfigFindLabel - Find a label
27.2.4 ESMC_ConfigGetDim - Get table sizes
27.2.5 ESMC_ConfigGetLen - Get the length of the line in words
27.2.6 ESMC_ConfigLoadFile - Load resource file into memory
27.2.7 ESMC_ConfigNextLine - Find next line
27.2.8 ESMC_ConfigValidate - Validate a Config object
28 Log Class
28.1 Description
28.2 Class API
28.2.1 ESMC_LogWrite - Write an entry into the Log file
28.2.2 ESMC_LogSet - Set Log properties
29 VM Class
29.1 Description
29.2 Class API
29.2.1 ESMC_VMGet - Get VM internals
29.2.2 ESMC_VMGetCurrent - Get current VM
29.2.3 ESMC_VMGetGlobal - Get global VM
29.2.4 ESMC_VMPrint - Print a VM
6 References
Bibliography
7 Appendices
30 Appendix A: A Brief Introduction to UML
31 Appendix B: ESMF Error Return Codes
esmf_support@list.woc.noaa.gov
