cee::ug Namespace Reference

Namespace cee::ug contains all functionality and structures under the UnstructGrid component. More...

Classes

class  BackgroundPropertyHandler
 Property handler for background properties. More...
 
class  BulkCalculation
 Calculation of bulk values from cutting planes and visible surfaces of parts. More...
 
class  BulkValues
 Class for storing results of bulk calculations. More...
 
class  CameraPropertyHandler
 Property handler for camera properties. More...
 
class  ColorMapper
 Controlling the color mapping and the color setup of the legend. More...
 
class  ColorMapperContinuousPropertyHandler
 Property handler for continuous colormapper properties. More...
 
class  ColorMapperFilledContoursPropertyHandler
 Property handler for colormapper filled contours properties. More...
 
class  ColorMapperFilledContoursUniformPropertyHandler
 Property handler for colormapper filled contours properties. More...
 
class  ContourLines
 Controlling how the contour lines are drawn. More...
 
class  CustomResultFunction
 A CustomResultFunction produces the output values of a custom result on a given item. More...
 
class  CustomResultGenerator
 A class to generate custom results. More...
 
class  CuttingPlane
 Configuration of a cutting plane. More...
 
class  CuttingPlaneAnimation
 Use this class to generate a cutting plane animation. More...
 
class  CuttingPlaneData
 Returns raw node coordinates and result values for a cutting plane. More...
 
class  CuttingPlanePropertyHandler
 Property handler for cutting plane properties. More...
 
class  DataElements
 Collection of elements in a part. Examples of element types are points, triangles or hexahedrons. More...
 
class  DataElementSet
 A DataElementSet is a set of unique elements within a DataSource. More...
 
class  DataElementSetBuilder
 Helper class for building element sets in an efficient matter. More...
 
class  DataElementSetGenerator
 This class is used to generate DataElementSets from the current DataSource of an UnstructGridModel. More...
 
class  DataElementSetItem
 This class identifies an element within an UnstructGrid model and is used as an item in a DataElementSet. More...
 
class  DataGeometry
 The geometry of the model for a certain state. More...
 
class  DataNodes
 Collection of coordinates (and optionally ids) of the element nodes in a part. More...
 
class  DataNodeSet
 A DataNodeSet is a set of unique nodes within a DataSource. More...
 
class  DataNodeSetGenerator
 This class is used to generate DataNodeSet's from the current DataSource of an UnstructGridModel. More...
 
class  DataNodeSetItem
 This class identifies a node within an UnstructGrid model and is used as an item in a DataNodeSet. More...
 
class  DataPart
 A part in the geometry. Consists of a collection of node coordinates and a collection element connectivities. More...
 
class  DataPartDisplacement
 Displacement results for a part. More...
 
class  DataPartScalar
 Scalar result values for a part. More...
 
class  DataPartSymmetricTensor
 Symmetric tensor result values for a part. More...
 
class  DataPartVector
 Vector result values for a part. More...
 
class  DataPartVisibility
 Per element visibility result for a part. More...
 
class  DataReader
 The DataReader is an easy and efficient way to get data into the UnstructGridModel, leveraging the data management support of UnstructGridModel through the DataSourceReader. More...
 
class  DataResultDisplacement
 Displacements results for all parts in the geometry. More...
 
class  DataResultGroup
 Result group binding a geometry and results (scalar, vector, displacement and/or transformation) More...
 
class  DataResultScalar
 Scalar result for all parts in the geometry. More...
 
class  DataResultSymmetricTensor
 Symmetric tensor results for all parts in the geometry. More...
 
class  DataResultTransformation
 Transformation results for all parts in the geometry. More...
 
class  DataResultVector
 Vector results for all parts in the geometry. More...
 
class  DataResultVisibility
 Visibility result for all parts in the geometry for one data state. More...
 
class  DataSource
 The data source of the model. For instance a file interface or custom built by the user. More...
 
class  DataSourceDirectory
 Metadata directory for a data source. More...
 
class  DataSourceInterface
 A parent class for interface data sources. More...
 
