diff --git a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-any.md b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-any.md index 4bf5e3a28..54975ef0d 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-any.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-any.md @@ -37,6 +37,7 @@ * [getAsField](classansys-dpf-any.md#classansys-dpf-any-1a8bb8b9c5c9b8caccff78ff66a16780cb) * [getAsFieldsContainer](classansys-dpf-any.md#classansys-dpf-any-1af48a4b58d4d52dd107e75fdb6db2cdea) * [getAsGenericDataContainer](classansys-dpf-any.md#classansys-dpf-any-1a8a4ae829c4e5142a390158b7f1842cfb) +* [getAsGenericSupport](classansys-dpf-any.md#classansys-dpf-any-1a31d1d3ef7e7043252be52ab9a75ac926) * [getAsInt](classansys-dpf-any.md#classansys-dpf-any-1a00cce5475752905812ab028e4c1ca97b) * [getAsIntVector](classansys-dpf-any.md#classansys-dpf-any-1a9b3531295f844610cc131f78c96ef04d) * [getAsLabelSpace](classansys-dpf-any.md#classansys-dpf-any-1a53dda1baccbaa272f72df5195f30591b) @@ -167,7 +168,7 @@ ansys::dpf::Any::Any(Any const &) **Parameters**: -* Any const & +* [Any](classansys-dpf-any.md#classansys-dpf-any) const & **Return type**: @@ -196,7 +197,7 @@ ansys::dpf::Any::Any(Any &&) noexcept **Parameters**: -* Any && +* [Any](classansys-dpf-any.md#classansys-dpf-any) && **Return type**: @@ -225,9 +226,9 @@ Any & ansys::dpf::Any::operator=(Any const &) **Parameters**: -* Any const & +* [Any](classansys-dpf-any.md#classansys-dpf-any) const & -**Return type**: Any & +**Return type**: [Any](classansys-dpf-any.md#classansys-dpf-any) & + +### Function getAsGenericSupport + +![][public] +![][const] + + +```cpp +GenericSupport ansys::dpf::Any::getAsGenericSupport() const +``` + + + + +**Returns**: + +[GenericSupport](classansys-dpf-genericsupport.md#classansys-dpf-genericsupport) held in the [Any](classansys-dpf-any.md#classansys-dpf-any) object. + + +**Exceptions**: + +* **[DpfException](classansys-dpf-dpfexception.md#classansys-dpf-dpfexception)**: + + + +**Return type**: [GenericSupport](classansys-dpf-genericsupport.md#classansys-dpf-genericsupport) + + + ### Function getAsDataSources @@ -1233,7 +1267,7 @@ Make a deep copy on a given client. * [ansys::dpf::Client](classansys-dpf-client.md#classansys-dpf-client) const *const **client** = nullptr : [in] Remote client -**Return type**: Any +**Return type**: [Any](classansys-dpf-any.md#classansys-dpf-any) - + ### Function setSupport ![][public] ```cpp -void ansys::dpf::CustomTypeField::setSupport(ansys::dpf::Support &s) +void ansys::dpf::CustomTypeField::setSupport(ansys::dpf::Support const &s) ``` @@ -1234,7 +1235,7 @@ Set the support of the [Field](classansys-dpf-field.md#classansys-dpf-field). **Parameters**: -* [ansys::dpf::Support](classansys-dpf-support.md#classansys-dpf-support) & **s**: [in] [Field](classansys-dpf-field.md#classansys-dpf-field) to support. +* [ansys::dpf::Support](classansys-dpf-support.md#classansys-dpf-support) const & **s**: [in] [Support](classansys-dpf-support.md#classansys-dpf-support) to support. **Return type**: void @@ -1244,14 +1245,14 @@ Set the support of the [Field](classansys-dpf-field.md#classansys-dpf-field). * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::CustomTypeField::setSupport"}]}` --> - + ### Function setSupport ![][public] ```cpp -void ansys::dpf::CustomTypeField::setSupport(ansys::dpf::TimeFreqSupport &s) +void ansys::dpf::CustomTypeField::setSupport(ansys::dpf::TimeFreqSupport const &s) ``` @@ -1263,7 +1264,7 @@ Set the support of the [Field](classansys-dpf-field.md#classansys-dpf-field). **Parameters**: -* [ansys::dpf::TimeFreqSupport](classansys-dpf-timefreqsupport.md#classansys-dpf-timefreqsupport) & **s**: [in] [Field](classansys-dpf-field.md#classansys-dpf-field) to support. +* [ansys::dpf::TimeFreqSupport](classansys-dpf-timefreqsupport.md#classansys-dpf-timefreqsupport) const & **s**: [in] [TimeFreqSupport](classansys-dpf-timefreqsupport.md#classansys-dpf-timefreqsupport) to support. **Return type**: void @@ -1273,14 +1274,14 @@ Set the support of the [Field](classansys-dpf-field.md#classansys-dpf-field). * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::CustomTypeField::setSupport"}]}` --> - + ### Function setSupport ![][public] ```cpp -void ansys::dpf::CustomTypeField::setSupport(ansys::dpf::MeshedRegion &s) +void ansys::dpf::CustomTypeField::setSupport(ansys::dpf::MeshedRegion const &s) ``` @@ -1292,7 +1293,36 @@ Set the support of the [Field](classansys-dpf-field.md#classansys-dpf-field). **Parameters**: -* [ansys::dpf::MeshedRegion](classansys-dpf-meshedregion.md#classansys-dpf-meshedregion) & **s**: [in] [Field](classansys-dpf-field.md#classansys-dpf-field) to support. +* [ansys::dpf::MeshedRegion](classansys-dpf-meshedregion.md#classansys-dpf-meshedregion) const & **s**: [in] [MeshedRegion](classansys-dpf-meshedregion.md#classansys-dpf-meshedregion) to support. + +**Return type**: void + + + + +### Function setSupport + +![][public] + + +```cpp +void ansys::dpf::CustomTypeField::setSupport(ansys::dpf::CyclicSupport const &s) +``` + + + + +Set the support of the [Field](classansys-dpf-field.md#classansys-dpf-field). + + + +**Parameters**: + +* [ansys::dpf::CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport) const & **s**: [in] [CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport) to support. **Return type**: void @@ -1383,7 +1413,7 @@ Creates a new custom type field object from current field without its data. * bool const **copy_data_ptr** = true : [in] Boolean to decide if data pointer is to be copied * bool const **copy_support** = true : [in] Boolean to decide if the support reference is to be copied -**Return type**: CustomTypeField +**Return type**: [CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield) - -### Function getSizeFor - -![][public] -![][const] - - -```cpp -dp_int ansys::dpf::CustomTypeFieldsContainer::getSizeFor(LabelSpace const &label_space) const -``` - - - - -**Returns**: - -Number of CustomTypeFields for given label space. - - - -**Parameters**: - -* [LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) const & **label_space**: [in] [Label](structansys-dpf-label.md#structansys-dpf-label) space for which to get number of entities. - -**Return type**: [dp_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) - - - ### Function getCustomTypeFields @@ -631,7 +600,7 @@ create a [CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md * [LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) const & **lab_space** -**Return type**: CustomTypeFieldsContainer +**Return type**: [CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer) + +### Function deep_copy + +![][public] +![][const] + + +```cpp +CustomTypeFieldsContainer ansys::dpf::CustomTypeFieldsContainer::deep_copy(ansys::dpf::Client const *const client=nullptr) const +``` + + + + +Create a new [CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer) on a server by copying all the data of this [CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer). + + + +**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**: [CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer) + + + ## Public static functions @@ -662,7 +661,7 @@ Empty container. -**Return type**: CustomTypeFieldsContainer +**Return type**: [CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer) ## Public functions @@ -93,7 +93,7 @@ ansys::dpf::ElementCursor::ElementCursor(ElementCursor const &)=delete **Parameters**: -* ElementCursor const & +* [ElementCursor](classansys-dpf-elementcursor.md#classansys-dpf-elementcursor) const & **Return type**: @@ -122,7 +122,7 @@ ansys::dpf::ElementCursor::ElementCursor(ElementCursor &&)=delete **Parameters**: -* ElementCursor && +* [ElementCursor](classansys-dpf-elementcursor.md#classansys-dpf-elementcursor) && **Return type**: diff --git a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-eventhandler.md b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-eventhandler.md index b9460ba8f..0a7fc6e97 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-eventhandler.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-eventhandler.md @@ -161,7 +161,7 @@ A workflow has finished. * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class Session"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::EventHandler::Session"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"Session"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1Session"},"children":[{"type":"text","text":"Session"}]}]},{"type":"text","text":"\n "}]}` --> ## Public functions diff --git a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-field.md b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-field.md index f5f75fb05..49fba93d6 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-field.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-field.md @@ -25,7 +25,7 @@ The field is the main simulation data container. In numerical simulations, resul * [data](classansys-dpf-field.md#classansys-dpf-field-1ad435429e8f1b152c7b4dad665665d9a4) * [dataPointer](classansys-dpf-field.md#classansys-dpf-field-1a47656e1ead80a6f2cac7c21266429212) * [dataSize](classansys-dpf-field.md#classansys-dpf-field-1a9bb7ac154ee6720cbb98b1c09e056942) -* [deep_copy](classansys-dpf-field.md#classansys-dpf-field-1ad91f3c235727ec55359488edd877ba9f) +* [deep_copy](classansys-dpf-field.md#classansys-dpf-field-1a8a3a031e901d5f571c047a2131ecc93c) * [describe](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a9977945710983bc03d2940fa007847b2) * [empty](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a39cd546c42518e2332be8f287db95459) * [emptyField](classansys-dpf-field.md#classansys-dpf-field-1a5b60dee96313f0f9791c11e1c7f58d5b) @@ -76,6 +76,7 @@ The field is the main simulation data container. In numerical simulations, resul * [setSupport](classansys-dpf-field.md#classansys-dpf-field-1ab71f825765a7ce1b37373443917ec23e) * [setSupport](classansys-dpf-field.md#classansys-dpf-field-1a14d300919db7ae24a917af9e1262cea3) * [setSupport](classansys-dpf-field.md#classansys-dpf-field-1ae846597f402a69d4d78d5c8b5e80d219) +* [setSupport](classansys-dpf-field.md#classansys-dpf-field-1a0d5aa669792de7257dcdea01463dc0ac) * [support](classansys-dpf-field.md#classansys-dpf-field-1a773481e9f7efb04d74c72be914b317d6) * [~DpfTypes](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1ab7c83b6ea160c2b115e056f6c312112f) * [~Field](classansys-dpf-field.md#classansys-dpf-field-1ad4e2524e104248f824921d6755daa36a) @@ -160,7 +161,7 @@ ansys::dpf::Field::Field(int id, Client const *const client) -Retrieve an existing instance of [Field](classansys-dpf-field.md#classansys-dpf-field) on a server. +Retrieve an existing instance of [Field](classansys-dpf-field.md#classansys-dpf-field) on a server.
@@ -221,7 +222,7 @@ ansys::dpf::Field::Field(Field const &) **Parameters**: -* Field const & +* [Field](classansys-dpf-field.md#classansys-dpf-field) const & **Return type**: @@ -250,7 +251,7 @@ ansys::dpf::Field::Field(Field &&) noexcept **Parameters**: -* Field && +* [Field](classansys-dpf-field.md#classansys-dpf-field) && **Return type**: @@ -279,9 +280,9 @@ Field & ansys::dpf::Field::operator=(Field const &) **Parameters**: -* Field const & +* [Field](classansys-dpf-field.md#classansys-dpf-field) const & -**Return type**: Field & +**Return type**: [Field](classansys-dpf-field.md#classansys-dpf-field) & + +### Function setSupport + +![][public] + + +```cpp +void ansys::dpf::Field::setSupport(ansys::dpf::CyclicSupport const &s) +``` + + + + +Set the support of the [Field](classansys-dpf-field.md#classansys-dpf-field). + + + +**Parameters**: + +* [ansys::dpf::CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport) const & **s**: [in] [CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport) to support. + +**Return type**: void + + + ### Function reserve @@ -1488,7 +1518,7 @@ Push back the entity data. * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Field::push_back"}]}` --> - + ### Function deep_copy ![][public] @@ -1496,7 +1526,7 @@ Push back the entity data. ```cpp -Field ansys::dpf::Field::deep_copy(ansys::dpf::Client const *const client=nullptr) const +Field ansys::dpf::Field::deep_copy(ansys::dpf::Client const *const client=nullptr, const bool copy_data=true) const ``` @@ -1509,8 +1539,9 @@ 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 +* const bool **copy_data** = true : [in] Boolean that allows to decide if data is to be copied -**Return type**: Field +**Return type**: [Field](classansys-dpf-field.md#classansys-dpf-field) ## Public functions diff --git a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-fielddefinition.md b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-fielddefinition.md index 787cc467d..08766e619 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-fielddefinition.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-fielddefinition.md @@ -157,7 +157,7 @@ ansys::dpf::FieldDefinition::FieldDefinition(FieldDefinition const &) **Parameters**: -* FieldDefinition const & +* [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition) const & **Return type**: @@ -186,7 +186,7 @@ ansys::dpf::FieldDefinition::FieldDefinition(FieldDefinition &&) noexcept **Parameters**: -* FieldDefinition && +* [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition) && **Return type**: @@ -339,9 +339,9 @@ FieldDefinition & ansys::dpf::FieldDefinition::operator=(FieldDefinition const & **Parameters**: -* FieldDefinition const & +* [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition) const & -**Return type**: FieldDefinition & +**Return type**: [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition) & + +### Function setBaseName + +![][public] + + +```cpp +void ansys::dpf::FieldsContainer::setBaseName(const std::string &base_name) +``` + + + + +Set the name of [FieldsContainer](classansys-dpf-fieldscontainer.md#classansys-dpf-fieldscontainer) and inside Fields based on the name set as argument. + + + +**Parameters**: + +* const std::string & **base_name** + +**Return type**: void + + + ## Public static functions @@ -799,7 +829,7 @@ Empty [FieldsContainer](classansys-dpf-fieldscontainer.md#classansys-dpf-fieldsc -**Return type**: FieldsContainer +**Return type**: [FieldsContainer](classansys-dpf-fieldscontainer.md#classansys-dpf-fieldscontainer) + +### Function testInputCustom + +![][public] + + +```cpp +bool ansys::dpf::OperatorMain::testInputCustom(dp_int pin_index) +``` + + + + +**Returns**: + +Indication that input pin contains typed data. + + + +**Parameters**: + +* [dp_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) **pin_index**: [in] Input pin for which to check data type. + +**Return type**: bool + + + ### Function hasInput diff --git a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-operatorspecification.md b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-operatorspecification.md index 72f784406..532dd80a6 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-operatorspecification.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-operatorspecification.md @@ -141,7 +141,7 @@ ansys::dpf::OperatorSpecification::OperatorSpecification(OperatorSpecification c **Parameters**: -* OperatorSpecification const & +* [OperatorSpecification](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification) const & **Return type**: @@ -170,7 +170,7 @@ ansys::dpf::OperatorSpecification::OperatorSpecification(OperatorSpecification & **Parameters**: -* OperatorSpecification && +* [OperatorSpecification](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification) && **Return type**: @@ -199,9 +199,9 @@ OperatorSpecification & ansys::dpf::OperatorSpecification::operator=(OperatorSpe **Parameters**: -* OperatorSpecification const & +* [OperatorSpecification](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification) const & -**Return type**: OperatorSpecification & +**Return type**: [OperatorSpecification](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification) & + +### Function setSupport + +![][public] + + +```cpp +void ansys::dpf::PropertyField::setSupport(ansys::dpf::CyclicSupport const &s) +``` + + + + +Set the support of the [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield). + + + +**Parameters**: + +* [ansys::dpf::CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport) const & **s**: [in] [CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport) to support. + +**Return type**: void + + + ### Function name @@ -1157,7 +1187,7 @@ DpfVector< int > ansys::dpf::PropertyField::data() const -**Return type**: DpfVector< int > +**Return type**: [DpfVector](classansys-dpf-dpfvector.md#classansys-dpf-dpfvector)< int > ## Public functions diff --git a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-resultinfo.md b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-resultinfo.md index 705fb0229..1edfa39d9 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-resultinfo.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-resultinfo.md @@ -307,8 +307,8 @@ ansys::dpf::ResultInfo::ResultInfo(analysis_type const &analysis_type=analysis_t **Parameters**: -* [analysis_type](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo-1a7242b85e3d035f0953356a1146e742ae) const & **analysis_type** = [analysis_type::eUnknownAnalysis](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo-1a7242b85e3d035f0953356a1146e742aea533f3644550f70cbfc2a2892f9aba9c5) -* [physics_type](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo-1a4c9d8d076df7a3899011b1b2195dfaba) const & **physics_type** = [physics_type::eUnknownPhysics](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo-1a4c9d8d076df7a3899011b1b2195dfabaad00f4b71e4db56a56048bc9ecd1786f3) +* [analysis_type](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo-1a7242b85e3d035f0953356a1146e742ae) const & **analysis_type** = analysis_type::eUnknownAnalysis +* [physics_type](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo-1a4c9d8d076df7a3899011b1b2195dfaba) const & **physics_type** = physics_type::eUnknownPhysics **Return type**: @@ -362,7 +362,7 @@ ansys::dpf::ResultInfo::ResultInfo(ResultInfo const &) **Parameters**: -* ResultInfo const & +* [ResultInfo](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo) const & **Return type**: @@ -391,7 +391,7 @@ ansys::dpf::ResultInfo::ResultInfo(ResultInfo &&) noexcept **Parameters**: -* ResultInfo && +* [ResultInfo](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo) && **Return type**: @@ -420,9 +420,9 @@ ResultInfo & ansys::dpf::ResultInfo::operator=(ResultInfo const &) **Parameters**: -* ResultInfo const & +* [ResultInfo](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo) const & -**Return type**: ResultInfo & +**Return type**: [ResultInfo](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo) & @@ -89,7 +95,7 @@ Define an abstract support notion. * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class CustomTypeField"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Support::CustomTypeField"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"CustomTypeField"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1CustomTypeField"},"children":[{"type":"text","text":"CustomTypeField"}]}]},{"type":"text","text":"\n "}]}` --> @@ -111,7 +117,7 @@ Define an abstract support notion. * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class PropertyField"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Support::PropertyField"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"PropertyField"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1PropertyField"},"children":[{"type":"text","text":"PropertyField"}]}]},{"type":"text","text":"\n "}]}` --> @@ -155,7 +161,7 @@ Define an abstract support notion. * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class Operator"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Support::Operator"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"Operator"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1Operator"},"children":[{"type":"text","text":"Operator"}]}]},{"type":"text","text":"\n "}]}` --> @@ -221,7 +227,7 @@ Define an abstract support notion. * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class ResultInfo"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Support::ResultInfo"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"ResultInfo"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1ResultInfo"},"children":[{"type":"text","text":"ResultInfo"}]}]},{"type":"text","text":"\n "}]}` --> @@ -243,7 +249,7 @@ Define an abstract support notion. * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class Any"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Support::Any"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"Any"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1Any"},"children":[{"type":"text","text":"Any"}]}]},{"type":"text","text":"\n "}]}` --> @@ -287,7 +293,7 @@ Define an abstract support notion. * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class core"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Support::core"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"core"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1core"},"children":[{"type":"text","text":"core"}]}]},{"type":"text","text":"\n "}]}` --> ## Public functions @@ -336,7 +342,123 @@ ansys::dpf::Support::Support(Support const &) **Parameters**: -* Support const & +* [Support](classansys-dpf-support.md#classansys-dpf-support) const & + +**Return type**: + + + + +### Function Support + +![][public] + + +```cpp +ansys::dpf::Support::Support(MeshedRegion const &) +``` + + + + + + + + +**Parameters**: + +* [MeshedRegion](classansys-dpf-meshedregion.md#classansys-dpf-meshedregion) const & + +**Return type**: + + + + +### Function Support + +![][public] + + +```cpp +ansys::dpf::Support::Support(CyclicSupport const &) +``` + + + + + + + + +**Parameters**: + +* [CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport) const & + +**Return type**: + + + + +### Function Support + +![][public] + + +```cpp +ansys::dpf::Support::Support(GenericSupport const &) +``` + + + + + + + + +**Parameters**: + +* [GenericSupport](classansys-dpf-genericsupport.md#classansys-dpf-genericsupport) const & + +**Return type**: + + + + +### Function Support + +![][public] + + +```cpp +ansys::dpf::Support::Support(TimeFreqSupport const &) +``` + + + + + + + + +**Parameters**: + +* [TimeFreqSupport](classansys-dpf-timefreqsupport.md#classansys-dpf-timefreqsupport) const & **Return type**: @@ -365,7 +487,7 @@ ansys::dpf::Support::Support(Support &&) noexcept **Parameters**: -* Support && +* [Support](classansys-dpf-support.md#classansys-dpf-support) && **Return type**: @@ -394,9 +516,9 @@ Support & ansys::dpf::Support::operator=(Support const &) **Parameters**: -* Support const & +* [Support](classansys-dpf-support.md#classansys-dpf-support) const & -**Return type**: Support & +**Return type**: [Support](classansys-dpf-support.md#classansys-dpf-support) & + +### Function type + +![][public] +![][const] + + +```cpp +std::string ansys::dpf::Support::type() const +``` + + + + +**Returns**: + +The support type as a string ([MeshedRegion](classansys-dpf-meshedregion.md#classansys-dpf-meshedregion), [CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport), [TimeFreqSupport](classansys-dpf-timefreqsupport.md#classansys-dpf-timefreqsupport), ...). + + + +**Return type**: std::string + + + ### Function getAsDomainMesh @@ -545,6 +695,34 @@ TimeFreqSupport ansys::dpf::Support::getAsTimeFreqSupport() const * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Support::getAsTimeFreqSupport"}]}` --> + +### Function getAsGenericSupport + +![][public] +![][const] + + +```cpp +GenericSupport ansys::dpf::Support::getAsGenericSupport() const +``` + + + + +**Returns**: + +[Support](classansys-dpf-support.md#classansys-dpf-support) as generic support. + + + +**Return type**: [GenericSupport](classansys-dpf-genericsupport.md#classansys-dpf-genericsupport) + + + ### Function getFieldSupportByProperty @@ -571,7 +749,7 @@ return empty [Field](classansys-dpf-field.md#classansys-dpf-field) if the proper * [PropertyType](structansys-dpf-propertytype.md#structansys-dpf-propertytype) const & **property_name** -**Return type**: Field +**Return type**: [Field](classansys-dpf-field.md#classansys-dpf-field) @@ -240,7 +240,7 @@ * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class core"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Workflow::core"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"core"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1core"},"children":[{"type":"text","text":"core"}]}]},{"type":"text","text":"\n "}]}` --> @@ -262,7 +262,7 @@ * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class Operator"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Workflow::Operator"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"Operator"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1Operator"},"children":[{"type":"text","text":"Operator"}]}]},{"type":"text","text":"\n "}]}` --> @@ -328,7 +328,7 @@ * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class Any"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Workflow::Any"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"Any"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1Any"},"children":[{"type":"text","text":"Any"}]}]},{"type":"text","text":"\n "}]}` --> @@ -350,7 +350,7 @@ * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class Field"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Workflow::Field"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"Field"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1Field"},"children":[{"type":"text","text":"Field"}]}]},{"type":"text","text":"\n "}]}` --> @@ -372,7 +372,7 @@ * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class PropertyField"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Workflow::PropertyField"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"PropertyField"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1PropertyField"},"children":[{"type":"text","text":"PropertyField"}]}]},{"type":"text","text":"\n "}]}` --> @@ -757,7 +757,7 @@ Add operator to workflow. **Parameters**: -* Operator & **op**: [in] [Operator](classansys-dpf-operator.md#classansys-dpf-operator) to add. +* [Operator](classansys-dpf-operator.md#classansys-dpf-operator) & **op**: [in] [Operator](classansys-dpf-operator.md#classansys-dpf-operator) to add. **Return type**: void @@ -967,7 +967,7 @@ Add an input name to given pin of operator. * std::string const & **pin_name**: [in] Pin name. * int **operator_input_pin**: [in] Input pin. -* Operator & **op**: [in] [Operator](classansys-dpf-operator.md#classansys-dpf-operator) to which to add pin name. +* [Operator](classansys-dpf-operator.md#classansys-dpf-operator) & **op**: [in] [Operator](classansys-dpf-operator.md#classansys-dpf-operator) to which to add pin name. **Return type**: void @@ -996,7 +996,7 @@ Add an output name to given pin of operator. **Parameters**: -* Operator & **op**: [in] [Operator](classansys-dpf-operator.md#classansys-dpf-operator) to which to add pin name. +* [Operator](classansys-dpf-operator.md#classansys-dpf-operator) & **op**: [in] [Operator](classansys-dpf-operator.md#classansys-dpf-operator) to which to add pin name. * int **operator_output_pin**: [in] Output pin. * std::string const & **pin_name**: [in] Pin name. @@ -1500,7 +1500,7 @@ First operator in workflow chain. -**Return type**: Operator +**Return type**: [Operator](classansys-dpf-operator.md#classansys-dpf-operator) - + ### Function WorkflowStep ![][public] ```cpp -ansys::dpf::WorkflowStep::WorkflowStep(const std::vector< int > &ids) +ansys::dpf::WorkflowStep::WorkflowStep(const std::vector< int > &ids, int cachePriority=0) ``` @@ -64,6 +65,7 @@ ansys::dpf::WorkflowStep::WorkflowStep(const std::vector< int > &ids) **Parameters**: * const std::vector< int > & **ids** +* int **cachePriority** = 0 **Return type**: @@ -125,6 +127,32 @@ std::vector< int > ansys::dpf::WorkflowStep::getOperatorIds() const * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::WorkflowStep::getOperatorIds"}]}` --> + +### Function cachePriority + +![][public] +![][const] + + +```cpp +int ansys::dpf::WorkflowStep::cachePriority() const +``` + + + + + + + + +**Return type**: int + + + ### Function get diff --git a/2027R1/dpf-cpp-27-r1/api-reference/classes.md b/2027R1/dpf-cpp-27-r1/api-reference/classes.md index a64f27abc..9001d02c2 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/classes.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/classes.md @@ -138,6 +138,7 @@ List of Classes: - [ansys::dpf::reflect< short >](structansys-dpf-reflect-short.md) - [ansys::dpf::reflect< size_t >](structansys-dpf-reflect-size-t.md) - [ansys::dpf::reflect< unsigned int >](structansys-dpf-reflect-unsigned-int.md) +- [ansys::dpf::reflect< unsigned short >](structansys-dpf-reflect-unsigned-short.md) - [ansys::dpf::reflect< wchar_t >](structansys-dpf-reflect-wchar-t.md) - [ansys::dpf::spec](structansys-dpf-spec.md) - [ansys::dpf::spec::category](structansys-dpf-spec-category.md) diff --git a/2027R1/dpf-cpp-27-r1/api-reference/deprecated.md b/2027R1/dpf-cpp-27-r1/api-reference/deprecated.md index b3e8f036c..fc2f38164 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/deprecated.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/deprecated.md @@ -10,7 +10,7 @@ use eFilterResults pin instead -Member [ansys::dpf::LibraryHandle::LibraryHandle](classansys-dpf-libraryhandle.md#classansys-dpf-libraryhandle-1a0651cd01e74e2cb90f320435bc7fc87a) (std::string const &key, std::string const &shared_object_root_name, [ApiType](namespaceansys-dpf.md#namespaceansys-dpf-1a318ab16f856ec8d2ef6e13af94a6dc56) api_type, [LoadType](namespaceansys-dpf.md#namespaceansys-dpf-1ac4f1380f00170887891b5cf54d8c94b3) load_type=[LoadType::try_load](namespaceansys-dpf.md#namespaceansys-dpf-1ac4f1380f00170887891b5cf54d8c94b3a6d450e9598ea0dffeaff74fbcccb116f), std::string const &dpf_client_api="DPFClientAPI"): +Member [ansys::dpf::LibraryHandle::LibraryHandle](classansys-dpf-libraryhandle.md#classansys-dpf-libraryhandle-1a0651cd01e74e2cb90f320435bc7fc87a) (std::string const &key, std::string const &shared_object_root_name, ApiType api_type, LoadType load_type=[LoadType::try_load](namespaceansys-dpf.md#namespaceansys-dpf-1ac4f1380f00170887891b5cf54d8c94b3a6d450e9598ea0dffeaff74fbcccb116f), std::string const &dpf_client_api="DPFClientAPI"): This call is deprecated. usage is not maintained. diff --git a/2027R1/dpf-cpp-27-r1/api-reference/dir-dd83be0cfbcc27aa9f.md b/2027R1/dpf-cpp-27-r1/api-reference/dir-dd83be0cfbcc27aa9f.md index 1538e22a9..abed68f14 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/dir-dd83be0cfbcc27aa9f.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/dir-dd83be0cfbcc27aa9f.md @@ -1,4 +1,4 @@ -# Directory D:/ANSYSDev/Sandbox/DPF/Ans.Dpf.Hgp +# Directory E:/ANSYSDev/TFSAgent/_work/38/s/DPF/Ans.Dpf.Hgp @@ -8,7 +8,7 @@ ## Subdirectories -* [D:/ANSYSDev/Sandbox/DPF/Ans.Dpf.Hgp/helpers](dir-fca9ddd4acaabdc476476.md#dir-fca9ddd4acaabdc476476) +* [E:/ANSYSDev/TFSAgent/_work/38/s/DPF/Ans.Dpf.Hgp/helpers](dir-fca9ddd4acaabdc476476.md#dir-fca9ddd4acaabdc476476) ## Files diff --git a/2027R1/dpf-cpp-27-r1/api-reference/dir-fca9ddd4acaabdc476476.md b/2027R1/dpf-cpp-27-r1/api-reference/dir-fca9ddd4acaabdc476476.md index 19eee58fc..8c3a036d7 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/dir-fca9ddd4acaabdc476476.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/dir-fca9ddd4acaabdc476476.md @@ -1,4 +1,4 @@ -# Directory D:/ANSYSDev/Sandbox/DPF/Ans.Dpf.Hgp/helpers +# Directory E:/ANSYSDev/TFSAgent/_work/38/s/DPF/Ans.Dpf.Hgp/helpers diff --git a/2027R1/dpf-cpp-27-r1/api-reference/dpf-api-base-h.md b/2027R1/dpf-cpp-27-r1/api-reference/dpf-api-base-h.md index 89ff9a3fc..9ad4525e9 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/dpf-api-base-h.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/dpf-api-base-h.md @@ -56,6 +56,7 @@ * [ansys::dpf::reflect\< float \>](structansys-dpf-reflect-float.md#structansys-dpf-reflect-float-4) * [ansys::dpf::reflect\< unsigned int \>](structansys-dpf-reflect-unsigned-int.md#structansys-dpf-reflect-unsigned-int-4) * [ansys::dpf::reflect\< short \>](structansys-dpf-reflect-short.md#structansys-dpf-reflect-short-4) +* [ansys::dpf::reflect\< unsigned short \>](structansys-dpf-reflect-unsigned-short.md#structansys-dpf-reflect-unsigned-short-4) * [ansys::dpf::reflect\< int8_t \>](structansys-dpf-reflect-int8-t.md#structansys-dpf-reflect-int8-t-4) ## Namespaces @@ -117,6 +118,19 @@ click 1 "dpf__api__base_8h.md#dpf__api__base_8h" * [dpf/include/dpf_api.h](dpf-api-h.md#dpf-api-h) +## Macros + + +### Macro DPF_HAVE_STD_SPAN + +![][public] + +```cpp +#define DPF_HAVE_STD_SPAN (__cplusplus >= 202002L) +``` + +When set to 1, DPF_HAVE_STD_SPAN will add additional functions returning std::span in addition to raw pointer APIs By default this is enabled with C++20 and later, and disabled in previous versions. + [C++]: https://img.shields.io/badge/language-C%2B%2B-blue (C++) [const]: https://img.shields.io/badge/-const-lightblue (const) [public]: https://img.shields.io/badge/-public-brightgreen (public) diff --git a/2027R1/dpf-cpp-27-r1/api-reference/namespaceansys-dpf.md b/2027R1/dpf-cpp-27-r1/api-reference/namespaceansys-dpf.md index 7ecc9793f..be31685e9 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/namespaceansys-dpf.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/namespaceansys-dpf.md @@ -10,132 +10,133 @@ This namespace encapsulates all of the HGP functionality. ## Classes -* [ansys::dpf::Model](classansys-dpf-model.md#classansys-dpf-model) -* [ansys::dpf::Result](classansys-dpf-result.md#classansys-dpf-result) -* [ansys::dpf::MeshQuery](classansys-dpf-meshquery.md#classansys-dpf-meshquery) -* [ansys::dpf::Collection](classansys-dpf-collection.md#classansys-dpf-collection) -* [ansys::dpf::ExternalData](classansys-dpf-externaldata.md#classansys-dpf-externaldata) -* [ansys::dpf::ExternalDataT](classansys-dpf-externaldatat.md#classansys-dpf-externaldatat) +* [ansys::dpf::Any](classansys-dpf-any.md#classansys-dpf-any) * [ansys::dpf::array_to_pointer_decay](structansys-dpf-array-to-pointer-decay.md#structansys-dpf-array-to-pointer-decay) * [ansys::dpf::array_to_pointer_decay\< T[N]\>](structansys-dpf-array-to-pointer-decay-t-fn-e.md#structansys-dpf-array-to-pointer-decay-t-fn-e-4) +* [ansys::dpf::CacheInformation](classansys-dpf-cacheinformation.md#classansys-dpf-cacheinformation) +* [ansys::dpf::Changelog](classansys-dpf-changelog.md#classansys-dpf-changelog) +* [ansys::dpf::Client](classansys-dpf-client.md#classansys-dpf-client) +* [ansys::dpf::Collection](classansys-dpf-collection.md#classansys-dpf-collection) +* [ansys::dpf::CollectionBase](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase) +* [ansys::dpf::ConfigOptionSpecification](structansys-dpf-configoptionspecification.md#structansys-dpf-configoptionspecification) * [ansys::dpf::ConstructHelpers](structansys-dpf-constructhelpers.md#structansys-dpf-constructhelpers) -* [ansys::dpf::SemanticVersion](classansys-dpf-semanticversion.md#classansys-dpf-semanticversion) -* [ansys::dpf::Any](classansys-dpf-any.md#classansys-dpf-any) -* [ansys::dpf::Unit](classansys-dpf-unit.md#classansys-dpf-unit) -* [ansys::dpf::ResultInfo](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo) -* [ansys::dpf::FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition) -* [ansys::dpf::LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) -* [ansys::dpf::Scoping](classansys-dpf-scoping.md#classansys-dpf-scoping) -* [ansys::dpf::ElementCursor](classansys-dpf-elementcursor.md#classansys-dpf-elementcursor) -* [ansys::dpf::Support](classansys-dpf-support.md#classansys-dpf-support) -* [ansys::dpf::MeshedRegion](classansys-dpf-meshedregion.md#classansys-dpf-meshedregion) -* [ansys::dpf::TimeFreqSupport](classansys-dpf-timefreqsupport.md#classansys-dpf-timefreqsupport) -* [ansys::dpf::CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport) -* [ansys::dpf::GenericSupport](classansys-dpf-genericsupport.md#classansys-dpf-genericsupport) -* [ansys::dpf::DataTree](classansys-dpf-datatree.md#classansys-dpf-datatree) +* [ansys::dpf::Context](classansys-dpf-context.md#classansys-dpf-context) +* [ansys::dpf::core](classansys-dpf-core.md#classansys-dpf-core) +* [ansys::dpf::CustomContainerBase](classansys-dpf-customcontainerbase.md#classansys-dpf-customcontainerbase) * [ansys::dpf::CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield) -* [ansys::dpf::FieldCursor](classansys-dpf-fieldcursor.md#classansys-dpf-fieldcursor) -* [ansys::dpf::Field](classansys-dpf-field.md#classansys-dpf-field) -* [ansys::dpf::PropFieldCursor](classansys-dpf-propfieldcursor.md#classansys-dpf-propfieldcursor) -* [ansys::dpf::PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) -* [ansys::dpf::StringField](classansys-dpf-stringfield.md#classansys-dpf-stringfield) -* [ansys::dpf::CollectionBase](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase) -* [ansys::dpf::FieldsContainer](classansys-dpf-fieldscontainer.md#classansys-dpf-fieldscontainer) -* [ansys::dpf::ScopingsContainer](classansys-dpf-scopingscontainer.md#classansys-dpf-scopingscontainer) -* [ansys::dpf::MeshesContainer](classansys-dpf-meshescontainer.md#classansys-dpf-meshescontainer) * [ansys::dpf::CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer) +* [ansys::dpf::CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport) * [ansys::dpf::DataSources](classansys-dpf-datasources.md#classansys-dpf-datasources) +* [ansys::dpf::DataTree](classansys-dpf-datatree.md#classansys-dpf-datatree) +* [ansys::dpf::dimensionalities](structansys-dpf-dimensionalities.md#structansys-dpf-dimensionalities) +* [ansys::dpf::Dimensionality](structansys-dpf-dimensionality.md#structansys-dpf-dimensionality) +* [ansys::dpf::DpfError](classansys-dpf-dpferror.md#classansys-dpf-dpferror) +* [ansys::dpf::DpfException](classansys-dpf-dpfexception.md#classansys-dpf-dpfexception) +* [ansys::dpf::DpfTypes](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes) +* [ansys::dpf::DpfVector](classansys-dpf-dpfvector.md#classansys-dpf-dpfvector) +* [ansys::dpf::DpfVectorData](classansys-dpf-dpfvectordata.md#classansys-dpf-dpfvectordata) +* [ansys::dpf::DpfVectorDataHelper](structansys-dpf-dpfvectordatahelper.md#structansys-dpf-dpfvectordatahelper) +* [ansys::dpf::ElementCursor](classansys-dpf-elementcursor.md#classansys-dpf-elementcursor) +* [ansys::dpf::ElementDescriptor](structansys-dpf-elementdescriptor.md#structansys-dpf-elementdescriptor) +* [ansys::dpf::elements](structansys-dpf-elements.md#structansys-dpf-elements) +* [ansys::dpf::EventHandler](classansys-dpf-eventhandler.md#classansys-dpf-eventhandler) +* [ansys::dpf::ExternalData](classansys-dpf-externaldata.md#classansys-dpf-externaldata) +* [ansys::dpf::ExternalDataT](classansys-dpf-externaldatat.md#classansys-dpf-externaldatat) * [ansys::dpf::ExternalStream](classansys-dpf-externalstream.md#classansys-dpf-externalstream) -* [ansys::dpf::Streams](classansys-dpf-streams.md#classansys-dpf-streams) +* [ansys::dpf::Field](classansys-dpf-field.md#classansys-dpf-field) +* [ansys::dpf::FieldCursor](classansys-dpf-fieldcursor.md#classansys-dpf-fieldcursor) +* [ansys::dpf::FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition) +* [ansys::dpf::FieldsContainer](classansys-dpf-fieldscontainer.md#classansys-dpf-fieldscontainer) * [ansys::dpf::GenericDataContainer](classansys-dpf-genericdatacontainer.md#classansys-dpf-genericdatacontainer) +* [ansys::dpf::GenericSupport](classansys-dpf-genericsupport.md#classansys-dpf-genericsupport) +* [ansys::dpf::homogeneities](structansys-dpf-homogeneities.md#structansys-dpf-homogeneities) +* [ansys::dpf::Homogeneity](classansys-dpf-homogeneity.md#classansys-dpf-homogeneity) +* [ansys::dpf::Interface](classansys-dpf-interface.md#classansys-dpf-interface) +* [ansys::dpf::Label](structansys-dpf-label.md#structansys-dpf-label) +* [ansys::dpf::labels](structansys-dpf-labels.md#structansys-dpf-labels) +* [ansys::dpf::LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) +* [ansys::dpf::LibraryHandle](classansys-dpf-libraryhandle.md#classansys-dpf-libraryhandle) +* [ansys::dpf::LibraryHolder](classansys-dpf-libraryholder.md#classansys-dpf-libraryholder) +* [ansys::dpf::LicenseContextManager](classansys-dpf-licensecontextmanager.md#classansys-dpf-licensecontextmanager) +* [ansys::dpf::Location](structansys-dpf-location.md#structansys-dpf-location) +* [ansys::dpf::locations](structansys-dpf-locations.md#structansys-dpf-locations) +* [ansys::dpf::Mapping](classansys-dpf-mapping.md#classansys-dpf-mapping) +* [ansys::dpf::MeshedRegion](classansys-dpf-meshedregion.md#classansys-dpf-meshedregion) +* [ansys::dpf::MeshesContainer](classansys-dpf-meshescontainer.md#classansys-dpf-meshescontainer) +* [ansys::dpf::MeshInfo](classansys-dpf-meshinfo.md#classansys-dpf-meshinfo) +* [ansys::dpf::MeshQuery](classansys-dpf-meshquery.md#classansys-dpf-meshquery) +* [ansys::dpf::Model](classansys-dpf-model.md#classansys-dpf-model) * [ansys::dpf::Operator](classansys-dpf-operator.md#classansys-dpf-operator) -* [ansys::dpf::CacheInformation](classansys-dpf-cacheinformation.md#classansys-dpf-cacheinformation) -* [ansys::dpf::Workflow](classansys-dpf-workflow.md#classansys-dpf-workflow) * [ansys::dpf::OperatorConfig](classansys-dpf-operatorconfig.md#classansys-dpf-operatorconfig) -* [ansys::dpf::CustomContainerBase](classansys-dpf-customcontainerbase.md#classansys-dpf-customcontainerbase) -* [ansys::dpf::MeshInfo](classansys-dpf-meshinfo.md#classansys-dpf-meshinfo) -* [ansys::dpf::Mapping](classansys-dpf-mapping.md#classansys-dpf-mapping) -* [ansys::dpf::Interface](classansys-dpf-interface.md#classansys-dpf-interface) -* [ansys::dpf::WorkflowStep](classansys-dpf-workflowstep.md#classansys-dpf-workflowstep) -* [ansys::dpf::OperatorMain](classansys-dpf-operatormain.md#classansys-dpf-operatormain) * [ansys::dpf::OperatorDerivativeMain](classansys-dpf-operatorderivativemain.md#classansys-dpf-operatorderivativemain) -* [ansys::dpf::PinDefinition](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition) -* [ansys::dpf::ConfigOptionSpecification](structansys-dpf-configoptionspecification.md#structansys-dpf-configoptionspecification) +* [ansys::dpf::OperatorMain](classansys-dpf-operatormain.md#classansys-dpf-operatormain) * [ansys::dpf::OperatorSpecification](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification) -* [ansys::dpf::RemoteOperator](classansys-dpf-remoteoperator.md#classansys-dpf-remoteoperator) -* [ansys::dpf::RemoteWorkflow](classansys-dpf-remoteworkflow.md#classansys-dpf-remoteworkflow) -* [ansys::dpf::EventHandler](classansys-dpf-eventhandler.md#classansys-dpf-eventhandler) -* [ansys::dpf::Session](classansys-dpf-session.md#classansys-dpf-session) -* [ansys::dpf::RuntimeConfig](classansys-dpf-runtimeconfig.md#classansys-dpf-runtimeconfig) -* [ansys::dpf::RuntimeCoreConfig](classansys-dpf-runtimecoreconfig.md#classansys-dpf-runtimecoreconfig) -* [ansys::dpf::RuntimeClientConfig](classansys-dpf-runtimeclientconfig.md#classansys-dpf-runtimeclientconfig) -* [ansys::dpf::Changelog](classansys-dpf-changelog.md#classansys-dpf-changelog) -* [ansys::dpf::core](classansys-dpf-core.md#classansys-dpf-core) +* [ansys::dpf::param_helpers](structansys-dpf-param-helpers.md#structansys-dpf-param-helpers) +* [ansys::dpf::PinDefinition](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition) +* [ansys::dpf::property_types](structansys-dpf-property-types.md#structansys-dpf-property-types) +* [ansys::dpf::PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) +* [ansys::dpf::PropertyType](structansys-dpf-propertytype.md#structansys-dpf-propertytype) +* [ansys::dpf::PropFieldCursor](classansys-dpf-propfieldcursor.md#classansys-dpf-propfieldcursor) +* [ansys::dpf::quantity_types](structansys-dpf-quantity-types.md#structansys-dpf-quantity-types) +* [ansys::dpf::QuantityType](structansys-dpf-quantitytype.md#structansys-dpf-quantitytype) +* [ansys::dpf::reflect](structansys-dpf-reflect.md#structansys-dpf-reflect) +* [ansys::dpf::reflect\< bool \>](structansys-dpf-reflect-bool.md#structansys-dpf-reflect-bool-4) +* [ansys::dpf::reflect\< char \>](structansys-dpf-reflect-char.md#structansys-dpf-reflect-char-4) +* [ansys::dpf::reflect\< CustomTypeField \>](structansys-dpf-reflect-customtypefield.md#structansys-dpf-reflect-customtypefield-4) +* [ansys::dpf::reflect\< CustomTypeFieldsContainer \>](structansys-dpf-reflect-customtypefieldscontainer.md#structansys-dpf-reflect-customtypefieldscontainer-4) +* [ansys::dpf::reflect\< DataSources \>](structansys-dpf-reflect-datasources.md#structansys-dpf-reflect-datasources-4) +* [ansys::dpf::reflect\< DataTree \>](structansys-dpf-reflect-datatree.md#structansys-dpf-reflect-datatree-4) +* [ansys::dpf::reflect\< double \>](structansys-dpf-reflect-double.md#structansys-dpf-reflect-double-4) * [ansys::dpf::reflect\< Field \>](structansys-dpf-reflect-field.md#structansys-dpf-reflect-field-4) * [ansys::dpf::reflect\< FieldsContainer \>](structansys-dpf-reflect-fieldscontainer.md#structansys-dpf-reflect-fieldscontainer-4) +* [ansys::dpf::reflect\< float \>](structansys-dpf-reflect-float.md#structansys-dpf-reflect-float-4) +* [ansys::dpf::reflect\< GenericDataContainer \>](structansys-dpf-reflect-genericdatacontainer.md#structansys-dpf-reflect-genericdatacontainer-4) +* [ansys::dpf::reflect\< int \>](structansys-dpf-reflect-int.md#structansys-dpf-reflect-int-4) +* [ansys::dpf::reflect\< int64_t \>](structansys-dpf-reflect-int64-t.md#structansys-dpf-reflect-int64-t-4) +* [ansys::dpf::reflect\< int8_t \>](structansys-dpf-reflect-int8-t.md#structansys-dpf-reflect-int8-t-4) +* [ansys::dpf::reflect\< LabelSpace \>](structansys-dpf-reflect-labelspace.md#structansys-dpf-reflect-labelspace-4) * [ansys::dpf::reflect\< MeshedRegion \>](structansys-dpf-reflect-meshedregion.md#structansys-dpf-reflect-meshedregion-4) -* [ansys::dpf::reflect\< DataSources \>](structansys-dpf-reflect-datasources.md#structansys-dpf-reflect-datasources-4) -* [ansys::dpf::reflect\< Streams \>](structansys-dpf-reflect-streams.md#structansys-dpf-reflect-streams-4) -* [ansys::dpf::reflect\< Scoping \>](structansys-dpf-reflect-scoping.md#structansys-dpf-reflect-scoping-4) -* [ansys::dpf::reflect\< ScopingsContainer \>](structansys-dpf-reflect-scopingscontainer.md#structansys-dpf-reflect-scopingscontainer-4) * [ansys::dpf::reflect\< MeshesContainer \>](structansys-dpf-reflect-meshescontainer.md#structansys-dpf-reflect-meshescontainer-4) -* [ansys::dpf::reflect\< PropertyField \>](structansys-dpf-reflect-propertyfield.md#structansys-dpf-reflect-propertyfield-4) -* [ansys::dpf::reflect\< ResultInfo \>](structansys-dpf-reflect-resultinfo.md#structansys-dpf-reflect-resultinfo-4) -* [ansys::dpf::reflect\< TimeFreqSupport \>](structansys-dpf-reflect-timefreqsupport.md#structansys-dpf-reflect-timefreqsupport-4) -* [ansys::dpf::reflect\< DataTree \>](structansys-dpf-reflect-datatree.md#structansys-dpf-reflect-datatree-4) -* [ansys::dpf::reflect\< Workflow \>](structansys-dpf-reflect-workflow.md#structansys-dpf-reflect-workflow-4) * [ansys::dpf::reflect\< Operator \>](structansys-dpf-reflect-operator.md#structansys-dpf-reflect-operator-4) +* [ansys::dpf::reflect\< PropertyField \>](structansys-dpf-reflect-propertyfield.md#structansys-dpf-reflect-propertyfield-4) * [ansys::dpf::reflect\< RemoteOperator \>](structansys-dpf-reflect-remoteoperator.md#structansys-dpf-reflect-remoteoperator-4) * [ansys::dpf::reflect\< RemoteWorkflow \>](structansys-dpf-reflect-remoteworkflow.md#structansys-dpf-reflect-remoteworkflow-4) +* [ansys::dpf::reflect\< ResultInfo \>](structansys-dpf-reflect-resultinfo.md#structansys-dpf-reflect-resultinfo-4) +* [ansys::dpf::reflect\< Scoping \>](structansys-dpf-reflect-scoping.md#structansys-dpf-reflect-scoping-4) +* [ansys::dpf::reflect\< ScopingsContainer \>](structansys-dpf-reflect-scopingscontainer.md#structansys-dpf-reflect-scopingscontainer-4) +* [ansys::dpf::reflect\< short \>](structansys-dpf-reflect-short.md#structansys-dpf-reflect-short-4) +* [ansys::dpf::reflect\< size_t \>](structansys-dpf-reflect-size-t.md#structansys-dpf-reflect-size-t-4) +* [ansys::dpf::reflect\< Streams \>](structansys-dpf-reflect-streams.md#structansys-dpf-reflect-streams-4) * [ansys::dpf::reflect\< StringField \>](structansys-dpf-reflect-stringfield.md#structansys-dpf-reflect-stringfield-4) -* [ansys::dpf::reflect\< CustomTypeField \>](structansys-dpf-reflect-customtypefield.md#structansys-dpf-reflect-customtypefield-4) -* [ansys::dpf::reflect\< LabelSpace \>](structansys-dpf-reflect-labelspace.md#structansys-dpf-reflect-labelspace-4) -* [ansys::dpf::reflect\< GenericDataContainer \>](structansys-dpf-reflect-genericdatacontainer.md#structansys-dpf-reflect-genericdatacontainer-4) -* [ansys::dpf::reflect\< CustomTypeFieldsContainer \>](structansys-dpf-reflect-customtypefieldscontainer.md#structansys-dpf-reflect-customtypefieldscontainer-4) -* [ansys::dpf::LicenseContextManager](classansys-dpf-licensecontextmanager.md#classansys-dpf-licensecontextmanager) -* [ansys::dpf::reflect](structansys-dpf-reflect.md#structansys-dpf-reflect) -* [ansys::dpf::param_helpers](structansys-dpf-param-helpers.md#structansys-dpf-param-helpers) -* [ansys::dpf::QuantityType](structansys-dpf-quantitytype.md#structansys-dpf-quantitytype) -* [ansys::dpf::quantity_types](structansys-dpf-quantity-types.md#structansys-dpf-quantity-types) -* [ansys::dpf::Location](structansys-dpf-location.md#structansys-dpf-location) -* [ansys::dpf::locations](structansys-dpf-locations.md#structansys-dpf-locations) -* [ansys::dpf::PropertyType](structansys-dpf-propertytype.md#structansys-dpf-propertytype) -* [ansys::dpf::property_types](structansys-dpf-property-types.md#structansys-dpf-property-types) -* [ansys::dpf::Homogeneity](classansys-dpf-homogeneity.md#classansys-dpf-homogeneity) -* [ansys::dpf::homogeneities](structansys-dpf-homogeneities.md#structansys-dpf-homogeneities) -* [ansys::dpf::UnitSystem](structansys-dpf-unitsystem.md#structansys-dpf-unitsystem) -* [ansys::dpf::unit_systems](structansys-dpf-unit-systems.md#structansys-dpf-unit-systems) -* [ansys::dpf::Label](structansys-dpf-label.md#structansys-dpf-label) -* [ansys::dpf::labels](structansys-dpf-labels.md#structansys-dpf-labels) +* [ansys::dpf::reflect\< TimeFreqSupport \>](structansys-dpf-reflect-timefreqsupport.md#structansys-dpf-reflect-timefreqsupport-4) +* [ansys::dpf::reflect\< unsigned int \>](structansys-dpf-reflect-unsigned-int.md#structansys-dpf-reflect-unsigned-int-4) +* [ansys::dpf::reflect\< unsigned short \>](structansys-dpf-reflect-unsigned-short.md#structansys-dpf-reflect-unsigned-short-4) +* [ansys::dpf::reflect\< wchar_t \>](structansys-dpf-reflect-wchar-t.md#structansys-dpf-reflect-wchar-t-4) +* [ansys::dpf::reflect\< Workflow \>](structansys-dpf-reflect-workflow.md#structansys-dpf-reflect-workflow-4) +* [ansys::dpf::RemoteOperator](classansys-dpf-remoteoperator.md#classansys-dpf-remoteoperator) +* [ansys::dpf::RemoteWorkflow](classansys-dpf-remoteworkflow.md#classansys-dpf-remoteworkflow) +* [ansys::dpf::Result](classansys-dpf-result.md#classansys-dpf-result) +* [ansys::dpf::ResultInfo](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo) +* [ansys::dpf::RuntimeClientConfig](classansys-dpf-runtimeclientconfig.md#classansys-dpf-runtimeclientconfig) +* [ansys::dpf::RuntimeConfig](classansys-dpf-runtimeconfig.md#classansys-dpf-runtimeconfig) +* [ansys::dpf::RuntimeCoreConfig](classansys-dpf-runtimecoreconfig.md#classansys-dpf-runtimecoreconfig) +* [ansys::dpf::Scoping](classansys-dpf-scoping.md#classansys-dpf-scoping) +* [ansys::dpf::ScopingsContainer](classansys-dpf-scopingscontainer.md#classansys-dpf-scopingscontainer) +* [ansys::dpf::SemanticVersion](classansys-dpf-semanticversion.md#classansys-dpf-semanticversion) +* [ansys::dpf::Session](classansys-dpf-session.md#classansys-dpf-session) * [ansys::dpf::ShellDescriptor](structansys-dpf-shelldescriptor.md#structansys-dpf-shelldescriptor) -* [ansys::dpf::ElementDescriptor](structansys-dpf-elementdescriptor.md#structansys-dpf-elementdescriptor) -* [ansys::dpf::elements](structansys-dpf-elements.md#structansys-dpf-elements) +* [ansys::dpf::spec](structansys-dpf-spec.md#structansys-dpf-spec) +* [ansys::dpf::Streams](classansys-dpf-streams.md#classansys-dpf-streams) +* [ansys::dpf::StringField](classansys-dpf-stringfield.md#classansys-dpf-stringfield) +* [ansys::dpf::Support](classansys-dpf-support.md#classansys-dpf-support) +* [ansys::dpf::TimeFreqSupport](classansys-dpf-timefreqsupport.md#classansys-dpf-timefreqsupport) * [ansys::dpf::TypeDescriptor](structansys-dpf-typedescriptor.md#structansys-dpf-typedescriptor) * [ansys::dpf::types](structansys-dpf-types.md#structansys-dpf-types) -* [ansys::dpf::Dimensionality](structansys-dpf-dimensionality.md#structansys-dpf-dimensionality) -* [ansys::dpf::dimensionalities](structansys-dpf-dimensionalities.md#structansys-dpf-dimensionalities) -* [ansys::dpf::spec](structansys-dpf-spec.md#structansys-dpf-spec) -* [ansys::dpf::DpfTypes](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes) -* [ansys::dpf::Client](classansys-dpf-client.md#classansys-dpf-client) -* [ansys::dpf::DpfError](classansys-dpf-dpferror.md#classansys-dpf-dpferror) -* [ansys::dpf::DpfException](classansys-dpf-dpfexception.md#classansys-dpf-dpfexception) -* [ansys::dpf::DpfVectorDataHelper](structansys-dpf-dpfvectordatahelper.md#structansys-dpf-dpfvectordatahelper) -* [ansys::dpf::DpfVectorData](classansys-dpf-dpfvectordata.md#classansys-dpf-dpfvectordata) -* [ansys::dpf::DpfVector](classansys-dpf-dpfvector.md#classansys-dpf-dpfvector) -* [ansys::dpf::Context](classansys-dpf-context.md#classansys-dpf-context) -* [ansys::dpf::LibraryHandle](classansys-dpf-libraryhandle.md#classansys-dpf-libraryhandle) -* [ansys::dpf::LibraryHolder](classansys-dpf-libraryholder.md#classansys-dpf-libraryholder) -* [ansys::dpf::reflect\< int \>](structansys-dpf-reflect-int.md#structansys-dpf-reflect-int-4) -* [ansys::dpf::reflect\< double \>](structansys-dpf-reflect-double.md#structansys-dpf-reflect-double-4) -* [ansys::dpf::reflect\< bool \>](structansys-dpf-reflect-bool.md#structansys-dpf-reflect-bool-4) -* [ansys::dpf::reflect\< size_t \>](structansys-dpf-reflect-size-t.md#structansys-dpf-reflect-size-t-4) -* [ansys::dpf::reflect\< int64_t \>](structansys-dpf-reflect-int64-t.md#structansys-dpf-reflect-int64-t-4) -* [ansys::dpf::reflect\< char \>](structansys-dpf-reflect-char.md#structansys-dpf-reflect-char-4) -* [ansys::dpf::reflect\< wchar_t \>](structansys-dpf-reflect-wchar-t.md#structansys-dpf-reflect-wchar-t-4) -* [ansys::dpf::reflect\< float \>](structansys-dpf-reflect-float.md#structansys-dpf-reflect-float-4) -* [ansys::dpf::reflect\< unsigned int \>](structansys-dpf-reflect-unsigned-int.md#structansys-dpf-reflect-unsigned-int-4) -* [ansys::dpf::reflect\< short \>](structansys-dpf-reflect-short.md#structansys-dpf-reflect-short-4) -* [ansys::dpf::reflect\< int8_t \>](structansys-dpf-reflect-int8-t.md#structansys-dpf-reflect-int8-t-4) +* [ansys::dpf::Unit](classansys-dpf-unit.md#classansys-dpf-unit) +* [ansys::dpf::unit_systems](structansys-dpf-unit-systems.md#structansys-dpf-unit-systems) +* [ansys::dpf::UnitSystem](structansys-dpf-unitsystem.md#structansys-dpf-unitsystem) +* [ansys::dpf::Workflow](classansys-dpf-workflow.md#classansys-dpf-workflow) +* [ansys::dpf::WorkflowStep](classansys-dpf-workflowstep.md#classansys-dpf-workflowstep) ## Enumeration types @@ -514,7 +515,7 @@ Bottom shell layer -Both Top and Bottom shell layer +Both Top and Bottom shell layer. Order of results: 1.Bottom Shell Layer results. 2.Top Shell Layer results #### Enumerator eMid @@ -528,7 +529,7 @@ Middle shell layer -All shell layers +All shell layers. Order of results: 1.Bottom Shell Layer results. 2.Top Shell Layer results. 3.Mid Shell Layer results #### Enumerator eNoneLayer @@ -902,14 +903,14 @@ typedef void(* ansys::dpf::OperatorDerivateFunction) (OperatorDerivativeMain &) * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::OperatorDerivateFunction"}]}` --> - + ### Typedef FbsClient ![][public] ```cpp -using ansys::dpf::FbsClient = Any +using ansys::dpf::FbsClient = typedef Any ``` @@ -927,14 +928,14 @@ using ansys::dpf::FbsClient = Any * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::FbsClient"}]}` --> - + ### Typedef HasGenericDataContainerConstructor ![][public] ```cpp -using ansys::dpf::HasGenericDataContainerConstructor = std::is_constructible +using ansys::dpf::HasGenericDataContainerConstructor = typedef std::is_constructible ``` @@ -1139,7 +1140,7 @@ typedef UnitSystem ansys::dpf::UnitSytem ``` -using [UnitSytem](namespaceansys-dpf.md#namespaceansys-dpf-1aae1038d08681cf4311d36bd77661272c) = [UnitSystem](structansys-dpf-unitsystem.md#structansys-dpf-unitsystem); +using UnitSytem = [UnitSystem](structansys-dpf-unitsystem.md#structansys-dpf-unitsystem); diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-constructhelpers-construct-trait.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-constructhelpers-construct-trait.md index 4d61faaaf..3331e25d6 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-constructhelpers-construct-trait.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-constructhelpers-construct-trait.md @@ -12,7 +12,7 @@ traits specialized below to handle derived class of [CustomContainerBase](classa **Template parameters**: * typename DataT -* typename IsGDC = typename [HasGenericDataContainerConstructor](namespaceansys-dpf.md#namespaceansys-dpf-1acc01990faa84aba04f8d6534727dd204)::type +* typename IsGDC = typename [HasGenericDataContainerConstructor](namespaceansys-dpf.md#namespaceansys-dpf-1a5f3f18dc09482854dd40ed01d0d6e583)::type ## Members diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-context-internal.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-context-internal.md index cc14964f8..631ac6928 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-context-internal.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-context-internal.md @@ -36,7 +36,7 @@ static int ansys::dpf::Context::internal::getAPIVersion(Context const &context) **Parameters**: -* [Context](classansys-dpf-context.md#classansys-dpf-context-1ae26354fe1dea7b2691e115275704278b) const & **context** +* [Context](classansys-dpf-context.md#classansys-dpf-context) const & **context** **Return type**: int @@ -66,7 +66,7 @@ static DataTree ansys::dpf::Context::internal::contextToDataTree(Context const & **Parameters**: -* [Context](classansys-dpf-context.md#classansys-dpf-context-1ae26354fe1dea7b2691e115275704278b) const & **context** +* [Context](classansys-dpf-context.md#classansys-dpf-context) const & **context** * [Client](classansys-dpf-client.md#classansys-dpf-client) const *const **client** = nullptr **Return type**: [DataTree](classansys-dpf-datatree.md#classansys-dpf-datatree) diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-core-fbsserverdata.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-core-fbsserverdata.md index 7352a2f4a..cbc1aca4f 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-core-fbsserverdata.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-core-fbsserverdata.md @@ -33,7 +33,7 @@ FbsClient ansys::dpf::core::FbsServerData::server_holder -**Type**: FbsClient +**Type**: [FbsClient](classansys-dpf-any.md#classansys-dpf-any) diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-elementdescriptor.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-elementdescriptor.md index a6e262ce5..7a48aa5f0 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-elementdescriptor.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-elementdescriptor.md @@ -338,7 +338,7 @@ bool ansys::dpf::ElementDescriptor::operator==(ElementDescriptor const &rhs) con **Parameters**: -* [ElementDescriptor](structansys-dpf-elementdescriptor.md#structansys-dpf-elementdescriptor-1ab19bfe010b78317bd83e6d1d2b9b1ebf) const & **rhs** +* [ElementDescriptor](structansys-dpf-elementdescriptor.md#structansys-dpf-elementdescriptor) const & **rhs** **Return type**: bool diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-label.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-label.md index d3420f91e..66ae623ae 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-label.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-label.md @@ -71,7 +71,7 @@ ansys::dpf::Label::Label(Label const &)=default **Parameters**: -* Label const & +* [Label](structansys-dpf-label.md#structansys-dpf-label) const & **Return type**: @@ -101,7 +101,7 @@ bool ansys::dpf::Label::operator==(Label const &) const **Parameters**: -* [Label](structansys-dpf-label.md#structansys-dpf-label-1aa16652a3ceeda62dce2af07722a0ec80) const & +* [Label](structansys-dpf-label.md#structansys-dpf-label) const & **Return type**: bool @@ -131,7 +131,7 @@ bool ansys::dpf::Label::operator<(Label const &) const **Parameters**: -* [Label](structansys-dpf-label.md#structansys-dpf-label-1aa16652a3ceeda62dce2af07722a0ec80) const & +* [Label](structansys-dpf-label.md#structansys-dpf-label) const & **Return type**: bool @@ -161,7 +161,7 @@ bool ansys::dpf::Label::operator<=(Label const &) const **Parameters**: -* [Label](structansys-dpf-label.md#structansys-dpf-label-1aa16652a3ceeda62dce2af07722a0ec80) const & +* [Label](structansys-dpf-label.md#structansys-dpf-label) const & **Return type**: bool @@ -191,7 +191,7 @@ bool ansys::dpf::Label::operator!=(Label const &) const **Parameters**: -* [Label](structansys-dpf-label.md#structansys-dpf-label-1aa16652a3ceeda62dce2af07722a0ec80) const & +* [Label](structansys-dpf-label.md#structansys-dpf-label) const & **Return type**: bool diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-labels.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-labels.md index 90336e8ef..7a3510756 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-labels.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-labels.md @@ -19,6 +19,7 @@ Predefined labels. * [dofs](structansys-dpf-labels.md#structansys-dpf-labels-1ad2788c414a549ad634c56f272ecd0607) * [domain](structansys-dpf-labels.md#structansys-dpf-labels-1ae97916221f9fab4003318668faf26b87) * [ghost](structansys-dpf-labels.md#structansys-dpf-labels-1ac0403bfca2736100f8d4881f12b50ed9) +* [input_dof_index](structansys-dpf-labels.md#structansys-dpf-labels-1a92f62c0505698cea4cfff620c8e2838e) * [panel](structansys-dpf-labels.md#structansys-dpf-labels-1a6e29cda8e31c6c272d2ae30d3c2491ea) * [partition](structansys-dpf-labels.md#structansys-dpf-labels-1a57963c7165b37fb727a885b561171a86) * [phase](structansys-dpf-labels.md#structansys-dpf-labels-1a3536d0ec8b45d3388ddf47337fe0eca9) @@ -340,6 +341,32 @@ const Label ansys::dpf::labels::ghost * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::labels::ghost"}]}` --> + +### Variable input_dof_index + +![][public] +![][static] + + +```cpp +const Label ansys::dpf::labels::input_dof_index +``` + + + + +[Label](structansys-dpf-label.md#structansys-dpf-label) for input_dof_index. + + + +**Type**: const [Label](structansys-dpf-label.md#structansys-dpf-label) + + + [C++]: https://img.shields.io/badge/language-C%2B%2B-blue (C++) [const]: https://img.shields.io/badge/-const-lightblue (const) [public]: https://img.shields.io/badge/-public-brightgreen (public) diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-location.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-location.md index 403f134a6..3cefc6810 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-location.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-location.md @@ -72,7 +72,7 @@ ansys::dpf::Location::Location(Location const &)=default **Parameters**: -* Location const & +* [Location](structansys-dpf-location.md#structansys-dpf-location) const & **Return type**: @@ -102,7 +102,7 @@ bool ansys::dpf::Location::operator==(Location const &) const **Parameters**: -* [Location](structansys-dpf-location.md#structansys-dpf-location-1a2b3efab2807517d182bc9a486a0fb837) const & +* [Location](structansys-dpf-location.md#structansys-dpf-location) const & **Return type**: bool @@ -132,7 +132,7 @@ bool ansys::dpf::Location::operator<(Location const &) const **Parameters**: -* [Location](structansys-dpf-location.md#structansys-dpf-location-1a2b3efab2807517d182bc9a486a0fb837) const & +* [Location](structansys-dpf-location.md#structansys-dpf-location) const & **Return type**: bool @@ -162,7 +162,7 @@ bool ansys::dpf::Location::operator<=(Location const &) const **Parameters**: -* [Location](structansys-dpf-location.md#structansys-dpf-location-1a2b3efab2807517d182bc9a486a0fb837) const & +* [Location](structansys-dpf-location.md#structansys-dpf-location) const & **Return type**: bool @@ -192,7 +192,7 @@ bool ansys::dpf::Location::operator!=(Location const &) const **Parameters**: -* [Location](structansys-dpf-location.md#structansys-dpf-location-1a2b3efab2807517d182bc9a486a0fb837) const & +* [Location](structansys-dpf-location.md#structansys-dpf-location) const & **Return type**: bool diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-locations.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-locations.md index 7643061a6..8e1ed3973 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-locations.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-locations.md @@ -24,12 +24,14 @@ Results are evaluated at locations. * [elemental_nodal_centroid](structansys-dpf-locations.md#structansys-dpf-locations-1a5b54316cebce849e6a8489d19a990246) * [faces](structansys-dpf-locations.md#structansys-dpf-locations-1a111716841842157a978ebebdc9c503b6) * [harmonic_index](structansys-dpf-locations.md#structansys-dpf-locations-1a46ac72d7066346bc309dfb44de1a20cf) +* [input_dof_index](structansys-dpf-locations.md#structansys-dpf-locations-1aad4c73875803704a0e4c6dcc43a7fb51) * [joint](structansys-dpf-locations.md#structansys-dpf-locations-1a0a7d57a4476a34178090d4fa96f0c550) * [nodal](structansys-dpf-locations.md#structansys-dpf-locations-1aa4e1967b0838d8597200c606c8564d29) * [nodal_elemental](structansys-dpf-locations.md#structansys-dpf-locations-1aba56d24e91e52e4742ee5505dff04b94) * [overall](structansys-dpf-locations.md#structansys-dpf-locations-1ada5a62dea9a6a1bf156f90282a273959) * [phase](structansys-dpf-locations.md#structansys-dpf-locations-1abaf9f2158d14707096139ab5eb27d70d) * [species](structansys-dpf-locations.md#structansys-dpf-locations-1a76bdfc819d94d708b849281adf480677) +* [time](structansys-dpf-locations.md#structansys-dpf-locations-1af97eb8c6e2585662148a029e71591567) * [time_set](structansys-dpf-locations.md#structansys-dpf-locations-1a3cf1bbc2ad6d8b8f6173e83b5118031a) * [time_step](structansys-dpf-locations.md#structansys-dpf-locations-1abc48364ef6b184ddf696099c9a2993cd) * [topology](structansys-dpf-locations.md#structansys-dpf-locations-1a3049c32b1dc96441810bd53803916a58) @@ -429,6 +431,32 @@ Predefined time_set location. * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::locations::time_set"}]}` --> + +### Variable time + +![][public] +![][static] + + +```cpp +const Location ansys::dpf::locations::time +``` + + + + +Predefined time location. + + + +**Type**: const [Location](structansys-dpf-location.md#structansys-dpf-location) + + + ### Variable harmonic_index @@ -559,6 +587,32 @@ Predefined band location. * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::locations::band"}]}` --> + +### Variable input_dof_index + +![][public] +![][static] + + +```cpp +const Location ansys::dpf::locations::input_dof_index +``` + + + + +Predefined input_dof_index location. + + + +**Type**: const [Location](structansys-dpf-location.md#structansys-dpf-location) + + + ### Variable unknown diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-pindefinition.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-pindefinition.md index 2c8a9fca4..1f4cf8a92 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-pindefinition.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-pindefinition.md @@ -339,7 +339,7 @@ Pin definition. * std::string const & **n**: [in] Name of pin. -**Return type**: PinDefinition & +**Return type**: [PinDefinition](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition) & + +[C++]: https://img.shields.io/badge/language-C%2B%2B-blue (C++) +[const]: https://img.shields.io/badge/-const-lightblue (const) +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[static]: https://img.shields.io/badge/-static-lightgrey (static) \ No newline at end of file diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-spec.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-spec.md index 4bab43cf8..f6135fc3b 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-spec.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-spec.md @@ -11,10 +11,10 @@ Must be used while writing the specification of an operator. Use lower case for ## Inner classes -* [ansys::dpf::spec::exposure](structansys-dpf-spec-exposure.md#structansys-dpf-spec-exposure) * [ansys::dpf::spec::category](structansys-dpf-spec-category.md#structansys-dpf-spec-category) -* [ansys::dpf::spec::plugin](structansys-dpf-spec-plugin.md#structansys-dpf-spec-plugin) +* [ansys::dpf::spec::exposure](structansys-dpf-spec-exposure.md#structansys-dpf-spec-exposure) * [ansys::dpf::spec::license](structansys-dpf-spec-license.md#structansys-dpf-spec-license) +* [ansys::dpf::spec::plugin](structansys-dpf-spec-plugin.md#structansys-dpf-spec-plugin) ## Members diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-typedescriptor.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-typedescriptor.md index ff950e290..ddf88cf28 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-typedescriptor.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-typedescriptor.md @@ -45,7 +45,7 @@ Description of type. * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend struct types"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::TypeDescriptor::types"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"types"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"structansys_1_1dpf_1_1types"},"children":[{"type":"text","text":"types"}]}]},{"type":"text","text":"\n "}]}` --> @@ -67,7 +67,7 @@ Description of type. * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class OperatorSpecification"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::TypeDescriptor::OperatorSpecification"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"OperatorSpecification"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1OperatorSpecification"},"children":[{"type":"text","text":"OperatorSpecification"}]}]},{"type":"text","text":"\n "}]}` --> ## Public functions @@ -120,7 +120,7 @@ ansys::dpf::TypeDescriptor::TypeDescriptor(TypeDescriptor const &)=default **Parameters**: -* TypeDescriptor const & +* [TypeDescriptor](structansys-dpf-typedescriptor.md#structansys-dpf-typedescriptor) const & **Return type**: @@ -149,7 +149,7 @@ ansys::dpf::TypeDescriptor::TypeDescriptor(TypeDescriptor &&)=default **Parameters**: -* TypeDescriptor && +* [TypeDescriptor](structansys-dpf-typedescriptor.md#structansys-dpf-typedescriptor) && **Return type**: @@ -178,9 +178,9 @@ TypeDescriptor & ansys::dpf::TypeDescriptor::operator=(TypeDescriptor const &)=d **Parameters**: -* TypeDescriptor const & +* [TypeDescriptor](structansys-dpf-typedescriptor.md#structansys-dpf-typedescriptor) const & -**Return type**: TypeDescriptor & +**Return type**: [TypeDescriptor](structansys-dpf-typedescriptor.md#structansys-dpf-typedescriptor) &