UCVM API

From SCECpedia
Revision as of 23:06, 20 April 2011 by Patrices (talk | contribs)
Jump to navigationJump to search

Overview

The Unified California Velocity Model API (UCVM API) is a programming interface that allows the user to directly query multiple velocity models in a program. The API currently support these models:

  • CVM-S
  • CVM-H
  • USGS Central California
  • Hadley-Kanamori 1D
  • Lin Thurber CVM California Statewide
  • Rob Graves Cape Mendocino
  • Any user-defined model that can be encapsulated in a C header and source/library file

Notes:

  • MPI-capable, has been shown to scale to 2100 cores on NCCS Jaguar in a mesh generator.
  • Allows application programs to tailor which set of CVMs are linked in to minimize memory footprint.
  • API is currently a prototype C interface.
  • Compatible with grid resources that have data stage-in policies for jobs, such as USC HPCC, and light-weight kernels that support static libraries only, such as NCCS Jaguar and NICS Kraken.
  • Tested on NCCS Jaguar and USC HPCC.

Significant science issues remain to be resolved. Please see the Science Issues section below.

Data Types and Definitions

The following data types are defined in the API (/include/ucvm_dtypes.h): 

/* Maximum number of supported models */
#define UCVM_MAX_MODELS 10

/* Maximum projection description length */
#define UCVM_MAX_PROJ_LEN 256

/* Maximum model label length */
#define UCVM_MAX_LABEL_LEN 64

/* Maximum model version length */
#define UCVM_MAX_VERSION_LEN 64

/* Maximum path length */
#define UCVM_MAX_PATH_LEN 256

/* NO CVM flag */
#define UCVM_MODEL_NONE -1

/* Supported error codes */
typedef enum { UCVM_CODE_SUCCESS = 0, 
               UCVM_CODE_ERROR,
               UCVM_CODE_DATAGAP,
               UCVM_CODE_NODATA} ucvm_code_t;

/* Supported coordinate query modes */
typedef enum { UCVM_COORD_GEO_DEPTH = 0, 
               UCVM_COORD_UTM_DEPTH,
               UCVM_COORD_GEO_ELEV,
               UCVM_COORD_UTM_ELEV } ucvm_ctype_t;

/* Supported grid types */
typedef enum { UCVM_GRID_CELL_CENTER = 0, 
               UCVM_GRID_CELL_VERTEX} ucvm_gtype_t;

/* 3D point */
typedef struct ucvm_point_t 
{
  double coord[3];
} ucvm_point_t;

/* 3D dims */
typedef struct ucvm_dim_t 
{
  int dim[3];
} ucvm_dim_t;

/* Material properties */
typedef struct ucvm_prop_t 
{
  int model;
  double vp;
  double vs;
  double rho;
} ucvm_prop_t;

/* Region box */
typedef struct ucvm_region_t 
{
  ucvm_ctype_t cmode;
  double p1[3];
  double p2[3];
} ucvm_region_t;

/* Projection */
typedef struct ucvm_proj_t 
{
  char proj[UCVM_MAX_PROJ_LEN];
} ucvm_proj_t;

/* Projection transformation */
typedef struct ucvm_trans_t 
{
  double origin[3];
  double rotate;
  double translate[3];
  ucvm_gtype_t gtype;
} ucvm_trans_t;

/* Model */
typedef struct ucvm_model_t 
{
  char label[UCVM_MAX_LABEL_LEN];
  ucvm_region_t region;
  char config[UCVM_MAX_PATH_LEN];
  int (*init)(int id, ucvm_region_t *r, const char *config);
  int (*finalize)();
  const char* (*version)();
  int (*query)(ucvm_ctype_t cmode,
               int n, ucvm_point_t *pnt, 
               ucvm_prop_t *prop);
} ucvm_model_t;


UCVM Interface

UCVM provides an interface for querying Vp, Vs, and rho from any user-defined model. Models are described by the ucvm_model_t structure. Pre-defined models are defined for CVM-S, CVM-H, CenCal, and 1D to allow the programmer to easily use these velocity models. These models may be enabled by calling ucvm_add_model() with their string identifier. 