class  DataSourceMemory
 A custom built data source for an unstructured grid model. More...
 
class  DataSourceMerged
 A data source for an unstructured grid model that enabled merging of additional data sources. More...
 
class  DataSourceReader
 This class implements a data source that will use a DataReader to populate the data source with geometry and results data. More...
 
class  DataSourceVTF
 Data source interface for VTF model files. More...
 
class  DataSourceVTFx
 Data source interface for VTFx model files. More...
 
class  DataState
 A state contains all data available for one time step, load case or frequency. More...
 
class  DataStateSpec
 Specification of data to load for a state. More...
 
class  DisplacementSettings
 Settings for a specific displacement result. More...
 
class  Element
 Class for a FEM element. More...
 
class  ElementHighlighter
 Helper class for annotating elements. More...
 
class  ElementsQuery
 A query object for extracting data and information from data elements. More...
 
class  Error
 Error object for simple error management More...
 
class  HitItem
 Small class containing the data for a hit of an intersection between a ray and a part in an UnstructGridModel. More...
 
class  HitItemCollection
 A collection of HitItem instances. More...
 
class  Isosurface
 Configuration of an isosurface. More...
 
class  IsosurfaceData
 Returns raw node coordinates and result values for an isosurface. More...
 
class  IsosurfacePropertyHandler
 Property handler for isosurface properties. More...
 
class  Isovolume
 Configuration of an isovolume. More...
 
class  IsovolumeData
 Returns raw node coordinates and result values for an isovolume. More...
 
class  IsovolumePropertyHandler
 Property handler for isovolume properties. More...
 
class  MirrorSettings
 Settings for mirrors in the model. More...
 
class  MirrorSettingsPropertyHandler
 Property handler for mirror settings properties. More...
 
class  ModelSettings
 Various settings for the unstructured grid model. More...
 
class  ModelSpec
 The model specification. More...
 
class  ModeShapeAnimation
 Settings for mode shape animation. More...
 
class  OverlayColorLegend
 A color legend to show as overlay in the view. More...
 
class  OverlayColorLegendPropertyHandler
 Property handler for overlay color legend properties. More...
 
class  OverlayImagePropertyHandler
 Property handler for overlay image properties. More...
 
class  OverlayPlotCurvePropertyHandler
 Property handler for overlay plot curve properties. More...
 
class  OverlayPlotPropertyHandler
 Property handler for overlay plot properties. More...
 
class  PartHitItems
 Class for storing identifier for a part (state id, geometry id, part id/index) and optionally also a list of element indices within this part. More...
 
class  ParticleTraceData
 Data for a single particle trace within a group. More...
 
class  ParticleTraceGroup
 Configuration of a group of particle trace objects. More...
 
class  ParticleTraceGroupPropertyHandler
 Property handler for particle trace group properties. More...
 
class  ParticleTraceUtils
 Utilities for particle traces. More...
 
class  PartInfo
 Simple class containing metadata info for a part. More...
 
class  PartSettings
 Settings for a specific part. More...
 
class  PartSettingsIterator
 Part settings iterator. More...
 
class  PartSettingsPropertyHandler
 Property handler for part settings properties. More...
 
class  PartSettingsTexture
 Texture part settings. More...
 
class  Progress
 Progress object class. More...
 
class  PropertyApplierPlot2d
 Creates overlay plots from VTFx properties in a property set collection and the corresponding data source. More...
 
class  PropertyApplierVTFx
 Applies VTFx properties in a property set collection and image resources to an existing model or view. More...
 
class  PropertyBuilder
 Finds VTFx properties from model and/or view and builds a property set collection and image resources. More...
 
class  ResultCalculatorParams
 Parameters for a given result calculator. More...
 
class  ResultInfo
 Simple class containing metadata info for a result. More...
 
class  ResultSelectionPropertyHandler
 Property handler for result section properties. More...
 
class  ResultsQuery
 A query object to retrieve results from a given DataSource. More...
 
class  ResultsQueryItem
 Used to identify an element or a node within a DataGeometry in order to query result values for it using a ResultsQuery. More...
 
