VR-Vantage 3.0.3 API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Macros | Enumerations | Functions
modrad_common.h File Reference

Go to the source code of this file.

Macros

#define CO2ppmv   0.0
#define H2Oscale   1.0
#define O2scale   1.0
#define H2Omax   0.9
#define gamH2O   1.0E-5
#define CO2max   0.0
#define gamCO2   1.0E-5
#define DEFAULT_LOG   (-38.0*log(10.0))

Enumerations

enum  MODRAD_ERRORS {
  MODRAD_SUCCESS, MODRAD_FILE_NOT_FOUND, MODRAD_MEMORY_ALLOCATION_ERROR, MODRAD_FILE_FORMAT_ERROR,
  MODRAD_REGISTRATION_ERROR, MODRAD_FUNCTION_FAILURE, MODRAD_REGISTRATION_OUT_OF_ITEMS, MODRAD_ATTRIBWRITE_ERROR,
  MODRAD_ATTRIBUSER_ERROR
}

Functions

MODRAD_API int InitializeModcard (MODCARD *mc)
MODRAD_API int GetTOAIrradiance (int day, float moonphasedeg, long nlambda, double *lambda, double *solarTOA, double *lunarTOA)
int _stdcall scenv (char *IDIR, char *ODIR, int *ilen, int *olen)
int _stdcall sc1 (char *code, int *model, int *type, int *mode, int *mult, int *m1, int *m2, int *m3, int *m4, int *m5, int *m6, int *mdef, int *im, int *noprnt, float *tbound, float *salb)
int _stdcall sc1a (int *DIS, int *NSTR, int *LSUN, int *ISUN, float *CO2MX, float *SOLCON, char *H2OSTR, char *O3STR, char *SUNFL2)
int _stdcall sc1a1 (char *SUNFL2)
int _stdcall sc1a2 (char *c1a2Bmname)
int _stdcall sc1a3 (char *c1a3Fltnam)
int _stdcall sc2 (char *APLUS, int *IHAZE, char *CNOVAM, int *ISEASN, char *ARUSS, int *IVULCN, int *ICSTL, int *ICLD, int *IVSA, float *VIS, float *WSS, float *WHH, float *RAINRT, float *GNDALT)
int _stdcall sc2a (float *CTHIK, float *CALT, float *CEXT, int *ISEED, int *NCRALT, int *NCRSPC, float *CWAVLN, float *CCOLWD, float *CCOLIP, float *CHUMID, float *ASYMWD, float *ASYMIP)
int _stdcall sc2ap (float *ZAER11, float *ZAER12, float *SCALE1, float *ZAER21, float *ZAER22, float *SCALE2, float *ZAER31, float *ZAER32, float *SCALE3, float *ZAER41, float *ZAER42, float *SCALE4)
int _stdcall sc2b (float *ZCVSA, float *ZTVSA, float *ZINVSA)
int _stdcall sc2c (int *ML, int *IRD1, int *IRD2, char *HMODEL)
int _stdcall sc2c1 (float *C2C1ZM, float *C2C1P, float *C2C1T, float *C2C1WMOL1, float *C2C1WMOL2, float *C2C1WMOL3, char *C2C1JCHAR)
int _stdcall sc2c2 (float *WMOL4, float *WMOL5, float *WMOL6, float *WMOL7, float *WMOL8, float *WMOL9, float *WMOL10, float *WMOL11, float *WMOL12)
int _stdcall sc2c2x (float *WMOLX1, float *WMOLX2, float *WMOLX3, float *WMOLX4, float *WMOLX5, float *WMOLX6, float *WMOLX7, float *WMOLX8, float *WMOLX9, float *WMOLX10, float *WMOLX11, float *WMOLX12, float *WMOLX13)
int _stdcall sc2c3 (int *IHA1, int *ICLD1, int *IVUL1, int *ISEA1, int *ICHR, float *AHAZE1, float *AHAZE2, float *AHAZE3, float *AHAZE4, float *EQLWCZ, float *RRATZ)
int _stdcall sc2d (int *C2DIREG)
int _stdcall sc2d1 (float *C2D1AWCCON, char *C2D1TITLE)
int _stdcall sc2d2 (float *C2D2VARSPC, float *C2D2EXTC, float *C2D2ABSC, float *C2D2ASYM)
int _stdcall sc2e1 (float *ZCLD, float *CLD, float *CLDICE, float *RR)
int _stdcall sc2e2 (float *C2E2WAVLEN, float *C2E2EXTC6, float *C2E2ABSC6, float *C2E2ASYM6, float *C2E2EXTC7, float *C2E2ABSC7, float *C2E2ASYM7)
int _stdcall sc3 (float *H1, float *H2, float *ANGLE, float *RANGE, float *BETA, float *RO, int *LENN, float *PHI, int *IDAY, int *ISOURCE, float *ANGLEM)
int _stdcall sc3a1 (int *IPARM, int *IPH, int *IDAY, int *ISOURC)
int _stdcall sc3a2 (float *PARM1, float *PARM2, float *PARM3, float *PARM4, float *TIME, float *PSIPO, float *ANGLEM, float *G)
int _stdcall sc3b1 (int *C3B1NANGLS, int *C3B1NWLF)
int _stdcall sc3b2 (float *C3B2ANGF, float *C3B2F1, float *C3B2F2, float *C3B2F3, float *C3B2F4)
int _stdcall sc3c (float *C3C1ANGF, float *C3C2WLF, float *C3C36F)
int _stdcall sc4 (float *V1, float *V2, float *DV, float *FWHM, char *YFLAG, char *XFLAG, char *DLIMIT, char *FLAGS)
int _stdcall sc5 (int *IRPT)
int _stdcall scirradangles (int *cIon_off, float *cIsolar_angle, float *cIlunar_angle)
int _stdcall fillprofile ()
int _stdcall driver ()
int _stdcall gxmit (float *AVXMIT)
int _stdcall gptrad (float *RADSUM)
int _stdcall pltdat (int *nPts, float *x, float *y, float *y2, float *ysum, float *y2sum)
int _stdcall putatm (int *nx, float *x, int *nalt, float *alt)
int _stdcall getatm (int *num, float *prd, float *ext, float *psc, float *agd, float *ssa, float *lth)
int _stdcall toairradiance (int *IDAY, float *ANGLE, int *NLAMBDA, float *LAMBDA, float *SOLAR, float *LUNAR)
int _stdcall getprofile (int *nlayers, int *nspecs, float *altkm, float *presmb, float *tempk, float *rfindex, float *dense, int *ncld, float *zcld, float *wat, float *ice, float *rr)
int SetRequiredMOD2ATMFields (char *sigsim_atm_dir, double altlo, EPHEMERIS fm, BAND band, MODCARD *mc)
MODRAD_API void ModSetDefaultSTD (char *sigsim_atm_dir, MODCARD *mc, EPHEMERIS fm, ATM_DEFAULT atm_default)
MODRAD_API void ModSetPlumeShell (char *sigsim_atm_dir, MODCARD *mc, EPHEMERIS fm, ATM_VOL_PROPS atm, double dalt_km)
int TransferData (MODCARD mc)
int AddRadCloudRainLevel (RADCARD *rc, float altkm, float cloud_gm3, float rain_mmhr, float RH_ratio)
float ModCloudBaseAltkm (int CloudType)
float ModCloudThicknesskm (int CloudType)
float ModCloudDensitykmgm3 (int CloudType)
MODRAD_API int UpdateMODCARD (char *sigsim_atm_dir, MODCARD *mc, ATM_DEFAULT *atm_default, EPHEMERIS fm, jrmbool Use_Default)
MODRAD_API int WriteModcard (char *filename, MODCARD *mc)
MODRAD_API int ReadModcard (char *filename, MODCARD *mc)
MODRAD_API int WriteM37Tape5 (char *filename, MODCARD *mc)
MODRAD_API int ConvertModcard2Radcard (MODCARD *mc, RADCARD *rc)
MODRAD_API int ReadM37Tape5 (char *filename, MODCARD *mc)
int _stdcall rcenv (char *IDIR, char *ODIR, int *ilen, int *olen)
int _stdcall rc1 (char *TITLE)
int _stdcall rc2 (int *IRDTRN, int *IATM, int *ISRFC, int *IMS, int *IPLOT, int *NANGLE, int *MODE, int *ITABLE, int *IATTEN, int *IATINC, int *IWF, int *IWFINC, int *IRDH2O, int *NOPR, float *TGRND)
int _stdcall rc3 (float *DIST, float *PHASE, float *FREQ, int *RNRATE, int *TEMP)
int _stdcall rc411 (int *ICNTRL, int *MLEV, char *ATITLE)
int _stdcall rc412 (char *FMT)
int _stdcall rc413 (float *H, float *P, float *T, float *RH, float *CLOUD, float *RAIN)
int _stdcall rc42 (int *MOD, int *MHUMID, int *MCLOUD, int *MRAIN)
int _stdcall rc511 (int *IGRND, int *IEMTAB, float *TEMP1, float *TEMP2)
int _stdcall rc512 (float *A, float *FRAC, float *EB, float *E2DRY, float *DEPDRY)
int _stdcall rc513 (float *A1, float *FS1, float *A2, float *FS2, float *E2WET, float *DEPWET)
int _stdcall rc514 (float *LP, float *LZ, float *MV, float *E2RAN, float *DEPRAN, float *HH, float *DMV)
int _stdcall rc515 (float *VV, float *VB, float *VBW, float *BULK)
int _stdcall rc516 (float *WT, float *GA, float *PO, float *ROCK)
int _stdcall rc517 (float *EM, float *DEL)
int _stdcall rc52 (float *EMISH)
int _stdcall rc53 (float *EMISV)
int _stdcall rc61 (float *EMHMS)
int _stdcall rc62 (float *EMVMS)
int _stdcall rc7 (char *NAME)
int _stdcall rc8 (float *ANGLE)
int _stdcall rc91 (float *VV1, float *VV2, float *DV)
int _stdcall rc92 (int *NFREQ, float *V1, float *V2, float *V3, float *E2R, float *E2I, float *DELF)
int _stdcall rc10 (int *IRPT, int *DOFLAG)
int _stdcall radtran ()
int _stdcall rtextcoef (int *NALT, int *NFREQ, float *ALT, float *FREQ, float *EXTCOEF, float *BT)
int _stdcall rtbright (int *NFREQ, int *NANGLE, float *FREQ, float *ANGLE, float *GAM, float *DSUM, float *UPAT, float *SRFH, float *SRFV, float *USMH, float *USMV, float *MISH, float *MISV)
int _stdcall scatter (float *F_GHZ, float *RR_mmphr, float *T_K, int *PHASE12, int *DIST12, float *SC, int *SCATERR)
int AllocateRadCoef (RADCOEF **rte, RADINFO inf)
int FillRADCOEF (RADINFO *inf, RADCOEF *rte)
void RadSetDefaultSTD (char *sigsim_atm_dir, RADCARD *rc, ATM_DEFAULT atm_default)
int RadTransferData (RADCARD rc)
MODRAD_API int WriteR89Skypar (char *filename, RADCARD *rc)
MODRAD_API int ReadR89Skypar (char *filename, RADCARD *rc)

