    

 ## On this page

  

 

 # Class ansys::dpf::FieldDefinition

 Last update: 25.03.2026 

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

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

Provide all the information about the content of a [Field](classansys-dpf-field.md#classansys-dpf-field) ([Unit](classansys-dpf-unit.md#classansys-dpf-unit), [location](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1a9ea61f23ef1eb93c794b7c222d7740b8), dimension, a.s.o.).

**See also**: [Field](classansys-dpf-field.md#classansys-dpf-field)

**Inherits from**:

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

## Members

- [callAPI](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1aea34d37e0c080126eff70db34bf46597)
- [deep\_copy](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1a55532a5f5029319a6d388f2c8ef4e704)
- [describe](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a9977945710983bc03d2940fa007847b2)
- [dimensions](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1a0d33e4d4faaa30b3808014b19de680cd)
- [empty](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a39cd546c42518e2332be8f287db95459)
- [emptyFieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1ae55318ae24aadd39ef0bb18a4b27c004)
- [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1a55fcf5f1d96e6561b556aa24b60c6c30)
- [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1a1a73bbd28c4d55a2338071a3fa91f6f2)
- [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1a0b4846c843a0473ea8b8e856619a6fb8)
- [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1abdb982a583acaa9e29ee0bf169b9632b)
- [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1a7b2ce85121239d3571ab9a92ec230d2e)
- [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1acc41b3a0c2b6009f103b02c6f0fbe17e)
- [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1a5a95d2e30068bba5ef9b312542e1f898)
- [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1a035018ec94f2ca6a312b7110b73ec227)
- [getClient](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a968afd9daa0b0f13b65a2ac61369d73a)
- [hasBeenMovedLocally](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a1a5634202c15404b6b24e8f50e51cb66)
- [hasInternalObject](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1ae198f89868d85c7db6dc1a934a1d3c15)
- [isOfQuantityType](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1aa06bf73d67fde6d8fab8679cb0f4297b)
- [isOnCommonAPI](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a9f9789ff61cc9d400a2a344830706b73)
- [isSameObject](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1aa64d5f8fcd7d85ad6ebf708494dbefd7)
- [location](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1a9ea61f23ef1eb93c794b7c222d7740b8)
- [name](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1a75a4c68f58429c63d6fee153d1f46ca3)
- [numberOfQuantityTypes](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1a5d02a40074a8fb9c0aa2541f02fe439c)
- [operator=](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1ad5b3ffb901b9fae885af420f727956ef)
- [operator=](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1a61679cddaa8bd95bd9fa23d605da23ca)
- [quantity\_type](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1af7d513babc5f529f1ba3e324f5e0b60a)
- [setDimensions](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1ab05632e1f011855593928c927908ccdc)
- [setDimensions](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1abb7364b9d7860660498d8b28bf9aa212)
- [setLocation](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1a5ef8fa0b594db3066e6aab50d3b019b6)
- [setName](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1a18256bc3d3e9733f4cd951ba145d0087)
- [setQuantityType](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1a2795d6f4b1c5396a99e6022c804b7b4b)
- [setShellLayers](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1acdab27568afdd87e18e6ad7745564536)
- [setUnit](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1a8033b1d4486ea3d819ecbb6418bab079)
- [shellLayers](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1a960c51c470854c20ad8682fcfa891db6)
- [unit](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1aaf9c5c92a6d192207f01067950907af8)
- [~DpfTypes](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1ab7c83b6ea160c2b115e056f6c312112f)
- [~FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition-1afbd7071f1b5fb4f9aefc944444b4535f)

## Friends

## Public functions

<a id="classansys-dpf-fielddefinition-1a55fcf5f1d96e6561b556aa24b60c6c30"></a>

### Function FieldDefinition

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

```cpp
ansys::dpf::FieldDefinition::FieldDefinition()

```

Create [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition).

**Return type**:

<a id="classansys-dpf-fielddefinition-1a1a73bbd28c4d55a2338071a3fa91f6f2"></a>

### Function FieldDefinition

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

```cpp
ansys::dpf::FieldDefinition::FieldDefinition(Client const *const client)

```

Create [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition) on a server.

**Parameters**:

- [Client](classansys-dpf-client.md#classansys-dpf-client) const \*const **client**: \[in\] Remote client.

**Return type**:

<a id="classansys-dpf-fielddefinition-1afbd7071f1b5fb4f9aefc944444b4535f"></a>

### Function ~FieldDefinition

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

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

```

**Return type**:

<a id="classansys-dpf-fielddefinition-1a0b4846c843a0473ea8b8e856619a6fb8"></a>

### Function FieldDefinition

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

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

```

**Parameters**:

- FieldDefinition const &amp;

**Return type**:

<a id="classansys-dpf-fielddefinition-1abdb982a583acaa9e29ee0bf169b9632b"></a>

### Function FieldDefinition

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

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

```

**Parameters**:

- FieldDefinition &amp;&amp;

**Return type**:

<a id="classansys-dpf-fielddefinition-1a7b2ce85121239d3571ab9a92ec230d2e"></a>

### Function FieldDefinition

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

```cpp
ansys::dpf::FieldDefinition::FieldDefinition(const ansys::dpf::Location &loc, const std::vector< dp_int > &dimensions)

```

Create [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition).

**Parameters**:

- const [ansys::dpf::Location](structansys-dpf-location.md#structansys-dpf-location) &amp; **loc**: \[in\] [Location](structansys-dpf-location.md#structansys-dpf-location) on which field defined.
- const std::vector&lt; [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) &gt; &amp; **dimensions**: \[in\] Vector defining size of each dimension. See [Dimensionality](structansys-dpf-dimensionality.md#structansys-dpf-dimensionality).

**Return type**:

<a id="classansys-dpf-fielddefinition-1acc41b3a0c2b6009f103b02c6f0fbe17e"></a>

### Function FieldDefinition

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

```cpp
ansys::dpf::FieldDefinition::FieldDefinition(const ansys::dpf::Location &loc, const std::vector< dp_int > &dimensions, const Unit &unit)

```

Create [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition).

**Parameters**:

- const [ansys::dpf::Location](structansys-dpf-location.md#structansys-dpf-location) &amp; **loc**: \[in\] [Location](structansys-dpf-location.md#structansys-dpf-location) on which field defined.
- const std::vector&lt; [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) &gt; &amp; **dimensions**: \[in\] Vector defining size of each dimension. See [Dimensionality](structansys-dpf-dimensionality.md#structansys-dpf-dimensionality).
- const [Unit](classansys-dpf-unit.md#classansys-dpf-unit) &amp; **unit**: \[in\] [Unit](classansys-dpf-unit.md#classansys-dpf-unit) defined for field.

**Return type**:

<a id="classansys-dpf-fielddefinition-1a5a95d2e30068bba5ef9b312542e1f898"></a>

### Function FieldDefinition

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

```cpp
ansys::dpf::FieldDefinition::FieldDefinition(Client const *const client, const ansys::dpf::Location &loc, const std::vector< dp_int > &dimensions)

```

Create [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition).

**Parameters**:

- [Client](classansys-dpf-client.md#classansys-dpf-client) const \*const **client**: \[in\] Remote client.
- const [ansys::dpf::Location](structansys-dpf-location.md#structansys-dpf-location) &amp; **loc**: \[in\] [Location](structansys-dpf-location.md#structansys-dpf-location) on which field defined.
- const std::vector&lt; [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) &gt; &amp; **dimensions**: \[in\] Vector defining size of each dimension. See [Dimensionality](structansys-dpf-dimensionality.md#structansys-dpf-dimensionality).

**Return type**:

<a id="classansys-dpf-fielddefinition-1a035018ec94f2ca6a312b7110b73ec227"></a>

### Function FieldDefinition

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

```cpp
ansys::dpf::FieldDefinition::FieldDefinition(Client const *const client, const ansys::dpf::Location &loc, const std::vector< dp_int > &dimensions, const Unit &unit)

```

Create [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition).

**Parameters**:

- [Client](classansys-dpf-client.md#classansys-dpf-client) const \*const **client**: \[in\] Remote client.
- const [ansys::dpf::Location](structansys-dpf-location.md#structansys-dpf-location) &amp; **loc**: \[in\] [Location](structansys-dpf-location.md#structansys-dpf-location) on which field defined.
- const std::vector&lt; [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) &gt; &amp; **dimensions**: \[in\] Vector defining size of each dimension. See [Dimensionality](structansys-dpf-dimensionality.md#structansys-dpf-dimensionality).
- const [Unit](classansys-dpf-unit.md#classansys-dpf-unit) &amp; **unit**: \[in\] [Unit](classansys-dpf-unit.md#classansys-dpf-unit) defined for field.

**Return type**:

<a id="classansys-dpf-fielddefinition-1ad5b3ffb901b9fae885af420f727956ef"></a>

### Function operator=

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

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

```

**Parameters**:

- FieldDefinition const &amp;

**Return type**: FieldDefinition &amp;

<a id="classansys-dpf-fielddefinition-1a61679cddaa8bd95bd9fa23d605da23ca"></a>

### Function operator=

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

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

```

**Parameters**:

- FieldDefinition &amp;&amp;

**Return type**: FieldDefinition &amp;

<a id="classansys-dpf-fielddefinition-1aaf9c5c92a6d192207f01067950907af8"></a>

### Function unit

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

```cpp
ansys::dpf::Unit ansys::dpf::FieldDefinition::unit() const

```

**Returns**:

[Unit](classansys-dpf-unit.md#classansys-dpf-unit) of [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition).

**Return type**: [ansys::dpf::Unit](classansys-dpf-unit.md#classansys-dpf-unit)

<a id="classansys-dpf-fielddefinition-1a0d33e4d4faaa30b3808014b19de680cd"></a>

### Function dimensions

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

```cpp
std::vector< dp_int > ansys::dpf::FieldDefinition::dimensions() const

```

**Returns**:

Vector defining size of each dimension. See [Dimensionality](structansys-dpf-dimensionality.md#structansys-dpf-dimensionality).

**Return type**: std::vector&lt; [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) &gt;

<a id="classansys-dpf-fielddefinition-1a9ea61f23ef1eb93c794b7c222d7740b8"></a>

### Function location

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

```cpp
ansys::dpf::Location ansys::dpf::FieldDefinition::location() const

```

**Returns**:

[Location](structansys-dpf-location.md#structansys-dpf-location) on which field defined.

**Return type**: [ansys::dpf::Location](structansys-dpf-location.md#structansys-dpf-location)

<a id="classansys-dpf-fielddefinition-1a75a4c68f58429c63d6fee153d1f46ca3"></a>

### Function name

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

```cpp
std::string ansys::dpf::FieldDefinition::name() const

```

**Returns**:

Name of the field.

**Return type**: std::string

<a id="classansys-dpf-fielddefinition-1a960c51c470854c20ad8682fcfa891db6"></a>

### Function shellLayers

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

```cpp
eshellLayers ansys::dpf::FieldDefinition::shellLayers() const

```

**Returns**:

Layers over which field defined.

**Return type**: [eshellLayers](namespaceansys-dpf.md#namespaceansys-dpf-1a6d14c6ea165905b13e914d776c880751)

<a id="classansys-dpf-fielddefinition-1a18256bc3d3e9733f4cd951ba145d0087"></a>

### Function setName

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

```cpp
void ansys::dpf::FieldDefinition::setName(std::string const &rhs)

```

Set field name.

**Parameters**:

- std::string const &amp; **rhs**

**Return type**: void

<a id="classansys-dpf-fielddefinition-1a5ef8fa0b594db3066e6aab50d3b019b6"></a>

### Function setLocation

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

```cpp
void ansys::dpf::FieldDefinition::setLocation(ansys::dpf::Location const &rhs)

```

Set field location.

**Parameters**:

- [ansys::dpf::Location](structansys-dpf-location.md#structansys-dpf-location) const &amp; **rhs**: \[in\] [Location](structansys-dpf-location.md#structansys-dpf-location) on which field defined.

**Return type**: void

<a id="classansys-dpf-fielddefinition-1a8033b1d4486ea3d819ecbb6418bab079"></a>

### Function setUnit

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

```cpp
void ansys::dpf::FieldDefinition::setUnit(ansys::dpf::Unit const &rhs)

```

Set field unit.

**Parameters**:

- [ansys::dpf::Unit](classansys-dpf-unit.md#classansys-dpf-unit) const &amp; **rhs**: \[in\] [Unit](classansys-dpf-unit.md#classansys-dpf-unit) for field.

**Return type**: void

<a id="classansys-dpf-fielddefinition-1ab05632e1f011855593928c927908ccdc"></a>

### Function setDimensions

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

```cpp
void ansys::dpf::FieldDefinition::setDimensions(std::vector< dp_int > const &rhs, int effective_size)

```

Set dimensions of field.

**Parameters**:

- std::vector&lt; [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) &gt; const &amp; **rhs**: \[in\] Vector defining size of each dimension. See [Dimensionality](structansys-dpf-dimensionality.md#structansys-dpf-dimensionality).
- int **effective\_size**: \[in\] Effective size of data per field entry. (scalar is 1, xyz vector is 3, 2 Dimensional 3x3 Matrix is 9, ...)

**Return type**: void

<a id="classansys-dpf-fielddefinition-1abb7364b9d7860660498d8b28bf9aa212"></a>

### Function setDimensions

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

```cpp
void ansys::dpf::FieldDefinition::setDimensions(std::vector< dp_int > const &rhs)

```

Set dimensions of field.

**Parameters**:

- std::vector&lt; [dp\_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) &gt; const &amp; **rhs**: \[in\] Vector defining size of each dimension. See [Dimensionality](structansys-dpf-dimensionality.md#structansys-dpf-dimensionality).

**Return type**: void

<a id="classansys-dpf-fielddefinition-1acdab27568afdd87e18e6ad7745564536"></a>

### Function setShellLayers

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

```cpp
void ansys::dpf::FieldDefinition::setShellLayers(ansys::dpf::eshellLayers layers)

```

Set layers of field.

**Parameters**:

- [ansys::dpf::eshellLayers](namespaceansys-dpf.md#namespaceansys-dpf-1a6d14c6ea165905b13e914d776c880751) **layers**: \[in\] Layers over which field defined.

**Return type**: void

<a id="classansys-dpf-fielddefinition-1a55532a5f5029319a6d388f2c8ef4e704"></a>

### Function deep\_copy

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

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

```

Make a deep copy on a given client.

**Parameters**:

- [ansys::dpf::Client](classansys-dpf-client.md#classansys-dpf-client) const \*const **client** = nullptr : \[in\] Remote client

**Return type**: FieldDefinition

<a id="classansys-dpf-fielddefinition-1aa06bf73d67fde6d8fab8679cb0f4297b"></a>

### Function isOfQuantityType

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

```cpp
bool ansys::dpf::FieldDefinition::isOfQuantityType(QuantityType const &quantitytype) const

```

checks is the field data is of the given quantity type.

**Parameters**:

- [QuantityType](structansys-dpf-quantitytype.md#structansys-dpf-quantitytype) const &amp; **quantitytype**

**Return type**: bool

<a id="classansys-dpf-fielddefinition-1a2795d6f4b1c5396a99e6022c804b7b4b"></a>

### Function setQuantityType

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

```cpp
void ansys::dpf::FieldDefinition::setQuantityType(QuantityType const &quantitytype)

```

Set field data quantity type.

**Parameters**:

- [QuantityType](structansys-dpf-quantitytype.md#structansys-dpf-quantitytype) const &amp; **quantitytype**

**Return type**: void

<a id="classansys-dpf-fielddefinition-1a5d02a40074a8fb9c0aa2541f02fe439c"></a>

### Function numberOfQuantityTypes

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

```cpp
int ansys::dpf::FieldDefinition::numberOfQuantityTypes() const

```

Get the number of quantity types.

**Return type**: int

<a id="classansys-dpf-fielddefinition-1af7d513babc5f529f1ba3e324f5e0b60a"></a>

### Function quantity\_type

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

```cpp
std::string ansys::dpf::FieldDefinition::quantity_type(int i) const

```

Get i'th quantity types.

**Parameters**:

- int **i**

**Return type**: std::string

## Public static functions

<a id="classansys-dpf-fielddefinition-1ae55318ae24aadd39ef0bb18a4b27c004"></a>

### Function emptyFieldDefinition

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

```cpp
static FieldDefinition ansys::dpf::FieldDefinition::emptyFieldDefinition()

```

Create an empty [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition). **Returns**:

Empty [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition).

**Return type**: FieldDefinition