    

 ## On this page

  

 

 # Class ansys::dpf::Support

 Last update: 25.03.2026 

<a id="classansys-dpf-support"></a>

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

Define an abstract support notion.

[Support](classansys-dpf-support.md#classansys-dpf-support) describes the model. It can be the mesh, geometric entities, time or frequency domain...

**Inherits from**:

- [ansys::dpf::DpfTypes](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes)

**Inherited by**:

- [ansys::dpf::GenericSupport](classansys-dpf-genericsupport.md#classansys-dpf-genericsupport)

## Members

- [callAPI](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1aea34d37e0c080126eff70db34bf46597)
- [deep\_copy](classansys-dpf-support.md#classansys-dpf-support-1a3b4233346825454e052a9de678d9ef0a)
- [describe](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a9977945710983bc03d2940fa007847b2)
- [empty](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a39cd546c42518e2332be8f287db95459)
- [emptySupport](classansys-dpf-support.md#classansys-dpf-support-1ad5b62f0bc3fc29380461006280edf89b)
- [getAsCyclicSupport](classansys-dpf-support.md#classansys-dpf-support-1a5903cf9eb1f3f3fec9fc0a22331db3d3)
- [getAsDomainMesh](classansys-dpf-support.md#classansys-dpf-support-1a244cc29be85eb6192faf468268478064)
- [getAsTimeFreqSupport](classansys-dpf-support.md#classansys-dpf-support-1a2ced0ad4403332166b14f301d67f4a4e)
- [getAvailablePropertyNamesForFields](classansys-dpf-support.md#classansys-dpf-support-1ac6c5332826a5eb2814e71a02fe3e7132)
- [getAvailablePropertyNamesForPropertyFields](classansys-dpf-support.md#classansys-dpf-support-1adb40c35236879d4d6d8a418c618a2f00)
- [getAvailablePropertyNamesForStringFields](classansys-dpf-support.md#classansys-dpf-support-1aefed9b020ce057f1c59e87c5cd0c11f5)
- [getClient](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a968afd9daa0b0f13b65a2ac61369d73a)
- [getFieldSupportByProperty](classansys-dpf-support.md#classansys-dpf-support-1aa4704f682e0e0543acf44e37e9350aab)
- [getPropertyFieldSupportByProperty](classansys-dpf-support.md#classansys-dpf-support-1a7b80b961c6418d9c54bb2d50560d3d2f)
- [getStringFieldSupportByProperty](classansys-dpf-support.md#classansys-dpf-support-1a85465ef9621478e6990fddc5ecddc264)
- [hasBeenMovedLocally](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a1a5634202c15404b6b24e8f50e51cb66)
- [hasInternalObject](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1ae198f89868d85c7db6dc1a934a1d3c15)
- [isMeshedDomain](classansys-dpf-support.md#classansys-dpf-support-1a3cad097e6d82306d5ab8ba23bdb7c8ff)
- [isOnCommonAPI](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a9f9789ff61cc9d400a2a344830706b73)
- [isSameObject](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1aa64d5f8fcd7d85ad6ebf708494dbefd7)
- [operator=](classansys-dpf-support.md#classansys-dpf-support-1aafaebcbcdc49b2ab6fe730399f382d81)
- [operator=](classansys-dpf-support.md#classansys-dpf-support-1a8584e7d484ca126718b4bd7e563011de)
- [Support](classansys-dpf-support.md#classansys-dpf-support-1a7437ca78d2d2fa368dc0063fdf3c221a)
- [Support](classansys-dpf-support.md#classansys-dpf-support-1a71326b7a5a317dd79c6b97a4eb18e79a)
- [~DpfTypes](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1ab7c83b6ea160c2b115e056f6c312112f)
- [~Support](classansys-dpf-support.md#classansys-dpf-support-1a3f63403200b8eb094dd8ebb3e43661ef)

## Friends

<a id="classansys-dpf-support-1aaec47a26a3c11c1debd3ed922b69cbd2"></a>

### Friend Field

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

<a id="classansys-dpf-support-1ad19b1aa2f28448bd897fc6c5dd771f02"></a>

### Friend CustomTypeField

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

<a id="classansys-dpf-support-1abb4aa5a7ed62b741f0b146a257d0fe5e"></a>

### Friend PropertyField

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

<a id="classansys-dpf-support-1af891ea2ca8eebe3679e051763ba989ce"></a>

### Friend CollectionBase

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

<a id="classansys-dpf-support-1a33ff3f826991522d2e77c1c523f33e19"></a>

### Friend Operator

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

<a id="classansys-dpf-support-1afa07847c7cb432b260e61a0c18025ba3"></a>

### Friend Workflow

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

<a id="classansys-dpf-support-1a81d95df60edf516a1de9878b780f8fb3"></a>

### Friend OperatorMain

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

<a id="classansys-dpf-support-1afb1dc59f2e0edbbfe9016fab50e74fbd"></a>

### Friend ResultInfo

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

<a id="classansys-dpf-support-1a9820c685b67a3355c042bb0b3365d9e2"></a>

### Friend Any

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

<a id="classansys-dpf-support-1acc06c4380c923e11af63f95e97c3c259"></a>

### Friend GenericDataContainer

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

<a id="classansys-dpf-support-1af764561c544bacc1b90b526ee8d3c708"></a>

### Friend core

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

## Public functions

<a id="classansys-dpf-support-1a3f63403200b8eb094dd8ebb3e43661ef"></a>

### Function ~Support

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

```cpp
virtual ansys::dpf::Support::~Support()

```

**Return type**:

<a id="classansys-dpf-support-1a7437ca78d2d2fa368dc0063fdf3c221a"></a>

### Function Support

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

```cpp
ansys::dpf::Support::Support(Support const &)

```

**Parameters**:

- Support const &amp;

**Return type**:

<a id="classansys-dpf-support-1a71326b7a5a317dd79c6b97a4eb18e79a"></a>

### Function Support

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

```cpp
ansys::dpf::Support::Support(Support &&) noexcept

```

**Parameters**:

- Support &amp;&amp;

**Return type**:

<a id="classansys-dpf-support-1aafaebcbcdc49b2ab6fe730399f382d81"></a>

### Function operator=

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

```cpp
Support & ansys::dpf::Support::operator=(Support const &)

```

**Parameters**:

- Support const &amp;

**Return type**: Support &amp;

<a id="classansys-dpf-support-1a8584e7d484ca126718b4bd7e563011de"></a>

### Function operator=

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

```cpp
Support & ansys::dpf::Support::operator=(Support &&) noexcept

```

**Parameters**:

- Support &amp;&amp;

**Return type**: Support &amp;

<a id="classansys-dpf-support-1a3cad097e6d82306d5ab8ba23bdb7c8ff"></a>

### Function isMeshedDomain

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

```cpp
bool ansys::dpf::Support::isMeshedDomain() const

```

**Returns**:

Indication if support is meshed domain.

**Return type**: bool

<a id="classansys-dpf-support-1a244cc29be85eb6192faf468268478064"></a>

### Function getAsDomainMesh

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

```cpp
MeshedRegion ansys::dpf::Support::getAsDomainMesh() const

```

**Returns**:

[Support](classansys-dpf-support.md#classansys-dpf-support) as domain mesh.

**Return type**: [MeshedRegion](classansys-dpf-meshedregion.md#classansys-dpf-meshedregion)

<a id="classansys-dpf-support-1a5903cf9eb1f3f3fec9fc0a22331db3d3"></a>

### Function getAsCyclicSupport

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

```cpp
CyclicSupport ansys::dpf::Support::getAsCyclicSupport() const

```

**Returns**:

[Support](classansys-dpf-support.md#classansys-dpf-support) as cyclic support.

**Return type**: [CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport)

<a id="classansys-dpf-support-1a2ced0ad4403332166b14f301d67f4a4e"></a>

### Function getAsTimeFreqSupport

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

```cpp
TimeFreqSupport ansys::dpf::Support::getAsTimeFreqSupport() const

```

**Returns**:

[Support](classansys-dpf-support.md#classansys-dpf-support) as time frequency support.

**Return type**: [TimeFreqSupport](classansys-dpf-timefreqsupport.md#classansys-dpf-timefreqsupport)

<a id="classansys-dpf-support-1aa4704f682e0e0543acf44e37e9350aab"></a>

### Function getFieldSupportByProperty

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

```cpp
Field ansys::dpf::Support::getFieldSupportByProperty(PropertyType const &property_name) const

```

**Returns**:

[Field](classansys-dpf-field.md#classansys-dpf-field) for a given property.

return empty [Field](classansys-dpf-field.md#classansys-dpf-field) if the property doesn't exist.

**Parameters**:

- [PropertyType](structansys-dpf-propertytype.md#structansys-dpf-propertytype) const &amp; **property\_name**

**Return type**: Field

<a id="classansys-dpf-support-1a7b80b961c6418d9c54bb2d50560d3d2f"></a>

### Function getPropertyFieldSupportByProperty

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

```cpp
PropertyField ansys::dpf::Support::getPropertyFieldSupportByProperty(PropertyType const &property_name) const

```

**Returns**:

[PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) for a given property.

return empty [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) if the property doesn't exist.

**Parameters**:

- [PropertyType](structansys-dpf-propertytype.md#structansys-dpf-propertytype) const &amp; **property\_name**

**Return type**: PropertyField

<a id="classansys-dpf-support-1a85465ef9621478e6990fddc5ecddc264"></a>

### Function getStringFieldSupportByProperty

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

```cpp
StringField ansys::dpf::Support::getStringFieldSupportByProperty(PropertyType const &property_name) const

```

**Returns**:

[StringField](classansys-dpf-stringfield.md#classansys-dpf-stringfield) for a given property.

return empty [StringField](classansys-dpf-stringfield.md#classansys-dpf-stringfield) if the property doesn't exist.

**Parameters**:

- [PropertyType](structansys-dpf-propertytype.md#structansys-dpf-propertytype) const &amp; **property\_name**

**Return type**: [StringField](classansys-dpf-stringfield.md#classansys-dpf-stringfield)

<a id="classansys-dpf-support-1ac6c5332826a5eb2814e71a02fe3e7132"></a>

### Function getAvailablePropertyNamesForFields

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

```cpp
std::vector< std::string > ansys::dpf::Support::getAvailablePropertyNamesForFields() const

```

**Returns**:

the list of available properties returning a [Field](classansys-dpf-field.md#classansys-dpf-field).

**Return type**: std::vector&lt; std::string &gt;

<a id="classansys-dpf-support-1adb40c35236879d4d6d8a418c618a2f00"></a>

### Function getAvailablePropertyNamesForPropertyFields

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

```cpp
std::vector< std::string > ansys::dpf::Support::getAvailablePropertyNamesForPropertyFields() const

```

**Returns**:

the list of available properties returning a [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield).

**Return type**: std::vector&lt; std::string &gt;

<a id="classansys-dpf-support-1aefed9b020ce057f1c59e87c5cd0c11f5"></a>

### Function getAvailablePropertyNamesForStringFields

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

```cpp
std::vector< std::string > ansys::dpf::Support::getAvailablePropertyNamesForStringFields() const

```

**Returns**:

the list of available properties returning a [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield).

**Return type**: std::vector&lt; std::string &gt;

<a id="classansys-dpf-support-1a3b4233346825454e052a9de678d9ef0a"></a>

### Function deep\_copy

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

```cpp
Support ansys::dpf::Support::deep_copy(ansys::dpf::Client const *const client=nullptr) const

```

Create a new [Support](classansys-dpf-support.md#classansys-dpf-support) on a server by copying all the data of this [Support](classansys-dpf-support.md#classansys-dpf-support).

**Parameters**:

- [ansys::dpf::Client](classansys-dpf-client.md#classansys-dpf-client) const \*const **client** = nullptr : \[in\] [Client](classansys-dpf-client.md#classansys-dpf-client) instance designating the IP, port and protocol to use.

**Return type**: Support

## Public static functions

<a id="classansys-dpf-support-1ad5b62f0bc3fc29380461006280edf89b"></a>

### Function emptySupport

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

```cpp
static Support ansys::dpf::Support::emptySupport()

```

Create an empty support. **Returns**:

Empty [Support](classansys-dpf-support.md#classansys-dpf-support).

**Return type**: Support