    

 ## On this page

  

 

 # Namespace ansys::dpf

 Last update: 25.03.2026 

<a id="namespaceansys-dpf"></a>

![](https://img.shields.io/badge/language-C%2B%2B-blue "C++")

This is the main namespace of the HGP API.

This namespace encapsulates all of the HGP functionality.

## Classes

- [ansys::dpf::Model](classansys-dpf-model.md#classansys-dpf-model)
- [ansys::dpf::Result](classansys-dpf-result.md#classansys-dpf-result)
- [ansys::dpf::MeshQuery](classansys-dpf-meshquery.md#classansys-dpf-meshquery)
- [ansys::dpf::Collection](classansys-dpf-collection.md#classansys-dpf-collection)
- [ansys::dpf::ExternalData](classansys-dpf-externaldata.md#classansys-dpf-externaldata)
- [ansys::dpf::ExternalDataT](classansys-dpf-externaldatat.md#classansys-dpf-externaldatat)
- [ansys::dpf::array\_to\_pointer\_decay](structansys-dpf-array-to-pointer-decay.md#structansys-dpf-array-to-pointer-decay)
- [ansys::dpf::array\_to\_pointer\_decay&lt; T\[N\]&gt;](structansys-dpf-array-to-pointer-decay-t-fn-e.md#structansys-dpf-array-to-pointer-decay-t-fn-e-4)
- [ansys::dpf::ConstructHelpers](structansys-dpf-constructhelpers.md#structansys-dpf-constructhelpers)
- [ansys::dpf::SemanticVersion](classansys-dpf-semanticversion.md#classansys-dpf-semanticversion)
- [ansys::dpf::Any](classansys-dpf-any.md#classansys-dpf-any)
- [ansys::dpf::Unit](classansys-dpf-unit.md#classansys-dpf-unit)
- [ansys::dpf::ResultInfo](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo)
- [ansys::dpf::FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition)
- [ansys::dpf::LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace)
- [ansys::dpf::Scoping](classansys-dpf-scoping.md#classansys-dpf-scoping)
- [ansys::dpf::ElementCursor](classansys-dpf-elementcursor.md#classansys-dpf-elementcursor)
- [ansys::dpf::Support](classansys-dpf-support.md#classansys-dpf-support)
- [ansys::dpf::MeshedRegion](classansys-dpf-meshedregion.md#classansys-dpf-meshedregion)
- [ansys::dpf::TimeFreqSupport](classansys-dpf-timefreqsupport.md#classansys-dpf-timefreqsupport)
- [ansys::dpf::CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport)
- [ansys::dpf::GenericSupport](classansys-dpf-genericsupport.md#classansys-dpf-genericsupport)
- [ansys::dpf::DataTree](classansys-dpf-datatree.md#classansys-dpf-datatree)
- [ansys::dpf::CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield)
- [ansys::dpf::FieldCursor](classansys-dpf-fieldcursor.md#classansys-dpf-fieldcursor)
- [ansys::dpf::Field](classansys-dpf-field.md#classansys-dpf-field)
- [ansys::dpf::PropFieldCursor](classansys-dpf-propfieldcursor.md#classansys-dpf-propfieldcursor)
- [ansys::dpf::PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield)
- [ansys::dpf::StringField](classansys-dpf-stringfield.md#classansys-dpf-stringfield)
- [ansys::dpf::CollectionBase](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase)
- [ansys::dpf::FieldsContainer](classansys-dpf-fieldscontainer.md#classansys-dpf-fieldscontainer)
- [ansys::dpf::ScopingsContainer](classansys-dpf-scopingscontainer.md#classansys-dpf-scopingscontainer)
- [ansys::dpf::MeshesContainer](classansys-dpf-meshescontainer.md#classansys-dpf-meshescontainer)
- [ansys::dpf::CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer)
- [ansys::dpf::DataSources](classansys-dpf-datasources.md#classansys-dpf-datasources)
- [ansys::dpf::ExternalStream](classansys-dpf-externalstream.md#classansys-dpf-externalstream)
- [ansys::dpf::Streams](classansys-dpf-streams.md#classansys-dpf-streams)
- [ansys::dpf::Operator](classansys-dpf-operator.md#classansys-dpf-operator)
- [ansys::dpf::CacheInformation](classansys-dpf-cacheinformation.md#classansys-dpf-cacheinformation)
- [ansys::dpf::Workflow](classansys-dpf-workflow.md#classansys-dpf-workflow)
- [ansys::dpf::OperatorConfig](classansys-dpf-operatorconfig.md#classansys-dpf-operatorconfig)
- [ansys::dpf::GenericDataContainer](classansys-dpf-genericdatacontainer.md#classansys-dpf-genericdatacontainer)
- [ansys::dpf::CustomContainerBase](classansys-dpf-customcontainerbase.md#classansys-dpf-customcontainerbase)
- [ansys::dpf::MeshInfo](classansys-dpf-meshinfo.md#classansys-dpf-meshinfo)
- [ansys::dpf::Mapping](classansys-dpf-mapping.md#classansys-dpf-mapping)
- [ansys::dpf::Interface](classansys-dpf-interface.md#classansys-dpf-interface)
- [ansys::dpf::WorkflowStep](classansys-dpf-workflowstep.md#classansys-dpf-workflowstep)
- [ansys::dpf::OperatorMain](classansys-dpf-operatormain.md#classansys-dpf-operatormain)
- [ansys::dpf::OperatorDerivativeMain](classansys-dpf-operatorderivativemain.md#classansys-dpf-operatorderivativemain)
- [ansys::dpf::PinDefinition](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition)
- [ansys::dpf::ConfigOptionSpecification](structansys-dpf-configoptionspecification.md#structansys-dpf-configoptionspecification)
- [ansys::dpf::OperatorSpecification](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification)
- [ansys::dpf::RemoteOperator](classansys-dpf-remoteoperator.md#classansys-dpf-remoteoperator)
- [ansys::dpf::RemoteWorkflow](classansys-dpf-remoteworkflow.md#classansys-dpf-remoteworkflow)
- [ansys::dpf::EventHandler](classansys-dpf-eventhandler.md#classansys-dpf-eventhandler)
- [ansys::dpf::Session](classansys-dpf-session.md#classansys-dpf-session)
- [ansys::dpf::RuntimeConfig](classansys-dpf-runtimeconfig.md#classansys-dpf-runtimeconfig)
- [ansys::dpf::RuntimeCoreConfig](classansys-dpf-runtimecoreconfig.md#classansys-dpf-runtimecoreconfig)
- [ansys::dpf::RuntimeClientConfig](classansys-dpf-runtimeclientconfig.md#classansys-dpf-runtimeclientconfig)
- [ansys::dpf::Changelog](classansys-dpf-changelog.md#classansys-dpf-changelog)
- [ansys::dpf::core](classansys-dpf-core.md#classansys-dpf-core)
- [ansys::dpf::reflect&lt; Field &gt;](structansys-dpf-reflect-field.md#structansys-dpf-reflect-field-4)
- [ansys::dpf::reflect&lt; FieldsContainer &gt;](structansys-dpf-reflect-fieldscontainer.md#structansys-dpf-reflect-fieldscontainer-4)
- [ansys::dpf::reflect&lt; MeshedRegion &gt;](structansys-dpf-reflect-meshedregion.md#structansys-dpf-reflect-meshedregion-4)
- [ansys::dpf::reflect&lt; DataSources &gt;](structansys-dpf-reflect-datasources.md#structansys-dpf-reflect-datasources-4)
- [ansys::dpf::reflect&lt; Streams &gt;](structansys-dpf-reflect-streams.md#structansys-dpf-reflect-streams-4)
- [ansys::dpf::reflect&lt; Scoping &gt;](structansys-dpf-reflect-scoping.md#structansys-dpf-reflect-scoping-4)
- [ansys::dpf::reflect&lt; ScopingsContainer &gt;](structansys-dpf-reflect-scopingscontainer.md#structansys-dpf-reflect-scopingscontainer-4)
- [ansys::dpf::reflect&lt; MeshesContainer &gt;](structansys-dpf-reflect-meshescontainer.md#structansys-dpf-reflect-meshescontainer-4)
- [ansys::dpf::reflect&lt; PropertyField &gt;](structansys-dpf-reflect-propertyfield.md#structansys-dpf-reflect-propertyfield-4)
- [ansys::dpf::reflect&lt; ResultInfo &gt;](structansys-dpf-reflect-resultinfo.md#structansys-dpf-reflect-resultinfo-4)
- [ansys::dpf::reflect&lt; TimeFreqSupport &gt;](structansys-dpf-reflect-timefreqsupport.md#structansys-dpf-reflect-timefreqsupport-4)
- [ansys::dpf::reflect&lt; DataTree &gt;](structansys-dpf-reflect-datatree.md#structansys-dpf-reflect-datatree-4)
- [ansys::dpf::reflect&lt; Workflow &gt;](structansys-dpf-reflect-workflow.md#structansys-dpf-reflect-workflow-4)
- [ansys::dpf::reflect&lt; Operator &gt;](structansys-dpf-reflect-operator.md#structansys-dpf-reflect-operator-4)
- [ansys::dpf::reflect&lt; RemoteOperator &gt;](structansys-dpf-reflect-remoteoperator.md#structansys-dpf-reflect-remoteoperator-4)
- [ansys::dpf::reflect&lt; RemoteWorkflow &gt;](structansys-dpf-reflect-remoteworkflow.md#structansys-dpf-reflect-remoteworkflow-4)
- [ansys::dpf::reflect&lt; StringField &gt;](structansys-dpf-reflect-stringfield.md#structansys-dpf-reflect-stringfield-4)
- [ansys::dpf::reflect&lt; CustomTypeField &gt;](structansys-dpf-reflect-customtypefield.md#structansys-dpf-reflect-customtypefield-4)
- [ansys::dpf::reflect&lt; LabelSpace &gt;](structansys-dpf-reflect-labelspace.md#structansys-dpf-reflect-labelspace-4)
- [ansys::dpf::reflect&lt; GenericDataContainer &gt;](structansys-dpf-reflect-genericdatacontainer.md#structansys-dpf-reflect-genericdatacontainer-4)
- [ansys::dpf::reflect&lt; CustomTypeFieldsContainer &gt;](structansys-dpf-reflect-customtypefieldscontainer.md#structansys-dpf-reflect-customtypefieldscontainer-4)
- [ansys::dpf::LicenseContextManager](classansys-dpf-licensecontextmanager.md#classansys-dpf-licensecontextmanager)
- [ansys::dpf::reflect](structansys-dpf-reflect.md#structansys-dpf-reflect)
- [ansys::dpf::param\_helpers](structansys-dpf-param-helpers.md#structansys-dpf-param-helpers)
- [ansys::dpf::QuantityType](structansys-dpf-quantitytype.md#structansys-dpf-quantitytype)
- [ansys::dpf::quantity\_types](structansys-dpf-quantity-types.md#structansys-dpf-quantity-types)
- [ansys::dpf::Location](structansys-dpf-location.md#structansys-dpf-location)
- [ansys::dpf::locations](structansys-dpf-locations.md#structansys-dpf-locations)
- [ansys::dpf::PropertyType](structansys-dpf-propertytype.md#structansys-dpf-propertytype)
- [ansys::dpf::property\_types](structansys-dpf-property-types.md#structansys-dpf-property-types)
- [ansys::dpf::Homogeneity](classansys-dpf-homogeneity.md#classansys-dpf-homogeneity)
- [ansys::dpf::homogeneities](structansys-dpf-homogeneities.md#structansys-dpf-homogeneities)
- [ansys::dpf::UnitSystem](structansys-dpf-unitsystem.md#structansys-dpf-unitsystem)
- [ansys::dpf::unit\_systems](structansys-dpf-unit-systems.md#structansys-dpf-unit-systems)
- [ansys::dpf::Label](structansys-dpf-label.md#structansys-dpf-label)
- [ansys::dpf::labels](structansys-dpf-labels.md#structansys-dpf-labels)
- [ansys::dpf::ShellDescriptor](structansys-dpf-shelldescriptor.md#structansys-dpf-shelldescriptor)
- [ansys::dpf::ElementDescriptor](structansys-dpf-elementdescriptor.md#structansys-dpf-elementdescriptor)
- [ansys::dpf::elements](structansys-dpf-elements.md#structansys-dpf-elements)
- [ansys::dpf::TypeDescriptor](structansys-dpf-typedescriptor.md#structansys-dpf-typedescriptor)
- [ansys::dpf::types](structansys-dpf-types.md#structansys-dpf-types)
- [ansys::dpf::Dimensionality](structansys-dpf-dimensionality.md#structansys-dpf-dimensionality)
- [ansys::dpf::dimensionalities](structansys-dpf-dimensionalities.md#structansys-dpf-dimensionalities)
- [ansys::dpf::spec](structansys-dpf-spec.md#structansys-dpf-spec)
- [ansys::dpf::DpfTypes](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes)
- [ansys::dpf::Client](classansys-dpf-client.md#classansys-dpf-client)
- [ansys::dpf::DpfError](classansys-dpf-dpferror.md#classansys-dpf-dpferror)
- [ansys::dpf::DpfException](classansys-dpf-dpfexception.md#classansys-dpf-dpfexception)
- [ansys::dpf::DpfVectorDataHelper](structansys-dpf-dpfvectordatahelper.md#structansys-dpf-dpfvectordatahelper)
- [ansys::dpf::DpfVectorData](classansys-dpf-dpfvectordata.md#classansys-dpf-dpfvectordata)
- [ansys::dpf::DpfVector](classansys-dpf-dpfvector.md#classansys-dpf-dpfvector)
- [ansys::dpf::Context](classansys-dpf-context.md#classansys-dpf-context)
- [ansys::dpf::LibraryHandle](classansys-dpf-libraryhandle.md#classansys-dpf-libraryhandle)
- [ansys::dpf::LibraryHolder](classansys-dpf-libraryholder.md#classansys-dpf-libraryholder)
- [ansys::dpf::reflect&lt; int &gt;](structansys-dpf-reflect-int.md#structansys-dpf-reflect-int-4)
- [ansys::dpf::reflect&lt; double &gt;](structansys-dpf-reflect-double.md#structansys-dpf-reflect-double-4)
- [ansys::dpf::reflect&lt; bool &gt;](structansys-dpf-reflect-bool.md#structansys-dpf-reflect-bool-4)
- [ansys::dpf::reflect&lt; size\_t &gt;](structansys-dpf-reflect-size-t.md#structansys-dpf-reflect-size-t-4)
- [ansys::dpf::reflect&lt; int64\_t &gt;](structansys-dpf-reflect-int64-t.md#structansys-dpf-reflect-int64-t-4)
- [ansys::dpf::reflect&lt; char &gt;](structansys-dpf-reflect-char.md#structansys-dpf-reflect-char-4)
- [ansys::dpf::reflect&lt; wchar\_t &gt;](structansys-dpf-reflect-wchar-t.md#structansys-dpf-reflect-wchar-t-4)
- [ansys::dpf::reflect&lt; float &gt;](structansys-dpf-reflect-float.md#structansys-dpf-reflect-float-4)
- [ansys::dpf::reflect&lt; unsigned int &gt;](structansys-dpf-reflect-unsigned-int.md#structansys-dpf-reflect-unsigned-int-4)
- [ansys::dpf::reflect&lt; short &gt;](structansys-dpf-reflect-short.md#structansys-dpf-reflect-short-4)
- [ansys::dpf::reflect&lt; int8\_t &gt;](structansys-dpf-reflect-int8-t.md#structansys-dpf-reflect-int8-t-4)

## Enumeration types

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1"></a>

### Enumeration type pin

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
enum pin {
  eTimeScopPin = 0,
  eMeshScopPin = 1,
  eFieldsContainerPin = 2,
  eStreamPin = 3,
  eDataSourcesPin = 4,
  eRotToGlobalPin = 5,
  eParameter1Pin = 6,
  eMeshRegionPin = 7,
  eTimeFreqSupportPin = 8,
  eLocationPin = 9,
  eSecondFieldsContainerPin = 10,
  ePhysicalMeshScopPin = 11,
  eElementToNodalAverage = 12,
  ePropertyPin = 13,
  eReadCyclicPin = 14,
  eExpandedMeshRegionPin = 15,
  eCyclicSupportPin = 16,
  eDomainIdPin = 17,
  eSectorsScopPin = 18,
  eCyclicPhasePin = 19,
  eFilterResultsPin = 20,
  eFilterDegeneratedElPin = eFilterResultsPin,
  eHarmonicData = 21,
  eReadBeams = 22,
  eReorderENFPin = 23,
  eMetaDataPin = 24,
  ePartIdPin = 25,
  eMergeShellsPin = 26,
  eSplitShellsPin = 26,
  eShellLayerPin = 27,
  eUnitSystemPin = 50,
  eIdentifierPin = 60,
  eCacheHandlerPin = 61,
  eSourceOperatorPin = 62,
  eResultOperatorPin = 63,
  eDownStreamInfoPin = 100,
  eDownStreamResultPin = 101,
  eTuningPin =200
}

```

[Operator](classansys-dpf-operator.md#classansys-dpf-operator) connection pins

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1ac390a52dd8c4f1e8ff81a162cdc04d4f"></a>

#### Enumerator eTimeScopPin

Time scope

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a79a70f074b2f79ccaff75ae8e4ec9ec9"></a>

#### Enumerator eMeshScopPin

Mesh scope

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1af2c0ae047340bd15a80ef22d8711a455"></a>

#### Enumerator eFieldsContainerPin

Fields container

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a0f5631bb51d4a3e4a40e167cb1198799"></a>

#### Enumerator eStreamPin

Stream

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a5b6613f802062fde4faea4b553db7fbc"></a>

#### Enumerator eDataSourcesPin

Data sources

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a6a90da988334e2b3e0f9c41b03c407eb"></a>

#### Enumerator eRotToGlobalPin

Rot to global

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1affe5ff8fa5271741a9a8b93259dd2453"></a>

#### Enumerator eParameter1Pin

Parameter 1

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a88b6b8d0c02d2ac48fc40e8c02e3da7c"></a>

#### Enumerator eMeshRegionPin

Mesh region

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a10e202ebd92b2d71757c4c075f841fa6"></a>

#### Enumerator eTimeFreqSupportPin

Time frequency support

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1aa8522e00b69f3a2f2626a088f20823fe"></a>

#### Enumerator eLocationPin

[Location](structansys-dpf-location.md#structansys-dpf-location).

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a2970c8895cf1e20fb11a14896cc974bd"></a>

#### Enumerator eSecondFieldsContainerPin

Second fields container

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a66c4c9745677a5a8a2c844068f8a90ac"></a>

#### Enumerator ePhysicalMeshScopPin

Physical mesh scope

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1af5995777fdd2d43237d5e89c5315fffb"></a>

#### Enumerator eElementToNodalAverage

Element to nodal average

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1ab0a4214c639c00048ce8444f185543a2"></a>

#### Enumerator ePropertyPin

Property

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1ace74ea2958a32198189da2605bbf6d5b"></a>

#### Enumerator eReadCyclicPin

Read Cyclic

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a00364d8567e1117257690620bfa95276"></a>

#### Enumerator eExpandedMeshRegionPin

Expanded mesh region

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a1a9d64adcded0ac9bec3f370b541fbe9"></a>

#### Enumerator eCyclicSupportPin

Cyclic support

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1aa35c64dc0dc7675e4bb14e3919c35665"></a>

#### Enumerator eDomainIdPin

Domain Id

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a8ba7de7931a232a75e50cc3c6679ca9c"></a>

#### Enumerator eSectorsScopPin

Sectors scope

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1aab92d7c849d97afb6b5ee9ea27342e02"></a>

#### Enumerator eCyclicPhasePin

Cyclic phase

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a84e75712a09a148e7cf5204fa3ec5475"></a>

#### Enumerator eFilterResultsPin

Filter results

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a9218c2b63a3ebece21e101df19ea2c36"></a>

#### Enumerator eFilterDegeneratedElPin

Filter degenerated element **Deprecated**:

use eFilterResults pin instead

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1afcdff334e47095eeb0b2201aab357c25"></a>

#### Enumerator eHarmonicData

Harmonic data

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1aebc7afc12a376080ddec43f7908e428f"></a>

#### Enumerator eReadBeams

Read Beam data

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1ab91a4eb913483409f08befef7eb0ac34"></a>

#### Enumerator eReorderENFPin

Reorder Nodal Forces

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1aa9c7a92bb8960158b9709704aff3d531"></a>

#### Enumerator eMetaDataPin

Pin for meta data

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a5977b66ff62b8c5257c4b314e36545eb"></a>

#### Enumerator ePartIdPin

Pin for Part Id

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a8d47c8fbb596e6b46fa443a92a3f25d5"></a>

#### Enumerator eMergeShellsPin

Merge shells and solids (averaging)

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a0fcfab2a5671e07a18bf84098723350a"></a>

#### Enumerator eSplitShellsPin

Split shells and solids (results extraction)

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a61c269ed0fd3a36726b178c49b6ab141"></a>

#### Enumerator eShellLayerPin

Specicy a shell layer (results extraction)

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a97111226c931e88e1f8a1c964f4b0293"></a>

#### Enumerator eUnitSystemPin

[Unit](classansys-dpf-unit.md#classansys-dpf-unit) System pin

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1aefbb38f839ed10384cc3e04f057ea683"></a>

#### Enumerator eIdentifierPin

Identifier

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a02d67729d39a01086c5ac0f9b176d2bb"></a>

#### Enumerator eCacheHandlerPin

Cache handler

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a158f1a1fe3036626ed8ee3311324b8f5"></a>

#### Enumerator eSourceOperatorPin

Source operator

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a02ec14627f4203c2697df68eeb5a741e"></a>

#### Enumerator eResultOperatorPin

[Result](classansys-dpf-result.md#classansys-dpf-result) operator

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1ac8612a967fd7a535c46ffddcb7e7261a"></a>

#### Enumerator eDownStreamInfoPin

Down stream info

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1add3b446fd8dd46634c61f689ab6b1530"></a>

#### Enumerator eDownStreamResultPin

Down stream result

<a id="namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1af607f86e9475d2229252adf8e0b133ca"></a>

#### Enumerator eTuningPin

Tuning

<a id="namespaceansys-dpf-1a6d14c6ea165905b13e914d776c880751"></a>

### Enumeration type eshellLayers

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
enum eshellLayers {
  eTop = 0,
  eBottom = 1,
  eTopBottom = 2,
  eMid = 3,
  eTopBottomMid = 4,
  eNoneLayer = 5,
  eLayerIndependent = 6
}

```

Types of shell layers.

<a id="namespaceansys-dpf-1a6d14c6ea165905b13e914d776c880751abba81b5c651a204d16fc833715d65073"></a>

#### Enumerator eTop

Top shell layer

<a id="namespaceansys-dpf-1a6d14c6ea165905b13e914d776c880751a8ae95c0560f3eb57e2f2eb2421c17ac2"></a>

#### Enumerator eBottom

Bottom shell layer

<a id="namespaceansys-dpf-1a6d14c6ea165905b13e914d776c880751a5c57d647575d231025e6c5ed0ceb5fa5"></a>

#### Enumerator eTopBottom

Both Top and Bottom shell layer

<a id="namespaceansys-dpf-1a6d14c6ea165905b13e914d776c880751ae1b31c2caf647397b019fe1771d02ffa"></a>

#### Enumerator eMid

Middle shell layer

<a id="namespaceansys-dpf-1a6d14c6ea165905b13e914d776c880751af7ead61ae7d3acaca5c5108534158558"></a>

#### Enumerator eTopBottomMid

All shell layers

<a id="namespaceansys-dpf-1a6d14c6ea165905b13e914d776c880751acb131433cf92a2b813e983388037ef5b"></a>

#### Enumerator eNoneLayer

No shell layer

<a id="namespaceansys-dpf-1a6d14c6ea165905b13e914d776c880751a3537a8a6c0e5d7df7d8515b8e36142d1"></a>

#### Enumerator eLayerIndependent

Independent shell layer. The model might have shell layers, but the associated result does not rely on them.

<a id="namespaceansys-dpf-1aa85785755f5470ad631e33d5c44a1dcb"></a>

### Enumeration type OperatorState

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
enum OperatorState {
  eNotUptodate,
  eUpToDate,
  eFailed,
  eRunning
}

```

Status of operator.

<a id="namespaceansys-dpf-1aa85785755f5470ad631e33d5c44a1dcba48ef57c6e916a8c5aae7c2c9271242b9"></a>

#### Enumerator eNotUptodate

Not up to date.

<a id="namespaceansys-dpf-1aa85785755f5470ad631e33d5c44a1dcba2065e6350fac4dddc827026492136da8"></a>

#### Enumerator eUpToDate

Up to date.

<a id="namespaceansys-dpf-1aa85785755f5470ad631e33d5c44a1dcbaffeeb724410e7def0b3ad4b2ff92e839"></a>

#### Enumerator eFailed

Failed to run.

<a id="namespaceansys-dpf-1aa85785755f5470ad631e33d5c44a1dcbab23499ad7f3dd05d99fd73010d51558a"></a>

#### Enumerator eRunning

Still running.

<a id="namespaceansys-dpf-1a318ab16f856ec8d2ef6e13af94a6dc56"></a>

### Enumeration type ApiType

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
enum ApiType {
  local,
  remote
}

```

API connection type.

<a id="namespaceansys-dpf-1a318ab16f856ec8d2ef6e13af94a6dc56af5ddaf0ca7929578b408c909429f68f2"></a>

#### Enumerator local

Local API.

<a id="namespaceansys-dpf-1a318ab16f856ec8d2ef6e13af94a6dc56a2c18e486683a3db1e645ad8523223b72"></a>

#### Enumerator remote

Remote API.

<a id="namespaceansys-dpf-1ac4f1380f00170887891b5cf54d8c94b3"></a>

### Enumeration type LoadType

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
enum LoadType {
  assert_load,
  try_load
}

```

Load type.

<a id="namespaceansys-dpf-1ac4f1380f00170887891b5cf54d8c94b3a568e48779e3958b6d9c632b759bee1cb"></a>

#### Enumerator assert\_load

Requests a fully successful load of all function's symbols of the DPF API.

<a id="namespaceansys-dpf-1ac4f1380f00170887891b5cf54d8c94b3a6d450e9598ea0dffeaff74fbcccb116f"></a>

#### Enumerator try\_load

Try to load all function's symbols of the DPF API without being constrained if a part is missing.

<a id="namespaceansys-dpf-1a02d1b14b4a34eeae292e89f8ee7cfe60"></a>

### Enumeration type EDpfContext

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
enum EDpfContext {
  eDefault = 0,
  eStandalone = 1,
  eUserDefined = 2,
  eCustomDefinedLocation = 3,
  eEntry = 4
}

```

Enum to select the DPF context. This determines how DPF is loaded and initialized.

<a id="namespaceansys-dpf-1a02d1b14b4a34eeae292e89f8ee7cfe60aaf71f03861810014d736fcbae9d6050e"></a>

#### Enumerator eDefault

<a id="namespaceansys-dpf-1a02d1b14b4a34eeae292e89f8ee7cfe60af7172b6cb5f8beb46b3389f9f33f8690"></a>

#### Enumerator eStandalone

<a id="namespaceansys-dpf-1a02d1b14b4a34eeae292e89f8ee7cfe60a12d2a3e5f52831145ad19695024ee705"></a>

#### Enumerator eUserDefined

<a id="namespaceansys-dpf-1a02d1b14b4a34eeae292e89f8ee7cfe60a56043158bc02e5a05a5a75b97b3ee080"></a>

#### Enumerator eCustomDefinedLocation

<a id="namespaceansys-dpf-1a02d1b14b4a34eeae292e89f8ee7cfe60a4ea9c7a230937e9bceea1919a1c06ce9"></a>

#### Enumerator eEntry

## Typedefs

<a id="namespaceansys-dpf-1aadbf5b3c4ae5a01b37d6ef52d0c2bca1"></a>

### Typedef OperatorCallBack

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
typedef void(__stdcall * ansys::dpf::OperatorCallBack) (void *, opaque::DpfOperatorData *)

```

**Return type**: void(\_\_stdcall \*

<a id="namespaceansys-dpf-1aae87befbe5e66e5e668f603bb9dc87b7"></a>

### Typedef OperatorDerivCallBack

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
typedef void(__stdcall * ansys::dpf::OperatorDerivCallBack) (void *, opaque::DpfOperatorDerivData *)

```

**Return type**: void(\_\_stdcall \*

<a id="namespaceansys-dpf-1a66601500a7dae71ed26140babb2a3a02"></a>

### Typedef EventReception

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
typedef void(__stdcall * ansys::dpf::EventReception) (void *, int, const char *)

```

**Return type**: void(\_\_stdcall \*

<a id="namespaceansys-dpf-1ae031a034f0d8e2095e9ff9a316a3b598"></a>

### Typedef ExternalDataDeleter

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
typedef void(__stdcall * ansys::dpf::ExternalDataDeleter) (ExternalData *)

```

**Return type**: void(\_\_stdcall \*

<a id="namespaceansys-dpf-1a7dee004e945fa4b511ebe92f76c3bc59"></a>

### Typedef OperatorMainFunction

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
typedef void(* ansys::dpf::OperatorMainFunction) (OperatorMain &)

```

**Return type**: void(\*

<a id="namespaceansys-dpf-1a0aa6e7bb2d915b17a9f4e3a1dc6290c8"></a>

### Typedef OperatorDerivateFunction

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
typedef void(* ansys::dpf::OperatorDerivateFunction) (OperatorDerivativeMain &)

```

**Return type**: void(\*

<a id="namespaceansys-dpf-1acc01990faa84aba04f8d6534727dd204"></a>

### Typedef HasGenericDataContainerConstructor

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
using ansys::dpf::HasGenericDataContainerConstructor = std::is_constructible<T, ansys::dpf::GenericDataContainer const&>

```

used to flag derived class of [CustomContainerBase](classansys-dpf-customcontainerbase.md#classansys-dpf-customcontainerbase).

**Return type**: std::is\_constructible&lt; T, ansys::dpf::GenericDataContainer const &amp; &gt;

<a id="namespaceansys-dpf-1a224c24c4bc198dbbc76407c5669c2671"></a>

### Typedef LabelSpacesVector

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
typedef std::vector<LabelSpace> ansys::dpf::LabelSpacesVector

```

**Return type**: std::vector&lt; [LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) &gt;

<a id="namespaceansys-dpf-1af8857bb96208af64ea3241bd7f763b03"></a>

### Typedef databaseIdentifier

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
typedef std::string ansys::dpf::databaseIdentifier

```

**Return type**: std::string

<a id="namespaceansys-dpf-1a1ec0276da690d5eb462312712d67831c"></a>

### Typedef dataIdentifierInDatabase

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
typedef int ansys::dpf::dataIdentifierInDatabase

```

**Return type**: int

<a id="namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0"></a>

### Typedef dp\_int

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
typedef int ansys::dpf::dp_int

```

DPF integer.

**Return type**: int

<a id="namespaceansys-dpf-1ab4574c9af3f2bb8011da7d1f4c8da20e"></a>

### Typedef dp\_id

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
typedef int ansys::dpf::dp_id

```

DPF identifier.

**Return type**: int

<a id="namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920"></a>

### Typedef dp\_index

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
typedef int ansys::dpf::dp_index

```

DPF index.

**Return type**: int

<a id="namespaceansys-dpf-1acb480013bfed185b5e34a0bdcb0e3790"></a>

### Typedef dp\_double

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
typedef double ansys::dpf::dp_double

```

DPF double precision number.

**Return type**: double

<a id="namespaceansys-dpf-1aae1038d08681cf4311d36bd77661272c"></a>

### Typedef UnitSytem

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
typedef UnitSystem ansys::dpf::UnitSytem

```

using [UnitSytem](namespaceansys-dpf.md#namespaceansys-dpf-1aae1038d08681cf4311d36bd77661272c) = [UnitSystem](structansys-dpf-unitsystem.md#structansys-dpf-unitsystem);

**Return type**: [UnitSystem](structansys-dpf-unitsystem.md#structansys-dpf-unitsystem)

## Functions

<a id="namespaceansys-dpf-1a4b7a3685434ca305f7af4fd1e5f80a45"></a>

### Function UseType

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
T * ansys::dpf::UseType()

```

**Return type**: T \*