Macro Definition Documentation

#define CO2ppmv   0.0
#define H2Oscale   1.0
#define O2scale   1.0
#define H2Omax   0.9
#define gamH2O   1.0E-5
#define CO2max   0.0
#define gamCO2   1.0E-5
#define DEFAULT_LOG   (-38.0*log(10.0))

Enumeration Type Documentation

Enumerator:
MODRAD_SUCCESS 
MODRAD_FILE_NOT_FOUND 
MODRAD_MEMORY_ALLOCATION_ERROR 
MODRAD_FILE_FORMAT_ERROR 
MODRAD_REGISTRATION_ERROR 
MODRAD_FUNCTION_FAILURE 
MODRAD_REGISTRATION_OUT_OF_ITEMS 
MODRAD_ATTRIBWRITE_ERROR 
MODRAD_ATTRIBUSER_ERROR 

Function Documentation

MODRAD_API int InitializeModcard ( MODCARD mc)
MODRAD_API int GetTOAIrradiance ( int  day,
float  moonphasedeg,
long  nlambda,
double *  lambda,
double *  solarTOA,
double *  lunarTOA 
)
int _stdcall scenv ( char *  IDIR,
char *  ODIR,
int ilen,
int olen 
)
int _stdcall sc1 ( char *  code,
int model,
int type,
int mode,
int mult,
int m1,
int m2,
int m3,
int m4,
int m5,
int m6,
int mdef,
int im,
int noprnt,
float *  tbound,
float *  salb 
)
int _stdcall sc1a ( int DIS,
int NSTR,
int LSUN,
int ISUN,
float *  CO2MX,
float *  SOLCON,
char *  H2OSTR,
char *  O3STR,
char *  SUNFL2 
)
int _stdcall sc1a1 ( char *  SUNFL2)
int _stdcall sc1a2 ( char *  c1a2Bmname)
int _stdcall sc1a3 ( char *  c1a3Fltnam)
int _stdcall sc2 ( char *  APLUS,
int IHAZE,
char *  CNOVAM,
int ISEASN,
char *  ARUSS,
int IVULCN,
int ICSTL,
int ICLD,
int IVSA,
float *  VIS,
float *  WSS,
float *  WHH,
float *  RAINRT,
float *  GNDALT 
)
int _stdcall sc2a ( float *  CTHIK,
float *  CALT,
float *  CEXT,
int ISEED,
int NCRALT,
int NCRSPC,
float *  CWAVLN,
float *  CCOLWD,
float *  CCOLIP,
float *  CHUMID,
float *  ASYMWD,
float *  ASYMIP 
)
int _stdcall sc2ap ( float *  ZAER11,
float *  ZAER12,
float *  SCALE1,
float *  ZAER21,
float *  ZAER22,
float *  SCALE2,
float *  ZAER31,
float *  ZAER32,
float *  SCALE3,
float *  ZAER41,
float *  ZAER42,
float *  SCALE4 
)
int _stdcall sc2b ( float *  ZCVSA,
float *  ZTVSA,
float *  ZINVSA 
)
int _stdcall sc2c ( int ML,
int IRD1,
int IRD2,
char *  HMODEL 
)
int _stdcall sc2c1 ( float *  C2C1ZM,
float *  C2C1P,
float *  C2C1T,
float *  C2C1WMOL1,
float *  C2C1WMOL2,
float *  C2C1WMOL3,
char *  C2C1JCHAR 
)
int _stdcall sc2c2 ( float *  WMOL4,
float *  WMOL5,
float *  WMOL6,
float *  WMOL7,
float *  WMOL8,
float *  WMOL9,
float *  WMOL10,
float *  WMOL11,
float *  WMOL12 
)
int _stdcall sc2c2x ( float *  WMOLX1,
float *  WMOLX2,
float *  WMOLX3,
float *  WMOLX4,
float *  WMOLX5,
float *  WMOLX6,
float *  WMOLX7,
float *  WMOLX8,
float *  WMOLX9,
float *  WMOLX10,
float *  WMOLX11,
float *  WMOLX12,
float *  WMOLX13 
)
int _stdcall sc2c3 ( int IHA1,
int ICLD1,
int IVUL1,
int ISEA1,
int ICHR,
float *  AHAZE1,
float *  AHAZE2,
float *  AHAZE3,
float *  AHAZE4,
float *  EQLWCZ,
float *  RRATZ 
)
int _stdcall sc2d ( int C2DIREG)
int _stdcall sc2d1 ( float *  C2D1AWCCON,
char *  C2D1TITLE 
)
int _stdcall sc2d2 ( float *  C2D2VARSPC,
float *  C2D2EXTC,
float *  C2D2ABSC,
float *  C2D2ASYM 
)
int _stdcall sc2e1 ( float *  ZCLD,
float *  CLD,
float *  CLDICE,
float *  RR 
)
int _stdcall sc2e2 ( float *  C2E2WAVLEN,
float *  C2E2EXTC6,
float *  C2E2ABSC6,
float *  C2E2ASYM6,
float *  C2E2EXTC7,
float *  C2E2ABSC7,
float *  C2E2ASYM7 
)
int _stdcall sc3 ( float *  H1,
float *  H2,
float *  ANGLE,
float *  RANGE,
float *  BETA,
float *  RO,
int LENN,
float *  PHI,
int IDAY,
int ISOURCE,
float *  ANGLEM 
)
int _stdcall sc3a1 ( int IPARM,
int IPH,
int IDAY,
int ISOURC 
)
int _stdcall sc3a2 ( float *  PARM1,
float *  PARM2,
float *  PARM3,
float *  PARM4,
float *  TIME,
float *  PSIPO,
float *  ANGLEM,
float *  G 
)
int _stdcall sc3b1 ( int C3B1NANGLS,
int C3B1NWLF 
)
int _stdcall sc3b2 ( float *  C3B2ANGF,
float *  C3B2F1,
float *  C3B2F2,
float *  C3B2F3,
float *  C3B2F4 
)
int _stdcall sc3c ( float *  C3C1ANGF,
float *  C3C2WLF,
float *  C3C36F 
)
int _stdcall sc4 ( float *  V1,
float *  V2,
float *  DV,
float *  FWHM,
char *  YFLAG,
char *  XFLAG,
char *  DLIMIT,
char *  FLAGS 
)
int _stdcall sc5 ( int IRPT)
int _stdcall scirradangles ( int cIon_off,
float *  cIsolar_angle,
float *  cIlunar_angle 
)
int _stdcall fillprofile ( )
int _stdcall driver ( )
int _stdcall gxmit ( float *  AVXMIT)
int _stdcall gptrad ( float *  RADSUM)
int _stdcall pltdat ( int nPts,
float *  x,
float *  y,
float *  y2,
float *  ysum,
float *  y2sum 
)
int _stdcall putatm ( int nx,
float *  x,
int nalt,
float *  alt 
)
int _stdcall getatm ( int num,
float *  prd,
float *  ext,
float *  psc,
float *  agd,
float *  ssa,
float *  lth 
)
int _stdcall toairradiance ( int IDAY,
float *  ANGLE,
int NLAMBDA,
float *  LAMBDA,
float *  SOLAR,
float *  LUNAR 
)
int _stdcall getprofile ( int nlayers,
int nspecs,
float *  altkm,
float *  presmb,
float *  tempk,
float *  rfindex,
float *  dense,
int ncld,
float *  zcld,
float *  wat,
float *  ice,
float *  rr 
)
int SetRequiredMOD2ATMFields ( char *  sigsim_atm_dir,
double  altlo,
EPHEMERIS  fm,
BAND  band,
MODCARD mc 
)
MODRAD_API void ModSetDefaultSTD ( char *  sigsim_atm_dir,
MODCARD mc,
EPHEMERIS  fm,
ATM_DEFAULT  atm_default 
)
MODRAD_API void ModSetPlumeShell ( char *  sigsim_atm_dir,
MODCARD mc,
EPHEMERIS  fm,
ATM_VOL_PROPS  atm,
double  dalt_km 
)
int TransferData ( MODCARD  mc)
int AddRadCloudRainLevel ( RADCARD rc,
float  altkm,
float  cloud_gm3,
float  rain_mmhr,
float  RH_ratio 
)
float ModCloudBaseAltkm ( int  CloudType)
float ModCloudThicknesskm ( int  CloudType)
float ModCloudDensitykmgm3 ( int  CloudType)
MODRAD_API int UpdateMODCARD ( char *  sigsim_atm_dir,
MODCARD mc,
ATM_DEFAULT atm_default,
EPHEMERIS  fm,
jrmbool  Use_Default 
)
MODRAD_API int WriteModcard ( char *  filename,
MODCARD mc 
)
MODRAD_API int ReadModcard ( char *  filename,
MODCARD mc 
)
MODRAD_API int WriteM37Tape5 ( char *  filename,
MODCARD mc 
)
MODRAD_API int ConvertModcard2Radcard ( MODCARD mc,
RADCARD rc 
)
MODRAD_API int ReadM37Tape5 ( char *  filename,
MODCARD mc 
)
int _stdcall rcenv ( char *  IDIR,
char *  ODIR,
int ilen,
int olen 
)
int _stdcall rc1 ( char *  TITLE)
int _stdcall rc2 ( int IRDTRN,
int IATM,
int ISRFC,
int IMS,
int IPLOT,
int NANGLE,
int MODE,
int ITABLE,
int IATTEN,
int IATINC,
int IWF,
int IWFINC,
int IRDH2O,
int NOPR,
float *  TGRND 
)
int _stdcall rc3 ( float *  DIST,
float *  PHASE,
float *  FREQ,
int RNRATE,
int TEMP 
)
int _stdcall rc411 ( int ICNTRL,
int MLEV,
char *  ATITLE 
)
int _stdcall rc412 ( char *  FMT)
int _stdcall rc413 ( float *  H,
float *  P,
float *  T,
float *  RH,
float *  CLOUD,
float *  RAIN 
)
int _stdcall rc42 ( int MOD,
int MHUMID,
int MCLOUD,
int MRAIN 
)
int _stdcall rc511 ( int IGRND,
int IEMTAB,
float *  TEMP1,
float *  TEMP2 
)
int _stdcall rc512 ( float *  A,
float *  FRAC,
float *  EB,
float *  E2DRY,
float *  DEPDRY 
)
int _stdcall rc513 ( float *  A1,
float *  FS1,
float *  A2,
float *  FS2,
float *  E2WET,
float *  DEPWET 
)
int _stdcall rc514 ( float *  LP,
float *  LZ,
float *  MV,
float *  E2RAN,
float *  DEPRAN,
float *  HH,
float *  DMV 
)
int _stdcall rc515 ( float *  VV,
float *  VB,
float *  VBW,
float *  BULK 
)
int _stdcall rc516 ( float *  WT,
float *  GA,
float *  PO,
float *  ROCK 
)
int _stdcall rc517 ( float *  EM,
float *  DEL 
)
int _stdcall rc52 ( float *  EMISH)
int _stdcall rc53 ( float *  EMISV)
int _stdcall rc61 ( float *  EMHMS)
int _stdcall rc62 ( float *  EMVMS)
int _stdcall rc7 ( char *  NAME)
int _stdcall rc8 ( float *  ANGLE)
int _stdcall rc91 ( float *  VV1,
float *  VV2,
float *  DV 
)
int _stdcall rc92 ( int NFREQ,
float *  V1,
float *  V2,
float *  V3,
float *  E2R,
float *  E2I,
float *  DELF 
)
int _stdcall rc10 ( int IRPT,
int DOFLAG 
)
int _stdcall radtran ( )
int _stdcall rtextcoef ( int NALT,
int NFREQ,
float *  ALT,
float *  FREQ,
float *  EXTCOEF,
float *  BT 
)
int _stdcall rtbright ( int NFREQ,
int NANGLE,
float *  FREQ,
float *  ANGLE,
float *  GAM,
float *  DSUM,
float *  UPAT,
float *  SRFH,
float *  SRFV,
float *  USMH,
float *  USMV,
float *  MISH,
float *  MISV 
)
int _stdcall scatter ( float *  F_GHZ,
float *  RR_mmphr,
float *  T_K,
int PHASE12,
int DIST12,
float *  SC,
int SCATERR 
)
int AllocateRadCoef ( RADCOEF **  rte,
RADINFO  inf 
)
int FillRADCOEF ( RADINFO inf,
RADCOEF rte 
)
void RadSetDefaultSTD ( char *  sigsim_atm_dir,
RADCARD rc,
ATM_DEFAULT  atm_default 
)
int RadTransferData ( RADCARD  rc)
MODRAD_API int WriteR89Skypar ( char *  filename,
RADCARD rc 
)
MODRAD_API int ReadR89Skypar ( char *  filename,
RADCARD rc 
)


Copyright © 2005-2023 MAK Technologies. All Rights Reserved (www.mak.com)