Skip to main content

DPF Cpp Client Library 2026 R1

Namespace ansys::dpf

Last update: 25.03.2026

This is the main namespace of the HGP API.

This namespace encapsulates all of the HGP functionality.

Classes

Enumeration types

Enumeration type pin

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 connection pins

Enumerator eTimeScopPin

Time scope

Enumerator eMeshScopPin

Mesh scope

Enumerator eFieldsContainerPin

Fields container

Enumerator eStreamPin

Stream

Enumerator eDataSourcesPin

Data sources

Enumerator eRotToGlobalPin

Rot to global

Enumerator eParameter1Pin

Parameter 1

Enumerator eMeshRegionPin

Mesh region

Enumerator eTimeFreqSupportPin

Time frequency support

Enumerator eLocationPin

Location.

Enumerator eSecondFieldsContainerPin

Second fields container

Enumerator ePhysicalMeshScopPin

Physical mesh scope

Enumerator eElementToNodalAverage

Element to nodal average

Enumerator ePropertyPin

Property

Enumerator eReadCyclicPin

Read Cyclic

Enumerator eExpandedMeshRegionPin

Expanded mesh region

Enumerator eCyclicSupportPin

Cyclic support

Enumerator eDomainIdPin

Domain Id

Enumerator eSectorsScopPin

Sectors scope

Enumerator eCyclicPhasePin

Cyclic phase

Enumerator eFilterResultsPin

Filter results

Enumerator eFilterDegeneratedElPin

Filter degenerated element Deprecated:

use eFilterResults pin instead

Enumerator eHarmonicData

Harmonic data

Enumerator eReadBeams

Read Beam data

Enumerator eReorderENFPin

Reorder Nodal Forces

Enumerator eMetaDataPin

Pin for meta data

Enumerator ePartIdPin

Pin for Part Id

Enumerator eMergeShellsPin

Merge shells and solids (averaging)

Enumerator eSplitShellsPin

Split shells and solids (results extraction)

Enumerator eShellLayerPin

Specicy a shell layer (results extraction)

Enumerator eUnitSystemPin

Unit System pin

Enumerator eIdentifierPin

Identifier

Enumerator eCacheHandlerPin

Cache handler

Enumerator eSourceOperatorPin

Source operator

Enumerator eResultOperatorPin

Result operator

Enumerator eDownStreamInfoPin

Down stream info

Enumerator eDownStreamResultPin

Down stream result

Enumerator eTuningPin

Tuning

Enumeration type eshellLayers

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

Types of shell layers.

Enumerator eTop

Top shell layer

Enumerator eBottom

Bottom shell layer

Enumerator eTopBottom

Both Top and Bottom shell layer

Enumerator eMid

Middle shell layer

Enumerator eTopBottomMid

All shell layers

Enumerator eNoneLayer

No shell layer

Enumerator eLayerIndependent

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

Enumeration type OperatorState

enum OperatorState {
  eNotUptodate,
  eUpToDate,
  eFailed,
  eRunning
}

Status of operator.

Enumerator eNotUptodate

Not up to date.

Enumerator eUpToDate

Up to date.

Enumerator eFailed

Failed to run.

Enumerator eRunning

Still running.

Enumeration type ApiType

enum ApiType {
  local,
  remote
}

API connection type.

Enumerator local

Local API.

Enumerator remote

Remote API.

Enumeration type LoadType

enum LoadType {
  assert_load,
  try_load
}

Load type.

Enumerator assert_load

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

Enumerator try_load

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

Enumeration type EDpfContext

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.

Enumerator eDefault

Enumerator eStandalone

Enumerator eUserDefined

Enumerator eCustomDefinedLocation

Enumerator eEntry

Typedefs

Typedef OperatorCallBack

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

Return type: void(__stdcall *

Typedef OperatorDerivCallBack

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

Return type: void(__stdcall *

Typedef EventReception

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

Return type: void(__stdcall *

Typedef ExternalDataDeleter

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

Return type: void(__stdcall *

Typedef OperatorMainFunction

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

Return type: void(*

Typedef OperatorDerivateFunction

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

Return type: void(*

Typedef HasGenericDataContainerConstructor

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

used to flag derived class of CustomContainerBase.

Return type: std::is_constructible< T, ansys::dpf::GenericDataContainer const & >

Typedef LabelSpacesVector

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

Return type: std::vector< LabelSpace >

Typedef databaseIdentifier

typedef std::string ansys::dpf::databaseIdentifier

Return type: std::string

Typedef dataIdentifierInDatabase

typedef int ansys::dpf::dataIdentifierInDatabase

Return type: int

Typedef dp_int

typedef int ansys::dpf::dp_int

DPF integer.

Return type: int

Typedef dp_id

typedef int ansys::dpf::dp_id

DPF identifier.

Return type: int

Typedef dp_index

typedef int ansys::dpf::dp_index

DPF index.

Return type: int

Typedef dp_double

typedef double ansys::dpf::dp_double

DPF double precision number.

Return type: double

Typedef UnitSytem

typedef UnitSystem ansys::dpf::UnitSytem

using UnitSytem = UnitSystem;

Return type: UnitSystem

Functions

Function UseType

T * ansys::dpf::UseType()

Return type: T *

Connect with Ansys