This is the main namespace of the HGP API. More...

Data Structures
class	Any

class	Client

struct	ConfigOptionSpecification

class	Context

class	core

class	CustomTypeField

class	CyclicSupport

class	DataSources

class	DataTree

struct	dimensionalities

struct	Dimensionality

class	DpfError

class	DpfException

class	DpfTypes

class	DpfVector
	Represents a modifiable vector of data and manages its memory. More...

class	DpfVector< std::string >
	Represents a modifiable vector of data and manages its memory. More...

class	ElementCursor

struct	ElementDescriptor

struct	elements

class	EventHandler

class	ExternalData

class	ExternalDataT

class	ExternalStream

class	Field
	Data for an entity. More...

class	FieldCursor

class	FieldDefinition

class	FieldsContainer
	Contains a group of fields. More...

class	GenericSupport
	Define a generic support. More...

struct	homogeneities

class	Homogeneity
	User defined physical measurement quantity. More...

struct	Label

struct	labels

class	LabelSpace

class	LibraryHandle
	Provides an access to use DPF HGP API. The instance of LibraryHandle is only needed once. More...

struct	Location
	User defined location quantity. More...

struct	locations
	Predefined location quantities. More...

class	Mapping

class	MeshedRegion
	Holds the mesh for a given region (body, faces, skin, ...) More...

class	MeshesContainer

class	MeshQuery

class	Model

class	Operator
	Wrap an elementary operation. More...

class	OperatorConfig

class	OperatorMain

class	OperatorSpecification

struct	PinDefinition

struct	property_types

class	PropertyField

struct	PropertyType
	User defined property type. More...

class	PropFieldCursor

struct	quantity_types
	Predefined quantity types. More...

struct	QuantityType
	User defined quantity type. More...

class	Result

class	ResultInfo

class	RuntimeClientConfig

class	RuntimeCoreConfig

class	Scoping
	Define a set of entities by ids. More...

class	ScopingsContainer

class	Session

struct	ShellDescriptor

struct	spec
	Predefined specification entitled. More...

class	Streams
	Defines an open, ready-to-use, data sources. More...

class	StringField

class	Support
	Define an abstract support notion. More...

class	TimeFreqSupport
	Define a time/frequency set. More...

struct	TypeDescriptor

struct	types

class	Unit

struct	unit_systems

struct	UnitSystem

class	Workflow
	Group a set of connected operators in order to define a whole data treatment. More...

Typedefs
typedef void(__stdcall *	OperatorCallBack) (void , opaque::DpfOperatorData )

typedef void(__stdcall *	EventReception) (void , int, const char )

typedef void(__stdcall *	ExternalDataDeleter) (ExternalData *)

typedef void(*	OperatorMainFunction) (OperatorMain &)

typedef std::vector< LabelSpace >	LabelSpacesVector

typedef std::string	databaseIdentifier

typedef int	dataIdentifierInDatabase

typedef int	dp_int

typedef int	dp_id

typedef int	dp_index

typedef double	dp_double

typedef UnitSystem	UnitSytem
	using UnitSytem = UnitSystem;

Enumerations
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 , eFilterDegeneratedElPin = 20 , eHarmonicData = 21 , eReorderENFPin = 23 , eMetaDataPin = 24 , ePartIdPin = 25 , eUnitSystemPin = 50 , eIdentifierPin = 60 , eCacheHandlerPin = 61 , eSourceOperatorPin = 62 , eResultOperatorPin = 63 , eDownStreamInfoPin = 100 , eDownStreamResultPin = 101 , eTuningPin =200 }

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

enum class	OperatorState { eNotUptodate , eUpToDate , eFailed , eRunning }

enum class	ApiType { local , remote }

enum class	LoadType { assert_load , try_load }

enum class	EDpfContext { eDefault , eStandalone , eUserDefined , eCustomDefinedLocation , eEntry }

Functions
template<typename T >
T *	UseType ()

Detailed Description

This is the main namespace of the HGP API.

This namespace encapsulates all of the HGP functionality.

Typedef Documentation

◆ dp_double

typedef double ansys::dpf::dp_double

DPF double precision number.

◆ dp_id

typedef int ansys::dpf::dp_id

DPF identifier.

◆ dp_index

typedef int ansys::dpf::dp_index

DPF index.

◆ dp_int

typedef int ansys::dpf::dp_int

DPF integer.

Enumeration Type Documentation

◆ ApiType

enum class ansys::dpf::ApiType

strong

API connection type.

Enumerator
local	Local API.
remote	Remote API.

◆ EDpfContext

enum class ansys::dpf::EDpfContext

strong

Context enum for LibraryHandle

Enumerator
eStandalone	DataProcessingCore.xml that is next to DataProcessingCore.dll/libDataProcessingCore.so will be taken.
eUserDefined	get the Specific Standalone DataProcessingCore.xml
eCustomDefinedLocation	user defined using path
eEntry	targets a location that is defined and known by the user to be modified minimum number of plugins loaded for a basic usage

◆ eshellLayers

enum ansys::dpf::eshellLayers

Types of shell layers.

Enumerator
eTop	Top shell layer
eBottom	Bottom shell layer
eTopBottom	Both Top and Bottom shell layer
eMid	Middle shell layer
eTopBottomMid	All shell layers
eNoneLayer	No shell layer
eLayerIndependent	Independent shell layer. The model might have shell layers, but the associated result does not rely on them.

◆ LoadType

enum class ansys::dpf::LoadType

strong

Load type.

Enumerator
assert_load	Requests a fully successful load of all function's symbols of the DPF API.
try_load	Try to load all function's symbols of the DPF API without being constrained if a part is missing.

◆ OperatorState

enum class ansys::dpf::OperatorState

strong

Status of operator.

Enumerator
eNotUptodate	Not up to date.
eUpToDate	Up to date.
eFailed	Failed to run.
eRunning	Still running.

◆ pin

enum ansys::dpf::pin

Operator connection pins

Enumerator
eTimeScopPin	Time scope
eMeshScopPin	Mesh scope
eFieldsContainerPin	Fields container
eStreamPin	Stream
eDataSourcesPin	Data sources
eRotToGlobalPin	Rot to global
eParameter1Pin	Parameter 1
eMeshRegionPin	Mesh region
eTimeFreqSupportPin	Time frequency support
eLocationPin	Location.
eSecondFieldsContainerPin	Second fields container
ePhysicalMeshScopPin	Physical mesh scope
eElementToNodalAverage	Element to nodal average
ePropertyPin	Property
eReadCyclicPin	Read Cyclic
eExpandedMeshRegionPin	Expanded mesh region
eCyclicSupportPin	Cyclic support
eDomainIdPin	Domain Id
eSectorsScopPin	Sectors scope
eCyclicPhasePin	Cyclic phase
eFilterDegeneratedElPin	Filter degenerated element
eHarmonicData	Harmonic data
eReorderENFPin	Reorder Nodal Forces
eMetaDataPin	Pin for meta data
ePartIdPin	Pin for Part Id
eUnitSystemPin	Unit System pin
eIdentifierPin	Identifier
eCacheHandlerPin	Cache handler
eSourceOperatorPin	Source operator
eResultOperatorPin	Result operator
eDownStreamInfoPin	Down stream info
eDownStreamResultPin	Down stream result
eTuningPin	Tuning

DPF C++ client library 2023 R2

ansys::dpf Namespace Reference

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ dp_double

◆ dp_id

◆ dp_index

◆ dp_int

Enumeration Type Documentation

◆ ApiType

◆ EDpfContext

◆ eshellLayers

◆ LoadType

◆ OperatorState

◆ pin

Connect with Ansys