Procedures

add_fvar – PFIO utility routine to create a variable and set attributes

addList – put user defined attribute into a list.

The subroutine Assert checks if the output value is valid.

CFIO_AttInquire – Get information about an attribute

CFIO_Close – Closes file

CFIO_DimInquire – Gets dimension information from a CFIO file.

CFIO_GetAttNames – Get global attribute names

CFIO_GetCharAtt – Read a user-defined character attribute

CFIO_GetIntAtt – Read a user-defined integer attribute

CFIO_GetRealAtt – Read a user-defined real attribute

CFIO_GetVar – Read a variable from the file

CFIO_Open – Opens an existing DAO gridded file

CFIO_PutCharAtt – Write a user-defined character attribute

CFIO_PutIntAtt – Write a user-defined integer attribute

CFIO_PutRealAtt – Write a user-defined real attribute

CFIO_PutVar – Write a variable to the file

CFIO_SGetVar – Read a variable from the file

CFIO_SPutVar – Write a variable to the file

The routine Cleanup closes any remaining open files.

create_file_metada – Create the file metada using PFIO methods and the file collection identifier

create_member_subcommunicator – Create a subcommunicator

decompose_dim – For a given number of grid points along a dimension and a number of available processors for that diemsion,, !! determine the number of grid points assigned to each processor.

decompose_proc – Given the total number of available processors and the number of dimensions, determine the number of processors along each dimension.

DiffDate — Calculates the number of seconds between two times.

ESMF_CFIOCreate – ESMF_CFIO object constructor

ESMF_CFIODestroy – destructor for a CFIO object

ESMF_CFIOEosFileClose – close an open CFIO stream.

ESMF_CFIOEosFileCreate – Create a CFIO output file with meta data

ESMF_CFIOFileClose – close an open CFIO stream

ESMF_CFIOFileCreate – Create a CFIO output file with meta data

ESMF_CFIOFileOpen – open a CFIO file, and get CFIO meta data into a cfio Object.

ESMF_CFIOGet – Get meta data from a CFIO object

ESMF_CFIOGridCreate – ESMF_Grid object constructor

ESMF_CFIOGridDestroy – destructor for a CFIO grid object

ESMF_CFIOGridGet – get grid info

ESMF_CFIOGridSet – set up a grid

ESMF_CFIOSdfFileClose – close an open CFIO stream.

ESMF_CFIOSdfFileCreate – Create a CFIO output file with meta data

ESMF_CFIOSdfFileOpen – open a CFIO file, and get CFIO meta data into a cfio Object.

ESMF_CFIOSet – Set meta data for a CFIO object

ESMF_CFIOVarInfoCreate – ESMF_CFIOVarInfo object constructor

ESMF_CFIOVarInfoDestroy – destructor for a CFIO varInfo object

ESMF_CFIOVarInfoGet – get information from a CFIO variable object

ESMF_CFIOVarInfoSet – Set meta data for a CFIO variable

The subroutine ESMFL_FieldGetDims returns some grid information associated from an ESMF field.

ESMFL_GridDistBlockSet …

Given a srcFLD and its associated 3dGrid and a dstFLD and its associated 3DGrid, the subroutine ESMFL_RegridStore creates their corresponding 2DGrids and a 2D routehandle.

GenericCplSetServices — SetServices for generic couplers.

The routine genGridName returns the name of a grid based on certain parameters. This mimics the MAPL behavior.

GetBegDateTime - Get begin date/time of file

GetDateInt4 — Returns a new date/time from an initial date/time and offset

GetDateInt8 — Returns a new date/time from an initial date/time and offset

GetDateTimeVec - Get date/time of file samples

getList – retrieve defined attributes from a list

The routine GetLUN finds a valid logical unit number in the range 1-100. IMPORTANT: This is the minimal-effort version of this routine, and extremely slow!

getMaxLenCnt – get length of a list and max number of data in the nodes

GX_ - evaluate a GrADS style string template

IdentifyDim - Identify a cooridate variable

initialize_ioserver – Initialize the IO Server using the command line options

initialize_mpi – Initialized MPI is MPI_Init has not been called yet.

This routine creates a balancing strategy over an MPI communicator (Comm) given the work in the local rank (OrgLen). The startegy can be committed and used later through Handle. If a handle is not requested, the latest non-committed strategy is kept at Handle=0, which will be the default strategy for the other methods. The number of passes may be optionally controlled with an upper limit (MaxPasses) or a limiting criterion (BalCond). The amount of work resulting for the local rank can be returned (BalLen).

