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

.. js:class:: cee.ug.QueryBulkCalculationValues

   The result of a :js:class:`QueryBulkCalculation <cee.ug.QueryBulkCalculation>` for one part/region of cutting plane.
   
   
   Index
   =====
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~cee.ug.QueryBulkCalculationValues.area`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.averageValue`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.boundingBoxMaximum`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.boundingBoxMinimum`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.centroid`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.elementCount`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.geometryIndex`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.maximumValue`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.maximumValuePosition`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.minimumValue`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.minimumValuePosition`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.nodeAverageValue`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.nodeCount`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.nodeMaximumValue`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.nodeMaximumValuePosition`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.nodeMinimumValue`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.nodeMinimumValuePosition`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.partId`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.regionTriangleVertices`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.resultant`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.surfaceCount`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.volume`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.volumeAverageValue`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.volumeMaximumValue`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.volumeMaximumValuePosition`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.volumeMinimumValue`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.volumeMinimumValuePosition`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.volumeNodeAverageValue`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.volumeNodeMaximumValue`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.volumeNodeMaximumValuePosition`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.volumeNodeMinimumValue`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.volumeNodeMinimumValuePosition`
   * :js:data:`~cee.ug.QueryBulkCalculationValues.volumeResultant`
   
   



.. rst-class:: kind-group kind-properties

.. rubric:: Properties
   :class: kind-group-title


.. js:data:: cee.ug.QueryBulkCalculationValues.area

      .. rst-class:: sig-pretty-signature
      
         | area: *number*
      
      The surface area of the region/part
      



.. js:data:: cee.ug.QueryBulkCalculationValues.averageValue

      .. rst-class:: sig-pretty-signature
      
         | averageValue: *number*
      
      Average per element surface scalar value in the region (either cutting plane or visible surface of the part)
      



.. js:data:: cee.ug.QueryBulkCalculationValues.boundingBoxMaximum

      .. rst-class:: sig-pretty-signature
      
         | boundingBoxMaximum: :js:class:`Vec3 <cee.Vec3>`
      
      The maximum corner of the bounding box of the part or the cutting plane region
      



.. js:data:: cee.ug.QueryBulkCalculationValues.boundingBoxMinimum

      .. rst-class:: sig-pretty-signature
      
         | boundingBoxMinimum: :js:class:`Vec3 <cee.Vec3>`
      
      The minimum corner of the bounding box of the part or the cutting plane region
      



.. js:data:: cee.ug.QueryBulkCalculationValues.centroid

      .. rst-class:: sig-pretty-signature
      
         | centroid: :js:class:`Vec3 <cee.Vec3>`
      
      The centroid of the region/part
      



.. js:data:: cee.ug.QueryBulkCalculationValues.elementCount

      .. rst-class:: sig-pretty-signature
      
         | elementCount: *number*
      
      Number of elements. For cutting planes: The number of elements intersected
      



.. js:data:: cee.ug.QueryBulkCalculationValues.geometryIndex

      .. rst-class:: sig-pretty-signature
      
         | geometryIndex: *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.
      



.. js:data:: cee.ug.QueryBulkCalculationValues.maximumValue

      .. rst-class:: sig-pretty-signature
      
         | maximumValue: *number*
      
      Maximum per element surface scalar value in the region (either cutting plane or visible surface of the part)
      



.. js:data:: cee.ug.QueryBulkCalculationValues.maximumValuePosition

      .. rst-class:: sig-pretty-signature
      
         | maximumValuePosition: :js:class:`Vec3 <cee.Vec3>`
      
      The position of the maximum per element surface scalar value :js:data:`maximumValue <cee.ug.QueryBulkCalculationValues.maximumValue>` (surface centroid)
      



.. js:data:: cee.ug.QueryBulkCalculationValues.minimumValue

      .. rst-class:: sig-pretty-signature
      
         | minimumValue: *number*
      
      Minimum per element surface scalar value in the region (either cutting plane or visible surface of the part)
      



.. js:data:: cee.ug.QueryBulkCalculationValues.minimumValuePosition

      .. rst-class:: sig-pretty-signature
      
         | minimumValuePosition: :js:class:`Vec3 <cee.Vec3>`
      
      The position of the minimum per element surface scalar value :js:data:`minimumValue <cee.ug.QueryBulkCalculationValues.minimumValue>` (surface centroid)
      



.. js:data:: cee.ug.QueryBulkCalculationValues.nodeAverageValue

      .. rst-class:: sig-pretty-signature
      
         | nodeAverageValue: *number*
      
      Average value of the nodes referenced by the region/part visible surface (applicable for PER_NODE and PER_ELEMENT_NODE results)
      



.. js:data:: cee.ug.QueryBulkCalculationValues.nodeCount

      .. rst-class:: sig-pretty-signature
      
         | nodeCount: *number*
      
      Number of nodes in the region / on the visible surface of the part
      



.. js:data:: cee.ug.QueryBulkCalculationValues.nodeMaximumValue

      .. rst-class:: sig-pretty-signature
      
         | nodeMaximumValue: *number*
      
      Maximum value of the nodes referenced by the region/part visible surface (applicable for PER_NODE and PER_ELEMENT_NODE results)
      



.. js:data:: cee.ug.QueryBulkCalculationValues.nodeMaximumValuePosition

      .. rst-class:: sig-pretty-signature
      
         | nodeMaximumValuePosition: :js:class:`Vec3 <cee.Vec3>`
      
      The position of the maximum value of the nodes referenced by the region/part visible surface :js:data:`nodeMaximumValue <cee.ug.QueryBulkCalculationValues.nodeMaximumValue>`
      



