## On this page

  

 

 # ansys::dpf Namespace Reference

 Last update: 16.07.2025 

This is the main namespace of the HGP API. [More...](namespaceansys_1_1dpf.xhtml#details)

## <a id="nested-classes" name="nested-classes"></a>Data Structures

class [Any](classansys_1_1dpf_1_1Any.xhtml) class [Client](classansys_1_1dpf_1_1Client.xhtml) struct [ConfigOptionSpecification](structansys_1_1dpf_1_1ConfigOptionSpecification.xhtml) class [Context](classansys_1_1dpf_1_1Context.xhtml) class [core](classansys_1_1dpf_1_1core.xhtml) class [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) class [CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) class [DataSources](classansys_1_1dpf_1_1DataSources.xhtml) class [DataTree](classansys_1_1dpf_1_1DataTree.xhtml) struct [dimensionalities](structansys_1_1dpf_1_1dimensionalities.xhtml) struct [Dimensionality](structansys_1_1dpf_1_1Dimensionality.xhtml) class [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) class [DpfException](classansys_1_1dpf_1_1DpfException.xhtml) class [DpfTypes](classansys_1_1dpf_1_1DpfTypes.xhtml) class [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml) Represents a modifiable vector of data and manages its memory. [More...](classansys_1_1dpf_1_1DpfVector.xhtml#details)  
 class [DpfVector&lt; std::string &gt;](classansys_1_1dpf_1_1DpfVector_3_01std_1_1string_01_4.xhtml) Represents a modifiable vector of data and manages its memory. [More...](classansys_1_1dpf_1_1DpfVector_3_01std_1_1string_01_4.xhtml#details)  
 class [ElementCursor](classansys_1_1dpf_1_1ElementCursor.xhtml) struct [ElementDescriptor](structansys_1_1dpf_1_1ElementDescriptor.xhtml) struct [elements](structansys_1_1dpf_1_1elements.xhtml) class [EventHandler](classansys_1_1dpf_1_1EventHandler.xhtml) class [ExternalData](classansys_1_1dpf_1_1ExternalData.xhtml) class [ExternalDataT](classansys_1_1dpf_1_1ExternalDataT.xhtml) class [ExternalStream](classansys_1_1dpf_1_1ExternalStream.xhtml) class [Field](classansys_1_1dpf_1_1Field.xhtml) Data for an entity. [More...](classansys_1_1dpf_1_1Field.xhtml#details)  
 class [FieldCursor](classansys_1_1dpf_1_1FieldCursor.xhtml) class [FieldDefinition](classansys_1_1dpf_1_1FieldDefinition.xhtml) class [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) Contains a group of fields. [More...](classansys_1_1dpf_1_1FieldsContainer.xhtml#details)  
 class [GenericSupport](classansys_1_1dpf_1_1GenericSupport.xhtml) Define a generic support. [More...](classansys_1_1dpf_1_1GenericSupport.xhtml#details)  
 struct [homogeneities](structansys_1_1dpf_1_1homogeneities.xhtml) class [Homogeneity](classansys_1_1dpf_1_1Homogeneity.xhtml) User defined physical measurement quantity. [More...](classansys_1_1dpf_1_1Homogeneity.xhtml#details)  
 struct [Label](structansys_1_1dpf_1_1Label.xhtml) struct [labels](structansys_1_1dpf_1_1labels.xhtml) class [LabelSpace](classansys_1_1dpf_1_1LabelSpace.xhtml) class [LibraryHandle](classansys_1_1dpf_1_1LibraryHandle.xhtml) Provides an access to use DPF HGP API. The instance of [LibraryHandle](classansys_1_1dpf_1_1LibraryHandle.xhtml "Provides an access to use DPF HGP API. The instance of LibraryHandle is only needed once.") is only needed once. [More...](classansys_1_1dpf_1_1LibraryHandle.xhtml#details)  
 struct [Location](structansys_1_1dpf_1_1Location.xhtml) User defined location quantity. [More...](structansys_1_1dpf_1_1Location.xhtml#details)  
 struct [locations](structansys_1_1dpf_1_1locations.xhtml) Predefined location quantities. [More...](structansys_1_1dpf_1_1locations.xhtml#details)  
 class [Mapping](classansys_1_1dpf_1_1Mapping.xhtml) class [MeshedRegion](classansys_1_1dpf_1_1MeshedRegion.xhtml) Holds the mesh for a given region (body, faces, skin, ...) [More...](classansys_1_1dpf_1_1MeshedRegion.xhtml#details)  
 class [MeshesContainer](classansys_1_1dpf_1_1MeshesContainer.xhtml) class [MeshQuery](classansys_1_1dpf_1_1MeshQuery.xhtml) class [Model](classansys_1_1dpf_1_1Model.xhtml) class [Operator](classansys_1_1dpf_1_1Operator.xhtml) Wrap an elementary operation. [More...](classansys_1_1dpf_1_1Operator.xhtml#details)  
 class [OperatorConfig](classansys_1_1dpf_1_1OperatorConfig.xhtml) class [OperatorMain](classansys_1_1dpf_1_1OperatorMain.xhtml) class [OperatorSpecification](classansys_1_1dpf_1_1OperatorSpecification.xhtml) struct [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml) struct [property\_types](structansys_1_1dpf_1_1property__types.xhtml) class [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) struct [PropertyType](structansys_1_1dpf_1_1PropertyType.xhtml) User defined property type. [More...](structansys_1_1dpf_1_1PropertyType.xhtml#details)  
 class [PropFieldCursor](classansys_1_1dpf_1_1PropFieldCursor.xhtml) struct [quantity\_types](structansys_1_1dpf_1_1quantity__types.xhtml) Predefined quantity types. [More...](structansys_1_1dpf_1_1quantity__types.xhtml#details)  
 struct [QuantityType](structansys_1_1dpf_1_1QuantityType.xhtml) User defined quantity type. [More...](structansys_1_1dpf_1_1QuantityType.xhtml#details)  
 class [Result](classansys_1_1dpf_1_1Result.xhtml) class [ResultInfo](classansys_1_1dpf_1_1ResultInfo.xhtml) class [RuntimeClientConfig](classansys_1_1dpf_1_1RuntimeClientConfig.xhtml) class [RuntimeCoreConfig](classansys_1_1dpf_1_1RuntimeCoreConfig.xhtml) class [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) Define a set of entities by [ids](classansys_1_1dpf_1_1Scoping.xhtml#acf26749e29d9f23de6c70806ccfaea6b). [More...](classansys_1_1dpf_1_1Scoping.xhtml#details)  
 class [ScopingsContainer](classansys_1_1dpf_1_1ScopingsContainer.xhtml) class [Session](classansys_1_1dpf_1_1Session.xhtml) struct [ShellDescriptor](structansys_1_1dpf_1_1ShellDescriptor.xhtml) struct [spec](structansys_1_1dpf_1_1spec.xhtml) Predefined specification entitled. [More...](structansys_1_1dpf_1_1spec.xhtml#details)  
 class [Streams](classansys_1_1dpf_1_1Streams.xhtml) Defines an open, ready-to-use, data sources. [More...](classansys_1_1dpf_1_1Streams.xhtml#details)  
 class [StringField](classansys_1_1dpf_1_1StringField.xhtml) class [Support](classansys_1_1dpf_1_1Support.xhtml) Define an abstract support notion. [More...](classansys_1_1dpf_1_1Support.xhtml#details)  
 class [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml) Define a time/frequency set. [More...](classansys_1_1dpf_1_1TimeFreqSupport.xhtml#details)  
 struct [TypeDescriptor](structansys_1_1dpf_1_1TypeDescriptor.xhtml) struct [types](structansys_1_1dpf_1_1types.xhtml) class [Unit](classansys_1_1dpf_1_1Unit.xhtml) struct [unit\_systems](structansys_1_1dpf_1_1unit__systems.xhtml) struct [UnitSystem](structansys_1_1dpf_1_1UnitSystem.xhtml) class [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) Group a set of connected operators in order to define a whole data treatment. [More...](classansys_1_1dpf_1_1Workflow.xhtml#details)  
 ## <a id="typedef-members" name="typedef-members"></a>Typedefs

<a id="aadbf5b3c4ae5a01b37d6ef52d0c2bca1" name="aadbf5b3c4ae5a01b37d6ef52d0c2bca1"></a>typedef void(\_\_stdcall \* **OperatorCallBack**) (void \*, opaque::DpfOperatorData \*) <a id="a66601500a7dae71ed26140babb2a3a02" name="a66601500a7dae71ed26140babb2a3a02"></a>typedef void(\_\_stdcall \* **EventReception**) (void \*, int, const char \*) <a id="ae031a034f0d8e2095e9ff9a316a3b598" name="ae031a034f0d8e2095e9ff9a316a3b598"></a>typedef void(\_\_stdcall \* **ExternalDataDeleter**) ([ExternalData](classansys_1_1dpf_1_1ExternalData.xhtml) \*) <a id="a7dee004e945fa4b511ebe92f76c3bc59" name="a7dee004e945fa4b511ebe92f76c3bc59"></a>typedef void(\* **OperatorMainFunction**) ([OperatorMain](classansys_1_1dpf_1_1OperatorMain.xhtml) &amp;) <a id="a224c24c4bc198dbbc76407c5669c2671" name="a224c24c4bc198dbbc76407c5669c2671"></a>typedef std::vector&lt; [LabelSpace](classansys_1_1dpf_1_1LabelSpace.xhtml) &gt; **LabelSpacesVector** <a id="af8857bb96208af64ea3241bd7f763b03" name="af8857bb96208af64ea3241bd7f763b03"></a>typedef std::string **databaseIdentifier** <a id="a1ec0276da690d5eb462312712d67831c" name="a1ec0276da690d5eb462312712d67831c"></a>typedef int **dataIdentifierInDatabase** typedef int [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) typedef int [dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e) typedef int [dp\_index](namespaceansys_1_1dpf.xhtml#a417548d1b705a9ba54ba9429afe68920) typedef double [dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790) <a id="aae1038d08681cf4311d36bd77661272c" name="aae1038d08681cf4311d36bd77661272c"></a>typedef [UnitSystem](structansys_1_1dpf_1_1UnitSystem.xhtml) **UnitSytem** using UnitSytem = [UnitSystem](structansys_1_1dpf_1_1UnitSystem.xhtml);   
 ## <a id="enum-members" name="enum-members"></a>Enumerations

enum [pin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1) {   
 [eTimeScopPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1ac390a52dd8c4f1e8ff81a162cdc04d4f) = 0 , [eMeshScopPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1a79a70f074b2f79ccaff75ae8e4ec9ec9) = 1 , [eFieldsContainerPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1af2c0ae047340bd15a80ef22d8711a455) = 2 , [eStreamPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1a0f5631bb51d4a3e4a40e167cb1198799) = 3 ,   
 [eDataSourcesPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1a5b6613f802062fde4faea4b553db7fbc) = 4 , [eRotToGlobalPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1a6a90da988334e2b3e0f9c41b03c407eb) = 5 , [eParameter1Pin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1affe5ff8fa5271741a9a8b93259dd2453) = 6 , [eMeshRegionPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1a88b6b8d0c02d2ac48fc40e8c02e3da7c) = 7 ,   
 [eTimeFreqSupportPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1a10e202ebd92b2d71757c4c075f841fa6) = 8 , [eLocationPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1aa8522e00b69f3a2f2626a088f20823fe) = 9 , [eSecondFieldsContainerPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1a2970c8895cf1e20fb11a14896cc974bd) = 10 , [ePhysicalMeshScopPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1a66c4c9745677a5a8a2c844068f8a90ac) = 11 ,   
 [eElementToNodalAverage](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1af5995777fdd2d43237d5e89c5315fffb) = 12 , [ePropertyPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1ab0a4214c639c00048ce8444f185543a2) = 13 , [eReadCyclicPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1ace74ea2958a32198189da2605bbf6d5b) = 14 , [eExpandedMeshRegionPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1a00364d8567e1117257690620bfa95276) = 15 ,   
 [eCyclicSupportPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1a1a9d64adcded0ac9bec3f370b541fbe9) = 16 , [eDomainIdPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1aa35c64dc0dc7675e4bb14e3919c35665) = 17 , [eSectorsScopPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1a8ba7de7931a232a75e50cc3c6679ca9c) = 18 , [eCyclicPhasePin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1aab92d7c849d97afb6b5ee9ea27342e02) = 19 ,   
 [eFilterDegeneratedElPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1a9218c2b63a3ebece21e101df19ea2c36) = 20 , [eHarmonicData](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1afcdff334e47095eeb0b2201aab357c25) = 21 , [eReorderENFPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1ab91a4eb913483409f08befef7eb0ac34) = 23 , [eMetaDataPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1aa9c7a92bb8960158b9709704aff3d531) = 24 ,   
 [ePartIdPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1a5977b66ff62b8c5257c4b314e36545eb) = 25 , [eUnitSystemPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1a97111226c931e88e1f8a1c964f4b0293) = 50 , [eIdentifierPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1aefbb38f839ed10384cc3e04f057ea683) = 60 , [eCacheHandlerPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1a02d67729d39a01086c5ac0f9b176d2bb) = 61 ,   
 [eSourceOperatorPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1a158f1a1fe3036626ed8ee3311324b8f5) = 62 , [eResultOperatorPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1a02ec14627f4203c2697df68eeb5a741e) = 63 , [eDownStreamInfoPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1ac8612a967fd7a535c46ffddcb7e7261a) = 100 , [eDownStreamResultPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1add3b446fd8dd46634c61f689ab6b1530) = 101 ,   
 [eTuningPin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1af607f86e9475d2229252adf8e0b133ca) =200   
 } enum [eshellLayers](namespaceansys_1_1dpf.xhtml#a6d14c6ea165905b13e914d776c880751) {   
 [eTop](namespaceansys_1_1dpf.xhtml#a6d14c6ea165905b13e914d776c880751abba81b5c651a204d16fc833715d65073) = 0 , [eBottom](namespaceansys_1_1dpf.xhtml#a6d14c6ea165905b13e914d776c880751a8ae95c0560f3eb57e2f2eb2421c17ac2) = 1 , [eTopBottom](namespaceansys_1_1dpf.xhtml#a6d14c6ea165905b13e914d776c880751a5c57d647575d231025e6c5ed0ceb5fa5) = 2 , [eMid](namespaceansys_1_1dpf.xhtml#a6d14c6ea165905b13e914d776c880751ae1b31c2caf647397b019fe1771d02ffa) = 3 ,   
 [eTopBottomMid](namespaceansys_1_1dpf.xhtml#a6d14c6ea165905b13e914d776c880751af7ead61ae7d3acaca5c5108534158558) = 4 , [eNoneLayer](namespaceansys_1_1dpf.xhtml#a6d14c6ea165905b13e914d776c880751acb131433cf92a2b813e983388037ef5b) = 5 , [eLayerIndependent](namespaceansys_1_1dpf.xhtml#a6d14c6ea165905b13e914d776c880751a3537a8a6c0e5d7df7d8515b8e36142d1) = 6   
 } enum class [OperatorState](namespaceansys_1_1dpf.xhtml#aa85785755f5470ad631e33d5c44a1dcb) { [eNotUptodate](namespaceansys_1_1dpf.xhtml#aa85785755f5470ad631e33d5c44a1dcba48ef57c6e916a8c5aae7c2c9271242b9), [eUpToDate](namespaceansys_1_1dpf.xhtml#aa85785755f5470ad631e33d5c44a1dcba2065e6350fac4dddc827026492136da8), [eFailed](namespaceansys_1_1dpf.xhtml#aa85785755f5470ad631e33d5c44a1dcbaffeeb724410e7def0b3ad4b2ff92e839), [eRunning](namespaceansys_1_1dpf.xhtml#aa85785755f5470ad631e33d5c44a1dcbab23499ad7f3dd05d99fd73010d51558a) } enum class [ApiType](namespaceansys_1_1dpf.xhtml#a318ab16f856ec8d2ef6e13af94a6dc56) { [local](namespaceansys_1_1dpf.xhtml#a318ab16f856ec8d2ef6e13af94a6dc56af5ddaf0ca7929578b408c909429f68f2), [remote](namespaceansys_1_1dpf.xhtml#a318ab16f856ec8d2ef6e13af94a6dc56a2c18e486683a3db1e645ad8523223b72) } enum class [LoadType](namespaceansys_1_1dpf.xhtml#ac4f1380f00170887891b5cf54d8c94b3) { [assert\_load](namespaceansys_1_1dpf.xhtml#ac4f1380f00170887891b5cf54d8c94b3a568e48779e3958b6d9c632b759bee1cb), [try\_load](namespaceansys_1_1dpf.xhtml#ac4f1380f00170887891b5cf54d8c94b3a6d450e9598ea0dffeaff74fbcccb116f) } enum class [EDpfContext](namespaceansys_1_1dpf.xhtml#a02d1b14b4a34eeae292e89f8ee7cfe60) {   
 **eDefault**, [eStandalone](namespaceansys_1_1dpf.xhtml#a02d1b14b4a34eeae292e89f8ee7cfe60af7172b6cb5f8beb46b3389f9f33f8690), [eUserDefined](namespaceansys_1_1dpf.xhtml#a02d1b14b4a34eeae292e89f8ee7cfe60a12d2a3e5f52831145ad19695024ee705), [eCustomDefinedLocation](namespaceansys_1_1dpf.xhtml#a02d1b14b4a34eeae292e89f8ee7cfe60a56043158bc02e5a05a5a75b97b3ee080),   
 [eEntry](namespaceansys_1_1dpf.xhtml#a02d1b14b4a34eeae292e89f8ee7cfe60a4ea9c7a230937e9bceea1919a1c06ce9)  
 } ## <a id="func-members" name="func-members"></a>Functions

<a id="a4b7a3685434ca305f7af4fd1e5f80a45" name="a4b7a3685434ca305f7af4fd1e5f80a45"></a>template&lt;typename T &gt; T \* **UseType** () <a id="details" name="details"></a>## Detailed Description

This is the main namespace of the HGP API.

This namespace encapsulates all of the HGP functionality.



## Typedef Documentation

<a id="acb480013bfed185b5e34a0bdcb0e3790" name="acb480013bfed185b5e34a0bdcb0e3790"></a>## [◆ ](#acb480013bfed185b5e34a0bdcb0e3790)dp\_double

 typedef double [ansys::dpf::dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790)

DPF double precision number.





<a id="ab4574c9af3f2bb8011da7d1f4c8da20e" name="ab4574c9af3f2bb8011da7d1f4c8da20e"></a>## [◆ ](#ab4574c9af3f2bb8011da7d1f4c8da20e)dp\_id

 typedef int [ansys::dpf::dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e)

DPF identifier.





<a id="a417548d1b705a9ba54ba9429afe68920" name="a417548d1b705a9ba54ba9429afe68920"></a>## [◆ ](#a417548d1b705a9ba54ba9429afe68920)dp\_index

 typedef int [ansys::dpf::dp\_index](namespaceansys_1_1dpf.xhtml#a417548d1b705a9ba54ba9429afe68920)

DPF index.





<a id="a60d181a1f9d29cc7cc38b25dac4401f0" name="a60d181a1f9d29cc7cc38b25dac4401f0"></a>## [◆ ](#a60d181a1f9d29cc7cc38b25dac4401f0)dp\_int

 typedef int [ansys::dpf::dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)

DPF integer.





## Enumeration Type Documentation

<a id="a318ab16f856ec8d2ef6e13af94a6dc56" name="a318ab16f856ec8d2ef6e13af94a6dc56"></a>## [◆ ](#a318ab16f856ec8d2ef6e13af94a6dc56)ApiType

 enum class [ansys::dpf::ApiType](namespaceansys_1_1dpf.xhtml#a318ab16f856ec8d2ef6e13af94a6dc56)  strong 

API connection type.

Enumerator<a id="a318ab16f856ec8d2ef6e13af94a6dc56af5ddaf0ca7929578b408c909429f68f2" name="a318ab16f856ec8d2ef6e13af94a6dc56af5ddaf0ca7929578b408c909429f68f2"></a>local Local API.

<a id="a318ab16f856ec8d2ef6e13af94a6dc56a2c18e486683a3db1e645ad8523223b72" name="a318ab16f856ec8d2ef6e13af94a6dc56a2c18e486683a3db1e645ad8523223b72"></a>remote Remote API.





<a id="a02d1b14b4a34eeae292e89f8ee7cfe60" name="a02d1b14b4a34eeae292e89f8ee7cfe60"></a>## [◆ ](#a02d1b14b4a34eeae292e89f8ee7cfe60)EDpfContext

 enum class [ansys::dpf::EDpfContext](namespaceansys_1_1dpf.xhtml#a02d1b14b4a34eeae292e89f8ee7cfe60)  strong 

[Context](classansys_1_1dpf_1_1Context.xhtml) enum for [LibraryHandle](classansys_1_1dpf_1_1LibraryHandle.xhtml "Provides an access to use DPF HGP API. The instance of LibraryHandle is only needed once.")

Enumerator<a id="a02d1b14b4a34eeae292e89f8ee7cfe60af7172b6cb5f8beb46b3389f9f33f8690" name="a02d1b14b4a34eeae292e89f8ee7cfe60af7172b6cb5f8beb46b3389f9f33f8690"></a>eStandalone DataProcessingCore.xml that is next to DataProcessingCore.dll/libDataProcessingCore.so will be taken.

<a id="a02d1b14b4a34eeae292e89f8ee7cfe60a12d2a3e5f52831145ad19695024ee705" name="a02d1b14b4a34eeae292e89f8ee7cfe60a12d2a3e5f52831145ad19695024ee705"></a>eUserDefined get the Specific Standalone DataProcessingCore.xml

<a id="a02d1b14b4a34eeae292e89f8ee7cfe60a56043158bc02e5a05a5a75b97b3ee080" name="a02d1b14b4a34eeae292e89f8ee7cfe60a56043158bc02e5a05a5a75b97b3ee080"></a>eCustomDefinedLocation user defined using path

<a id="a02d1b14b4a34eeae292e89f8ee7cfe60a4ea9c7a230937e9bceea1919a1c06ce9" name="a02d1b14b4a34eeae292e89f8ee7cfe60a4ea9c7a230937e9bceea1919a1c06ce9"></a>eEntry targets a location that is defined and known by the user to be modified

minimum number of plugins loaded for a basic usage





<a id="a6d14c6ea165905b13e914d776c880751" name="a6d14c6ea165905b13e914d776c880751"></a>## [◆ ](#a6d14c6ea165905b13e914d776c880751)eshellLayers

 enum [ansys::dpf::eshellLayers](namespaceansys_1_1dpf.xhtml#a6d14c6ea165905b13e914d776c880751)

Types of shell layers.

Enumerator<a id="a6d14c6ea165905b13e914d776c880751abba81b5c651a204d16fc833715d65073" name="a6d14c6ea165905b13e914d776c880751abba81b5c651a204d16fc833715d65073"></a>eTop Top shell layer

<a id="a6d14c6ea165905b13e914d776c880751a8ae95c0560f3eb57e2f2eb2421c17ac2" name="a6d14c6ea165905b13e914d776c880751a8ae95c0560f3eb57e2f2eb2421c17ac2"></a>eBottom Bottom shell layer

<a id="a6d14c6ea165905b13e914d776c880751a5c57d647575d231025e6c5ed0ceb5fa5" name="a6d14c6ea165905b13e914d776c880751a5c57d647575d231025e6c5ed0ceb5fa5"></a>eTopBottom Both Top and Bottom shell layer

<a id="a6d14c6ea165905b13e914d776c880751ae1b31c2caf647397b019fe1771d02ffa" name="a6d14c6ea165905b13e914d776c880751ae1b31c2caf647397b019fe1771d02ffa"></a>eMid Middle shell layer

<a id="a6d14c6ea165905b13e914d776c880751af7ead61ae7d3acaca5c5108534158558" name="a6d14c6ea165905b13e914d776c880751af7ead61ae7d3acaca5c5108534158558"></a>eTopBottomMid All shell layers

<a id="a6d14c6ea165905b13e914d776c880751acb131433cf92a2b813e983388037ef5b" name="a6d14c6ea165905b13e914d776c880751acb131433cf92a2b813e983388037ef5b"></a>eNoneLayer No shell layer

<a id="a6d14c6ea165905b13e914d776c880751a3537a8a6c0e5d7df7d8515b8e36142d1" name="a6d14c6ea165905b13e914d776c880751a3537a8a6c0e5d7df7d8515b8e36142d1"></a>eLayerIndependent Independent shell layer. The model might have shell layers, but the associated result does not rely on them.





<a id="ac4f1380f00170887891b5cf54d8c94b3" name="ac4f1380f00170887891b5cf54d8c94b3"></a>## [◆ ](#ac4f1380f00170887891b5cf54d8c94b3)LoadType

 enum class [ansys::dpf::LoadType](namespaceansys_1_1dpf.xhtml#ac4f1380f00170887891b5cf54d8c94b3)  strong 

Load type.

Enumerator<a id="ac4f1380f00170887891b5cf54d8c94b3a568e48779e3958b6d9c632b759bee1cb" name="ac4f1380f00170887891b5cf54d8c94b3a568e48779e3958b6d9c632b759bee1cb"></a>assert\_load Requests a fully successful load of all function's symbols of the DPF API.

<a id="ac4f1380f00170887891b5cf54d8c94b3a6d450e9598ea0dffeaff74fbcccb116f" name="ac4f1380f00170887891b5cf54d8c94b3a6d450e9598ea0dffeaff74fbcccb116f"></a>try\_load Try to load all function's symbols of the DPF API without being constrained if a part is missing.





<a id="aa85785755f5470ad631e33d5c44a1dcb" name="aa85785755f5470ad631e33d5c44a1dcb"></a>## [◆ ](#aa85785755f5470ad631e33d5c44a1dcb)OperatorState

 enum class [ansys::dpf::OperatorState](namespaceansys_1_1dpf.xhtml#aa85785755f5470ad631e33d5c44a1dcb)  strong 

Status of operator.

Enumerator<a id="aa85785755f5470ad631e33d5c44a1dcba48ef57c6e916a8c5aae7c2c9271242b9" name="aa85785755f5470ad631e33d5c44a1dcba48ef57c6e916a8c5aae7c2c9271242b9"></a>eNotUptodate Not up to date.

<a id="aa85785755f5470ad631e33d5c44a1dcba2065e6350fac4dddc827026492136da8" name="aa85785755f5470ad631e33d5c44a1dcba2065e6350fac4dddc827026492136da8"></a>eUpToDate Up to date.

<a id="aa85785755f5470ad631e33d5c44a1dcbaffeeb724410e7def0b3ad4b2ff92e839" name="aa85785755f5470ad631e33d5c44a1dcbaffeeb724410e7def0b3ad4b2ff92e839"></a>eFailed Failed to run.

<a id="aa85785755f5470ad631e33d5c44a1dcbab23499ad7f3dd05d99fd73010d51558a" name="aa85785755f5470ad631e33d5c44a1dcbab23499ad7f3dd05d99fd73010d51558a"></a>eRunning Still running.





<a id="aa4a44a04a0aafb8fe0645f019bbd94d1" name="aa4a44a04a0aafb8fe0645f019bbd94d1"></a>## [◆ ](#aa4a44a04a0aafb8fe0645f019bbd94d1)pin

 enum [ansys::dpf::pin](namespaceansys_1_1dpf.xhtml#aa4a44a04a0aafb8fe0645f019bbd94d1)

[Operator](classansys_1_1dpf_1_1Operator.xhtml "Wrap an elementary operation.") connection pins

Enumerator<a id="aa4a44a04a0aafb8fe0645f019bbd94d1ac390a52dd8c4f1e8ff81a162cdc04d4f" name="aa4a44a04a0aafb8fe0645f019bbd94d1ac390a52dd8c4f1e8ff81a162cdc04d4f"></a>eTimeScopPin Time scope

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1a79a70f074b2f79ccaff75ae8e4ec9ec9" name="aa4a44a04a0aafb8fe0645f019bbd94d1a79a70f074b2f79ccaff75ae8e4ec9ec9"></a>eMeshScopPin Mesh scope

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1af2c0ae047340bd15a80ef22d8711a455" name="aa4a44a04a0aafb8fe0645f019bbd94d1af2c0ae047340bd15a80ef22d8711a455"></a>eFieldsContainerPin Fields container

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1a0f5631bb51d4a3e4a40e167cb1198799" name="aa4a44a04a0aafb8fe0645f019bbd94d1a0f5631bb51d4a3e4a40e167cb1198799"></a>eStreamPin Stream

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1a5b6613f802062fde4faea4b553db7fbc" name="aa4a44a04a0aafb8fe0645f019bbd94d1a5b6613f802062fde4faea4b553db7fbc"></a>eDataSourcesPin Data sources

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1a6a90da988334e2b3e0f9c41b03c407eb" name="aa4a44a04a0aafb8fe0645f019bbd94d1a6a90da988334e2b3e0f9c41b03c407eb"></a>eRotToGlobalPin Rot to global

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1affe5ff8fa5271741a9a8b93259dd2453" name="aa4a44a04a0aafb8fe0645f019bbd94d1affe5ff8fa5271741a9a8b93259dd2453"></a>eParameter1Pin Parameter 1

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1a88b6b8d0c02d2ac48fc40e8c02e3da7c" name="aa4a44a04a0aafb8fe0645f019bbd94d1a88b6b8d0c02d2ac48fc40e8c02e3da7c"></a>eMeshRegionPin Mesh region

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1a10e202ebd92b2d71757c4c075f841fa6" name="aa4a44a04a0aafb8fe0645f019bbd94d1a10e202ebd92b2d71757c4c075f841fa6"></a>eTimeFreqSupportPin Time frequency support

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1aa8522e00b69f3a2f2626a088f20823fe" name="aa4a44a04a0aafb8fe0645f019bbd94d1aa8522e00b69f3a2f2626a088f20823fe"></a>eLocationPin [Location](structansys_1_1dpf_1_1Location.xhtml).

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1a2970c8895cf1e20fb11a14896cc974bd" name="aa4a44a04a0aafb8fe0645f019bbd94d1a2970c8895cf1e20fb11a14896cc974bd"></a>eSecondFieldsContainerPin Second fields container

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1a66c4c9745677a5a8a2c844068f8a90ac" name="aa4a44a04a0aafb8fe0645f019bbd94d1a66c4c9745677a5a8a2c844068f8a90ac"></a>ePhysicalMeshScopPin Physical mesh scope

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1af5995777fdd2d43237d5e89c5315fffb" name="aa4a44a04a0aafb8fe0645f019bbd94d1af5995777fdd2d43237d5e89c5315fffb"></a>eElementToNodalAverage Element to nodal average

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1ab0a4214c639c00048ce8444f185543a2" name="aa4a44a04a0aafb8fe0645f019bbd94d1ab0a4214c639c00048ce8444f185543a2"></a>ePropertyPin Property

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1ace74ea2958a32198189da2605bbf6d5b" name="aa4a44a04a0aafb8fe0645f019bbd94d1ace74ea2958a32198189da2605bbf6d5b"></a>eReadCyclicPin Read Cyclic

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1a00364d8567e1117257690620bfa95276" name="aa4a44a04a0aafb8fe0645f019bbd94d1a00364d8567e1117257690620bfa95276"></a>eExpandedMeshRegionPin Expanded mesh region

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1a1a9d64adcded0ac9bec3f370b541fbe9" name="aa4a44a04a0aafb8fe0645f019bbd94d1a1a9d64adcded0ac9bec3f370b541fbe9"></a>eCyclicSupportPin Cyclic support

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1aa35c64dc0dc7675e4bb14e3919c35665" name="aa4a44a04a0aafb8fe0645f019bbd94d1aa35c64dc0dc7675e4bb14e3919c35665"></a>eDomainIdPin Domain Id

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1a8ba7de7931a232a75e50cc3c6679ca9c" name="aa4a44a04a0aafb8fe0645f019bbd94d1a8ba7de7931a232a75e50cc3c6679ca9c"></a>eSectorsScopPin Sectors scope

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1aab92d7c849d97afb6b5ee9ea27342e02" name="aa4a44a04a0aafb8fe0645f019bbd94d1aab92d7c849d97afb6b5ee9ea27342e02"></a>eCyclicPhasePin Cyclic phase

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1a9218c2b63a3ebece21e101df19ea2c36" name="aa4a44a04a0aafb8fe0645f019bbd94d1a9218c2b63a3ebece21e101df19ea2c36"></a>eFilterDegeneratedElPin Filter degenerated element

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1afcdff334e47095eeb0b2201aab357c25" name="aa4a44a04a0aafb8fe0645f019bbd94d1afcdff334e47095eeb0b2201aab357c25"></a>eHarmonicData Harmonic data

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1ab91a4eb913483409f08befef7eb0ac34" name="aa4a44a04a0aafb8fe0645f019bbd94d1ab91a4eb913483409f08befef7eb0ac34"></a>eReorderENFPin Reorder Nodal Forces

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1aa9c7a92bb8960158b9709704aff3d531" name="aa4a44a04a0aafb8fe0645f019bbd94d1aa9c7a92bb8960158b9709704aff3d531"></a>eMetaDataPin Pin for meta data

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1a5977b66ff62b8c5257c4b314e36545eb" name="aa4a44a04a0aafb8fe0645f019bbd94d1a5977b66ff62b8c5257c4b314e36545eb"></a>ePartIdPin Pin for Part Id

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1a97111226c931e88e1f8a1c964f4b0293" name="aa4a44a04a0aafb8fe0645f019bbd94d1a97111226c931e88e1f8a1c964f4b0293"></a>eUnitSystemPin [Unit](classansys_1_1dpf_1_1Unit.xhtml) System pin

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1aefbb38f839ed10384cc3e04f057ea683" name="aa4a44a04a0aafb8fe0645f019bbd94d1aefbb38f839ed10384cc3e04f057ea683"></a>eIdentifierPin Identifier

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1a02d67729d39a01086c5ac0f9b176d2bb" name="aa4a44a04a0aafb8fe0645f019bbd94d1a02d67729d39a01086c5ac0f9b176d2bb"></a>eCacheHandlerPin Cache handler

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1a158f1a1fe3036626ed8ee3311324b8f5" name="aa4a44a04a0aafb8fe0645f019bbd94d1a158f1a1fe3036626ed8ee3311324b8f5"></a>eSourceOperatorPin Source operator

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1a02ec14627f4203c2697df68eeb5a741e" name="aa4a44a04a0aafb8fe0645f019bbd94d1a02ec14627f4203c2697df68eeb5a741e"></a>eResultOperatorPin [Result](classansys_1_1dpf_1_1Result.xhtml) operator

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1ac8612a967fd7a535c46ffddcb7e7261a" name="aa4a44a04a0aafb8fe0645f019bbd94d1ac8612a967fd7a535c46ffddcb7e7261a"></a>eDownStreamInfoPin Down stream info

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1add3b446fd8dd46634c61f689ab6b1530" name="aa4a44a04a0aafb8fe0645f019bbd94d1add3b446fd8dd46634c61f689ab6b1530"></a>eDownStreamResultPin Down stream result

<a id="aa4a44a04a0aafb8fe0645f019bbd94d1af607f86e9475d2229252adf8e0b133ca" name="aa4a44a04a0aafb8fe0645f019bbd94d1af607f86e9475d2229252adf8e0b133ca"></a>eTuningPin Tuning