The subroutine MAPL_CFIOClose only closes the file in MAPL CFIO Object (not a full destroy).

The subroutine MAPL_CFIODestroy destroys a MAPL CFIO object. It closes any file associated with it and deallocates memory.

Returns Psize and Root, the size (in nodes) and root node of each node partition assigned to active collections.

The subroutine MAPL_CFIOSet sets the member variables of a MAPL CFIO Object.

The subroutine MAPL_CFIOWriteBundlePost writes an ESMF Bundle to a File. Only the MAPL_CFIO object is a required argument as pointers to the actual data to be written is recorded in it during creation.

For each entry in NAMES marks the export spec to not be deferred during MAPL_GenericInitialize.

The subroutine MAPL_EQsatSET set behavior of MAPL_EQsat. MAPL_EQsatSet can be used to set three parameters that control the behavior of the working routine, MAPL_EQsat.

MAPL_GenericSetServices performs the following tasks:

Find value of array variable in config

Find value of scalar variable in config

Destructor for the MAPL Simple Bundle. It is assumed that the bundle has been created from an ESMF Field Bundle.

Finds the index of the first variable with name vname. This routine is case insensitive.

Prints the global max/min for each variable in the Simple Bundle.

Given an ESMF Config object and a filename, reads the corresponding file into a MAPL SimpleBundle.

Return the daylight duration in seconds (i.e, the time between sunrise and sunset) for a day around the specified time. The routine is accurate enough for most purposes, but does not solve for precise sunrise/sunset times influenced by changes in the orbital parameters between those times. The time input does NOT need to be noon — it is used simply to evaluate the solar declination needed for the daylight duration calculation. In order of preference, time is taken from currTime, if present, or else the currTime of CLOCK, if present, or else the currTime of the ORBIT’s associated clock.

Return the daylight duration in seconds (i.e, the time between sunrise and sunset) for its MAXIMUM at the summer solstice. The routine is accurate enough for most purposes, but does not solve for precise sunrise/sunset times influenced by changes in the orbital parameters between those times. The time input does NOT need to be noon — it is used simply to evaluate the obliquity needed for the maximum daylight duration calculation. In order of preference, time is taken from currTime, if present, or else the currTime of CLOCK, if present, or else the currTime of the ORBIT’s associated clock. Note: Unless ORBIT_ANAL2B, the obliquity is fixed and the time is irrelevant.

Returns the local solar hour angle (in radians) at the single time and multiple longitudes specified. In order of preference, time is taken from TIME, if present, or else the CURRTIME of CLOCK, if present, or else the CURRTIME of the ORBIT’s associated clock.

Integrates the earths orbit and stores the necessary parameters to easily compute the earths position for each day of the full (usually 4-year) intercalation cycle. The orbital parameters are passed as arguments. The full calendar intercalation cycle is obtained from the ESMF clock passed as an argument. This becomes the orbit`s attached clock. Currently we assume a single intercalation.

The function MAPL_SunOrbitCreated returns .true. if the given orbit object has been initilized.

The function MAPL_SunOrbitCreateFromConfig works like MAPL_SunOrbitCreate() but gets orbital parameters from Config CF.

The routine MAPL_SunOrbitDestroy Destroys a GEOS_SunOrbit object, deallocating the space used to save the ephemeris.

Query for quantities in an orbit object. Optionally returns the parameters of the orbit and its associated ESMF_Clock. It fails if the orbit has not been created.

mapping_domain – Determime the indices of the local domain corners with respect to the global domain.

The routine nXYtoVec estimate the X/Y mid-point vectors based on as little data as possible.

The subroutine Orbits_Track calculates the satellite ground track during a given time interval. These calculations are performed using pre-calculated coefficients using combination of coordinate transformations, optimization techniques and mathematical modeling techniques.

The routine parseGridName determines a grid specification based on a string. The string can either be a standardized MAPL grid name (eg DE0180xPC0091, CF0024x6C) or a small number of shorthand options:

ParseTimeUnits – Parse the COARDS time units string

perform_domain_deposition – Perfom the domain decomposition

The routine ReadInput reads the input options file.

The routine readTileFile reads a tile file and stores the relevant data in module variables for later use.

The routine readTileFileNC reads a Tempest NetCDF tile file and stores the relevant data in module variables for later use.