class  ResultsQueryResult
 A ResultsQuery result that contains the values found by a ResultsQuery on one ResultsQueryItem. More...
 
class  ResultsQueryResultPosition
 A ResultsQueryResultPosition object contains the position and the ResultsQueryResult of a specific value. More...
 
class  ScalarSettings
 Settings for a specific scalar result. More...
 
class  ScalarSettingsPropertyHandler
 Property handler for scalar settings properties. More...
 
class  SectionCategoryInfo
 Simple class containing metadata info for a section category. More...
 
class  SectionGroupInfo
 Simple class containing metadata info for a section Group. More...
 
class  SectionInfo
 Simple class containing metadata info for a section. More...
 
class  SetInfo
 Simple class containing metadata info for a set. More...
 
class  SetPropertyHandler
 Property handler for set properties. More...
 
class  SimulationInfo
 Simple class containing metadata info for the simulation that produced the model database. More...
 
class  Situation
 A situation stores the setup of the unstructgrid model and view. More...
 
class  SituationIo
 A class to read and write a Situation. More...
 
class  StateGroupInfo
 Simple class containing metadata info for a group of states. More...
 
class  StateInfo
 Simple class containing metadata info for a state. More...
 
class  StateSelectionPropertyHandler
 Property handler for state selection properties. More...
 
class  SurfacePathQuery
 Helper class for generating a path on a UnstructGridModel model and for sampling a scalar value along this path. More...
 
class  UnstructGridComponent
 Static class for initialization of the component. More...
 
class  UnstructGridModel
 UnstructGridModel is a subclass of Model which adds specific model structure and functionality for representing scientific and engineering models, e.g. finite element data. More...
 
class  VectorSettings
 Settings for a specific vector result. More...
 
class  VectorSettingsPropertyHandler
 Property handler for vector settings properties. More...
 
class  ViewClippingPlanePropertyHandler
 Property handler for view clipping plane properties. More...
 
class  ViewerPropertyHandler
 Property handler for viewer properties. More...
 
class  VisualizationParticleTraceQuery
 Query for particle trace data. More...
 
class  VisualizationPartQuery
 Query for visible nodes, elements or triangles for a given part. More...
 
class  VTFxFileBrowser
 Helper class that allows you to read case metadata from a VTFx file. More...
 
class  VTFxMemoryFile
 A VTFx model file existing in memory. More...
 

Typedefs

typedef ResultInfo CustomResultArgument
 

Enumerations

enum  ResultMapping {
  PER_NODE = 1, PER_ELEMENT, PER_ELEMENT_NODE, PER_ELEMENT_SURFACE,
  UNKNOWN_MAPPING = 99
}
 Available scalar and vector result mappings. More...
 
enum  DeriveOperation {
  NOT_DERIVED = 0, X_COMPONENT, Y_COMPONENT, Z_COMPONENT,
  MAGNITUDE, XX_COMPONENT, YY_COMPONENT, ZZ_COMPONENT,
  XY_COMPONENT, YZ_COMPONENT, ZX_COMPONENT, VON_MISES,
  FIRST_PRINCIPAL, SECOND_PRINCIPAL, THIRD_PRINCIPAL, FIRST_PRINCIPAL_VECTOR,
  SECOND_PRINCIPAL_VECTOR, THIRD_PRINCIPAL_VECTOR, DISPLACEMENT_VECTOR, UNKNOWN_DERIVE_OPERATION = 99
}
 Available operations to derive a result from a base result. More...
 
enum  ResultType {
  SCALAR = 1, VECTOR, DISPLACEMENT, SYMMETRIC_TENSOR,
  VISIBILITY, ELEMENT, NO_RESULT_TYPE, UNKNOWN_RESULT_TYPE = 99
}
 Different types of results. More...
 
enum  StrainType { ENGINEERING_STRAIN = 1, STANDARD_STRAIN, NO_STRAIN_TYPE = 99 }
 Type of the strain result in the model, if any. More...
 