/* Predefined models */
#define UCVM_MODEL_CVMH "cvmh"
#define UCVM_MODEL_CVMS "cvms"
#define UCVM_MODEL_CENCAL "cencalvm"
#define UCVM_MODEL_1D "1d"

/* Initializer */
int ucvm_init(const char *config);

/* Finalizer */
int ucvm_finalize();

/* Set query mode */
int ucvm_query_mode(ucvm_ctype_t c);

/* Enable specific model, by label or by ucvm_model_t */
int ucvm_add_model(const char *label);
int ucvm_add_user_model(ucvm_model_t *m);

/* Get label for a model */
int ucvm_model_label(int m, char *label, int len);

/* Get version for a model */
int ucvm_model_version(int m, char *ver, int len);

/* Query underlying models */
int ucvm_query(int n, ucvm_point_t *pnt, ucvm_prop_t *prop);

The programmer may also define their own models and integrate them into UCVM. A user model is defined by creating the init(), finalize(), version(), and query() functions for the model, and populating the ucvm_model_t structure with these function pointers and some additional record keeping information. Once a model is fully described in a ucvm_model_t, it can be registered for use with the ucvm_add_user_model() function and queried with the ucvm_query() function.

Multiple models may be registered, and they are queried in order of registration.


UCVM Grid Interface

Provides an interface for generating 2D regular grids in any USGS map projection. 

/* Generate grid from projection and dimensions */
int ucvm_grid_gen(ucvm_proj_t *iproj, ucvm_trans_t *trans,
                  ucvm_proj_t *oproj,
                  ucvm_dim_t *dims, double spacing, 
                  ucvm_point_t *pnts);

/* Generate grid from projection and dimensions */
int ucvm_grid_gen_file(ucvm_proj_t *iproj, ucvm_trans_t *trans,
                       ucvm_proj_t *oproj,
                       ucvm_dim_t *dims, double spacing, 
                       const char *filename);

/* Convert point list from one projection to another */
int ucvm_grid_convert(ucvm_proj_t *iproj, 
                      ucvm_proj_t *oproj, 
                      size_t n, ucvm_point_t *pnts);

/* Convert point list from one projection to another */
int ucvm_grid_convert_file(ucvm_proj_t *iproj, 
                           ucvm_proj_t *oproj, 
                           size_t n, const char *filename);


Example Usage of API

The following code snippet illustrates how the API is used: 

  int nn = 1;
  ucvm_point_t pnt1;
  ucvm_prop_t prop1;
  
  printf("Init\n");
  if (ucvm_init("./ucvm.conf") != UCVM_CODE_SUCCESS) {
    fprintf(stderr, "Init failed\n");
    return(1);
  }
  
  printf("Query Mode\n");
  if (ucvm_query_mode(UCVM_COORD_GEO_DEPTH) != UCVM_CODE_SUCCESS) {
    fprintf(stderr, "Set query mode failed\n");
    return(1);
  }
  
  printf("Add Model CVM-S\n");
  if (ucvm_add_model(UCVM_MODEL_CVMS) != UCVM_CODE_SUCCESS) {
    fprintf(stderr, "Retrieval of CVM-S failed\n");
    return(1);
  }

  printf("Create point\n");
  pnt1.coord[0] = -119.0;
  pnt1.coord[1] = 31.0;
  pnt1.coord[2] = 2000.0;

  printf("Query Model\n");
  if (ucvm_query(nn, &pnt1, &prop1) != UCVM_CODE_SUCCESS) {
    fprintf(stderr, "Query CVM failed\n");
    return(1);
  }
 
  printf("Results\n");
  printf("model=%d, vp=%lf, vs=%lf, rho=%lf\n",
         prop1.model, prop1.vp, prop1.vs, prop1.rho);


Source Code

The UCVM source and cvm2mesh mesh generator may be checked out from SVN with these commands: 

UCVM: svn co https://source.usc.edu/svn/ucvm/trunk

cvm2mesh: svn co https://source.usc.edu/svn/cvm2mesh/trunk


