cstr/runtimeWrite.cxx

Go to the documentation of this file.

/****************************************************************************
 *
 * CaeXxxxx implementation of runtimeWrite(), runtimeCreate(), and
 * runtimeDestroy()
 *
 * (C) 2021 Cadence Design Systems, Inc. All rights reserved worldwide.
 *
 ***************************************************************************/
 
#include "apiCAEP.h"
#include "apiCAEPUtils.h"
#include "apiGridModel.h"
#include "apiPWP.h"
#include "runtimeWrite.h"
#include "pwpPlatform.h"
 
 
#if 0
static void
stepN(CAEP_RTITEM *pRti)
{
    PWP_UINT32 cnt = 1; /* the # of MINOR progress sub-steps */
    if (caeuProgressBeginStep(pRti, cnt)) {
        while (cnt--) {
            /*
            // PUT YOUR SUB-STEP OUTPUT LOGIC HERE
            */
            /* incr to next sub-step */
            caeuProgressIncr(pRti);
        }
        caeuProgressEndStep(pRti);
    }
}
#endif
 
 
PWP_BOOL
runtimeWrite(CAEP_RTITEM *pRti, PWGM_HGRIDMODEL, const CAEP_WRITEINFO *)
{
    // The PWGM_HGRIDMODEL and CAEP_WRITEINFO function arguments are deprecated.
    // The use of pRti->model and pRti->pWriteInfo is now preferred.
    // The grid model data is accessed via pRti->model.
    // The user or Glyph specified export options are available directly via
    // pRti->pWriteInfo or using one of the CAEPU_RT_XXXX(pRti) macros.
 
    PWP_BOOL ret = PWP_FALSE;
    PWP_UINT32 cnt = 1; // the # of MAJOR progress steps
    if (caeuProgressInit(pRti, cnt)) {
        // PUT YOUR MAJOR-STEP OUTPUT LOGIC HERE
        //step1(pRti);
        //step2(pRti);
        //...
        //stepN(pRti);
        caeuProgressEnd(pRti, ret);
        ret = !pRti->opAborted;
    }
 
    return ret;
}
 
 
PWP_BOOL
runtimeCreate(CAEP_RTITEM * /*pRti*/)
{
    PWP_BOOL ret = PWP_TRUE;
 
    //-----------------------------------------------------------------------
    // BYTE ORDERING:
    //   Uncomment the appropriate lines below to control the byte ordering
    //   options supported by the solver. If "AllowedFileByteOrders" is not
    //   set, the plugin will use the platform's native byte ordering.
    //   Currently, Pointwise only runs on little endian, intel platforms. If
    //   the solver targeted by this plugin cannot import little endian files,
    //   you must force big endian export.
    //-----------------------------------------------------------------------
    //const char * orders = "BigEndian"; // force big endian export
    //const char * orders = "LittleEndian"; // force little endian export
    //const char * orders = "BigEndian|LittleEndian";  // support both
    //ret = ret && caeuAssignInfoValue("AllowedFileByteOrders", orders, true);
 
    //-----------------------------------------------------------------------
    // ELEMENT TOPOLOGY:
    //   Uncomment the lines below and edit the topos[] value to explicitly
    //   control the element topology options supported by the solver. If 
    //   "AllowedElementTopologies" is not set, the allowed element topologies
    //   will be inferred from the supported element types.
    //-----------------------------------------------------------------------
    //const char topos[] = "Structured|Unstructured|Prismatic";
    //ret = ret && caeuAssignInfoValue("AllowedElementTopologies", topos, true);
 
    //-----------------------------------------------------------------------
    // NON-INFLATED BC TYPE NAMES:
    //   Uncomment the lines below and edit the shadowTypes[] value to
    //   specify which of the defined BCs types are non-inflated. Normally, if a
    //   BC is applied to a floating baffle domain, or block-to-block connection
    //   domain, the interior points are "inflated" to create a zero thickness
    //   wall. However, if a non-inflated BC is used, the points are NOT
    //   inflated. These BC types are often used for flow-through or porous
    //   conditions.
    //-----------------------------------------------------------------------
    //const char * const shadowTypes = "bcname1|bcname2";
    //ret = ret && caeuassigninfovalue("ShadowBcTypes", shadowTypes, true);
 
    // These attributes are for example only. You can publish any attribute
    // needed for your solver.
    //ret = ret &&
    //      caeuPublishValueDefinition("iterations", PWP_VALTYPE_UINT, "5",
    //          "RW", "Number of iterations", "0 2000") &&
    //      caeuPublishValueDefinition("magnitude", PWP_VALTYPE_INT, "-5",
    //          "RW", "Signed int magnitude", "-100 100") &&
    //      caeuPublishValueDefinition("mach", PWP_VALTYPE_REAL, "0.3", "RW",
    //          "Incoming flow velocity", "-Inf +Inf 0.0 50.0") &&
    //      caeuPublishValueDefinition("temperature", PWP_VALTYPE_REAL, "77.5",
    //          "RW", "Ambient temperature", "-Inf +Inf -100.0 3000.0") &&
    //      caeuPublishValueDefinition("temperature.units", PWP_VALTYPE_ENUM,
    //          "Fahrenheit", "RW", "Grid temperature units", TempUnitEnum) &&
    //      caeuPublishValueDefinition("units", PWP_VALTYPE_ENUM, "Inches",
    //          "RW", "Grid dimensional units", DimUnitEnum) &&
    //      caeuPublishValueDefinition("description", PWP_VALTYPE_STRING, "",
    //          "RW", "Grid description", "") &&
    //      caeuPublishValueDefinition("linear", PWP_VALTYPE_BOOL, "reject",
    //          "RW", "Grid is linear", "reject|accept");
 
    return ret;
}
 
 
PWP_VOID
runtimeDestroy(CAEP_RTITEM * /*pRti*/)
{
}