apiGRDPUtils.h

Go to the documentation of this file.

/****************************************************************************
 *
 * Pointwise Plugin utility functions
 *
 * (C) 2021 Cadence Design Systems, Inc. All rights reserved worldwide.
 *
 ***************************************************************************/
 
#ifndef _APIGRDPUTILS_H_
#define _APIGRDPUTILS_H_
 
#include <stdio.h>
#include <time.h>
 
#include "apiGRDP.h"
#include "apiPWP.h"
#include "apiPWPUtils.h"
#include "apiGridModel.h"
 
extern "C" {
 
/************************************************************************/
// include impl-defined instance runtime data types.
// Must also define the macro GRDP_RUNTIME_INSTDATADECL
#include "rtGrdpInstanceData.h"
 
#if !defined(GRDP_RUNTIME_INSTDATADECL)
#   define GRDP_RUNTIME_INSTDATADECL
#endif
 
 
/***********************************************************/
/***********************************************************/
//***************************************************************************
//***************************************************************************
enum GRDP_ENUM_CLOCKS {
    GRDP_CLKS_PROGUPDATE, 
    GRDP_CLKS_PROGINIT,   
    GRDP_CLKS_BEGSTEP,    
    GRDP_CLKS_PROGINCR,   
    GRDP_CLKS_ENDSTEP,    
    GRDP_CLKS_PROGEND,    
    /* add new group enum values before this line */
 
    GRDP_CLKS_SIZE,
    GRDP_CLKS_LAST = GRDP_CLKS_SIZE-1
 // sdkINTERNALS
};
 
 
/************************************************************************/
struct GRDP_RTITEM {
    GRDP_FORMATINFO         FormatInfo;
 
    PWU_RTITEM *            pApiData;
 
    FILE *                  fp;
 
    PWU_UNFDATA             unfData;
 
    PWGM_HGRIDMODEL         model;
 
    const GRDP_READINFO *   pReadInfo;
 
 
    PWP_UINT32              progTotal;
 
    PWP_UINT32              progComplete;
 
    clock_t                 clocks[GRDP_CLKS_SIZE];
 
    PWP_BOOL                opAborted;
 // sdkINTERNALS
 
    GRDP_RUNTIME_INSTDATADECL
};
 
 
/************************************************************************/
extern GRDP_RTITEM grdpRtItem[];
 
 
/************************************************************************/
extern PWP_UINT32 grdpFormatCnt;
 /* DOXGRP_APIGRDP_UTILS_DATA */
 
 
 
//***************************************************************************
//***************************************************************************
/************************************************************************/
GRDP_RTITEM* grdpFindFormatById (PWP_UINT32 id);
 
 
/************************************************************************/
GRDP_RTITEM* grdpFindFormatByName (const char name[]);
 /* DOXGRP_APIGRDP_UTILS_SDKGRDP */
 
 
 
//***************************************************************************
//***************************************************************************
/************************************************************************/
PWP_BOOL grdpProgressInit(GRDP_RTITEM *pRti, PWP_UINT32 cnt);
 
 
/************************************************************************/
PWP_BOOL grdpProgressBeginStep(GRDP_RTITEM *pRti, PWP_UINT32 total);
 
 
/************************************************************************/
PWP_BOOL grdpProgressIncr(GRDP_RTITEM *pRti);
 
 
/************************************************************************/
PWP_BOOL grdpProgressEndStep(GRDP_RTITEM *pRti);
 
 
/************************************************************************/
PWP_BOOL grdpProgressEnd(GRDP_RTITEM *pRti, const PWP_BOOL ok);
 /* DOXGRP_APIGRDP_UTILS_PROGRESS */
 
 
//***************************************************************************
//***************************************************************************
//-------------------------------------------------------------------------
void grdpSendDebugMsg (GRDP_RTITEM* pRti, const char txt[], PWP_UINT32 code);
 
//-------------------------------------------------------------------------
void grdpSendInfoMsg (GRDP_RTITEM* pRti, const char txt[], PWP_UINT32 code);
 
//-------------------------------------------------------------------------
void grdpSendWarningMsg (GRDP_RTITEM* pRti, const char txt[], PWP_UINT32 code);
 
//-------------------------------------------------------------------------
void grdpSendErrorMsg (GRDP_RTITEM* pRti, const char txt[], PWP_UINT32 code);
 /* DOXGRP_APIGRDP_UTILS_MSGS */
 
 
//***************************************************************************
//***************************************************************************
//-------------------------------------------------------------------------
PWP_BOOL grdpPublishValueDefinition(const char name[], PWP_ENUM_VALTYPE type,
    const char value[], const char access[], const char desc[],
    const char range[]);
 
 
//-------------------------------------------------------------------------
PWP_BOOL grdpAssignInfoValue(const char name[], const char value[],
            const bool create = true);
 
 
//-------------------------------------------------------------------------
PWP_BOOL grdpAssignInfoValueInt(const char name[], const PWP_INT value,
            const bool create = true);
 
 
//-------------------------------------------------------------------------
PWP_BOOL grdpAssignInfoValueUInt(const char name[], const PWP_UINT value,
            const bool create = true);
 
 
//-------------------------------------------------------------------------
PWP_BOOL grdpAssignInfoValueReal(const char name[], const PWP_REAL value,
            const bool create = true);
 
 
//-------------------------------------------------------------------------
PWP_BOOL grdpAssignInfoValueBool(const char name[], const bool value,
            const bool create = true);
 
 
//-------------------------------------------------------------------------
PWP_BOOL grdpAssignInfoValueEnum(const char name[], const char value[],
            bool create = true);
 /* DOXGRP_APIGRDP_UTILS_VARS */
 
 
//***************************************************************************
//***************************************************************************
/************************************************************************/
#define GRDP_RT_IMPORT_CONDITIONS(rti)       (rti)->pReadInfo->importConditions
 
 
/************************************************************************/
#define GRDP_RT_IS_ABORTED(rti)    PWP_CAST_BOOL((rti)->opAborted)
 
/************************************************************************/
#define GRDP_RT_ABORT(rti)    ((rti)->opAborted = PWP_TRUE)
 
/************************************************************************/
#define GRDP_IS_CLKS_ID(id) \
            PWP_CAST_BOOL(((id) >= 0) && ((id) <= GRDP_CLKS_LAST))
 
/************************************************************************/
#define GRDP_RT_CLKS_ID(rti, id) (GRDP_IS_CLKS_ID(id)? (rti)->clocks[id]: 0)
 
/************************************************************************/
#define GRDP_RT_CLKS_DIFF(rti, startId, endId) \
    ((GRDP_IS_CLKS_ID(startId) && GRDP_IS_CLKS_ID(endId)) ? \
        ((rti)->clocks[endId] - (rti)->clocks[startId]) : 0)
 
/************************************************************************/
#define GRDP_RT_CLKS_POLL(rti, id) \
            GRDP_RT_CLKS_DIFF(rti, id, GRDP_CLKS_PROGINCR)
 
/************************************************************************/
#define GRDP_RT_CLKS_POLL_STEP(rti) \
            GRDP_RT_CLKS_POLL(rti, GRDP_CLKS_BEGSTEP)
 
/************************************************************************/
#define GRDP_RT_CLKS_DIFF_STEP(rti) \
            GRDP_RT_CLKS_DIFF(rti, GRDP_CLKS_BEGSTEP, GRDP_CLKS_ENDSTEP)
 
/************************************************************************/
#define GRDP_RT_CLKS_POLL_TOTAL(rti) \
            GRDP_RT_CLKS_POLL(rti, GRDP_CLKS_PROGINIT)
 
/************************************************************************/
#define GRDP_RT_CLKS_DIFF_TOTAL(rti) \
            GRDP_RT_CLKS_DIFF(rti, GRDP_CLKS_PROGINIT, GRDP_CLKS_PROGEND)
 
/************************************************************************/
#define GRDP_CLKS_TO_MSECS(c) ((PWP_INT32)((c) * 1000) / CLOCKS_PER_SEC)
 
/************************************************************************/
#define GRDP_CLKS_TO_SECS(c) ((PWP_INT32)(c) / CLOCKS_PER_SEC)
 
/************************************************************************/
#define GRDP_CLKS_TO_MINS(c) (GRDP_CLKS_TO_SECS(c) / 60)
 
/************************************************************************/
#define GRDP_CLKS_TO_HOURS(c) (GRDP_CLKS_TO_MINS(c) / 60)
 
/************************************************************************/
#define GRDP_CLKS_TO_HMS(c, h, m, s) \
            (s = GRDP_CLKS_TO_SECS(c)), \
            (h = s / 3600), (s -= h * 3600), \
            (m = s / 60), \
            (s -= m * 60)
 
/************************************************************************/
#define GRDP_CLKS_TO_FSECS(c) ((PWP_FLOAT)(c) / (PWP_FLOAT)CLOCKS_PER_SEC)
 
} /* extern "C" */
 
#endif  /* _APIGRDPUTILS_H_ */