Implementation Details

  • Models are queried in the order they are enabled in the interface. The material properties for a particular (lon,lat) point are from the first model in the ordered list to return valid values.
  • Only lon,lat,dep coordinates are currently supported
  • No smoothing between models is performed. They are simply tiled.
  • Projections are performed with the Proj.4 package
  • Depth is defined as the offset from the free surface (ground-air interface, ground-water interface) in meters, positive down. Negative depths are not supported.


Future Improvements

  • Addition of a high resolution state-wide DEM to allow query by elevation
  • Addition of other regional models
  • Addition of one or more GTLs
  • Bindings for Fortran, C++

GTL Support

Datatypes

Add new ucvm_data_t structure and definitions as follows: 

#define UCVM_GTL_VS30 "vs30"

/* Interpolation functions */
typedef enum { UCVM_FUNC_NONE = 0, 
               UCVM_FUNC_CUBIC } ucvm_ifunc_t;

/* Data payload */
typedef struct ucvm_data_t 
{
  ucvm_prop_t vel;
  ucvm_prop_t gtl;
  ucvm_prop_t interp;
} ucvm_data_t;

Redefine ucvm_model_t structure as follows (employs variable argument va_arg interface, stdarg.h): 

typedef struct ucvm_model_t 
{
  char label[UCVM_MAX_LABEL_LEN];
  ucvm_region_t region;
  char config[UCVM_MAX_PATH_LEN];
  int (*init)(int id, ucvm_region_t *r, const char *config);
  int (*finalize)();
  const char* (*version)();
  int (*setparam)(int flag, ...);
  int (*query)(ucvm_ctype_t cmode,
               int n, ucvm_point_t *pnt, 
               ucvm_prop_t *prop);
} ucvm_model_t;

Functions

Add new functions to ucvm.h/ucvm.c: 

/* Enable specific GTL, by label or by ucvm_model_t */
int ucvm_add_gtl(const char *label);
int ucvm_add_user_gtl(ucvm_model_t *m);

/* Setup interpolation parameters */
int ucvm_set_interp_depth(double upper, double lower);
int ucvm_set_interp_func(ucvm_ifunc_t ifunc, ...);

Modify existing function ucvm_query() in ucvm.h/ucvm.c: 

/* Query underlying models */
int ucvm_query(int n, ucvm_point_t *pnt, ucvm_data_t *data);

Add new function to every model and gtl defined in UCVM: 

/* Set parameter or flag */
int ucvm_mname_model_setparam(int flag, ...);

/* That recognizes:
 flag=UCVM_PARAM_MIN_DEPTH, double argument that is minimum depth
 flag=UCVM_PARAM_MAX_DEPTH, double argument that is maximum depth 
*/


Science Issues

Overlapping Models

Imagine the scenario outlined below, where the user wishes to combine two models, a SoCal model and a NoCal model:

State-wide-Overlapping-Models.png

The models may overlap in ways which makes merging them difficult.

  • For a point that falls within the Kern County region, simply interpolating between the two models may not work if NoCal reports water properties (vp, rho, no vs) and the SoCal model reports soil/rock. No interpolation is possible in this case. To deal with this situation, there are several options:
    • Coordinate edits to each model to bring their material properties into better agreement within the overlap region.
    • Crop one or both models to remove the overlap, and smooth them into the California background model.
    • Create a new “Transition Model” that covers Kern County and surrounding area that interpolates/averages the the two other models in a scientifically acceptable way. Register this new model in the API, and give it priority over the other two models. In effect, tile the Transition Model, the NoCal Model, and the SoCal Model.
    • Allow the models to overlap with discontinuities. This is currently how the UCVM API handles overlap.


Projection Distortion

Several issues with map projections come into play:

  • Distortion in projections on large scales. Any state-wide model that supports querying by UTM or other projection coordinates must account for and minimize distortion.
  • Inconsistent handling of projections within models. Each model generally has its own internal projection. For example, CVM-H uses a UTM projection. The projection codes used across all models should be standardized on the Proj.4 projection package to avoid small differences in the handling of coordinates. This may require resampling of the data inside the models.


Standardized Handling of Elevation

All models that support query by elevation should use a standard DEM derived from the same source.


GTL

If a state-wide GTL is developed, the GTL within each underlying model must be stripped away.

Retrieved from "https://strike.scec.org/scecwiki/index.php?title=UCVM_API&oldid=2557"