CCubitFile.hpp

Go to the documentation of this file.

/*******************************************************************************
    COPYRIGHT 2002 CATERPILLAR INC.  ALL RIGHTS RESERVED

    This program is the property of Caterpillar Inc., includes Caterpillar's
    confidential and trade secret information, and is maintained as an
    unpublished copyrighted work.  It is not to be copied or used by others
    except under license from Caterpillar.  This program is also protected as an
    unpublished work in accordance with the copyright act of 1976.  In the event
    of either inadvertent or deliberate publication, Caterpillar Inc. intends to
    maintain copyright protection for this work under the relevant copyright
    laws pertaining to published works.  The inclusion of a copyright notice
    hereon is precautionary only, and does not imply publication or disclosure.

 
 Filename      : CCubitFile.hpp

 Purpose       : Declares an interface for reading and writing data in the
                 Cubit (*.cub) file format.
           
 Special Notes :

 Creator       : Will A. Helden

 Creation Date : 02/15/02

 Owner         : Will A. Helden

*******************************************************************************/

#ifndef CCubitFile_HPP
#define CCubitFile_HPP

#include <stdio.h>
#include <cstdio>
#include <memory.h>
#include "CGMUtilConfigure.h"
#include <vector>
#include "CubitFile.hpp"

namespace NCubitFile {

class CMetaData;
class CFEModel;
class CSimModel;

typedef unsigned int UnsignedInt32;  // This must always be a 32 bit integer!!!
typedef const char* ConstCharPtr;

struct SModelData {
    UnsignedInt32 mintModelHandle;
    UnsignedInt32 mintModelType;
    UnsignedInt32 mintModelOwner;
};
struct SElemData {
    UnsignedInt32 mintElemType;
    UnsignedInt32 mintElemOrder;
    UnsignedInt32 mintElemCount;
    UnsignedInt32* mpaElemIDs;
    UnsignedInt32* mpaElemGlobalIDs;
    UnsignedInt32* mpaElemConnect;
};
struct SGroupData {
    UnsignedInt32 mintMemberType;
    UnsignedInt32 mintMemberCount;
    UnsignedInt32* mpaMemberIDs;
};
typedef SGroupData SBlockData;
typedef SGroupData SNodeSetData;
typedef SGroupData SBCSetData;
typedef SGroupData SConstraintData;

// first edition of sideset data
struct SSideSetData_10 {
    UnsignedInt32 mintMemberType;
    UnsignedInt32 mintMemberCount;
    UnsignedInt32 mintMemberSenseSize;
    UnsignedInt32* mpaintMemberIDs;
    char* mpachrMemberSense;
    UnsignedInt32* mpaintMemberSense;
    char* mpachrMemberSideNumber;
};
// next edition of sideset data holds more information in a more flexible way
struct SSideSetData_11 {
    UnsignedInt32 mintMemberCount;  // number of members {type,id} ...
    UnsignedInt32* mpaintMemberTypes; // types of each member
    UnsignedInt32* mpaintMemberIDs; // ids of the members
    char* mpachrMemberSenses;        // shell sense (forward, reverse, both)
    UnsignedInt32* mpaintMemberWRTEntities; // wrt entities, format is  ( {num_wrt} {type,id} {type,id} ...
                                            //                            {num_wrt} {type,id} ...
};

struct SMaterialData {
    UnsignedInt32 mintMemberType;
    UnsignedInt32 mintMemberRows; //i.e. rows
    UnsignedInt32 mintMemberColumns;
    double* mpadblMemberData;
};

class CUBIT_UTIL_EXPORT CCubitFile  
{
public:
    typedef UnsignedInt32 HModel;
    enum EErrorCode { eSuccess = 0,
        eFileReadError, eFileSeekError, eFileTellError, eFileWriteError,
        eFileUnrecognizedFormat,
        eDuplicateWrite, eCorruptBlock,
        eNotFound, eOrderError,
        eMemoryError, ePassedNullPointer,
        eUnknownError
    };
    enum EMetaDataOwnerType {
        eModelMetaData,
        eGeomMetaData, eNodeMetaData, eElemMetaData, eGroupMetaData,
        eBlockMetaData, eNodeSetMetaData, eSideSetMetaData,
        eBCSetMetaData, eMaterialMetaData, eConstraintMetaData
    };
    enum EModelType {
      eFEModel, eACISText, eACISBinary, eAssemblyModel, eSimModel, eBoundaryLayerModel
    };
    enum ESideSetSenseSize {
        eSideSetSenseNone, eSideSetSenseByte, eSideSetSenseInt32
    };
    enum EConstraintType {
        eConstraintDistributing, eConstraintKinematic, eConstraintRigidBody
    };

    CCubitFile();
    virtual ~CCubitFile();

