<< prev file | next file >>    view single page | view frames    summary: fields | routine    details: routine

ToBeReviewed/UTILITAIRE/

fitintobox.pro

Routine summary

result = err_mess(sz, jpi, nx, jpj, ny, jpk, nz, jpt)

NAME:fitintobox PURPOSE: check that the input array has size and dimensions compatible with the domain that was defined with the previous call of domdef.

result = fitintobox(field, nx, ny, nz, firstx, firsty, firstz, lastx, lasty, lastz, WDEPTH=WDEPTH)

toperr_mess

result = err_mess(sz, jpi, nx, jpj, ny, jpk, nz, jpt)

NAME:fitintobox PURPOSE: check that the input array has size and dimensions compatible with the domain that was defined with the previous call of domdef. CATEGORY: domain compatibility CALLING SEQUENCE: res = fitintobox(field[, nx, ny, nz, firstx, firsty, firstz , lastx, lasty, lastz]) INPUTS: field: an array or a structure that can be read by the function litchamp.pro nx, ny, nz, firstx, firsty, firstz, lastx, lasty, lastz: optional parameters. If not given they will be define with a call to the procedure grille.pro KEYWORD PARAMETERS: none OUTPUTS: an array with dimensions matching the domain or -1 if there is an error... COMMON BLOCKS: cm_4mesh and cm_4cal SIDE EFFECTS: RESTRICTIONS: EXAMPLE: IDL> help, fitintobox(findgen(jpi,jpj)) FLOAT = Array[41, 3] IDL> help, fitintobox(findgen(jpi,jpj,78)) Error: the array dimensions [180,148,78] are incompatible with the the domain dimensions [jpi/nx, jpj/ny, jpk/nz, jpt] = [180/41, 148/3, 31/31, 1] INT = -1

Parameters

sz       

jpi       

nx       

jpj       

ny       

jpk       

nz       

jpt       

topfitintobox

result = fitintobox(field, nx, ny, nz, firstx, firsty, firstz, lastx, lasty, lastz, WDEPTH=WDEPTH)

Parameters

field       

nx       

ny       

nz       

firstx       

firsty       

firstz       

lastx       

lasty       

lastz       

Keywords

WDEPTH       

Produced by IDLdoc 2.0.