CaeStrGridModel.h

Go to the documentation of this file.

/****************************************************************************
 *
 * CaeStrGridModel class
 *
 * (C) 2021 Cadence Design Systems, Inc. All rights reserved worldwide.
 *
 ***************************************************************************/
 
#if !defined(PWGM_HIDE_STRUCTURED_API)
 
#ifndef _CAESTRGRIDMODEL_H_
#define _CAESTRGRIDMODEL_H_
 
 
#include "apiGridModel.h"
#include "apiPWP.h"
 
#include "CaeGridModel.h"
#include "CaeStrBoundaryGroup.h"
#include "CaeStrConnectionGroup.h"
 
 
class CaeStrCustomIndexHandler {
public:
    virtual ~CaeStrCustomIndexHandler()
    {
    }
 
 
    virtual PWGM_INDEX3 mapIndex(const PWGM_INDEX3 pwgmNdx) = 0;
};
 
 
class CaeStrGridModel : public CaeGridModel, public CaeStrConnectionGroup,
        public CaeStrBoundaryGroup {
public:
 
 
    CaeStrGridModel(PWGM_HGRIDMODEL model);
 
 
    CaeStrGridModel(const CaeStrGridModel &src);
 
    virtual ~CaeStrGridModel();
 
 
    bool        customIndexSchemeReady(CaeStrCustomIndexHandler &handler) const;
 
 
    static bool xform2to3(const PWGM_INDEX_XFORM2 &x2, PWGM_INDEX_XFORM &x3);
 
 
    static bool xform3to2(const PWGM_INDEX_XFORM &x3, PWGM_INDEX_XFORM2 &x2);
 
 
    static PWGM_INDEX3 xformApply(const PWGM_INDEX_XFORM &x3, const PWGM_INDEX3
                        &ijk);
 
 
    static PWGM_ENUM_IJK xformFollows(const PWGM_INDEX_XFORM &x3, PWGM_ENUM_IJK
                            localAxis, bool *pFlipped = 0);
 
 
    static PWGM_INDEX3 xform2Apply(const PWGM_INDEX_XFORM2 &x2, const
                            PWGM_INDEX3 &ijk);
 
 
    static PWGM_ENUM_IJK xform2Follows(const PWGM_INDEX_XFORM2 &x2,
                            PWGM_ENUM_IJK localAxis, bool *pFlipped = 0);
 
 
    static bool inRange(const PWGM_INDEX3 &ijk, const PWGM_STR_RANGE &range);
 
protected:
 
    virtual PWP_UINT32 connectionCountImpl() const {
        return PwModConnectionCount(model_);
    }
    virtual PWGM_HCNXN enumConnectionsImpl(PWP_UINT32 ndx) const {
        return PwModEnumConnections(model_, ndx);
    }
 
    virtual PWP_UINT32 boundaryCountImpl() const {
        return PwModBoundaryCount(model_);
    }
    virtual PWGM_HBNDRY enumBoundariesImpl(PWP_UINT32 ndx) const {
        return PwModEnumBoundaries(model_, ndx);
    }
};
 
bool    operator==(const PWGM_HBNDRY &h1, const PWGM_HBNDRY &h2);
bool    operator!=(const PWGM_HBNDRY &h1, const PWGM_HBNDRY &h2);
bool    operator<(const PWGM_HBNDRY &h1, const PWGM_HBNDRY &h2);
bool    operator>(const PWGM_HBNDRY &h1, const PWGM_HBNDRY &h2);
 
bool    operator==(const PWGM_HCNXN &h1, const PWGM_HCNXN &h2);
bool    operator!=(const PWGM_HCNXN &h1, const PWGM_HCNXN &h2);
bool    operator<(const PWGM_HCNXN &h1, const PWGM_HCNXN &h2);
bool    operator>(const PWGM_HCNXN &h1, const PWGM_HCNXN &h2);
 
 
// Must include here because these depend on CaeStrGridModel
#include "CaeStrBlock.h"
#include "CaeStrBoundary.h"
#include "CaeStrConnection.h"
 
 
#endif // _CAESTRGRIDMODEL_H_
 
#endif // PWGM_HIDE_STRUCTURED_API