    EErrorCode Open(const char* xstrReadFileName, const char* xstrWriteFileName,
        const char* xstrBackupFileName = NULL);
    EErrorCode Close();

    UnsignedInt32 GetModelList(UnsignedInt32& xintNumModels,
        const SModelData*& xpaModels);
    UnsignedInt32 IsModel(HModel xintModel);
    UnsignedInt32 GetReadModelLength(HModel xintModel,
                                     UnsignedInt32& xintLength);
    UnsignedInt32 CreateModel(EModelType xeModelType, HModel& xintModel);
    UnsignedInt32 DeleteModel(HModel xintModel);
    UnsignedInt32 GetModelOwner(HModel xintModel, HModel& xintOwner);
    UnsignedInt32 SetModelOwner(HModel xintModel, HModel xintOwner);

    // Returns a FILE* that can be directly written to.  Be sure to
    // call EndWriteAssemblyModel() to correctly accomodate the written data.
  UnsignedInt32 BeginWriteModel(HModel xintModelId, EModelType type,
                                        FILE*& writeable_file);
  UnsignedInt32 EndWriteModel(HModel xintModelId);
    // Returns a FILE* that can be read from.  The FILE* will NOT return EOF
    // at the end of the data...the reader should not go GetReadModelLength()
    // bytes beyond the current FILE* position.  You should copy the contents
    // to another FILE if this is an issue for the reader.
  UnsignedInt32 BeginReadModel(HModel xintGeomModel, EModelType type,
                                       FILE*& readable_file);
  UnsignedInt32 EndReadModel();
  
  UnsignedInt32 BeginWriteGeomModel(HModel xintGeomModel,
                                    const char* xstrGeomFile);
  UnsignedInt32 EndWriteGeomModel();
  UnsignedInt32 BeginReadGeomModel(HModel xintGeomModel,
                                   FILE* xpGeomFile);
  UnsignedInt32 EndReadGeomModel();
  
  UnsignedInt32 BeginWriteFEModel(HModel xintFEModel,
                                  UnsignedInt32 xintGeomCount,
                                  UnsignedInt32 xintGroupCount,
                                  UnsignedInt32 xintBlockCount,
                                  UnsignedInt32 xintNodeSetCount,
                                  UnsignedInt32 xintSideSetCount);
  UnsignedInt32 WriteNodes(UnsignedInt32 xintIndex, UnsignedInt32 xintGeomID,
                           UnsignedInt32 xintNodeCount, UnsignedInt32 *xpaintNodeIDs,
                           double *xpadblX, double *xpadblY, double *xpadblZ);
  UnsignedInt32 WriteElems(UnsignedInt32 xintIndex,
                           UnsignedInt32 xintNumTypes, SElemData* xpaElemData);
  UnsignedInt32 WriteGroup(UnsignedInt32 xintIndex,
                           UnsignedInt32 xintGroupID, UnsignedInt32 xintGroupType,
                           ConstCharPtr xpachrGroupName,
                           UnsignedInt32 xintNumTypes, SGroupData* xpaGroupData);
  UnsignedInt32 WriteBlock(UnsignedInt32 xintIndex,
                           UnsignedInt32 xintBlockID, 
                           int block_unique_id, 
                           UnsignedInt32 xintBlockType,
                           UnsignedInt32 xintBlockColor, UnsignedInt32 xintMixedElemType,
                           UnsignedInt32 xintDefPyramidType, UnsignedInt32 xintMaterialID,
                           UnsignedInt32 xintBlockDimension,
                           UnsignedInt32 xintNumTypes, SBlockData* xpaBlockData,
                           UnsignedInt32 xintAttributeOrder, double* xpadblAttributes);
  UnsignedInt32 WriteNodeSet(UnsignedInt32 xintIndex,
                             UnsignedInt32 xintNodeSetID, 
                             int nodeset_unique_id, 
                             UnsignedInt32 xintColor,
                             UnsignedInt32 xintPointSymbol,
                             UnsignedInt32 xintNumTypes, SNodeSetData* xpaNodeSetData,
                             const std::vector<char>& bcdata
                             );
  UnsignedInt32 WriteSideSet_11(UnsignedInt32 xintIndex,
                             UnsignedInt32 xintSideSetID,
                             int sideset_unique_id, 
                             UnsignedInt32 xintColor,
                             UnsignedInt32 xintUseShells,
                             UnsignedInt32 xintNumTypes, SSideSetData_11* xpaSideSetData,
                             UnsignedInt32 xintNumDistFact, double* xpadblDistribution,
                             const std::vector<char>& bcdata);
  UnsignedInt32 EndWriteFEModel();
  