.. js:data:: cee.ug.QueryBulkCalculationValues.nodeMinimumValue

      .. rst-class:: sig-pretty-signature
      
         | nodeMinimumValue: *number*
      
      Minimum value of the nodes referenced by the region/part visible surface (applicable for PER_NODE and PER_ELEMENT_NODE results)
      



.. js:data:: cee.ug.QueryBulkCalculationValues.nodeMinimumValuePosition

      .. rst-class:: sig-pretty-signature
      
         | nodeMinimumValuePosition: :js:class:`Vec3 <cee.Vec3>`
      
      The position of the minimum value of the nodes referenced by the region/part visible surface :js:data:`nodeMinimumValue <cee.ug.QueryBulkCalculationValues.nodeMinimumValue>`
      



.. js:data:: cee.ug.QueryBulkCalculationValues.partId

      .. rst-class:: sig-pretty-signature
      
         | partId: *number*
      
      The id of the part associated with the bulk values
      



.. js:data:: cee.ug.QueryBulkCalculationValues.regionTriangleVertices

      .. rst-class:: sig-pretty-signature
      
         | regionTriangleVertices: *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.
      



.. js:data:: cee.ug.QueryBulkCalculationValues.resultant

      .. rst-class:: sig-pretty-signature
      
         | resultant: *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.
      



.. js:data:: cee.ug.QueryBulkCalculationValues.surfaceCount

      .. rst-class:: sig-pretty-signature
      
         | surfaceCount: *number*
      
      Number of element surfaces in the region/visible surface of the part
      



.. js:data:: cee.ug.QueryBulkCalculationValues.volume

      .. rst-class:: sig-pretty-signature
      
         | volume: *number*
      
      The volume of the part (only applicable for parts with volume elements). For cutting planes: the volume of the intersected elements
      



.. js:data:: cee.ug.QueryBulkCalculationValues.volumeAverageValue

      .. rst-class:: sig-pretty-signature
      
         | volumeAverageValue: *number*
      
      The Average result for volume elements in the part (only applicable for parts with volume elements)
      



.. js:data:: cee.ug.QueryBulkCalculationValues.volumeMaximumValue

      .. rst-class:: sig-pretty-signature
      
         | volumeMaximumValue: *number*
      
      The Maximum result for volume elements in the part (only applicable for parts with volume elements)
      



.. js:data:: cee.ug.QueryBulkCalculationValues.volumeMaximumValuePosition

      .. rst-class:: sig-pretty-signature
      
         | volumeMaximumValuePosition: :js:class:`Vec3 <cee.Vec3>`
      
      The position of the maximum result for volume elements in the part :js:data:`volumeMaximumValue <cee.ug.QueryBulkCalculationValues.volumeMaximumValue>`
      



.. js:data:: cee.ug.QueryBulkCalculationValues.volumeMinimumValue

      .. rst-class:: sig-pretty-signature
      
         | volumeMinimumValue: *number*
      
      The minimum result for volume elements in the part (only applicable for parts with volume elements)
      



.. js:data:: cee.ug.QueryBulkCalculationValues.volumeMinimumValuePosition

      .. rst-class:: sig-pretty-signature
      
         | volumeMinimumValuePosition: :js:class:`Vec3 <cee.Vec3>`
      
      The position of the minimum result for volume elements in the part :js:data:`volumeMinimumValue <cee.ug.QueryBulkCalculationValues.volumeMinimumValue>`
      



.. js:data:: cee.ug.QueryBulkCalculationValues.volumeNodeAverageValue

      .. rst-class:: sig-pretty-signature
      
         | volumeNodeAverageValue: *number*
      
      Average value of the nodes referenced by the volume elements in the part (applicable for PER_NODE and PER_ELEMENT_NODE results)
      



.. js:data:: cee.ug.QueryBulkCalculationValues.volumeNodeMaximumValue

      .. rst-class:: sig-pretty-signature
      
         | volumeNodeMaximumValue: *number*
      
      Maximum value of the nodes referenced by the volume elements in the part (applicable for PER_NODE and PER_ELEMENT_NODE results)
      



.. js:data:: cee.ug.QueryBulkCalculationValues.volumeNodeMaximumValuePosition

      .. rst-class:: sig-pretty-signature
      
         | volumeNodeMaximumValuePosition: :js:class:`Vec3 <cee.Vec3>`
      
      The position of the maximum value of the nodes referenced by the volume elements in the part :js:data:`volumeNodeMaximumValue <cee.ug.QueryBulkCalculationValues.volumeNodeMaximumValue>`
      



.. js:data:: cee.ug.QueryBulkCalculationValues.volumeNodeMinimumValue

      .. rst-class:: sig-pretty-signature
      
         | volumeNodeMinimumValue: *number*
      
      Minimum value of the nodes referenced by the volume elements in the part (applicable for PER_NODE and PER_ELEMENT_NODE results)
      



.. js:data:: cee.ug.QueryBulkCalculationValues.volumeNodeMinimumValuePosition

      .. rst-class:: sig-pretty-signature
      
         | volumeNodeMinimumValuePosition: :js:class:`Vec3 <cee.Vec3>`
      
      The position of the minimum value of the nodes referenced by the volume elements in the part :js:data:`volumeNodeMinimumValue <cee.ug.QueryBulkCalculationValues.volumeNodeMinimumValue>`
      



.. js:data:: cee.ug.QueryBulkCalculationValues.volumeResultant

      .. rst-class:: sig-pretty-signature
      
         | volumeResultant: *number*
      
      Sum of ELEMENT_VOLUME\*ELEMENT_RESULT_VALUE for all volume elements (only applicable for parts with volume elements)
      




