include/opencascade/IGESAppli_ElementResults.hxx

0001 // Created on: 1993-01-11
0002 // Created by: CKY / Contract Toubro-Larsen ( Anand NATRAJAN )
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _IGESAppli_ElementResults_HeaderFile
0018 #define _IGESAppli_ElementResults_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Integer.hxx>
0023 #include <Standard_Real.hxx>
0024 #include <TColStd_HArray1OfInteger.hxx>
0025 #include <IGESAppli_HArray1OfFiniteElement.hxx>
0026 #include <IGESData_IGESEntity.hxx>
0027 #include <TColStd_HArray1OfReal.hxx>
0028 class IGESDimen_GeneralNote;
0029 class IGESBasic_HArray1OfHArray1OfInteger;
0030 class IGESBasic_HArray1OfHArray1OfReal;
0031 class IGESAppli_FiniteElement;
0032
0033
0034 class IGESAppli_ElementResults;
0035 DEFINE_STANDARD_HANDLE(IGESAppli_ElementResults, IGESData_IGESEntity)
0036
0037 //! defines ElementResults, Type <148>
0038 //! in package IGESAppli
0039 //! Used to find the results of FEM analysis
0040 class IGESAppli_ElementResults : public IGESData_IGESEntity
0041 {
0042
0043 public:
0044
0045
0046   Standard_EXPORT IGESAppli_ElementResults();
0047
0048   //! This method is used to set the fields of the class
0049   //! ElementResults
0050   //! - aNote             : GeneralNote Entity describing analysis
0051   //! - aSubCase          : Analysis Subcase number
0052   //! - aTime             : Analysis time value
0053   //! - nbResults         : Number of result values per FEM
0054   //! - aResRepFlag       : Results Reporting Flag
0055   //! - allElementIdents  : FEM element number for elements
0056   //! - allFiniteElems    : FEM element
0057   //! - allTopTypes       : Element Topology Types
0058   //! - nbLayers          : Number of layers per result data location
0059   //! - allDataLayerFlags : Data Layer Flags
0060   //! - allnbResDataLocs  : Number of result data report locations
0061   //! - allResDataLocs    : Result Data Report Locations
0062   //! - allResults        : List of Result data values of FEM analysis
0063   Standard_EXPORT void Init (const Handle(IGESDimen_GeneralNote)& aNote, const Standard_Integer aSubCase, const Standard_Real aTime, const Standard_Integer nbResults, const Standard_Integer aResRepFlag, const Handle(TColStd_HArray1OfInteger)& allElementIdents, const Handle(IGESAppli_HArray1OfFiniteElement)& allFiniteElems, const Handle(TColStd_HArray1OfInteger)& allTopTypes, const Handle(TColStd_HArray1OfInteger)& nbLayers, const Handle(TColStd_HArray1OfInteger)& allDataLayerFlags, const Handle(TColStd_HArray1OfInteger)& allnbResDataLocs, const Handle(IGESBasic_HArray1OfHArray1OfInteger)& allResDataLocs, const Handle(IGESBasic_HArray1OfHArray1OfReal)& allResults);
0064
0065   //! Changes the FormNumber (which indicates Type of Result)
0066   //! Error if not in range [0-34]
0067   Standard_EXPORT void SetFormNumber (const Standard_Integer form);
0068
0069   //! returns General Note Entity describing analysis case
0070   Standard_EXPORT Handle(IGESDimen_GeneralNote) Note() const;
0071
0072   //! returns analysis Subcase number
0073   Standard_EXPORT Standard_Integer SubCaseNumber() const;
0074
0075   //! returns analysis time value
0076   Standard_EXPORT Standard_Real Time() const;
0077
0078   //! returns number of result values per FEM
0079   Standard_EXPORT Standard_Integer NbResultValues() const;
0080
0081   //! returns Results Reporting Flag
0082   Standard_EXPORT Standard_Integer ResultReportFlag() const;
0083
0084   //! returns number of FEM elements
0085   Standard_EXPORT Standard_Integer NbElements() const;
0086
0087   //! returns FEM element number for elements
0088   Standard_EXPORT Standard_Integer ElementIdentifier (const Standard_Integer Index) const;
0089
0090   //! returns FEM element
0091   Standard_EXPORT Handle(IGESAppli_FiniteElement) Element (const Standard_Integer Index) const;
0092
0093   //! returns element Topology Types
0094   Standard_EXPORT Standard_Integer ElementTopologyType (const Standard_Integer Index) const;
0095
0096   //! returns number of layers per result data location
0097   Standard_EXPORT Standard_Integer NbLayers (const Standard_Integer Index) const;
0098
0099   //! returns Data Layer Flags
0100   Standard_EXPORT Standard_Integer DataLayerFlag (const Standard_Integer Index) const;
0101
0102   //! returns number of result data report locations
0103   Standard_EXPORT Standard_Integer NbResultDataLocs (const Standard_Integer Index) const;
0104
0105   //! returns Result Data Report Locations
0106   //! UNFINISHED
0107   Standard_EXPORT Standard_Integer ResultDataLoc (const Standard_Integer NElem, const Standard_Integer NLoc) const;
0108
0109   //! returns total number of results
0110   Standard_EXPORT Standard_Integer NbResults (const Standard_Integer Index) const;
0111
0112   //! returns Result data value for an Element, given its
0113   //! order between 1 and <NbResults(NElem)> (direct access)
0114   //! For a more comprehensive access, see below
0115   Standard_EXPORT Standard_Real ResultData (const Standard_Integer NElem, const Standard_Integer num) const;
0116
0117   //! Computes, for a given Element <NElem>, the rank of a
0118   //! individual Result Data, given <NVal>,<NLay>,<NLoc>
0119   Standard_EXPORT Standard_Integer ResultRank (const Standard_Integer NElem, const Standard_Integer NVal, const Standard_Integer NLay, const Standard_Integer NLoc) const;
0120
0121   //! returns Result data values of FEM analysis, according this
0122   //! definition :
0123   //! - <NElem> : n0 of the Element to be considered
0124   //! - <NVal> : n0 of the Value between 1 and NbResultValues
0125   //! - <NLay> : n0 of the Layer for this Element
0126   //! - <NLoc> : n0 of the Data Location for this Element
0127   //! This gives for each Element, the corresponding rank
0128   //! computed by ResultRank, in which the leftmost subscript
0129   //! changes most rapidly
0130   Standard_EXPORT Standard_Real ResultData (const Standard_Integer NElem, const Standard_Integer NVal, const Standard_Integer NLay, const Standard_Integer NLoc) const;
0131
0132   //! Returns in once the entire list of data for an Element,
0133   //! addressed as by ResultRank (See above)
0134   Standard_EXPORT Handle(TColStd_HArray1OfReal) ResultList (const Standard_Integer NElem) const;
0135
0136
0137
0138
0139   DEFINE_STANDARD_RTTIEXT(IGESAppli_ElementResults,IGESData_IGESEntity)
0140
0141 protected:
0142
0143
0144
0145
0146 private:
0147
0148
0149   Handle(IGESDimen_GeneralNote) theNote;
0150   Standard_Integer theSubcaseNumber;
0151   Standard_Real theTime;
0152   Standard_Integer theNbResultValues;
0153   Standard_Integer theResultReportFlag;
0154   Handle(TColStd_HArray1OfInteger) theElementIdentifiers;
0155   Handle(IGESAppli_HArray1OfFiniteElement) theElements;
0156   Handle(TColStd_HArray1OfInteger) theElementTopologyTypes;
0157   Handle(TColStd_HArray1OfInteger) theNbLayers;
0158   Handle(TColStd_HArray1OfInteger) theDataLayerFlags;
0159   Handle(TColStd_HArray1OfInteger) theNbResultDataLocs;
0160   Handle(IGESBasic_HArray1OfHArray1OfInteger) theResultDataLocs;
0161   Handle(IGESBasic_HArray1OfHArray1OfReal) theResultData;
0162
0163
0164 };
0165
0166
0167
0168
0169
0170
0171
0172 #endif // _IGESAppli_ElementResults_HeaderFile