  UnsignedInt32 BeginReadFEModel(HModel xintFEModel,
                                 UnsignedInt32& xintGeomCount,
                                 UnsignedInt32& xintGroupCount,
                                 UnsignedInt32& xintBlockCount,
                                 UnsignedInt32& xintNodeSetCount,
                                 UnsignedInt32& xintSideSetCount);
  UnsignedInt32 ReadNodes(UnsignedInt32 xintIndex, UnsignedInt32& xintGeomID,
                          UnsignedInt32& xintNodeCount, UnsignedInt32*& xpaintNodeIDs,
                          double*& xpadblX, double*& xpadblY, double*& xpadblZ);
  UnsignedInt32 ReadElems(HModel xintFEModel, UnsignedInt32 xintIndex, UnsignedInt32& xintGeomID,
                          UnsignedInt32& xintNumTypes, SElemData*& xpaElemData);
  UnsignedInt32 ReadGroupIdentity(UnsignedInt32 xintIndex,
                                  UnsignedInt32& xintGroupID,
                                  UnsignedInt32& xintGroupType,
                                  ConstCharPtr& xpachrGroupName);
  UnsignedInt32 ReadGroupMembers(UnsignedInt32 xintIndex,
                                 UnsignedInt32& xintNumTypes, SGroupData*& xpaGroupData);
    UnsignedInt32 ReadBlock(UnsignedInt32 xintIndex,
        UnsignedInt32& xintBlockID, int& unique_id, UnsignedInt32& xintBlockType,
        UnsignedInt32& xintBlockColor, UnsignedInt32& xintMixedElemType,
        UnsignedInt32& xintDefPyramidType, UnsignedInt32& xintMaterialID,
        UnsignedInt32& xintBlockDimension,
        UnsignedInt32& xintNumTypes, SBlockData*& xpaBlockData,
        UnsignedInt32& xintAttributeOrder, double*& xpadblAttributes);
    UnsignedInt32 ReadNodeSet(UnsignedInt32 xintIndex,
        UnsignedInt32& xintNodeSetID, int& unique_id, UnsignedInt32& xintColor,
        UnsignedInt32& xintPointSymbol,
        UnsignedInt32& xintNumTypes, SNodeSetData*& xpaNodeSetData,
        std::vector<char>& bcdata);

    // read old sideset format
    UnsignedInt32 ReadSideSet_10(UnsignedInt32 xintIndex,
        UnsignedInt32& xintSideSetID, UnsignedInt32& xintColor,
        UnsignedInt32& xintUseShells,
        UnsignedInt32& xintNumTypes, SSideSetData_10*& xpaSideSetData,
        UnsignedInt32& xintNumDistFact, double*& xpadblDistribution);
    
    // read new sideset format
    UnsignedInt32 ReadSideSet_11(UnsignedInt32 xintIndex,
        UnsignedInt32& xintSideSetID, int& unique_id, UnsignedInt32& xintColor,
        UnsignedInt32& xintUseShells,
        UnsignedInt32& xintNumTypes, SSideSetData_11*& xpaSideSetData,
        UnsignedInt32& xintNumDistFact, double*& xpadblDistribution,
        std::vector<char>& bcdata);
    
    UnsignedInt32 EndReadFEModel();

    // Simulation Model functions
    UnsignedInt32 BeginWriteSimModel(HModel xintGeomModel,
                                     UnsignedInt32 xintBCCount,
                                     UnsignedInt32 xintICCount,
                                     UnsignedInt32 xintBCSetCount,
                                     UnsignedInt32 xintMaterialCount,
                                     UnsignedInt32 xintAmplitudeCount,
                                     UnsignedInt32 xintConstraintCount
                                     );
    UnsignedInt32 WriteBCSet(UnsignedInt32 xintIndex,
                             UnsignedInt32 xintBCSetID,
                             UnsignedInt32 xintBCSetUniqueID,
                             UnsignedInt32 xintBCSetAnalysisType,
                             UnsignedInt32 xintRestraintTypesCount,
                             UnsignedInt32 xintLoadTypesCount,
                             UnsignedInt32 xintContactPairTypesCount,
                             SBCSetData* xpaBCSetRestraintData,
                             SBCSetData* xpaBCSetLoadData,
                             SBCSetData* xpaBCSetContactPairData
                             );
    UnsignedInt32 WriteMaterial(UnsignedInt32 xintIndex,
                                UnsignedInt32 xintMaterialID,
                                UnsignedInt32 xintMaterialUniqueID,
                                UnsignedInt32 xintPropertiesCount,
                                SMaterialData* xpaMaterialData
                                );
    UnsignedInt32 WriteConstraint(UnsignedInt32 xintIndex,
                                UnsignedInt32 xintConstraintID,
                                UnsignedInt32 xintConstraintUniqueID,
                                UnsignedInt32 xintConstraintType,
                                UnsignedInt32 xintIndependentTypeCount,
                                SConstraintData* xpaIndependentData,
                                UnsignedInt32 xintDependentTypeCount,
                                SConstraintData* xpaDependentData
                                );
    UnsignedInt32 EndWriteSimModel();