enum  SimulationType {
  SIMULATION_TYPE_STRUCTURAL, SIMULATION_TYPE_THERMAL, SIMULATION_TYPE_ELECTRIC, SIMULATION_TYPE_MAGNETIC,
  SIMULATION_TYPE_FLUID, SIMULATION_TYPE_ACOUSTIC, SIMULATION_TYPE_DIFFUSION, SIMULATION_TYPE_OTHER
}
 Type of the simulation run to produce the result database. More...
 
enum  SolutionType {
  SOLUTION_TYPE_STATIC, SOLUTION_TYPE_STEADY_STATE, SOLUTION_TYPE_VIBRATION, SOLUTION_TYPE_BUCKLING,
  SOLUTION_TYPE_TRANSIENT, SOLUTION_TYPE_SUPERELEMENT, SOLUTION_TYPE_FREQRESPONSE, SOLUTION_TYPE_COMPLEXEIGEN,
  SOLUTION_TYPE_QUASISTATIC, SOLUTION_TYPE_OUTPUT, SOLUTION_TYPE_SINGULAR, SOLUTION_TYPE_OTHER
}
 Type of the solution run to produce the result database. More...
 

Detailed Description

Namespace cee::ug contains all functionality and structures under the UnstructGrid component.

Enumeration Type Documentation

Available operations to derive a result from a base result.

Enumerator
X_COMPONENT 

Derive X-component Scalar result from Vector or Displacement results.

Y_COMPONENT 

Derive Y-component Scalar result from Vector or Displacement results.

Z_COMPONENT 

Derive Z-component Scalar result from Vector or Displacement results.

MAGNITUDE 

Derive Magnitude Scalar result from Vector or Displacement results.

XX_COMPONENT 

Derive XX-component Scalar result from SymmetricTensor result.

YY_COMPONENT 

Derive YY-component Scalar result from SymmetricTensor result.

ZZ_COMPONENT 

Derive ZZ-component Scalar result from SymmetricTensor result.

XY_COMPONENT 

Derive XY-component Scalar result from SymmetricTensor result.

YZ_COMPONENT 

Derive YZ-component Scalar result from SymmetricTensor result.

ZX_COMPONENT 

Derive ZX-component Scalar result from SymmetricTensor result.

VON_MISES 

Derive VonMises Scalar result from SymmetricTensor result.

FIRST_PRINCIPAL 

Derive 1st principal Scalar result from SymmetricTensor result.

SECOND_PRINCIPAL 

Derive 2nd principal Scalar result from SymmetricTensor result.

THIRD_PRINCIPAL 

Derive 3rd principal Scalar result from SymmetricTensor result.

FIRST_PRINCIPAL_VECTOR 

Derive 1st principal Vector result from SymmetricTensor result.

SECOND_PRINCIPAL_VECTOR 

Derive 2nd principal Vector result from SymmetricTensor result.

THIRD_PRINCIPAL_VECTOR 

Derive 3rd principal Vector result from SymmetricTensor result.

DISPLACEMENT_VECTOR 

Derive displacement Vector result from Displacement result.

Available scalar and vector result mappings.

Enumerator
PER_NODE 

Per node.

PER_ELEMENT 

Per element.

PER_ELEMENT_NODE 

Per element node.

PER_ELEMENT_SURFACE 

Per element surface.

Different types of results.

Enumerator
SCALAR 

Scalar result.

VECTOR 

Vector result.

DISPLACEMENT 

Scalar result.

SYMMETRIC_TENSOR 

Symmetric tensor result.

VISIBILITY 

Result used to indicate element visibility.

ELEMENT 

General element result.

NO_RESULT_TYPE 

No type.

Type of the simulation run to produce the result database.

Type of the solution run to produce the result database.

Type of the strain result in the model, if any.

Enumerator
ENGINEERING_STRAIN 

Strain tensor components are engineering values (off-diagonal components are doubled)

STANDARD_STRAIN 

Standard strain tensor components.

NO_STRAIN_TYPE 

No strain type, result is not a strain tensor.