.. role:: ts-api-decorator

##########################
QueryBulkCalculationValues
##########################

.. js:module:: cee.ug
   :noindex:

.. container:: ts-api-section

   .. js:class:: QueryBulkCalculationValues

      The result of a ``QueryBulkCalculation`` for one part/region of cutting plane.



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-interface

   * :js:attr:`~cee.ug.QueryBulkCalculationValues.area`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.averageValue`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.boundingBoxMaximum`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.boundingBoxMinimum`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.centroid`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.elementCount`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.geometryIndex`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.maximumValue`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.maximumValuePosition`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.minimumValue`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.minimumValuePosition`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.nodeAverageValue`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.nodeCount`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.nodeMaximumValue`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.nodeMaximumValuePosition`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.nodeMinimumValue`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.nodeMinimumValuePosition`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.partId`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.regionTriangleVertices`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.resultant`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.surfaceCount`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.volume`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.volumeAverageValue`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.volumeMaximumValue`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.volumeMaximumValuePosition`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.volumeMinimumValue`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.volumeMinimumValuePosition`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.volumeNodeAverageValue`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.volumeNodeMaximumValue`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.volumeNodeMaximumValuePosition`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.volumeNodeMinimumValue`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.volumeNodeMinimumValuePosition`
   * :js:attr:`~cee.ug.QueryBulkCalculationValues.volumeResultant`





------------

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.area

      :type: number

      The surface area of the region/part



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.averageValue

      :type: number

      Average per element surface scalar value in the region (either cutting plane or visible surface of the part)



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.boundingBoxMaximum

      :type: Vec3

      The maximum corner of the bounding box of the part or the cutting plane region



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.boundingBoxMinimum

      :type: Vec3

      The minimum corner of the bounding box of the part or the cutting plane region



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.centroid

      :type: Vec3

      The centroid of the region/part



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.elementCount

      :type: number

      Number of elements. For cutting planes: The number of elements intersected



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.geometryIndex

      :type: number

      The index of the CAE geometry.

      In almost all cases this will be 0. If using a partially adaptive model with remeshing only on parts of the model (e.g. in a Forging process) 
      the concept of multiple geometries might be relevant.



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.maximumValue

      :type: number

      Maximum per element surface scalar value in the region (either cutting plane or visible surface of the part)



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.maximumValuePosition

      :type: Vec3

      The position of the maximum per element surface scalar value ``maximumValue`` (surface centroid)



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.minimumValue

      :type: number

      Minimum per element surface scalar value in the region (either cutting plane or visible surface of the part)



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.minimumValuePosition

      :type: Vec3

      The position of the minimum per element surface scalar value ``minimumValue`` (surface centroid)



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.nodeAverageValue

      :type: number

      Average value of the nodes referenced by the region/part visible surface (applicable for PER_NODE and PER_ELEMENT_NODE results)



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.nodeCount

      :type: number

      Number of nodes in the region / on the visible surface of the part



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.nodeMaximumValue

      :type: number

      Maximum value of the nodes referenced by the region/part visible surface (applicable for PER_NODE and PER_ELEMENT_NODE results)



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.nodeMaximumValuePosition

      :type: Vec3

      The position of the maximum value of the nodes referenced by the region/part visible surface ``nodeMaximumValue``



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.nodeMinimumValue

      :type: number

      Minimum value of the nodes referenced by the region/part visible surface (applicable for PER_NODE and PER_ELEMENT_NODE results)



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.nodeMinimumValuePosition

      :type: Vec3

      The position of the minimum value of the nodes referenced by the region/part visible surface ``nodeMinimumValue``



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.partId

      :type: number

      The id of the part associated with the bulk values



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.regionTriangleVertices

      :type: Float32Array

      A tessellation of triangles of the cutting plane region if a cutting plane query was issued and includeRegionTriangles was true

      This array contains x,y,z values for each triangle vertex. So there will be 9 values (3 vertices * (x,y,z)) per triangle.
      This can be used to highlight the selected region using the geometry or the markup model.



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.resultant

      :type: number

      Sum of SURFACE_AREA*SURFACE_RESULT_VALUE for all element surfaces in the region (of cutting planes) or 
      of the visible surface of a part.



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.surfaceCount

      :type: number

      Number of element surfaces in the region/visible surface of the part



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.volume

      :type: number

      The volume of the part (only applicable for parts with volume elements). For cutting planes: the volume of the intersected elements



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.volumeAverageValue

      :type: number

      The Average result for volume elements in the part (only applicable for parts with volume elements)



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.volumeMaximumValue

      :type: number

      The Maximum result for volume elements in the part (only applicable for parts with volume elements)



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.volumeMaximumValuePosition

      :type: Vec3

      The position of the maximum result for volume elements in the part ``volumeMaximumValue``



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.volumeMinimumValue

      :type: number

      The minimum result for volume elements in the part (only applicable for parts with volume elements)



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.volumeMinimumValuePosition

      :type: Vec3

      The position of the minimum result for volume elements in the part ``volumeMinimumValue``



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.volumeNodeAverageValue

      :type: number

      Average value of the nodes referenced by the volume elements in the part (applicable for PER_NODE and PER_ELEMENT_NODE results)



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.volumeNodeMaximumValue

      :type: number

      Maximum value of the nodes referenced by the volume elements in the part (applicable for PER_NODE and PER_ELEMENT_NODE results)



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.volumeNodeMaximumValuePosition

      :type: Vec3

      The position of the maximum value of the nodes referenced by the volume elements in the part ``volumeNodeMaximumValue``



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.volumeNodeMinimumValue

      :type: number

      Minimum value of the nodes referenced by the volume elements in the part (applicable for PER_NODE and PER_ELEMENT_NODE results)



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.volumeNodeMinimumValuePosition

      :type: Vec3

      The position of the minimum value of the nodes referenced by the volume elements in the part ``volumeNodeMinimumValue``



.. container:: ts-api-section

   .. js:attribute:: QueryBulkCalculationValues.volumeResultant

      :type: number

      Sum of ELEMENT_VOLUME*ELEMENT_RESULT_VALUE for all volume elements (only applicable for parts with volume elements)



