include/opencascade/IGESAppli_NodalResults.hxx

0001 // Created on: 1993-01-11
0002 // Created by: CKY / Contract Toubro-Larsen ( Arun  MENON )
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_NodalResults_HeaderFile
0018 #define _IGESAppli_NodalResults_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Integer.hxx>
0023 #include <Standard_Real.hxx>
0024 #include <NCollection_Array1.hxx>
0025 #include <NCollection_HArray1.hxx>
0026 #include <IGESAppli_Node.hxx>
0027 #include <NCollection_Array2.hxx>
0028 #include <NCollection_HArray2.hxx>
0029 #include <IGESData_IGESEntity.hxx>
0030 class IGESDimen_GeneralNote;
0031 class IGESAppli_Node;
0032
0033 //! defines NodalResults, Type <146>
0034 //! in package IGESAppli
0035 //! Used to store the Analysis Data results per FEM Node
0036 class IGESAppli_NodalResults : public IGESData_IGESEntity
0037 {
0038
0039 public:
0040   Standard_EXPORT IGESAppli_NodalResults();
0041
0042   //! This method is used to set the fields of the class
0043   //! NodalResults
0044   //! - aNote              : General Note that describes the
0045   //! analysis case
0046   //! - aNumber            : Analysis Subcase number
0047   //! - aTime              : Analysis time
0048   //! - allNodeIdentifiers : Node identifiers for the nodes
0049   //! - allNodes           : List of FEM Node Entities
0050   //! - allData            : Values of the Finite Element analysis
0051   //! result data
0052   //! raises exception if Lengths of allNodeIdentifiers, allNodes and
0053   //! allData (Cols) are not same
0054   Standard_EXPORT void Init(
0055     const occ::handle<IGESDimen_GeneralNote>&                            aNote,
0056     const int                                                            aNumber,
0057     const double                                                         aTime,
0058     const occ::handle<NCollection_HArray1<int>>&                         allNodeIdentifiers,
0059     const occ::handle<NCollection_HArray1<occ::handle<IGESAppli_Node>>>& allNodes,
0060     const occ::handle<NCollection_HArray2<double>>&                      allData);
0061
0062   //! Changes the FormNumber (which indicates Type of Result)
0063   //! Error if not in range [0-34]
0064   Standard_EXPORT void SetFormNumber(const int form);
0065
0066   //! returns the General Note Entity that describes the analysis case
0067   Standard_EXPORT occ::handle<IGESDimen_GeneralNote> Note() const;
0068
0069   //! returns zero if there is no subcase
0070   Standard_EXPORT int SubCaseNumber() const;
0071
0072   //! returns the Analysis time value for this subcase. It is the time
0073   //! at which transient analysis results occur in the mathematical
0074   //! FEM model.
0075   Standard_EXPORT double Time() const;
0076
0077   //! returns number of real values in array V for a FEM node
0078   Standard_EXPORT int NbData() const;
0079
0080   //! returns number of FEM nodes for which data is to be read.
0081   Standard_EXPORT int NbNodes() const;
0082
0083   //! returns FEM node number identifier for the (Index)th node
0084   //! raises exception if Index <= 0 or Index > NbNodes
0085   Standard_EXPORT int NodeIdentifier(const int Index) const;
0086
0087   //! returns the node as specified by the Index
0088   //! raises exception if Index <= 0 or Index > NbNodes
0089   Standard_EXPORT occ::handle<IGESAppli_Node> Node(const int Index) const;
0090
0091   //! returns the finite element analysis result value
0092   //! raises exception if (NodeNum <= 0 or NodeNum > NbNodes()) or
0093   //! if (DataNum <=0 or DataNum > NbData())
0094   Standard_EXPORT double Data(const int NodeNum, const int DataNum) const;
0095
0096   DEFINE_STANDARD_RTTIEXT(IGESAppli_NodalResults, IGESData_IGESEntity)
0097
0098 private:
0099   occ::handle<IGESDimen_GeneralNote>                            theNote;
0100   int                                                           theSubCaseNum;
0101   double                                                        theTime;
0102   occ::handle<NCollection_HArray1<int>>                         theNodeIdentifiers;
0103   occ::handle<NCollection_HArray1<occ::handle<IGESAppli_Node>>> theNodes;
0104   occ::handle<NCollection_HArray2<double>>                      theData;
0105 };
0106
0107 #endif // _IGESAppli_NodalResults_HeaderFile