    UnsignedInt32 BeginReadSimModel(HModel xintGeomModel,
                                    UnsignedInt32& xintBCCount,
                                    UnsignedInt32& xintICCount,
                                    UnsignedInt32& xintBCSetCount,
                                    UnsignedInt32& xintMaterialCount,
                                    UnsignedInt32& xintAmplitudeCount,
                                    UnsignedInt32& xintConstraintCount
                                    );
    UnsignedInt32 ReadBCSet(UnsignedInt32 xintIndex,
                            UnsignedInt32& xintBCSetID,
                            UnsignedInt32& xintBCSetUniqueID,
                            UnsignedInt32& xintBCSetAnalysisType,
                            UnsignedInt32& xintRestraintTypesCount,
                            UnsignedInt32& xintLoadTypesCount,
                            UnsignedInt32& xintContactPairTypesCount,
                            SBCSetData*& xpaBCSetRestraintData,
                            SBCSetData*& xpaBCSetLoadData,
                            SBCSetData*& xpaBCSetContactPairData
                            );
    UnsignedInt32 ReadMaterial(UnsignedInt32 xintIndex,
                               UnsignedInt32& xintMaterialID,
                               UnsignedInt32& xintMaterialUniqueID,
                               UnsignedInt32& xintPropertiesCount,
                               SMaterialData*& xpaMaterialData
                               );
    UnsignedInt32 ReadConstraint(UnsignedInt32 xintIndex,
                               UnsignedInt32& xintConstraintID,
                               UnsignedInt32& xintConstraintUniqueID,
                               UnsignedInt32& xintConstraintType,
                               UnsignedInt32& xintIndependentTypeCount,
                               SConstraintData*& xpaIndependentData,
                               UnsignedInt32& xintDependentTypeCount,
                               SConstraintData*& xpaDependentData
                               );
    UnsignedInt32 EndReadSimModel();


    UnsignedInt32 GetReadMetaData(EMetaDataOwnerType xeType,
        CMetaData*& xpMetaData);
    UnsignedInt32 GetWriteMetaData(EMetaDataOwnerType xeType,
        CMetaData*& xpMetaData);

EErrorCode GetError() const; // ???

//  enum EEndian { eLittleEndian = 0, eBigEndian = 0xFFFFFFFF };
    static const UnsignedInt32 mintNativeEndian;
    enum ECompression { eNoCompression };

private:
    char* mstrReadFileName;
    char* mstrWriteFileName;
    char* mstrBackupFileName;
    UnsignedInt32 mintWriteTempFile;
    CubitFile mpReadFile;
    CubitFile mpWriteFile;
EErrorCode meErrorState;
    UnsignedInt32 mintWriteBuffNumModels;
    UnsignedInt32 mintNextModelID;

    struct SCubitFileContentsHeader {
        UnsignedInt32 mintHeaderSourceEndian;
        UnsignedInt32 mintHeaderSchema;
        UnsignedInt32 mintNumModels;
        UnsignedInt32 mintModelTableOffset;
        UnsignedInt32 mintModelMetaDataOffset;
        UnsignedInt32 mintActiveFEModel;
    } mReadContents, mWriteContents;
    static const UnsignedInt32 mintSizeOfContents;
    struct SCubitFileModelEntry {
        UnsignedInt32 mintModelHandle;
        UnsignedInt32 mintModelOffset;
        UnsignedInt32 mintModelLength;
        EModelType mintModelType;
        UnsignedInt32 mintModelOwner;
        UnsignedInt32 mintModel64bitOSPad;  // make struct 64 bit word aligned
    } *mpaReadModels, *mpaWriteModels;
    static const UnsignedInt32 mintSizeOfModel;
  enum EModelStat { eStatNotWritten, eStatWritten, eStatDelete, eStatWriting };
    EModelStat* mpaReadModelStat;

    void WriteModelTable();
    UnsignedInt32 FindModel(HModel xintModel, SCubitFileModelEntry* xpaModels,
        UnsignedInt32 xintNumModels, UnsignedInt32& xintIndex);
    void CopyModel(UnsignedInt32 xintReadOffset, UnsignedInt32& xintWriteOffset,
        UnsignedInt32 xintLength, FILE* xpReadFile, FILE* xpWriteFile);
    void FreeAll();

    UnsignedInt32 mintFEModelIndex;
    UnsignedInt32 mintSimModelIndex;
    CFEModel* mpReadFEModel;
    CFEModel* mpWriteFEModel;
    CSimModel* mpReadSimModel;
    CSimModel* mpWriteSimModel;
    CMetaData* mpMetaData;
    struct {
        UnsignedInt32 mintNumModels;
        SModelData* mpaModelData;
    } mModelBuff;
};

} // namespace NCubitFile

#endif