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 getServerVersionFull + +![][public] +![][static] + + +```cpp +static void ansys::dpf::core::getServerVersionFull(int &major_version, int &minor_version, int µ_version, std::string &modifier_version) +``` + + +Fills all version components of the In-Process server. + +**Parameters**: + +* **major_version**: Major version of the server +* **minor_version**: Minor version of the server +* **micro_version**: Micro version of the server +* **modifier_version**: Modifier version of the server + + + +**Parameters**: + +* int & **major_version** +* int & **minor_version** +* int & **micro_version** +* std::string & **modifier_version** + +**Return type**: void + + + ### Function copyTo diff --git a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-customtypefield.md b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-customtypefield.md index 0acbef2d4..08ab2d8fe 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-customtypefield.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-customtypefield.md @@ -67,9 +67,10 @@ Holds data located on given entities (the [Field](classansys-dpf-field.md#classa * [setHeaderAsDataTree](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield-1a0f9c8db836e630abab6e914bfad781a2) * [setName](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield-1aa4e89d6febec7ca3f83b6ab0dd505b6d) * [setScoping](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield-1a46281c0e95a5ea8aa038882f6b210f82) -* [setSupport](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield-1a6cc095d24302187139b81ad7843d5835) -* [setSupport](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield-1a1dc844fe2af7407a8333269be5cf99cd) -* [setSupport](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield-1a686bc9eade56aa283e052f81da8fec9b) +* [setSupport](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield-1acfcea99977b7fa89d2046f6ad4583ca3) +* [setSupport](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield-1a58db99281624f06e397fb0675ad61653) +* [setSupport](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield-1a42a4865d6dd7101dd937d4a5eaab5dfc) +* [setSupport](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield-1a3e2d48d20c6b045faab0618e89e004c3) * [support](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield-1ac395281a74f1a78df961f443a32648a1) * [~CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield-1a07dba2c5b6fccedaa06182c3b2749b22) * [~DpfTypes](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1ab7c83b6ea160c2b115e056f6c312112f) @@ -96,7 +97,7 @@ static CustomTypeField ansys::dpf::CustomTypeField::emptyCustomTypeField() -**Return type**: CustomTypeField +**Return type**: [CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield) - + ### 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) & - + ### Function ids ![][public] @@ -659,7 +659,7 @@ Pointer to list of [ids](classansys-dpf-scoping.md#classansys-dpf-scoping-1acf26 ```cpp -DpfVector< int > ansys::dpf::Scoping::ids() const +DpfVector< dp_id > ansys::dpf::Scoping::ids() const ``` @@ -671,7 +671,7 @@ DpfVector< int > ansys::dpf::Scoping::ids() const -**Return type**: DpfVector< int > +**Return type**: [DpfVector](classansys-dpf-dpfvector.md#classansys-dpf-dpfvector)< [dp_id](namespaceansys-dpf.md#namespaceansys-dpf-1ab4574c9af3f2bb8011da7d1f4c8da20e) > + +### Function splitStreams + +![][public] +![][const] + + +```cpp +std::vector< Streams > ansys::dpf::Streams::splitStreams() const +``` + + + + +Split the [Streams](classansys-dpf-streams.md#classansys-dpf-streams) into multiple single-domain [Streams](classansys-dpf-streams.md#classansys-dpf-streams) containers. +**Returns**: + +Vector of [Streams](classansys-dpf-streams.md#classansys-dpf-streams), one per domain. + + + +**Return type**: std::vector< [Streams](classansys-dpf-streams.md#classansys-dpf-streams) > + + + + +### Function getStreamByFileType + +![][public] +![][const] + + +```cpp +Streams ansys::dpf::Streams::getStreamByFileType(std::string const &file_type) const +``` + + + + +Get a single-stream [Streams](classansys-dpf-streams.md#classansys-dpf-streams) object for the stream identified by the given file type. +**Returns**: + +[Streams](classansys-dpf-streams.md#classansys-dpf-streams) containing only the stream matching the given file type extension (e.g. "rst", "h5dpf"). + + + +**Parameters**: + +* std::string const & **file_type**: [in] File type extension identifying the stream. + +**Return type**: [Streams](classansys-dpf-streams.md#classansys-dpf-streams) + + + + +### Function tryGetDataFromCache + +![][public] +![][const] + + +```cpp +bool ansys::dpf::Streams::tryGetDataFromCache(std::string const &identifier, DataT &to_fill) const +``` + + + + +Try to get data from a stream's cache. +**Returns**: + +true if data was found in cache, false otherwise. + + + +**Parameters**: + +* std::string const & **identifier**: [in] Cache key identifier. +* DataT & **to_fill**: [out] Data retrieved from cache. + +**Return type**: bool + + + ## Public static functions @@ -439,7 +539,7 @@ Empty [Streams](classansys-dpf-streams.md#classansys-dpf-streams). -**Return type**: Streams +**Return type**: [Streams](classansys-dpf-streams.md#classansys-dpf-streams) @@ -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..d875556ef 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/deprecated.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/deprecated.md @@ -4,15 +4,21 @@ +Member [ansys::dpf::core::getServerVersion](classansys-dpf-core.md#classansys-dpf-core-1ae3472a9ced3aff887f623d3a46943d5d) (int &major_version, int &minor_version): + + +Use getServerVersionFull instead + + Member [ansys::dpf::eFilterDegeneratedElPin](namespaceansys-dpf.md#namespaceansys-dpf-1aa4a44a04a0aafb8fe0645f019bbd94d1a9218c2b63a3ebece21e101df19ea2c36): 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. [C++]: https://img.shields.io/badge/language-C%2B%2B-blue (C++) 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..a0f76f984 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 C:/agent/installer/_work/7/s/DPF/Ans.Dpf.Hgp @@ -8,7 +8,7 @@ ## Subdirectories -* [D:/ANSYSDev/Sandbox/DPF/Ans.Dpf.Hgp/helpers](dir-fca9ddd4acaabdc476476.md#dir-fca9ddd4acaabdc476476) +* [C:/agent/installer/_work/7/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..3c646e718 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 C:/agent/installer/_work/7/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) - + ### Typedef iterator_category ![][public] ```cpp -using ansys::dpf::DpfVector< T >::iterator::iterator_category = std::bidirectional_iterator_tag +using ansys::dpf::DpfVector< T >::iterator::iterator_category = std::random_access_iterator_tag ``` @@ -177,7 +183,7 @@ using ansys::dpf::DpfVector< T >::iterator::iterator_category = std::bidirection -**Return type**: std::bidirectional_iterator_tag +**Return type**: std::random_access_iterator_tag - -### Friend operator== +## Public functions + + +### Function iterator -![][C++] ![][public] +```cpp +ansys::dpf::DpfVector< T >::iterator::iterator() +``` - - -### Friend operator!= -![][C++] -![][public] +**Return type**: + + +### Function iterator +![][public] +```cpp +ansys::dpf::DpfVector< T >::iterator::iterator(index_type index, DpfVectorData< T > *data) +``` - - -### Friend operator+ -![][C++] -![][public] +**Parameters**: +* index_type **index** +* DpfVectorData< T > * **data** +**Return type**: - -### Friend operator- + +### Function operator\< -![][C++] ![][public] +![][const] +```cpp +bool ansys::dpf::DpfVector< T >::iterator::operator<(const iterator &other) const +``` + + + +**Parameters**: + +* const [iterator](structansys-dpf-dpfvector-iterator.md#structansys-dpf-dpfvector-iterator) & **other** + +**Return type**: bool + - -### Friend operator- + +### Function operator\> -![][C++] ![][public] +![][const] + +```cpp +bool ansys::dpf::DpfVector< T >::iterator::operator>(const iterator &other) const +``` + + +**Parameters**: + +* const [iterator](structansys-dpf-dpfvector-iterator.md#structansys-dpf-dpfvector-iterator) & **other** + +**Return type**: bool + -## Public functions - - -### Function iterator + +### Function operator\<= ![][public] +![][const] ```cpp -ansys::dpf::DpfVector< T >::iterator::iterator() +bool ansys::dpf::DpfVector< T >::iterator::operator<=(const iterator &other) const ``` @@ -343,22 +350,27 @@ ansys::dpf::DpfVector< T >::iterator::iterator() -**Return type**: +**Parameters**: + +* const [iterator](structansys-dpf-dpfvector-iterator.md#structansys-dpf-dpfvector-iterator) & **other** + +**Return type**: bool - -### Function iterator + +### Function operator\>= ![][public] +![][const] ```cpp -ansys::dpf::DpfVector< T >::iterator::iterator(index_type index, DpfVectorData< T > *data) +bool ansys::dpf::DpfVector< T >::iterator::operator>=(const iterator &other) const ``` @@ -370,26 +382,25 @@ ansys::dpf::DpfVector< T >::iterator::iterator(index_type index, DpfVectorData< **Parameters**: -* index_type **index** -* DpfVectorData< T > * **data** +* const [iterator](structansys-dpf-dpfvector-iterator.md#structansys-dpf-dpfvector-iterator) & **other** -**Return type**: +**Return type**: bool - -### Function operator* + +### Function operator== ![][public] ![][const] ```cpp -reference ansys::dpf::DpfVector< T >::iterator::operator*() const +bool ansys::dpf::DpfVector< T >::iterator::operator==(const iterator &other) const ``` @@ -399,22 +410,27 @@ reference ansys::dpf::DpfVector< T >::iterator::operator*() const -**Return type**: reference +**Parameters**: + +* const [iterator](structansys-dpf-dpfvector-iterator.md#structansys-dpf-dpfvector-iterator) & **other** + +**Return type**: bool - -### Function operator-\> + +### Function operator!= ![][public] +![][const] ```cpp -pointer ansys::dpf::DpfVector< T >::iterator::operator->() +bool ansys::dpf::DpfVector< T >::iterator::operator!=(const iterator &other) const ``` @@ -424,12 +440,16 @@ pointer ansys::dpf::DpfVector< T >::iterator::operator->() -**Return type**: pointer +**Parameters**: + +* const [iterator](structansys-dpf-dpfvector-iterator.md#structansys-dpf-dpfvector-iterator) & **other** + +**Return type**: bool @@ -449,7 +469,7 @@ iterator & ansys::dpf::DpfVector< T >::iterator::operator++() -**Return type**: iterator & +**Return type**: [iterator](structansys-dpf-dpfvector-iterator.md#structansys-dpf-dpfvector-iterator) & + +### Function operator+ + +![][public] +![][const] + + +```cpp +iterator ansys::dpf::DpfVector< T >::iterator::operator+(difference_type n) const +``` + + + + + + + + +**Parameters**: + +* difference_type **n** + +**Return type**: [iterator](structansys-dpf-dpfvector-iterator.md#structansys-dpf-dpfvector-iterator) + + + + +### Function operator- + +![][public] +![][const] + + +```cpp +iterator ansys::dpf::DpfVector< T >::iterator::operator-(difference_type n) const +``` + + + + + + + + +**Parameters**: + +* difference_type **n** + +**Return type**: [iterator](structansys-dpf-dpfvector-iterator.md#structansys-dpf-dpfvector-iterator) + + + + +### Function operator- + +![][public] +![][const] + + +```cpp +difference_type ansys::dpf::DpfVector< T >::iterator::operator-(const iterator &other) const +``` + + + + + + + + +**Parameters**: + +* const [iterator](structansys-dpf-dpfvector-iterator.md#structansys-dpf-dpfvector-iterator) & **other** + +**Return type**: difference_type + + + + +### Function operator* + +![][public] +![][const] + + +```cpp +reference ansys::dpf::DpfVector< T >::iterator::operator*() const +``` + + + + + + + + +**Return type**: reference + + + + +### Function operator-\> + +![][public] +![][const] + + +```cpp +const pointer ansys::dpf::DpfVector< T >::iterator::operator->() const +``` + + + + + + + + +**Return type**: const pointer + + + + +### Function operator[] + +![][public] +![][const] + + +```cpp +reference ansys::dpf::DpfVector< T >::iterator::operator[](difference_type n) const +``` + + + + + + + + +**Parameters**: + +* difference_type **n** + +**Return type**: reference + + + + +### Function getIndex + +![][public] +![][const] + + +```cpp +dp_index ansys::dpf::DpfVector< T >::iterator::getIndex() const +``` + + +Retrieve the current index of the iterator. + + + + + +**Return type**: [dp_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) + + + [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-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-elements.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-elements.md index 9c2796840..4c18eae3b 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-elements.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-elements.md @@ -15,6 +15,8 @@ Predefined [ElementDescriptor](structansys-dpf-elementdescriptor.md#structansys- * [beam4](structansys-dpf-elements.md#structansys-dpf-elements-1a7651898827538618d188da12cb8be51a) * [descriptor](structansys-dpf-elements.md#structansys-dpf-elements-1a30e8daf92a36604a3c176d9f7b5d1f35) * [eBeam](structansys-dpf-elements.md#structansys-dpf-elements-1a52e134d27c3ea7a5158ad3707d0af86da79f8bbaf009f29ba6735fd6bf114b2cf) +* [edge2](structansys-dpf-elements.md#structansys-dpf-elements-1adc428a89ed87dbb0688ce2ba08aa4421) +* [edge3](structansys-dpf-elements.md#structansys-dpf-elements-1ac392e05d325dd5dc79130d905cecb365) * [EElementType](structansys-dpf-elements.md#structansys-dpf-elements-1a26cd9737847a69cd1f856a8936c3551c) * [EElementType](structansys-dpf-elements.md#structansys-dpf-elements-1a15f94658f6da65e43f52199c682eaa41) * [EShape](structansys-dpf-elements.md#structansys-dpf-elements-1a52e134d27c3ea7a5158ad3707d0af86d) @@ -966,6 +968,58 @@ Quadratic 3-nodes Line. * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::elements::line3"}]}` --> + +### Variable edge2 + +![][public] +![][static] + + +```cpp +const ElementDescriptor ansys::dpf::elements::edge2 +``` + + + + +Linear 2-nodes Edge( lined shaped edge of SURF). + + + +**Type**: const [ElementDescriptor](structansys-dpf-elementdescriptor.md#structansys-dpf-elementdescriptor) + + + + +### Variable edge3 + +![][public] +![][static] + + +```cpp +const ElementDescriptor ansys::dpf::elements::edge3 +``` + + + + +Quadratic 3-nodes Edge( lined shaped edge of SURF). + + + +**Type**: const [ElementDescriptor](structansys-dpf-elementdescriptor.md#structansys-dpf-elementdescriptor) + + + ### Variable beam3 diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-homogeneities.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-homogeneities.md index 0186895fe..8b1686983 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-homogeneities.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-homogeneities.md @@ -51,6 +51,7 @@ Predefined measurement quantities. * [surface](structansys-dpf-homogeneities.md#structansys-dpf-homogeneities-1aefeb2484e3b6b23181364355669ae987) * [temperature](structansys-dpf-homogeneities.md#structansys-dpf-homogeneities-1aae45fd764d3d7e52160eeaefb930c0eb) * [temperature_difference](structansys-dpf-homogeneities.md#structansys-dpf-homogeneities-1ac34f11f1e215920d52e22121ea776054) +* [thermal_compliance](structansys-dpf-homogeneities.md#structansys-dpf-homogeneities-1a0dc1ce3b904016e4b7d831322a489bed) * [thermal_conductivity](structansys-dpf-homogeneities.md#structansys-dpf-homogeneities-1a125c36d915cec998766cd68c0a24e77b) * [thermal_gradient](structansys-dpf-homogeneities.md#structansys-dpf-homogeneities-1a3a3006f58834a317b57fc098e9496298) * [time](structansys-dpf-homogeneities.md#structansys-dpf-homogeneities-1ae3a86014caf4a22880b41cabfd534733) @@ -1285,6 +1286,32 @@ Predefined measurement quantity for film_coefficient. * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::homogeneities::film_coefficient"}]}` --> + +### Variable thermal_compliance + +![][public] +![][static] + + +```cpp +const Homogeneity ansys::dpf::homogeneities::thermal_compliance +``` + + + + +Predefined measurement quantity for thermal_compliance. + + + +**Type**: const [Homogeneity](classansys-dpf-homogeneity.md#classansys-dpf-homogeneity) + + + ### Variable dimension_less 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) & "fields container over time or frequency expected in input" because the returned result did not carry the time label required by downstream time interpolation. The result now always carries the time label, so reading Euler angles at any time value works. + > + > 2. Body label lost when restricting to a single body. Asking for nodal Euler angles on a single body or material returned results labelled with body id 0 instead of the requested id. Multi-body requests were unaffected. Single-body requests now preserve the requested body / material id on every returned result, identically to the multi-body case. + > + > + > + > **No user-visible behaviour changes for adaptive analyses, multi-body requests, or pure rotation workflows.** + > + > + > + > + +- Add missing input pins to EUL_NOD and coords_and_euler_nodes operator specs: + > + > + > Fixed incomplete operator specifications for the `mapdl::rst::EUL_NOD` (node orientations) and `mapdl::rst::coords_and_euler_nodes` (euler nodes) operators. Both operators were missing several input pins from their specification, including `time_scoping`, `mesh_scoping`, `fields_container`, and `read_cyclic`. As a result, the operator graph visualization (`to_graphviz()`) did not show the mesh scoping pin for these operators. The mesh pin type constraint was also extended to accept `MeshesContainer` in addition to `MeshedRegion`. + > + > + > + > + +- Fix bug 1458972 Descriptor for plane183: + > + > + > + +- Remove redundant mapdl. prefix from operator scripting names: + > + > + > Four operators had a redundant `mapdl.` prefix in their scripting name. Because the plugin + > + > field already carries the `mapdl` context, this prefix caused the full documented name to + > + > become `result.mapdl.` instead of the correct `result.`. The scripting names + > + > have been corrected: + > + > + > + > - `pres_to_field` (was `mapdl.pres_to_field`) + > + > - `prns_to_field` (was `mapdl.prns_to_field`) + > + > - `run` (was `mapdl.run`) + > + > - `global_to_nodal` (was `mapdl.global_to_nodal`) + > + > + > + > The Python API (`dpf.operators.result.*`) is unaffected by this change. + > + > + > + > + +- Fix modal solution scoping for MCF_Legacy filtering: + > + > + > + - Support ElementalNodal input fields in mapdl::split_on_facet_indices and mapdl::split_to_acmo_facet_indices: > > @@ -1669,6 +1876,18 @@ The following table shows which components have updates in each category. ## math ### Features +- Complete usage of ScopingIterators and eliminate GetIds calls in Ans.Dpf.Math: + > + > + > + +- Perform modal_solve expansion using expansion::modal_superposition: + > - Allow input Custom Type Fields Containers on expansion::mode_superposition + > + > + > + > + - Create TPA objects to streamline TPA workflow: > @@ -1743,6 +1962,13 @@ The following table shows which components have updates in each category. ### Fixes +- Fix issue with specification in expansion operator: + > - Fix operator specification issue introduced in a previous PR + > + > + > + > + - FFT Multiharmonic performance enhancements: > FFT Multiharmonic performance enhancements > @@ -1752,6 +1978,9 @@ The following table shows which components have updates in each category. ## mechanical ### Features +- Complete usage of ScopingIterators and eliminate GetIds calls in Ans.Dpf.Mechanical: + > + - Adding operator for finding number of modes per chunk: > Add new operators to calculate number of modes that can be evaluated per chunk based on the result mesh and the available memory on the user's machine. > @@ -1838,6 +2067,15 @@ The following table shows which components have updates in each category. ## misc ### Features +- Set DPF versioning to ansys calendar like versioning: + > + > + > Set DPF versioning to Ansys calendar like versioning and add full version endpoints. + > + > + > + > + - Add operator Changelog support to C#: > Support operator changelogs in the C# client API. Add the Changelog class. > @@ -2001,6 +2239,11 @@ The following table shows which components have updates in each category. ### Fixes +- Ansys.dpf conanfile DPFEmpty.xml wrong source dir: + > + > + > + - Restored a number of error messages: > > @@ -2252,6 +2495,44 @@ The following table shows which components have updates in each category. ## native ### Features +- Enable incremental::composite::MeshProvider by default: + > Increased memory efficiency of mesh reading by improving the merging methodology. + > + > + +- Add the workflow_string input pin in the import_symbolic_workflow operator: + > + > + > Add the new `workflow_string` input pin in the `import_symbolic_workflow` operator. + > + > + > + > + +- XML-escape special characters in C# operator doc generation: + > + > + > The `csharp_generator` operator now correctly XML-escapes special characters (`<`, `>`, `&`) + > + > in operator and pin descriptions before writing them into C# XML documentation comments. + > + > This prevents malformed XML when descriptions contain Markdown blockquotes or LaTeX-style + > + > inequalities, which previously caused the C# compiler `/doc:` extraction and IntelliSense + > + > pipelines to produce invalid output. + > + > + > + > + +- Add a dedicated matrix_product operator: + > Adds a dedicated matrix_product operator as a helper to the generalized_inner_product for ease of use. + > + > + > + > + - Supported Generic Support in "field::get_attribute" and "propertyfield::get_attribute" APIs: > - Supported Generic Support (property_name = "generic_support") in "field::get_attribute" and "propertyfield::get_attribute" operators. > @@ -2312,6 +2593,61 @@ The following table shows which components have updates in each category. ### Fixes +- Skip empty input fields in min_max_over_label_fc: + > + > + > The `min_max_over_label_fc` operator now correctly handles fields containers that contain + > + > empty fields (fields with no data, such as those produced by unconverged time steps). + > + > Previously, empty fields caused spurious zero-valued entries in the min/max output. + > + > The operator now excludes domain IDs whose fields are entirely empty from the output, + > + > so the output scoping only contains the domain IDs for which actual data was available. + > + > + > + > + +- Fix solid_to_skin: + > Fixes intermittent crashes (access violations and heap corruption) that could occur when mapping solid results to skin meshes during parallel post-processing of multiple time steps or load cases. + > + > + > + > What was happening: When processing a multi-step results container in parallel, the skin-mapping computation (`solid_to_skin_fc`) would randomly crash due to internal data structures being accessed concurrently without protection. + > + > + > + > **What changed**: + > + > + > + > - Chirurgical fix to avoid crash in Nodal path when calling in parallel the `solid_to_skin_fc` operator. The crash was triggered during rescope in a very specific condition where the solid_field_scoping is the same as the skin_field_scoping we want to rescope. + > + > - Partially-initialized mesh objects no longer produce null-pointer dereferences downstream + > + > + > + > **Impact**: No change to inputs, outputs, or results. The fix is purely internal - the same computations execute in the same order, but safely under concurrency. + > + > + > + > No user-facing API changes. No pins added, removed, or renamed. Existing workflows continue to function identically, with improved robustness under concurrent and edge-case conditions. + > + > + > + > + +- Fix labels issue in adapt_with_scopings_container: + > + > + > Fix issue in `adapt_with_scopings_container` when input FieldsContainer and ScopingsContainer don't share labels. + > + > + > + > + - Fix int connection to time_scoping pin for cyclic models: > > @@ -2546,6 +2882,11 @@ The following table shows which components have updates in each category. ### Fixes +- Fixing parallelization issue with prime operators: + > Support parallelization for `prepare_morphing` (and so `morphed_field`) and `export_mesh_with_prime`. + > + > + - Restoring parallelization config options: > Restoring parallelization config options, when applies. > @@ -2595,6 +2936,11 @@ The following table shows which components have updates in each category. ## vtk ### Features +- Add pins for extra connectivity & input scoping in op:mesh_to_pyvista: + > Introduce capability to accept input mesh scoping that allows construction of vtk meshes for a specified subset of the original mesh. Add 'as_modified_connectivity' boolean input pin that returns VTK version>9 compatible connectivity representation consisting of an array of concatenated node indices for cells without node count headers and an offset array to it. + > + > + - Perf improvement of mesh_to_pyvista (part 2): > @@ -2607,8 +2953,27 @@ The following table shows which components have updates in each category. ### Fixes -- Fix beam3/beam4 mesh conversion support: - > DPF Mesh regions containing beam3/beam4 elements can be handled properly using the mesh_to_pyvista operator (even with 'as_linear' turned off). +- Vtu_export output DataSources has null result paths: + > + > + > The `vtu_export` operator now correctly populates the output `DataSources` with + > + > the paths of the exported VTU files when exporting a multi-timestep result. + > + > Previously, the result paths were stored in a domain-specific secondary slot + > + > (intended for distributed solver files) rather than as plain result files, + > + > causing the output `DataSources.result_files` to return null entries for every + > + > time step. + > + > + > + > + +- Fix beam3/beam4 mesh conversion support: + > DPF Mesh regions containing beam3/beam4 elements can be handled properly using the mesh_to_pyvista operator (even with 'as_linear' turned off). > > > @@ -2650,6 +3015,11 @@ The following table shows which components have updates in each category. ### Fixes +- Re-enable workflow tests: + > + > + > + - Tags in quantization workflow and tests helpers: > Allows the decompression in quantization workflow with a specific mesh scoping. > @@ -2669,7 +3039,7 @@ The following table shows which components have updates in each category. #### compression -- [quantization](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/compression/quantization.md): +- [quantization](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/compression/quantization.md): > Scales a field to a given precision threshold, then rounds all the values to the unit. > > The output of the quantization operation is : @@ -2678,7 +3048,7 @@ The following table shows which components have updates in each category. > > To truncate a number to \\(n\\) decimal places, the threshold must be chosen as \\(10^{-n}\\). -- [quantization_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/compression/quantization_fc.md): +- [quantization_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/compression/quantization_fc.md): > Scales all the fields of a fields container to a given precision threshold, then rounds all the values to the unit. > > The output of the quantization operation is : @@ -2690,7 +3060,7 @@ The following table shows which components have updates in each category. #### info -- [markdown_latex_example](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/info/markdown_latex_example.md): +- [markdown_latex_example](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/info/markdown_latex_example.md): > This operator showcases the use of Markdown and LaTeX in operator and pin descriptions: > #### Headings > ##### h2 @@ -2780,173 +3150,75 @@ The following table shows which components have updates in each category. #### mapping -- [apply_mechanical_native_mapping](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/apply_mechanical_native_mapping.md): - > - > Applies pre-computed mapping weights to interpolate field data from a source mesh to a target mesh. - > This is the second stage of the two-stage native mapping workflow; use `prepare_mechanical_native_mapping` (or a dedicated prepare operator) to compute the weights first. - > - > For each target point $j$, the interpolated value is: - > - > $$ - > u_{\text{target}}^{(j)} = \sum_{i \in S(j)} w_{ij} \cdot u_{\text{source}}^{(i)} - > $$ - > - > where $S(j)$ is the set of source points influencing target point $j$, and $w_{ij}$ are algorithm-specific weights: shape function values (shape function algorithms), barycentric coordinates or inverse-distance values (point cloud algorithms), or optimal linear predictors (kriging). - > - > For further details on the algorithms and their settings, see the Ansys Mechanical help page on - > [Data Transfer Mesh Mapping](https://ansyshelp.ansys.com/public/account/secured?returnurl=/Views/Secured/corp/v271/en/wb_sim/ds_appen_data_transfer.html). - -- [create_mech_kriging_convection_workflow](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/create_mech_kriging_convection_workflow.md): - > Prepares a workflow able to map data from an input mesh to a target mesh. - -- [create_mech_kriging_workflow](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/create_mech_kriging_workflow.md): - > Prepares a workflow able to map data from an input mesh to a target mesh. - -- [create_mech_point_cloud_convection_workflow](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/create_mech_point_cloud_convection_workflow.md): - > Prepares a workflow able to map data from an input mesh to a target mesh. - -- [create_mech_point_cloud_workflow](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/create_mech_point_cloud_workflow.md): - > Prepares a workflow able to map data from an input mesh to a target mesh. - -- [create_mech_shape_func_surf_convection_workflow](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/create_mech_shape_func_surf_convection_workflow.md): +- [create_sc_mapping_workflow](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mapping/create_sc_mapping_workflow.md): > Prepares a workflow able to map data from an input mesh to a target mesh. -- [create_mech_shape_func_surf_workflow](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/create_mech_shape_func_surf_workflow.md): - > Prepares a workflow able to map data from an input mesh to a target mesh. - -- [create_mech_shape_func_vol_convection_workflow](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/create_mech_shape_func_vol_convection_workflow.md): - > Prepares a workflow able to map data from an input mesh to a target mesh. +- [sc_mapping](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mapping/sc_mapping.md): + > Apply System Coupling to map data from an input mesh to a target mesh. -- [create_mech_shape_func_vol_workflow](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/create_mech_shape_func_vol_workflow.md): +- [sysc_point_cloud_wf](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mapping/sysc_point_cloud_wf.md): > Prepares a workflow able to map data from an input mesh to a target mesh. -- [create_sc_mapping_workflow](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/create_sc_mapping_workflow.md): +- [sysc_shape_function_wf](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mapping/sysc_shape_function_wf.md): > Prepares a workflow able to map data from an input mesh to a target mesh. -- [prepare_mechanical_native_mapping](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/prepare_mechanical_native_mapping.md): - > Prepares the interpolation weights for mapping source field data from a source mesh to a target mesh. - > This operator delegates to one of the dedicated algorithm operators (shape function volumes, shape function surfaces, point cloud, or kriging) depending on which DataTree input pin is provided. - > At least one of the `*_mapping` algorithm DataTree inputs (pins 30-33) must be set to choose the mapping algorithm and supply its options. - > This operator must be used together with the associated `apply_mechanical_native_mapping` operator. - > - > For further details on the available algorithms and their settings, see the Ansys Mechanical help page on [Data Transfer Mesh Mapping](https://ansyshelp.ansys.com/public/account/secured?returnurl=/Views/Secured/corp/v271/en/wb_sim/ds_appen_data_transfer.html). -- [prepare_mechanical_native_mapping_kriging](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/prepare_mechanical_native_mapping_kriging.md): - > Prepares field data mapping from a source mesh to a target mesh using **kriging interpolation**, a geostatistical method that assigns weights to nearby source points based on spatial covariance. Use this operator with `apply_mechanical_native_mapping`. - > - > **Ansys Mechanical equivalent**: Weighting = *Kriging*. - > - > For further details on the algorithm and its settings, see the Ansys Mechanical help page on [Data Transfer Mesh Mapping](https://ansyshelp.ansys.com/public/account/secured?returnurl=/Views/Secured/corp/v271/en/wb_sim/ds_appen_data_transfer.html). +#### math -- [prepare_mechanical_native_mapping_point_cloud](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/prepare_mechanical_native_mapping_point_cloud.md): - > - > Prepares field data mapping from source mesh to target mesh using **point cloud interpolation** - a scattered-data - > approximation method that constructs interpolation weights from spatial proximity relationships without requiring mesh - > connectivity. Use it together with `apply_mechanical_native_mapping`. - > - > For each target point $\mathbf{x}_t$, the interpolated value is: - > - > $$ - > u(\mathbf{x}_t) = \sum_{i=1}^{N_s} w_i(\mathbf{x}_t) \cdot u_i - > $$ - > - > where $u_i$ are the source field values, $w_i$ are normalized distance-based weights, and $N_s$ is the number of - > source neighbors (controlled by `search_limit`). See the individual pin descriptions for the available weighting - > schemes, outside-point strategies, and geometry options. - > - > **Ansys Mechanical equivalent**: Weighting = *Triangulation* (use `weighting_type = "triangulation"`) or Weighting = *Distance Based Average* (use `weighting_type = "weighted_average"`). - > - > For further details on the algorithm and its settings, see the Ansys Mechanical help page on - > [Data Transfer Mesh Mapping](https://ansyshelp.ansys.com/public/account/secured?returnurl=/Views/Secured/corp/v271/en/wb_sim/ds_appen_data_transfer.html). +- [linearized_stress](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/linearized_stress.md): + > get linearized stress -- [prepare_mechanical_native_mapping_shape_functions_for_surfaces](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/prepare_mechanical_native_mapping_shape_functions_for_surfaces.md): - > - > Prepares field data mapping from source mesh to target mesh using **finite element shape functions** for **surface - > elements** (shells and membranes). This operator computes interpolation weights by locating target points - > within source surface elements and evaluating isoparametric shape functions at the reduced coordinates. This operator - > must be used in conjunction with `apply_mechanical_native_mapping`. - > - > ##### Shape function interpolation for surfaces - > - > For surface elements, the field value at any point $\mathbf{x}$ within an element is interpolated using: - > - > $$ - > u(\mathbf{x}) = \sum_{i=1}^{N_{\text{nodes}}} N_i(\xi, \eta) \cdot u_i - > $$ +- [matrix_product](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/matrix_product.md): > - > where: - > - $N_i(\xi, \eta)$ are the 2D isoparametric shape functions - > - $(\xi, \eta)$ are the reduced (natural) coordinates in the reference element $[-1, 1]^2$ - > - $u_i$ are the nodal field values - > - $N_{\text{nodes}}$ is the number of nodes per element (3, 4, 6, 8, etc.) + > Computes the product of two matrix or matrix-vector fields: > - > ##### Comparison with volume shape functions + > | Pin 0 | Pin 1 | Operation | Result | + > |---|---|---|---| + > | matrix field | matrix field | [matrix product](https://en.wikipedia.org/wiki/Matrix_multiplication) | matrix field | + > | matrix field | vector field | matrix-vector product | vector field | > - > - **Reduced coordinate dimension**: 2D $(\xi, \eta)$ vs 3D $(\xi, \eta, \zeta)$ for volume elements - > - **Target input**: surface operator requires a **meshed_region** target; volume operator also accepts a field - > - **Additional proximity controls**: surface operator supports normal distance checking (pins 15-16) and a - > pinball region (pins 17-20), which are not available for volumes + > Raises an error if neither input is a matrix (second-order tensor) field, + > or if an input is neither a matrix nor a vector. + > For general inner products - including dot products and scaling - use the + > `generalized_inner_product` operator instead. + > If either input is empty, a dimensionless zero scalar field is returned. > - > **Ansys Mechanical equivalent**: Weighting = *Shape Function*, Transfer Type = *Surface*. - > Note: this mode only supports triangle and quadrilateral source elements. - > - > For further details on the algorithm and its settings, see the Ansys Mechanical help page on - > [Data Transfer Mesh Mapping](https://ansyshelp.ansys.com/public/account/secured?returnurl=/Views/Secured/corp/v271/en/wb_sim/ds_appen_data_transfer.html). -- [prepare_mechanical_native_mapping_shape_functions_for_volume](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/prepare_mechanical_native_mapping_shape_functions_for_volume.md): - > Prepares field data mapping from source mesh to target mesh using **finite element shape functions** on volume elements (hexahedra, tetrahedra, wedges, pyramids). +- [matrix_product_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/matrix_product_fc.md): > - > Each target point is located within a source element and the field value is interpolated using 3D isoparametric shape functions at the corresponding reduced coordinates. + > Computes the product of two matrix or matrix-vector fields: > - > Note: shape functions near the apex of pyramid elements exhibit singular behaviour and may produce errors for target points close to the apex. Use this operator with `apply_mechanical_native_mapping`. + > | Pin 0 | Pin 1 | Operation | Result | + > |---|---|---|---| + > | matrix field | matrix field | [matrix product](https://en.wikipedia.org/wiki/Matrix_multiplication) | matrix field | + > | matrix field | vector field | matrix-vector product | vector field | > - > **Ansys Mechanical equivalent**: Weighting = *Shape Function*, Transfer Type = *Volumetric*. + > Raises an error if neither input is a matrix (second-order tensor) field, + > or if an input is neither a matrix nor a vector. + > For general inner products - including dot products and scaling - use the + > `generalized_inner_product` operator instead. + > If either input is empty, a dimensionless zero scalar field is returned. > - > For further details on the algorithm and its settings, see the Ansys Mechanical help page on [Data Transfer Mesh Mapping](https://ansyshelp.ansys.com/public/account/secured?returnurl=/Views/Secured/corp/v271/en/wb_sim/ds_appen_data_transfer.html). - -- [sc_mapping](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/sc_mapping.md): - > Apply System Coupling to map data from an input mesh to a target mesh. - -- [sysc_point_cloud_wf](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/sysc_point_cloud_wf.md): - > Prepares a workflow able to map data from an input mesh to a target mesh. - -- [sysc_shape_function_wf](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/sysc_shape_function_wf.md): - > Prepares a workflow able to map data from an input mesh to a target mesh. - - -#### math - -- [linearized_stress](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/linearized_stress.md): - > get linearized stress #### mesh -- [edge_decimation](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/edge_decimation.md): +- [edge_decimation](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mesh/edge_decimation.md): > Takes a wireframe mesh (line elements) and reduces its node and edge count by collapsing interior nodes whose two incident edges deviate from straight by less than the given angular threshold. Branch nodes and sharp corners are preserved. -- [morphed_field](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/morphed_field.md): - > Computes the displacement to apply on input coordinates (in 2) if a morphing field (in 0) is applied on coordinates (in 1) - -- [morphing](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/morphing.md): - > Applies morphing on a meshed region depending on an input displacement field. - -- [prepare_morphing](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/prepare_morphing.md): - > Prepare morphing on a meshed region depending on an input displacement field. - #### result -- [acoustic_energy_density](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/acoustic_energy_density.md): +- [acoustic_energy_density](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/acoustic_energy_density.md): > Read/compute AED by calling the readers defined by the datasources. -- [acoustic_pressure](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/acoustic_pressure.md): +- [acoustic_pressure](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/acoustic_pressure.md): > Read/compute AcousticPressure by calling the readers defined by the datasources. -- [average_velocity](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/average_velocity.md): +- [average_velocity](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/average_velocity.md): > Read/compute average velocity by calling the readers defined by the datasources. -- [creep_strain](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/creep_strain.md): +- [creep_strain](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/creep_strain.md): > Read/compute element nodal component creep strains by calling the readers defined by the datasources. > - The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. > - Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: @@ -2980,25 +3252,25 @@ The following table shows which components have updates in each category. > | 13 | Pretension | > -- [creep_strain_X](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/creep_strain_X.md): +- [creep_strain_X](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/creep_strain_X.md): > Read/compute element nodal component creep strains XX normal component (00 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -- [creep_strain_XY](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/creep_strain_XY.md): +- [creep_strain_XY](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/creep_strain_XY.md): > Read/compute element nodal component creep strains XY shear component (01 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -- [creep_strain_XZ](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/creep_strain_XZ.md): +- [creep_strain_XZ](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/creep_strain_XZ.md): > Read/compute element nodal component creep strains XZ shear component (02 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -- [creep_strain_Y](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/creep_strain_Y.md): +- [creep_strain_Y](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/creep_strain_Y.md): > Read/compute element nodal component creep strains YY normal component (11 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -- [creep_strain_YZ](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/creep_strain_YZ.md): +- [creep_strain_YZ](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/creep_strain_YZ.md): > Read/compute element nodal component creep strains YZ shear component (12 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -- [creep_strain_Z](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/creep_strain_Z.md): +- [creep_strain_Z](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/creep_strain_Z.md): > Read/compute element nodal component creep strains ZZ normal component (22 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -- [creep_strain_eqv](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/creep_strain_eqv.md): +- [creep_strain_eqv](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/creep_strain_eqv.md): > Read/compute element nodal equivalent component creep strains by calling the readers defined by the datasources. > - The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. > - Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: @@ -3032,27 +3304,27 @@ The following table shows which components have updates in each category. > | 13 | Pretension | > -- [creep_strain_intensity](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/creep_strain_intensity.md): +- [creep_strain_intensity](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/creep_strain_intensity.md): > Reads/computes element nodal component creep strains, average it on nodes (by default) and computes its invariants. > This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. -- [creep_strain_max_shear](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/creep_strain_max_shear.md): +- [creep_strain_max_shear](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/creep_strain_max_shear.md): > Reads/computes element nodal component creep strains, average it on nodes (by default) and computes its invariants. > This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. -- [creep_strain_principal_1](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/creep_strain_principal_1.md): +- [creep_strain_principal_1](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/creep_strain_principal_1.md): > Read/compute element nodal component creep strains 1st principal component by calling the readers defined by the datasources and computing its eigen values. > This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. -- [creep_strain_principal_2](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/creep_strain_principal_2.md): +- [creep_strain_principal_2](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/creep_strain_principal_2.md): > Read/compute element nodal component creep strains 2nd principal component by calling the readers defined by the datasources and computing its eigen values. > This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. -- [creep_strain_principal_3](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/creep_strain_principal_3.md): +- [creep_strain_principal_3](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/creep_strain_principal_3.md): > Read/compute element nodal component creep strains 3rd principal component by calling the readers defined by the datasources and computing its eigen values. > This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. -- [element_nodal_heat](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/element_nodal_heat.md): +- [element_nodal_heat](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/element_nodal_heat.md): > Read/compute element nodal heat by calling the readers defined by the datasources. > - The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. > - Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: @@ -3086,7 +3358,7 @@ The following table shows which components have updates in each category. > | 13 | Pretension | > element_nodal_heat fields contain STATIC and DAMPING forces stored as components (when available). STATIC: component 0. DAMPING: component 1. -- [element_nodal_moments](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/element_nodal_moments.md): +- [element_nodal_moments](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/element_nodal_moments.md): > Read/compute element nodal moments by calling the readers defined by the datasources. > - The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location. > - Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is: @@ -3120,175 +3392,169 @@ The following table shows which components have updates in each category. > | 13 | Pretension | > element_nodal_moments fields contain STATIC, DAMPING and INERTIA forces stored as components (when available). STATIC: components 0 -> 2. DAMPING: components 3 -> 5. INERTIA components 6 -> 8 -- [emissivity](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/emissivity.md): +- [emissivity](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/emissivity.md): > Read/compute emissivity by calling the readers defined by the datasources. -- [emitted_radiation_heat_flux](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/emitted_radiation_heat_flux.md): +- [emitted_radiation_heat_flux](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/emitted_radiation_heat_flux.md): > Read/compute emitted radiation heat flux by calling the readers defined by the datasources. -- [enclosure_number](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/enclosure_number.md): +- [enclosure_number](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/enclosure_number.md): > Read/compute enclosure number by calling the readers defined by the datasources. -- [film_coefficient](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/film_coefficient.md): +- [film_coefficient](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/film_coefficient.md): > Read/compute film coefficient by calling the readers defined by the datasources. -- [flow_rate](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/flow_rate.md): +- [flow_rate](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/flow_rate.md): > Read/compute flow rate by calling the readers defined by the datasources. -- [fluid_velocity](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/fluid_velocity.md): +- [fluid_velocity](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/fluid_velocity.md): > Read/compute FV by calling the readers defined by the datasources. -- [gasket_total_closure](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/gasket_total_closure.md): +- [gasket_total_closure](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/gasket_total_closure.md): > computes the gasket total closure (sum of gasket thermal closure and gasket inelastic closure). -- [gasket_total_closure_X](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/gasket_total_closure_X.md): +- [gasket_total_closure_X](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/gasket_total_closure_X.md): > Read/compute elemental gasket total closure XX normal component (00 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -- [gasket_total_closure_XY](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/gasket_total_closure_XY.md): +- [gasket_total_closure_XY](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/gasket_total_closure_XY.md): > Read/compute elemental gasket total closure XY shear component (01 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -- [gasket_total_closure_XZ](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/gasket_total_closure_XZ.md): +- [gasket_total_closure_XZ](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/gasket_total_closure_XZ.md): > Read/compute elemental gasket total closure XZ shear component (02 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -- [heat_conductivity_rate](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/heat_conductivity_rate.md): +- [global_to_nodal](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/global_to_nodal.md): + > Rotate results from global coordinate system to local coordinate system. + +- [heat_conductivity_rate](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/heat_conductivity_rate.md): > Read/compute heat conductivity rate by calling the readers defined by the datasources. -- [heat_transport_rate](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/heat_transport_rate.md): +- [heat_transport_rate](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/heat_transport_rate.md): > Read/compute heat transport rate by calling the readers defined by the datasources. -- [incident_radiation_heat_flux](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/incident_radiation_heat_flux.md): +- [incident_radiation_heat_flux](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/incident_radiation_heat_flux.md): > Read/compute incident radiation heat flux by calling the readers defined by the datasources. -- [input_sound_power](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/input_sound_power.md): +- [input_sound_power](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/input_sound_power.md): > Read/compute PINC by calling the readers defined by the datasources. -- [layer_orientation_provider](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/layer_orientation_provider.md): +- [layer_orientation_provider](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/layer_orientation_provider.md): > Read the layer orientations. -- [modal_acceleration](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/modal_acceleration.md): +- [modal_acceleration](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/modal_acceleration.md): > Read/compute modal acceleration by calling the readers defined by the datasources. -- [modal_coordinate](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/modal_coordinate.md): +- [modal_coordinate](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/modal_coordinate.md): > Read/compute modal coordinate by calling the readers defined by the datasources. -- [modal_velocity](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/modal_velocity.md): +- [modal_velocity](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/modal_velocity.md): > Read/compute modal velocity by calling the readers defined by the datasources. -- [net_radiation_heat_flux](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/net_radiation_heat_flux.md): +- [net_radiation_heat_flux](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/net_radiation_heat_flux.md): > Read/compute net radiation heat flux by calling the readers defined by the datasources. -- [nodal_rotation](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/nodal_rotation.md): +- [nodal_rotation](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/nodal_rotation.md): > Read/compute nodal rotation by calling the readers defined by the datasources. -- [nodal_rotation_X](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/nodal_rotation_X.md): +- [nodal_rotation_X](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/nodal_rotation_X.md): > Read/compute nodal rotation X component of the vector (1st component) by calling the readers defined by the datasources. -- [nodal_rotation_Y](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/nodal_rotation_Y.md): +- [nodal_rotation_Y](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/nodal_rotation_Y.md): > Read/compute nodal rotation Y component of the vector (2nd component) by calling the readers defined by the datasources. -- [nodal_rotation_Z](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/nodal_rotation_Z.md): +- [nodal_rotation_Z](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/nodal_rotation_Z.md): > Read/compute nodal rotation Z component of the vector (3rd component) by calling the readers defined by the datasources. -- [nodal_rotational_acceleration](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/nodal_rotational_acceleration.md): +- [nodal_rotational_acceleration](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/nodal_rotational_acceleration.md): > Read/compute nodal rotational acceleration by calling the readers defined by the datasources. -- [nodal_rotational_acceleration_X](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/nodal_rotational_acceleration_X.md): +- [nodal_rotational_acceleration_X](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/nodal_rotational_acceleration_X.md): > Read/compute nodal rotational acceleration X component of the vector (1st component) by calling the readers defined by the datasources. -- [nodal_rotational_acceleration_Y](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/nodal_rotational_acceleration_Y.md): +- [nodal_rotational_acceleration_Y](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/nodal_rotational_acceleration_Y.md): > Read/compute nodal rotational acceleration Y component of the vector (2nd component) by calling the readers defined by the datasources. -- [nodal_rotational_acceleration_Z](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/nodal_rotational_acceleration_Z.md): +- [nodal_rotational_acceleration_Z](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/nodal_rotational_acceleration_Z.md): > Read/compute nodal rotational acceleration Z component of the vector (3rd component) by calling the readers defined by the datasources. -- [nodal_rotational_velocity](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/nodal_rotational_velocity.md): +- [nodal_rotational_velocity](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/nodal_rotational_velocity.md): > Read/compute nodal rotational velocity by calling the readers defined by the datasources. -- [nodal_rotational_velocity_X](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/nodal_rotational_velocity_X.md): +- [nodal_rotational_velocity_X](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/nodal_rotational_velocity_X.md): > Read/compute nodal rotational velocity X component of the vector (1st component) by calling the readers defined by the datasources. -- [nodal_rotational_velocity_Y](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/nodal_rotational_velocity_Y.md): +- [nodal_rotational_velocity_Y](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/nodal_rotational_velocity_Y.md): > Read/compute nodal rotational velocity Y component of the vector (2nd component) by calling the readers defined by the datasources. -- [nodal_rotational_velocity_Z](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/nodal_rotational_velocity_Z.md): +- [nodal_rotational_velocity_Z](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/nodal_rotational_velocity_Z.md): > Read/compute nodal rotational velocity Z component of the vector (3rd component) by calling the readers defined by the datasources. -- [node_orientations](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/node_orientations.md): +- [node_orientations](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/node_orientations.md): > Read/compute node euler angles by calling the readers defined by the datasources. -- [node_orientations_X](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/node_orientations_X.md): +- [node_orientations_X](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/node_orientations_X.md): > Read/compute node euler angles X component of the vector (1st component) by calling the readers defined by the datasources. -- [node_orientations_Y](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/node_orientations_Y.md): +- [node_orientations_Y](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/node_orientations_Y.md): > Read/compute node euler angles Y component of the vector (2nd component) by calling the readers defined by the datasources. -- [node_orientations_Z](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/node_orientations_Z.md): +- [node_orientations_Z](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/node_orientations_Z.md): > Read/compute node euler angles Z component of the vector (3rd component) by calling the readers defined by the datasources. -- [nusselt_number](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/nusselt_number.md): +- [nusselt_number](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/nusselt_number.md): > Read/compute nusselt number by calling the readers defined by the datasources. -- [output_sound_power](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/output_sound_power.md): +- [output_sound_power](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/output_sound_power.md): > Read/compute POUT by calling the readers defined by the datasources. -- [prandtl_number](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/prandtl_number.md): +- [prandtl_number](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/prandtl_number.md): > Read/compute prandtl number by calling the readers defined by the datasources. -- [radiation_area](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/radiation_area.md): +- [radiation_area](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/radiation_area.md): > Read/compute radiation area by calling the readers defined by the datasources. -- [raw_acceleration](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/raw_acceleration.md): +- [raw_acceleration](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/raw_acceleration.md): > Read/compute A vector from the finite element problem MA+CV+KU=F by calling the readers defined by the datasources. -- [raw_velocity](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/raw_velocity.md): +- [raw_velocity](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/raw_velocity.md): > Read/compute V vector from the finite element problem MA+CV+KU=F by calling the readers defined by the datasources. -- [reaction_heat](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/reaction_heat.md): +- [reaction_heat](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/reaction_heat.md): > Read/compute nodal reaction heat by calling the readers defined by the datasources. -- [reaction_moment](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/reaction_moment.md): +- [reaction_moment](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/reaction_moment.md): > Read/compute nodal reaction moments by calling the readers defined by the datasources. -- [reaction_moment_X](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/reaction_moment_X.md): +- [reaction_moment_X](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/reaction_moment_X.md): > Read/compute nodal reaction moments X component of the vector (1st component) by calling the readers defined by the datasources. -- [reaction_moment_Y](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/reaction_moment_Y.md): +- [reaction_moment_Y](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/reaction_moment_Y.md): > Read/compute nodal reaction moments Y component of the vector (2nd component) by calling the readers defined by the datasources. -- [reaction_moment_Z](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/reaction_moment_Z.md): +- [reaction_moment_Z](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/reaction_moment_Z.md): > Read/compute nodal reaction moments Z component of the vector (3rd component) by calling the readers defined by the datasources. -- [record_reader](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/record_reader.md): - > Extracts a record from a file. - -- [reflected_radiation_heat_flux](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/reflected_radiation_heat_flux.md): +- [reflected_radiation_heat_flux](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/reflected_radiation_heat_flux.md): > Read/compute reflected radiation heat flux by calling the readers defined by the datasources. -- [reynolds_number](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/reynolds_number.md): +- [reynolds_number](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/reynolds_number.md): > Read/compute reynolds number by calling the readers defined by the datasources. -- [squared_l2norm_pressure](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/squared_l2norm_pressure.md): +- [squared_l2norm_pressure](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/squared_l2norm_pressure.md): > Read/compute Square of the L2 norm of pressure over element volume by calling the readers defined by the datasources. -- [view_factor_sum](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/view_factor_sum.md): +- [view_factor_sum](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/view_factor_sum.md): > Read/compute view factor sum by calling the readers defined by the datasources. #### scoping -- [extend_midside_nodal_scoping](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/scoping/extend_midside_nodal_scoping.md): +- [extend_midside_nodal_scoping](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/scoping/extend_midside_nodal_scoping.md): > Extends the input nodal scoping with the neighbor corner nodes of every midside node in the input. For each midside node in the scoping, the two corner nodes that bound it on the element edge are added to the output scoping. -#### serialization - -- [export_mesh_with_prime](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/serialization/export_mesh_with_prime.md): - > Transfer DPF's meshed region into an external layer prime model and serialize it into a given file format. - - #### utility -- [concatenate_fields](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/concatenate_fields.md): +- [concatenate_fields](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/concatenate_fields.md): > Concatenates fields into a unique one by incrementing the number of components. > > Example: @@ -3296,7 +3562,7 @@ The following table shows which components have updates in each category. > - Field2 components: { RX, RY, RZ } > - Output field : { UX, UY, UZ, RX, RY, RZ } -- [concatenate_fields_containers](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/concatenate_fields_containers.md): +- [concatenate_fields_containers](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/concatenate_fields_containers.md): > Concatenates fields containers into a unique one by concatenating each of their fields. > > Example: @@ -3310,19 +3576,34 @@ The following table shows which components have updates in each category. > - Field1 with components: { UX, UY, UZ, RX, RY, RZ } > - Field2 with components: { VX, VY, VZ, AX, AY, AZ } -- [customtypefield_get_attribute](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/customtypefield_get_attribute.md): +- [csharp_generator](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/csharp_generator.md): + > + > Generates a C# wrapper file (.cs) containing a class for each public operator + > found in a loaded plugin DLL. + > The DLL is loaded using the given `load_symbol` and `library_key`. + > All non-private operators discovered in the plugin are written to the single + > file at `output_path`. + > + > > **Note:** Operators whose exposure property is set to `private` are silently + > > excluded from the generated output. + > + > Inputs & outputs of each operator are represented as typed `LinkableInput` + > and `LinkableOutput` properties on the generated class. + > + +- [customtypefield_get_attribute](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/customtypefield_get_attribute.md): > Gets a property from an input field/field container. A CustomTypeFieldin pin 0, a property name (string) in pin 1 are expected as inputs -- [cyclic_support_get_attribute](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/cyclic_support_get_attribute.md): +- [cyclic_support_get_attribute](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/cyclic_support_get_attribute.md): > A CyclicSupport in pin 0 and a property name (string) in pin 1 are expected in input. -- [get_operators](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/get_operators.md): +- [get_operators](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/get_operators.md): > Getter on operators inside a workflow. -- [operator_changelog](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/operator_changelog.md): +- [operator_changelog](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/operator_changelog.md): > Return a GenericDataContainer used to instantiate the Changelog of an operator based on its name. -- [propertyfield_get_attribute](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/propertyfield_get_attribute.md): +- [propertyfield_get_attribute](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/propertyfield_get_attribute.md): > Gets a property from an input field/field container. A PropertyFieldin pin 0, a property name (string) in pin 1 are expected as inputs @@ -3331,7 +3612,7 @@ The following table shows which components have updates in each category. #### averaging -- [elemental_difference](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/elemental_difference.md) +- [elemental_difference](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/elemental_difference.md) > 0.0.1: Internal refactoring to use Scoping Iterators. @@ -3342,27 +3623,27 @@ The following table shows which components have updates in each category. > 0.0.4: Fix shell layer metadata when computing elemental difference from nodal input. -- [elemental_difference_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/elemental_difference_fc.md) +- [elemental_difference_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/elemental_difference_fc.md) > 0.0.1: Fix exception type preservation during parallel execution. -- [elemental_fraction_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/elemental_fraction_fc.md) +- [elemental_fraction_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/elemental_fraction_fc.md) > 0.0.1: Fix exception type preservation during parallel execution. -- [elemental_mean](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/elemental_mean.md) +- [elemental_mean](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/elemental_mean.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [elemental_mean_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/elemental_mean_fc.md) +- [elemental_mean_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/elemental_mean_fc.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [elemental_nodal_to_nodal](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/elemental_nodal_to_nodal.md) +- [elemental_nodal_to_nodal](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/elemental_nodal_to_nodal.md) > 0.0.1: Fixed issue with semiparabolic elements. @@ -3373,17 +3654,17 @@ The following table shows which components have updates in each category. > 0.0.4: Internal refactoring to use Scoping Iterators. -- [elemental_nodal_to_nodal_elemental](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/elemental_nodal_to_nodal_elemental.md) +- [elemental_nodal_to_nodal_elemental](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/elemental_nodal_to_nodal_elemental.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [elemental_nodal_to_nodal_elemental_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/elemental_nodal_to_nodal_elemental_fc.md) +- [elemental_nodal_to_nodal_elemental_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/elemental_nodal_to_nodal_elemental_fc.md) > 0.0.1: Fix exception type preservation during parallel execution. -- [elemental_nodal_to_nodal_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/elemental_nodal_to_nodal_fc.md) +- [elemental_nodal_to_nodal_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/elemental_nodal_to_nodal_fc.md) > 0.0.1: Fixed issue with semiparabolic elements. @@ -3396,24 +3677,24 @@ The following table shows which components have updates in each category. > 0.0.5: Fix exception type preservation during parallel execution. -- [elemental_to_elemental_nodal](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/elemental_to_elemental_nodal.md) +- [elemental_to_elemental_nodal](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/elemental_to_elemental_nodal.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [elemental_to_elemental_nodal_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/elemental_to_elemental_nodal_fc.md) +- [elemental_to_elemental_nodal_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/elemental_to_elemental_nodal_fc.md) > 0.0.1: Fix exception type preservation during parallel execution. -- [elemental_to_nodal](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/elemental_to_nodal.md) +- [elemental_to_nodal](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/elemental_to_nodal.md) > 0.0.1: Internal refactoring to use Scoping Iterators. > 0.0.2: Fix division by zero in face-based FVM averaging. -- [elemental_to_nodal_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/elemental_to_nodal_fc.md) +- [elemental_to_nodal_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/elemental_to_nodal_fc.md) > 0.0.1: Fixed shell management issue. @@ -3422,12 +3703,12 @@ The following table shows which components have updates in each category. > 0.0.3: Fix exception type preservation during parallel execution. -- [extend_to_mid_nodes_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/extend_to_mid_nodes_fc.md) +- [extend_to_mid_nodes_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/extend_to_mid_nodes_fc.md) > 0.0.1: Fix exception type preservation during parallel execution. -- [force_summation](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/force_summation.md) +- [force_summation](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/force_summation.md) > 0.1.0: Scopings container supported on pins 1 and 2. Fields container supported on pin 6. @@ -3439,8 +3720,10 @@ The following table shows which components have updates in each category. > 1.0.2: Internal refactoring to remove usage of deprecated pin 200 of ENF + > 2.0.0: Addition of support for cyclic expansion with associated input pins. + -- [force_summation_psd](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/force_summation_psd.md) +- [force_summation_psd](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/force_summation_psd.md) > 0.1.0: Scopings container supported on pins 1 and 2. Fields container supported on pin 6. @@ -3449,39 +3732,39 @@ The following table shows which components have updates in each category. > 1.0.0: The moment unit is now kept from the input units and not converted to N*m. -- [gauss_to_node_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/gauss_to_node_fc.md) +- [gauss_to_node_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/gauss_to_node_fc.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [nodal_difference](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/nodal_difference.md) +- [nodal_difference](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/nodal_difference.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [nodal_difference_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/nodal_difference_fc.md) +- [nodal_difference_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/nodal_difference_fc.md) > 0.0.1: Fix exception type preservation during parallel execution. -- [nodal_fraction_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/nodal_fraction_fc.md) +- [nodal_fraction_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/nodal_fraction_fc.md) > 0.0.1: Internal refactoring to use Scoping Iterators. > 0.0.2: Fix exception type preservation during parallel execution. -- [nodal_to_elemental](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/nodal_to_elemental.md) +- [nodal_to_elemental](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/nodal_to_elemental.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [nodal_to_elemental_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/nodal_to_elemental_fc.md) +- [nodal_to_elemental_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/nodal_to_elemental_fc.md) > 0.0.1: Fix exception type preservation during parallel execution. -- [nodal_to_elemental_nodal](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/nodal_to_elemental_nodal.md) +- [nodal_to_elemental_nodal](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/nodal_to_elemental_nodal.md) > 0.0.1: Fixed issue with resize output field. @@ -3490,7 +3773,7 @@ The following table shows which components have updates in each category. > 0.1.1: Internal refactoring to use Scoping Iterators. -- [nodal_to_elemental_nodal_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/nodal_to_elemental_nodal_fc.md) +- [nodal_to_elemental_nodal_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/nodal_to_elemental_nodal_fc.md) > 0.0.1: Fixed issue with resize output fields. @@ -3501,12 +3784,20 @@ The following table shows which components have updates in each category. > 0.1.2: Fix exception type preservation during parallel execution. -- [to_nodal](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/to_nodal.md) +- [to_nodal](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/to_nodal.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [to_nodal_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/averaging/to_nodal_fc.md) +- [to_nodal_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/averaging/to_nodal_fc.md) + + > 0.0.1: Internal refactoring to use Scoping Iterators. + + + +#### compression + +- [kmeans_clustering](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/compression/kmeans_clustering.md) > 0.0.1: Internal refactoring to use Scoping Iterators. @@ -3514,107 +3805,107 @@ The following table shows which components have updates in each category. #### filter -- [abc_weightings](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/abc_weightings.md) +- [abc_weightings](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/filter/abc_weightings.md) > 0.0.1: Fixed bug in frequency calculation with multiple rpms in the support. -- [field_band_pass](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/field_band_pass.md) +- [field_band_pass](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/filter/field_band_pass.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [field_band_pass_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/field_band_pass_fc.md) +- [field_band_pass_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/filter/field_band_pass_fc.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [field_high_pass](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/field_high_pass.md) +- [field_high_pass](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/filter/field_high_pass.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [field_high_pass_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/field_high_pass_fc.md) +- [field_high_pass_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/filter/field_high_pass_fc.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [field_low_pass](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/field_low_pass.md) +- [field_low_pass](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/filter/field_low_pass.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [field_low_pass_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/field_low_pass_fc.md) +- [field_low_pass_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/filter/field_low_pass_fc.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [field_signed_high_pass](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/field_signed_high_pass.md) +- [field_signed_high_pass](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/filter/field_signed_high_pass.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [field_signed_high_pass_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/field_signed_high_pass_fc.md) +- [field_signed_high_pass_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/filter/field_signed_high_pass_fc.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [scoping_band_pass](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/scoping_band_pass.md) +- [scoping_band_pass](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/filter/scoping_band_pass.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [scoping_high_pass](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/scoping_high_pass.md) +- [scoping_high_pass](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/filter/scoping_high_pass.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [scoping_low_pass](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/scoping_low_pass.md) +- [scoping_low_pass](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/filter/scoping_low_pass.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [scoping_signed_high_pass](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/scoping_signed_high_pass.md) +- [scoping_signed_high_pass](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/filter/scoping_signed_high_pass.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [timefreq_band_pass](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/timefreq_band_pass.md) +- [timefreq_band_pass](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/filter/timefreq_band_pass.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [timefreq_high_pass](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/timefreq_high_pass.md) +- [timefreq_high_pass](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/filter/timefreq_high_pass.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [timefreq_low_pass](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/timefreq_low_pass.md) +- [timefreq_low_pass](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/filter/timefreq_low_pass.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [timefreq_signed_high_pass](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/timefreq_signed_high_pass.md) +- [timefreq_signed_high_pass](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/filter/timefreq_signed_high_pass.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [timescoping_band_pass](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/timescoping_band_pass.md) +- [timescoping_band_pass](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/filter/timescoping_band_pass.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [timescoping_high_pass](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/timescoping_high_pass.md) +- [timescoping_high_pass](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/filter/timescoping_high_pass.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [timescoping_low_pass](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/timescoping_low_pass.md) +- [timescoping_low_pass](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/filter/timescoping_low_pass.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [timescoping_signed_high_pass](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/timescoping_signed_high_pass.md) +- [timescoping_signed_high_pass](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/filter/timescoping_signed_high_pass.md) > 0.0.1: Internal refactoring to use Scoping Iterators. @@ -3622,59 +3913,59 @@ The following table shows which components have updates in each category. #### geo -- [cartesian_to_spherical](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/geo/cartesian_to_spherical.md) +- [cartesian_to_spherical](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/geo/cartesian_to_spherical.md) > 0.0.1: Fix exception type preservation during parallel execution. -- [cartesian_to_spherical_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/geo/cartesian_to_spherical_fc.md) +- [cartesian_to_spherical_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/geo/cartesian_to_spherical_fc.md) > 0.0.1: Fix exception type preservation during parallel execution. -- [element_nodal_contribution](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/geo/element_nodal_contribution.md) +- [element_nodal_contribution](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/geo/element_nodal_contribution.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [elements_facets_surfaces_over_time](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/geo/elements_facets_surfaces_over_time.md) +- [elements_facets_surfaces_over_time](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/geo/elements_facets_surfaces_over_time.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [elements_volume](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/geo/elements_volume.md) +- [elements_volume](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/geo/elements_volume.md) > 0.0.1: Internal refactoring to use Scoping Iterators. > 0.0.2: Fix exception type preservation during parallel execution. -- [elements_volumes_over_time](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/geo/elements_volumes_over_time.md) +- [elements_volumes_over_time](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/geo/elements_volumes_over_time.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [faces_area](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/geo/faces_area.md) +- [faces_area](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/geo/faces_area.md) > 0.0.1: Fix exception type preservation during parallel execution. -- [gauss_to_node](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/geo/gauss_to_node.md) +- [gauss_to_node](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/geo/gauss_to_node.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [integrate_over_elements](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/geo/integrate_over_elements.md) +- [integrate_over_elements](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/geo/integrate_over_elements.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [normals](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/geo/normals.md) +- [normals](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/geo/normals.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [normals_provider_nl](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/geo/normals_provider_nl.md) +- [normals_provider_nl](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/geo/normals_provider_nl.md) > 0.0.1: Bug fixed for input mesh type containing solid elements. @@ -3683,12 +3974,12 @@ The following table shows which components have updates in each category. > 1.0.1: Internal refactoring to use Scoping Iterators. -- [rotate_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/geo/rotate_fc.md) +- [rotate_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/geo/rotate_fc.md) > 0.0.1: Fix exception type preservation during parallel execution. -- [rotate_in_cylindrical_cs](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/geo/rotate_in_cylindrical_cs.md) +- [rotate_in_cylindrical_cs](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/geo/rotate_in_cylindrical_cs.md) > 1.0.0: Fix bug for the rotation of strain fields with a cylindrical system whose axis is rotated. @@ -3697,22 +3988,22 @@ The following table shows which components have updates in each category. > 1.0.2: Fix exception type preservation during parallel execution. -- [rotate_in_cylindrical_cs_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/geo/rotate_in_cylindrical_cs_fc.md) +- [rotate_in_cylindrical_cs_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/geo/rotate_in_cylindrical_cs_fc.md) > 0.0.1: Fix exception type preservation during parallel execution. -- [spherical_to_cartesian](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/geo/spherical_to_cartesian.md) +- [spherical_to_cartesian](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/geo/spherical_to_cartesian.md) > 0.0.1: Fix exception type preservation during parallel execution. -- [spherical_to_cartesian_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/geo/spherical_to_cartesian_fc.md) +- [spherical_to_cartesian_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/geo/spherical_to_cartesian_fc.md) > 0.0.1: Fix exception type preservation during parallel execution. -- [to_polar_coordinates](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/geo/to_polar_coordinates.md) +- [to_polar_coordinates](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/geo/to_polar_coordinates.md) > 0.0.1: Fix exception type preservation during parallel execution. @@ -3720,29 +4011,29 @@ The following table shows which components have updates in each category. #### invariant -- [eigen_values_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/invariant/eigen_values_fc.md) +- [eigen_values_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/invariant/eigen_values_fc.md) > 0.0.1: Fix exception type preservation during parallel execution. -- [invariants](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/invariant/invariants.md) +- [invariants](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/invariant/invariants.md) > 0.1.0: Add input and output pins to control the principal stress output. -- [invariants_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/invariant/invariants_fc.md) +- [invariants_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/invariant/invariants_fc.md) > 0.1.0: Add input and output pins to control the principal stress output. > 0.1.1: Fix exception type preservation during parallel execution. -- [segalman_von_mises_eqv_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/invariant/segalman_von_mises_eqv_fc.md) +- [segalman_von_mises_eqv_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/invariant/segalman_von_mises_eqv_fc.md) > 0.0.1: Fix exception type preservation during parallel execution. -- [von_mises_eqv](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/invariant/von_mises_eqv.md) +- [von_mises_eqv](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/invariant/von_mises_eqv.md) > 0.0.1: Fix exception type preservation during parallel execution. @@ -3750,27 +4041,27 @@ The following table shows which components have updates in each category. #### logic -- [ascending_sort](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/logic/ascending_sort.md) +- [ascending_sort](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/logic/ascending_sort.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [ascending_sort_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/logic/ascending_sort_fc.md) +- [ascending_sort_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/logic/ascending_sort_fc.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [descending_sort](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/logic/descending_sort.md) +- [descending_sort](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/logic/descending_sort.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [descending_sort_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/logic/descending_sort_fc.md) +- [descending_sort_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/logic/descending_sort_fc.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [elementary_data_selector](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/logic/elementary_data_selector.md) +- [elementary_data_selector](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/logic/elementary_data_selector.md) > 0.1.0: fix of crash when input field data pointer is empty, the operator will output an empty field in this case moving forward. @@ -3779,17 +4070,17 @@ The following table shows which components have updates in each category. > 0.2.1: Internal refactoring to use Scoping Iterators. -- [identical_meshes](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/logic/identical_meshes.md) +- [identical_meshes](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/logic/identical_meshes.md) > 0.0.1: Support comparing the node to element connectivity. -- [identical_property_fields](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/logic/identical_property_fields.md) +- [identical_property_fields](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/logic/identical_property_fields.md) > 0.0.1: Add the order_independent input pin. -- [solid_shell_fields](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/logic/solid_shell_fields.md) +- [solid_shell_fields](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/logic/solid_shell_fields.md) > 0.0.1: Input Fields Containers can contain empty fields. @@ -3797,7 +4088,7 @@ The following table shows which components have updates in each category. #### mapping -- [find_reduced_coordinates](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/find_reduced_coordinates.md) +- [find_reduced_coordinates](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mapping/find_reduced_coordinates.md) > 0.1.0: Fix bug with interpolation points at corner nodes. @@ -3806,7 +4097,7 @@ The following table shows which components have updates in each category. > 0.1.2: Internal refactoring to use Scoping Iterators. -- [on_coordinates](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/on_coordinates.md) +- [on_coordinates](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mapping/on_coordinates.md) > 0.1.0: Performance improvement. @@ -3817,24 +4108,24 @@ The following table shows which components have updates in each category. > 0.3.1: Update the operator and pin descriptions. -- [on_reduced_coordinates](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/on_reduced_coordinates.md) +- [on_reduced_coordinates](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mapping/on_reduced_coordinates.md) > 0.0.1: Update the operator and pin descriptions. > 0.0.2: Internal refactoring to use Scoping Iterators. -- [prepare_mapping_workflow](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/prepare_mapping_workflow.md) +- [prepare_mapping_workflow](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mapping/prepare_mapping_workflow.md) > 0.0.1: Update the operator and pin descriptions. -- [scoping_on_coordinates](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/scoping_on_coordinates.md) +- [scoping_on_coordinates](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mapping/scoping_on_coordinates.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [solid_to_skin](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/solid_to_skin.md) +- [solid_to_skin](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mapping/solid_to_skin.md) > 0.1.0: Improving performance for Nodal locations. @@ -3858,8 +4149,12 @@ The following table shows which components have updates in each category. > 0.2.9: Fix condition check on skin element properties lookup. + > 0.2.10: Fix heap corruption in the Nodal fast-path when invoked in parallel by solid_to_skin_fc: clone the field returned by Rescope when it aliases the input field, so concurrent SetSupport calls no longer mutate a shared CField. + + > 0.2.11: Fix const-safe access to the shared properties map under parallel execution (use at() instead of operator[]). + -- [solid_to_skin_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mapping/solid_to_skin_fc.md) +- [solid_to_skin_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mapping/solid_to_skin_fc.md) > 0.1.0: Improving performance for Nodal locations. Added parallelization. @@ -3879,31 +4174,95 @@ The following table shows which components have updates in each category. > 0.2.6: Fix null pointer access when input field has no mesh support. + > 0.2.7: Fix data race on exception short-circuit flag in the parallel OMP loop by using std::atomic. + + > 0.2.8: Fix const-safe access to the shared properties map under parallel execution (use at() instead of operator[]). + #### math -- [accumulate_level_over_label_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/accumulate_level_over_label_fc.md) +- [absolute_value_by_component](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/absolute_value_by_component.md) + + > 0.0.1: Improve operator description with formula and Wikipedia link. Improve output pin description. + + +- [absolute_value_by_component_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/absolute_value_by_component_fc.md) + + > 0.0.1: Improve operator description with formula and Wikipedia link. Improve output pin description. + + +- [accumulate](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/accumulate.md) + + > 0.0.1: Improve operator description with weighted sum formula. Improve pin 2 and output pin descriptions. + + +- [accumulate_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/accumulate_fc.md) + + > 0.0.1: Improve operator description with weighted sum formula. Improve pin 2 and output pin descriptions. + + +- [accumulate_level_over_label_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/accumulate_level_over_label_fc.md) > 0.0.1: Fixed issue with crash due to empty label. -- [accumulate_min_over_label_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/accumulate_min_over_label_fc.md) +- [accumulate_min_over_label_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/accumulate_min_over_label_fc.md) > 0.0.1: Fixed issue with crash due to empty label. -- [accumulate_over_label_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/accumulate_over_label_fc.md) +- [accumulate_over_label_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/accumulate_over_label_fc.md) > 0.0.1: Fixed issue with crash due to empty label. -- [average_over_label_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/average_over_label_fc.md) +- [add](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/add.md) + + > 0.0.1: Improve operator description to document formula, broadcast behaviour, unit handling, and inplace option. Improve output pin description. Add entity-wise addition synonym. + + +- [add_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/add_fc.md) + + > 0.0.1: Improve operator description. Improve output pin description. Add entity-wise addition synonym. + + +- [amplitude](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/amplitude.md) + + > 0.0.1: Improve operator description. Add output pin description. Add Wikipedia link. + + +- [amplitude_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/amplitude_fc.md) + + > 0.0.1: Improve operator description with amplitude formula, fallback behaviour and Wikipedia link. Add input and output pin descriptions. + + +- [average_over_label_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/average_over_label_fc.md) > 0.0.1: Fixed issue with crash due to empty label. -- [compute_residual_and_error](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/compute_residual_and_error.md) +- [centroid](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/centroid.md) + + > 0.0.1: Improve operator description with interpolation formula, convexity criterion and Wikipedia link. Improve pin 2 and output pin descriptions. + + +- [centroid_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/centroid_fc.md) + + > 0.0.1: Improve operator description with interpolation formula, exact-match behaviour and Wikipedia link. Improve pin descriptions. + + +- [component_wise_divide](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/component_wise_divide.md) + + > 0.0.1: Improve operator description with formula and zero-denominator behaviour. Add output pin description. Add Wikipedia link. + + +- [component_wise_divide_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/component_wise_divide_fc.md) + + > 0.0.1: Improve operator description. Add output pin description. Add Wikipedia link. + + +- [compute_residual_and_error](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/compute_residual_and_error.md) > 0.1.0: Support generic labels (not only time) in the input FieldsContainer @@ -3913,110 +4272,260 @@ The following table shows which components have updates in each category. Upgraded documentation -- [entity_extractor](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/entity_extractor.md) +- [conjugate](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/conjugate.md) + + > 0.0.1: Improve operator description with conjugate formula and Wikipedia link. Add input and output pin descriptions. + + +- [cos](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/cos.md) + + > 0.0.1: Improve operator description to document unit constraints and formula. Improve input and output pin descriptions. Add Wikipedia link. + + +- [cos_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/cos_fc.md) + + > 0.0.1: Improve operator description to document unit constraints and formula. Improve input and output pin descriptions. Add Wikipedia link. + + +- [cplx_derive](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/cplx_derive.md) + + > 0.0.1: Improve operator description with frequency-domain derivation formula and Wikipedia link. Add input and output pin descriptions. + + +- [cplx_divide](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/cplx_divide.md) + + > 0.0.1: Improve operator description with complex division formula, zero-denominator error and Wikipedia link. Improve pin and output pin descriptions. + + +- [cplx_dot](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/cplx_dot.md) + + > 0.0.1: Improve operator description with Hermitian inner product formula and Wikipedia link. + + +- [cplx_multiply](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/cplx_multiply.md) + + > 0.0.1: Improve operator description with complex multiplication formula and Wikipedia link. Add output pin description. + + +- [entity_extractor](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/entity_extractor.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [expansion_psd](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/expansion_psd.md) +- [exponential](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/exponential.md) - > 0.0.1: Fix handling of empty fields in mode shapes. + > 0.0.1: Improve operator description with formula and dimensionless constraint. Improve input and output pin descriptions. Add Wikipedia link. -- [fft_approx](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/fft_approx.md) +- [exponential_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/exponential_fc.md) - > 0.0.1: Fix exception type preservation during parallel execution. + > 0.0.1: Improve operator description with formula and dimensionless constraint. Improve input and output pin descriptions. Add Wikipedia link. + + +- [generalized_inner_product](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/generalized_inner_product.md) + + > 0.0.1: Improve operator description with Wikipedia links and dispatch table. Add missing optional input pin 2 (mesh) for elemental-nodal/nodal dot product. Improve output pin description. + + +- [generalized_inner_product_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/generalized_inner_product_fc.md) + + > 0.0.1: Improve operator description with Wikipedia links and dispatch table. Add missing optional input pin 2 (mesh) for elemental-nodal/nodal dot product. Improve output pin description. + + +- [img_part](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/img_part.md) + + > 0.0.1: Improve operator description. Add input and output pin descriptions. + + +- [kronecker_prod](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/kronecker_prod.md) + + > 0.0.1: Improve operator description with Kronecker product formula and Wikipedia link. Add output pin description. + + +- [linear_combination](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/linear_combination.md) + > 0.0.1: Improve operator description with LaTeX formula and Wikipedia link. Improve pin 0, 3, 4 and output pin descriptions. -- [mac](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/mac.md) + +- [ln](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/ln.md) + + > 0.0.1: Improve operator description with formula and dimensionless constraint. Improve input and output pin descriptions. Add Wikipedia link. + + +- [ln_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/ln_fc.md) + + > 0.0.1: Improve operator description with formula and dimensionless constraint. Improve input and output pin descriptions. Add Wikipedia link. + + +- [mac](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/mac.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [make_one_on_comp](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/make_one_on_comp.md) +- [make_one_on_comp](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/make_one_on_comp.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [modal_participation](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/modal_participation.md) +- [minus](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/minus.md) + + > 0.0.1: Improve operator description to document formula, broadcast behaviour, unit handling, and temperature-difference unit. Improve output pin description. Add entity-wise subtraction synonym. + + +- [minus_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/minus_fc.md) + + > 0.0.1: Improve operator description to document formula, broadcast behaviour, unit handling, and temperature-difference unit. Improve output pin description. Add entity-wise subtraction synonym. + + +- [modal_participation](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/modal_participation.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [norm_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/norm_fc.md) +- [modulus](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/modulus.md) - > 0.0.1: Fix exception type preservation during parallel execution. + > 0.0.1: Improve operator description with complex modulus formula and Wikipedia link. Add input and output pin descriptions. + + +- [norm](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/norm.md) + > 0.0.1: Improve operator description with $L_p$ norm formula and Wikipedia link. Improve pin 1 and output pin descriptions. -- [outer_product](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/outer_product.md) + +- [norm_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/norm_fc.md) + + > 0.0.1: Fix exception type preservation during parallel execution. Fix operator description accuracy: now documents $L_p$ norm (not just $L_2$). Improve pin 1 and output pin descriptions. Add Wikipedia link. + + +- [outer_product](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/outer_product.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [pow](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/pow.md) +- [phase](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/phase.md) + + > 0.0.1: Improve operator description with atan2 formula and Wikipedia link. Add output pin description. + + +- [phase_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/phase_fc.md) + + > 0.0.1: Improve operator description with atan2 formula, zero-field fallback and Wikipedia link. Add input and output pin descriptions. + + +- [polar_to_cplx](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/polar_to_cplx.md) + + > 0.0.1: Improve operator description with polar-to-rectangular conversion formulas and Wikipedia link. Add input and output pin descriptions. + + +- [pow](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/pow.md) > 0.1.0: Pin added to chose the value to set for division by zero for negative exponents -- [pow_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/pow_fc.md) +- [pow_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/pow_fc.md) > 0.1.0: Pin added to chose the value to set for division by zero for negative exponents -- [scale](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/scale.md) +- [real_part](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/real_part.md) + + > 0.0.1: Improve operator description. Add input and output pin descriptions. + + +- [scale](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/scale.md) - > 0.0.1: Fixed a segmentation fault. + > 0.0.1: Fixed a segmentation fault. Improve operator description with scalar and vector scale formulas. Fix 'scaler' typo. Add Hadamard product synonym for field-valued scale factor. -- [scale_by_field](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/scale_by_field.md) +- [scale_by_field](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/scale_by_field.md) > 0.0.1: Add support of fields with shell layers -- [scale_by_field_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/scale_by_field_fc.md) +- [scale_by_field_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/scale_by_field_fc.md) > 0.0.1: Add support of fields with shell layers -- [scale_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/scale_fc.md) +- [scale_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/scale_fc.md) - > 0.0.1: Fix exception type preservation during parallel execution. + > 0.0.1: Fix exception type preservation during parallel execution. Improve operator description with supported scale-factor types. Fix 'scaler' typo. Add Hadamard product synonym for field-valued scale factor. -- [sweeping_phase](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/sweeping_phase.md) +- [sin](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/sin.md) - > 0.0.1: Clarify the documentation. + > 0.0.1: Improve operator description to document unit constraints and formula. Add input and output pin descriptions. Add Wikipedia link. -- [sweeping_phase_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/sweeping_phase_fc.md) +- [sin_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/sin_fc.md) - > 0.0.1: Clarify the documentation. + > 0.0.1: Improve operator description to document unit constraints and formula. Add input and output pin descriptions. Add Wikipedia link. -- [time_freq_interpolation](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/time_freq_interpolation.md) +- [sqr](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/sqr.md) - > 0.0.1: Internal refactoring to use Scoping Iterators. + > 0.0.1: Improve operator description with formula and output unit. Improve output pin description. Add Wikipedia link. + + +- [sqr_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/sqr_fc.md) + + > 0.0.1: Improve operator description with formula and output unit. Improve output pin description. Add Wikipedia link. + + +- [sqrt](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/sqrt.md) + + > 0.0.1: Improve operator description with formula, non-negativity constraint, and output unit. Improve input and output pin descriptions. Add Wikipedia link. + + +- [sqrt_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/sqrt_fc.md) + + > 0.0.1: Improve operator description with formula, non-negativity constraint, and output unit. Improve input and output pin descriptions. Add Wikipedia link. + + +- [sweeping_phase](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/sweeping_phase.md) + + > 0.0.1: Improve operator description with projection formula and Wikipedia link. Improve pin 2, 4 and output pin descriptions. + + +- [sweeping_phase_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/sweeping_phase_fc.md) + + > 0.0.1: Improve operator description with projection formula and Wikipedia link. Improve pin 2, 4 and output pin descriptions. + + +- [time_freq_interpolation](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/time_freq_interpolation.md) + + > 0.0.1: Internal refactoring to use Scoping Iterators. Improve operator description with interpolation formula and Wikipedia link. Add missing output pin 1 (TimeFreqSupport). Improve pin descriptions. + + +- [unit_convert](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/unit_convert.md) + + > 0.0.1: Improve operator description to document conversion formula, mesh handling, and permissive behaviour. Improve output pin description. + + +- [unit_convert_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/math/unit_convert_fc.md) + + > 0.0.1: Improve operator description to document conversion formula and permissive behaviour. Add input pin description. Improve output pin description. #### mesh -- [change_cs](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/change_cs.md) +- [change_cs](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mesh/change_cs.md) > 0.0.1: Fix exception type preservation during parallel execution. -- [combine_levelset](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/combine_levelset.md) +- [combine_levelset](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mesh/combine_levelset.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [exclude_levelset](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/exclude_levelset.md) +- [exclude_levelset](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mesh/exclude_levelset.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [from_scoping](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/from_scoping.md) +- [from_scoping](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mesh/from_scoping.md) > 0.1.0: Improvement in the performance. @@ -4035,7 +4544,7 @@ Upgraded documentation > 0.3.1: Internal refactoring to use Scoping Iterators. -- [from_scopings](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/from_scopings.md) +- [from_scopings](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mesh/from_scopings.md) > 0.0.1: Improvement in the performance. @@ -4044,39 +4553,39 @@ Upgraded documentation > 0.1.0: Improvement in the performance for cases with non shared scoping between property fields and mesh. -- [make_plane_levelset](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/make_plane_levelset.md) +- [make_plane_levelset](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mesh/make_plane_levelset.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [make_sphere_levelset](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/make_sphere_levelset.md) +- [make_sphere_levelset](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mesh/make_sphere_levelset.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [mesh_extraction](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/mesh_extraction.md) +- [mesh_extraction](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mesh/mesh_extraction.md) > 1.0.0: Property fields associated to the mesh are rescoped on the selection and associated to the new mesh. > 1.0.1: Internal refactoring to use Scoping Iterators. -- [mesh_provider](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/mesh_provider.md) +- [mesh_provider](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mesh/mesh_provider.md) > 0.1.0: Update the effect of the permissive configuration. -- [mesh_to_graphics](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/mesh_to_graphics.md) +- [mesh_to_graphics](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mesh/mesh_to_graphics.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [mesh_to_graphics_edges](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/mesh_to_graphics_edges.md) +- [mesh_to_graphics_edges](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mesh/mesh_to_graphics_edges.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [mesh_to_pyvista](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/mesh_to_pyvista.md) +- [mesh_to_pyvista](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mesh/mesh_to_pyvista.md) > 0.0.1: Fix node ordering for face connectivity of fluid cell faces marked as reversed. @@ -4084,30 +4593,34 @@ Upgraded documentation > 0.0.3: Improve performance of mesh conversions for all types of meshes. + > 1.0.0: Add new mesh scoping input pin to allow exporting a subset of the original mesh. Add new as_modified_connectivity input pin to allow exporting connectivity in a VTK 9 compatible format without node count headers and with offsets to it. + -- [meshes_provider](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/meshes_provider.md) +- [meshes_provider](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mesh/meshes_provider.md) > 0.1.0: Update the effect of the permissive configuration. + > 0.1.1: Increased memory efficiency. + -- [points_from_coordinates](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/points_from_coordinates.md) +- [points_from_coordinates](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mesh/points_from_coordinates.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [skin](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/skin.md) +- [skin](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mesh/skin.md) > 0.0.1: Fixing issue related to share pointers of property fields and mesh. > 0.0.2: Internal change to share pointers of property fields and mesh. -- [split_fields](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/split_fields.md) +- [split_fields](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mesh/split_fields.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [split_mesh](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/split_mesh.md) +- [split_mesh](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mesh/split_mesh.md) > 0.0.1: Improvement in the performance. @@ -4116,7 +4629,7 @@ Upgraded documentation > 0.1.0: Improvement in the performance by implementing scoping_build_index_tables operator. -- [wireframe](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/mesh/wireframe.md) +- [wireframe](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/mesh/wireframe.md) > 0.1.0: Addition of optional element_restriction pin. @@ -4128,34 +4641,34 @@ Upgraded documentation #### metadata -- [boundary_condition_provider](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/metadata/boundary_condition_provider.md) +- [boundary_condition_provider](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/metadata/boundary_condition_provider.md) > 0.0.1: Improved documentation and exceptions handling. -- [cyclic_mesh_expansion](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/metadata/cyclic_mesh_expansion.md) +- [cyclic_mesh_expansion](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/metadata/cyclic_mesh_expansion.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [element_types_provider](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/metadata/element_types_provider.md) +- [element_types_provider](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/metadata/element_types_provider.md) > 0.1.0: Added the possibility to output a PropertyField. -- [integrate_over_time_freq](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/metadata/integrate_over_time_freq.md) +- [integrate_over_time_freq](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/metadata/integrate_over_time_freq.md) > 0.0.1: Internal refactoring to use Scoping Iterators. > 0.0.2: Allow to make integration even if the time freq support contains several steps (for example multiple RPM), only if the provided scoping correspond to frequencies of a unique RPM. -- [streams_provider](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/metadata/streams_provider.md) +- [streams_provider](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/metadata/streams_provider.md) > 0.1.0: Add the permissive configuration. -- [time_freq_support_get_attribute](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/metadata/time_freq_support_get_attribute.md) +- [time_freq_support_get_attribute](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/metadata/time_freq_support_get_attribute.md) > 0.1.0: Add new supported property name 'step_id_from_harmonic_index' returning an int. @@ -4165,12 +4678,17 @@ Upgraded documentation #### min_max -- [min_max_fc_inc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/min_max/min_max_fc_inc.md) +- [min_max_fc_inc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/min_max/min_max_fc_inc.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [min_max_over_time_by_entity](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/min_max/min_max_over_time_by_entity.md) +- [min_max_over_label_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/min_max/min_max_over_label_fc.md) + + > 0.0.1: Input fields with no data are now excluded from the output instead of producing zero-valued entries. + + +- [min_max_over_time_by_entity](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/min_max/min_max_over_time_by_entity.md) > 0.0.1: Internal refactoring to use Scoping Iterators. @@ -4178,534 +4696,503 @@ Upgraded documentation #### result -- [accu_eqv_creep_strain](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/accu_eqv_creep_strain.md) +- [accu_eqv_creep_strain](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/accu_eqv_creep_strain.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [accu_eqv_plastic_strain](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/accu_eqv_plastic_strain.md) +- [accu_eqv_plastic_strain](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/accu_eqv_plastic_strain.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [artificial_hourglass_energy](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/artificial_hourglass_energy.md) +- [artificial_hourglass_energy](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/artificial_hourglass_energy.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [beam_axial_force](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/beam_axial_force.md) +- [beam_axial_force](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/beam_axial_force.md) > 0.1.0: MAPDL results supported. -- [beam_axial_stress](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/beam_axial_stress.md) +- [beam_axial_stress](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/beam_axial_stress.md) > 0.1.0: MAPDL results supported. -- [beam_axial_total_strain](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/beam_axial_total_strain.md) +- [beam_axial_total_strain](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/beam_axial_total_strain.md) > 0.1.0: MAPDL results supported. -- [beam_s_bending_moment](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/beam_s_bending_moment.md) +- [beam_s_bending_moment](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/beam_s_bending_moment.md) > 0.1.0: MAPDL results supported. -- [beam_s_shear_force](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/beam_s_shear_force.md) +- [beam_s_shear_force](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/beam_s_shear_force.md) > 0.1.0: MAPDL results supported. -- [beam_t_bending_moment](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/beam_t_bending_moment.md) +- [beam_t_bending_moment](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/beam_t_bending_moment.md) > 0.1.0: MAPDL results supported. -- [beam_t_shear_force](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/beam_t_shear_force.md) +- [beam_t_shear_force](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/beam_t_shear_force.md) > 0.1.0: MAPDL results supported. -- [beam_torsional_moment](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/beam_torsional_moment.md) +- [beam_torsional_moment](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/beam_torsional_moment.md) > 0.1.0: MAPDL results supported. -- [co_energy](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/co_energy.md) +- [co_energy](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/co_energy.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [contact_fluid_penetration_pressure](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/contact_fluid_penetration_pressure.md) +- [contact_fluid_penetration_pressure](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/contact_fluid_penetration_pressure.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [contact_friction_stress](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/contact_friction_stress.md) +- [contact_friction_stress](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/contact_friction_stress.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [contact_gap_distance](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/contact_gap_distance.md) +- [contact_gap_distance](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/contact_gap_distance.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [contact_penetration](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/contact_penetration.md) +- [contact_penetration](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/contact_penetration.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [contact_pressure](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/contact_pressure.md) +- [contact_pressure](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/contact_pressure.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [contact_sliding_distance](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/contact_sliding_distance.md) +- [contact_sliding_distance](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/contact_sliding_distance.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [contact_status](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/contact_status.md) +- [contact_status](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/contact_status.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [contact_surface_heat_flux](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/contact_surface_heat_flux.md) +- [contact_surface_heat_flux](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/contact_surface_heat_flux.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [contact_total_stress](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/contact_total_stress.md) +- [contact_total_stress](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/contact_total_stress.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [coordinate_system](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/coordinate_system.md) +- [coordinate_system](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/coordinate_system.md) > 0.0.1: Output pin 0 documentation update. -- [creep_strain_energy_density](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/creep_strain_energy_density.md) +- [creep_strain_energy_density](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/creep_strain_energy_density.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [displacement](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/displacement.md) +- [displacement](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/displacement.md) > 1.0.0: Modal coordinates from RFRQ, RDSP and DSUB files can't be extracted through displacement operator anymore, user can use modal_coordinate operator instead. -- [elastic_strain](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/elastic_strain.md) +- [elastic_strain](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/elastic_strain.md) > 0.1.0: Add pin eExtendMidNodesPin to add/remove mid-nodes when averaging from ElementalNodal to Nodal. Default:True -- [elastic_strain_energy_density](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/elastic_strain_energy_density.md) +- [elastic_strain_energy_density](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/elastic_strain_energy_density.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [elastic_strain_eqv](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/elastic_strain_eqv.md) +- [elastic_strain_eqv](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/elastic_strain_eqv.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [elastic_strain_intensity](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/elastic_strain_intensity.md) +- [elastic_strain_intensity](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/elastic_strain_intensity.md) > 1.0.0: bool_rotate_to_global pin removed for server versions >25.2. An error is raised if connected. -- [elastic_strain_max_shear](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/elastic_strain_max_shear.md) +- [elastic_strain_max_shear](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/elastic_strain_max_shear.md) > 1.0.0: bool_rotate_to_global pin removed for server versions >25.2. An error is raised if connected. -- [elastic_strain_principal_1](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/elastic_strain_principal_1.md) +- [elastic_strain_principal_1](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/elastic_strain_principal_1.md) > 1.0.0: bool_rotate_to_global pin removed for server versions >25.2. An error is raised if connected. -- [elastic_strain_principal_2](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/elastic_strain_principal_2.md) +- [elastic_strain_principal_2](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/elastic_strain_principal_2.md) > 1.0.0: bool_rotate_to_global pin removed for server versions >25.2. An error is raised if connected. -- [elastic_strain_principal_3](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/elastic_strain_principal_3.md) +- [elastic_strain_principal_3](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/elastic_strain_principal_3.md) > 1.0.0: bool_rotate_to_global pin removed for server versions >25.2. An error is raised if connected. -- [electric_field](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/electric_field.md) +- [electric_field](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/electric_field.md) > 0.1.0: Add pin eExtendMidNodesPin to add/remove mid-nodes when averaging from ElementalNodal to Nodal. Default:True -- [electric_flux_density](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/electric_flux_density.md) +- [electric_flux_density](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/electric_flux_density.md) > 0.1.0: Add pin eExtendMidNodesPin to add/remove mid-nodes when averaging from ElementalNodal to Nodal. Default:True -- [electric_potential](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/electric_potential.md) +- [electric_potential](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/electric_potential.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [element_centroids](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/element_centroids.md) +- [element_centroids](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/element_centroids.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [element_nodal_forces](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/element_nodal_forces.md) +- [element_nodal_forces](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/element_nodal_forces.md) > 0.1.0: split_force_components pin deprecated. To obtain rotation and temperature dofs please use the dedicated operator (element_nodal_moments, element_nodal_heat)Use the component selector to retrieve a specific derivative order. Components 0, 1 and 2 for stiffness. Components 3, 4 and 5 for damping. Components 6, 7 and 8 for inertia. -- [element_orientations](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/element_orientations.md) +- [element_orientations](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/element_orientations.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [elemental_heat_generation](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/elemental_heat_generation.md) +- [elemental_heat_generation](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/elemental_heat_generation.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [elemental_mass](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/elemental_mass.md) +- [elemental_mass](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/elemental_mass.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [elemental_volume](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/elemental_volume.md) +- [elemental_volume](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/elemental_volume.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [equivalent_mass](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/equivalent_mass.md) +- [equivalent_mass](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/equivalent_mass.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [eqv_stress_parameter](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/eqv_stress_parameter.md) +- [eqv_stress_parameter](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/eqv_stress_parameter.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [euler_load_buckling](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/euler_load_buckling.md) +- [euler_load_buckling](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/euler_load_buckling.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [gasket_inelastic_closure](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/gasket_inelastic_closure.md) +- [gasket_inelastic_closure](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/gasket_inelastic_closure.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [gasket_stress](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/gasket_stress.md) +- [gasket_stress](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/gasket_stress.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [gasket_thermal_closure](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/gasket_thermal_closure.md) +- [gasket_thermal_closure](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/gasket_thermal_closure.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [heat_flux](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/heat_flux.md) +- [heat_flux](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/heat_flux.md) > 0.1.0: Add pin eExtendMidNodesPin to add/remove mid-nodes when averaging from ElementalNodal to Nodal. Default:True -- [hydrostatic_pressure](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/hydrostatic_pressure.md) +- [hydrostatic_pressure](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/hydrostatic_pressure.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [incremental_energy](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/incremental_energy.md) +- [incremental_energy](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/incremental_energy.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [kinetic_energy](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/kinetic_energy.md) +- [kinetic_energy](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/kinetic_energy.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. + > 2.0.0: In the case of a Modal analysis computation of cyclic expanded kinetic and strain energies from Element Nodal Forces and DOFs, rotation contributions were not accounted for. -- [magnetic_field](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/magnetic_field.md) + +- [magnetic_field](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/magnetic_field.md) > 0.1.0: Add pin eExtendMidNodesPin to add/remove mid-nodes when averaging from ElementalNodal to Nodal. Default:True -- [magnetic_flux_density](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/magnetic_flux_density.md) +- [magnetic_flux_density](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/magnetic_flux_density.md) > 0.1.0: Add pin eExtendMidNodesPin to add/remove mid-nodes when averaging from ElementalNodal to Nodal. Default:True -- [magnetic_scalar_potential](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/magnetic_scalar_potential.md) +- [magnetic_scalar_potential](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/magnetic_scalar_potential.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [magnetic_vector_potential](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/magnetic_vector_potential.md) +- [magnetic_vector_potential](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/magnetic_vector_potential.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [mapdl.global_to_nodal](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/mapdl.global_to_nodal.md) +- [members_in_bending_not_certified](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/members_in_bending_not_certified.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [mapdl.pres_to_field](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/mapdl.pres_to_field.md) - - > 0.0.1: Fix crash caused by invalid iterator when reading shell data. - - -- [mapdl_section](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/mapdl_section.md) - - > 0.0.1: Making the operator license-free. - - -- [mapdl_split_on_facet_indices](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/mapdl_split_on_facet_indices.md) - - > 0.0.1: ElementalNodal fields are now supported. - - -- [mapdl_split_to_acmo_facet_indices](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/mapdl_split_to_acmo_facet_indices.md) - - > 0.0.1: ElementalNodal fields are now supported. - - -- [members_in_bending_not_certified](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/members_in_bending_not_certified.md) +- [members_in_compression_not_certified](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/members_in_compression_not_certified.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [members_in_compression_not_certified](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/members_in_compression_not_certified.md) +- [members_in_linear_compression_bending_not_certified](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/members_in_linear_compression_bending_not_certified.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [members_in_linear_compression_bending_not_certified](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/members_in_linear_compression_bending_not_certified.md) - - > 0.0.1: Internal refactoring to use Scoping Iterators. - - -- [nmisc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/nmisc.md) +- [nmisc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/nmisc.md) > 1.0.0: num_components input pin is removed, please use the item_index pin with a vector of indexes. -- [nodal_to_global](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/nodal_to_global.md) +- [nodal_to_global](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/nodal_to_global.md) > 0.1.0: Addition of optional inverse_rotation pin. > 0.1.1: Internal refactoring to use Scoping Iterators. -- [num_surface_status_changes](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/num_surface_status_changes.md) +- [num_surface_status_changes](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/num_surface_status_changes.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [plastic_state_variable](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/plastic_state_variable.md) +- [plastic_state_variable](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/plastic_state_variable.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [plastic_strain](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/plastic_strain.md) +- [plastic_strain](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/plastic_strain.md) > 0.1.0: Add pin eExtendMidNodesPin to add/remove mid-nodes when averaging from ElementalNodal to Nodal. Default:True -- [plastic_strain_energy_density](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/plastic_strain_energy_density.md) +- [plastic_strain_energy_density](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/plastic_strain_energy_density.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [plastic_strain_eqv](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/plastic_strain_eqv.md) +- [plastic_strain_eqv](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/plastic_strain_eqv.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [plastic_strain_intensity](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/plastic_strain_intensity.md) +- [plastic_strain_intensity](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/plastic_strain_intensity.md) > 1.0.0: bool_rotate_to_global pin removed for server versions >25.2. An error is raised if connected. -- [plastic_strain_max_shear](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/plastic_strain_max_shear.md) +- [plastic_strain_max_shear](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/plastic_strain_max_shear.md) > 1.0.0: bool_rotate_to_global pin removed for server versions >25.2. An error is raised if connected. -- [plastic_strain_principal_1](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/plastic_strain_principal_1.md) +- [plastic_strain_principal_1](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/plastic_strain_principal_1.md) > 1.0.0: bool_rotate_to_global pin removed for server versions >25.2. An error is raised if connected. -- [plastic_strain_principal_2](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/plastic_strain_principal_2.md) +- [plastic_strain_principal_2](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/plastic_strain_principal_2.md) > 1.0.0: bool_rotate_to_global pin removed for server versions >25.2. An error is raised if connected. -- [plastic_strain_principal_3](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/plastic_strain_principal_3.md) +- [plastic_strain_principal_3](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/plastic_strain_principal_3.md) > 1.0.0: bool_rotate_to_global pin removed for server versions >25.2. An error is raised if connected. -- [poynting_vector_surface](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/poynting_vector_surface.md) +- [poynting_vector_surface](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/poynting_vector_surface.md) > 0.0.1: Fix bug in memory allocation for some local variables participating in interpolation at integration points. -- [pressure](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/pressure.md) +- [pressure](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/pressure.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [raw_displacement](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/raw_displacement.md) +- [raw_displacement](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/raw_displacement.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [raw_reaction_force](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/raw_reaction_force.md) +- [raw_reaction_force](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/raw_reaction_force.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [recombine_harmonic_indeces_cyclic](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/recombine_harmonic_indeces_cyclic.md) +- [recombine_harmonic_indeces_cyclic](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/recombine_harmonic_indeces_cyclic.md) > 0.1.0: Addition of is_constant pin -- [remove_rigid_body_motion](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/remove_rigid_body_motion.md) - - > 0.0.1: Replace vector of pointers with array of objects to prevent memory leaks - - -- [remove_rigid_body_motion_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/remove_rigid_body_motion_fc.md) - - > 0.0.1: Replace vector of pointers with array of objects to prevent memory leaks - - -- [result_provider](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/result_provider.md) +- [result_provider](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/result_provider.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were only performed if the requested result was a 3D vector or a symmetrical 3x3 matrix. -- [smisc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/smisc.md) +- [smisc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/smisc.md) > 1.0.0: num_components input pin is removed, please use the item_index pin with a vector of indexes. -- [state_variable](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/state_variable.md) +- [state_variable](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/state_variable.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [stiffness_matrix_energy](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/stiffness_matrix_energy.md) +- [stiffness_matrix_energy](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/stiffness_matrix_energy.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. + > 2.0.0: In the case of a Modal analysis computation of cyclic expanded kinetic and strain energies from Element Nodal Forces and DOFs, rotation contributions were not accounted for. + -- [stress](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/stress.md) +- [stress](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/stress.md) > 0.1.0: Add pin eExtendMidNodesPin to add/remove mid-nodes when averaging from ElementalNodal to Nodal. Default:True -- [stress_intensity](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/stress_intensity.md) +- [stress_intensity](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/stress_intensity.md) > 1.0.0: bool_rotate_to_global pin removed for server versions >25.2. An error is raised if connected. -- [stress_max_shear](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/stress_max_shear.md) +- [stress_max_shear](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/stress_max_shear.md) > 1.0.0: bool_rotate_to_global pin removed for server versions >25.2. An error is raised if connected. -- [stress_principal_1](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/stress_principal_1.md) +- [stress_principal_1](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/stress_principal_1.md) > 1.0.0: bool_rotate_to_global pin removed for server versions >25.2. An error is raised if connected. -- [stress_principal_2](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/stress_principal_2.md) +- [stress_principal_2](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/stress_principal_2.md) > 1.0.0: bool_rotate_to_global pin removed for server versions >25.2. An error is raised if connected. -- [stress_principal_3](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/stress_principal_3.md) +- [stress_principal_3](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/stress_principal_3.md) > 1.0.0: bool_rotate_to_global pin removed for server versions >25.2. An error is raised if connected. -- [stress_ratio](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/stress_ratio.md) +- [stress_ratio](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/stress_ratio.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [stress_von_mises](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/stress_von_mises.md) +- [stress_von_mises](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/stress_von_mises.md) > 1.0.0: bool_rotate_to_global pin removed for server versions >25.2. An error is raised if connected. -- [structural_temperature](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/structural_temperature.md) +- [structural_temperature](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/structural_temperature.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [swelling_strains](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/swelling_strains.md) +- [swelling_strains](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/swelling_strains.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [temperature](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/temperature.md) +- [temperature](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/temperature.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [temperature_grad](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/temperature_grad.md) +- [temperature_grad](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/temperature_grad.md) > 0.1.0: Add pin eExtendMidNodesPin to add/remove mid-nodes when averaging from ElementalNodal to Nodal. Default:True -- [thermal_dissipation_energy](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/thermal_dissipation_energy.md) +- [thermal_dissipation_energy](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/thermal_dissipation_energy.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [thermal_strain](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/thermal_strain.md) +- [thermal_strain](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/thermal_strain.md) > 0.1.0: Add pin eExtendMidNodesPin to add/remove mid-nodes when averaging from ElementalNodal to Nodal. Default:True -- [thermal_strain_principal_1](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/thermal_strain_principal_1.md) +- [thermal_strain_principal_1](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/thermal_strain_principal_1.md) > 1.0.0: bool_rotate_to_global pin removed for server versions >25.2. An error is raised if connected. -- [thermal_strain_principal_2](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/thermal_strain_principal_2.md) +- [thermal_strain_principal_2](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/thermal_strain_principal_2.md) > 1.0.0: bool_rotate_to_global pin removed for server versions >25.2. An error is raised if connected. -- [thermal_strain_principal_3](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/thermal_strain_principal_3.md) +- [thermal_strain_principal_3](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/thermal_strain_principal_3.md) > 1.0.0: bool_rotate_to_global pin removed for server versions >25.2. An error is raised if connected. -- [thermal_strains_eqv](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/thermal_strains_eqv.md) +- [thermal_strains_eqv](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/thermal_strains_eqv.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [thickness](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/thickness.md) +- [thickness](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/thickness.md) > 1.0.0: This operator had previously the bool_rotate_to_global pin exposed and set as True while rotations to global were not performed and results were output in the Solution Coordinate System. -- [torque](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/torque.md) +- [torque](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/torque.md) > 0.1.0: Fields container supported on pin 1. Pin 1 name changed. @@ -4714,7 +5201,7 @@ Upgraded documentation > 1.0.1: Internal refactoring to use Scoping Iterators. -- [transient_rayleigh_integration](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/result/transient_rayleigh_integration.md) +- [transient_rayleigh_integration](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/result/transient_rayleigh_integration.md) > 0.0.1: Internal refactoring to use Scoping Iterators. @@ -4722,57 +5209,67 @@ Upgraded documentation #### scoping -- [adapt_with_scopings_container](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/scoping/adapt_with_scopings_container.md) +- [adapt_with_scopings_container](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/scoping/adapt_with_scopings_container.md) > 0.0.1: Fix exception type preservation during parallel execution. + > 0.0.2: Fix issue when input FieldsContainer and ScopingsContainer don't share labels. -- [intersect](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/scoping/intersect.md) + +- [intersect](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/scoping/intersect.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [on_property](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/scoping/on_property.md) +- [on_property](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/scoping/on_property.md) > 1.0.0: Remove pin "inclusive" > 1.0.1: Internal refactoring to use Scoping Iterators. -- [reduce_sampling](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/scoping/reduce_sampling.md) +- [reduce_sampling](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/scoping/reduce_sampling.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [rescope](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/scoping/rescope.md) +- [rescope](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/scoping/rescope.md) > 0.1.0: Performance improvement. > 0.1.1: Internal refactoring to use Scoping Iterators. + > 0.1.2: Fix null pointer dereference before null check in extrapolation path. + -- [rescope_custom_type_field](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/scoping/rescope_custom_type_field.md) +- [rescope_custom_type_field](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/scoping/rescope_custom_type_field.md) > 0.1.0: Performance improvement. > 0.1.1: Internal refactoring to use Scoping Iterators. + > 0.1.2: Fix null pointer dereference before null check in extrapolation path. + -- [rescope_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/scoping/rescope_fc.md) +- [rescope_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/scoping/rescope_fc.md) > 0.1.0: Performance improvement. > 0.1.1: Internal refactoring to use Scoping Iterators. + > 0.1.2: Fix null pointer dereference before null check in extrapolation path. -- [rescope_property_field](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/scoping/rescope_property_field.md) + +- [rescope_property_field](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/scoping/rescope_property_field.md) > 0.1.0: Performance improvement. > 0.1.1: Internal refactoring to use Scoping Iterators. + > 0.1.2: Fix null pointer dereference before null check in extrapolation path. + -- [transpose](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/scoping/transpose.md) +- [transpose](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/scoping/transpose.md) > 0.1.0: Improvement of performance @@ -4786,17 +5283,44 @@ Upgraded documentation #### serialization -- [csv_to_field](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/serialization/csv_to_field.md) +- [csv_to_field](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/serialization/csv_to_field.md) > 1.0.0: Fixed issue while reading csv with multiple fields and common time id between fields. -- [field_to_csv](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/serialization/field_to_csv.md) +- [export_symbolic_workflow](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/serialization/export_symbolic_workflow.md) + + > 0.1.0: Changed the default name of input pin 1 to 'workflow_path', the previous name 'path' is kept as an alias. + + +- [field_to_csv](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/serialization/field_to_csv.md) > 1.0.0: Fixed issue while writing csv with multiple fields and common time id between fields. -- [workflow_to_pydpf](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/serialization/workflow_to_pydpf.md) +- [hdf5dpf_custom_read](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/serialization/hdf5dpf_custom_read.md) + + > 0.0.1: Internal refactoring to use Scoping Iterators. + + +- [hdf5dpf_generate_result_file](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/serialization/hdf5dpf_generate_result_file.md) + + > 0.0.1: Internal refactoring to use Scoping Iterators. + + +- [import_symbolic_workflow](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/serialization/import_symbolic_workflow.md) + + > 0.1.0: Added support for importing symbolic workflows directly from strings. + + > 0.2.0: Changed the default name of input pin 0 to 'workflow_path', the previous name 'string_or_path' is kept as an alias. + + +- [serialize_to_hdf5](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/serialization/serialize_to_hdf5.md) + + > 0.0.1: Internal refactoring to use Scoping Iterators. + + +- [workflow_to_pydpf](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/serialization/workflow_to_pydpf.md) > 0.0.1: Internal refactoring to use Scoping Iterators. @@ -4804,76 +5328,76 @@ Upgraded documentation #### utility -- [compute_time_scoping](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/compute_time_scoping.md) +- [compute_time_scoping](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/compute_time_scoping.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [extract_scoping](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/extract_scoping.md) +- [extract_scoping](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/extract_scoping.md) > 0.0.1: Error with license -- [extract_sub_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/extract_sub_fc.md) +- [extract_sub_fc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/extract_sub_fc.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [extract_sub_mc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/extract_sub_mc.md) +- [extract_sub_mc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/extract_sub_mc.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [extract_sub_sc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/extract_sub_sc.md) +- [extract_sub_sc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/extract_sub_sc.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [extract_time_freq](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/extract_time_freq.md) +- [extract_time_freq](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/extract_time_freq.md) > 0.0.1: Internal refactoring to use Scoping Iterators. > 0.1.0: Addition of an optional input pin to select frequencies from a unique step/RPM. -- [fc_get_attribute](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/fc_get_attribute.md) +- [fc_get_attribute](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/fc_get_attribute.md) > 0.1.0: Add new supported property names 'base_name' that returns a string and 'field_names' that returns a StringField. -- [for_each](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/for_each.md) +- [for_each](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/for_each.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [forward](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/forward.md) +- [forward](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/forward.md) > 1.0.0: Add ellipsis property to pins. -- [html_doc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/html_doc.md) +- [html_doc](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/html_doc.md) > 0.1.0: Show operator version and changelog. > 0.1.1: Fix support for dollar LaTeX delimiters in MathJax. -- [ints_to_scoping](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/ints_to_scoping.md) +- [ints_to_scoping](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/ints_to_scoping.md) > 0.1.0: Add input pin 2 to specify an upper bound to create a scoping for a given range (taking single input in pin 0 as the lower bound). -- [make_for_each_range](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/make_for_each_range.md) +- [make_for_each_range](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/make_for_each_range.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [merge_materials](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/merge_materials.md) +- [merge_materials](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/merge_materials.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [merge_meshes](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/merge_meshes.md) +- [merge_meshes](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/merge_meshes.md) > 0.0.1: Internal refactoring to use Scoping Iterators. @@ -4882,29 +5406,34 @@ Upgraded documentation > 0.0.3: Fix merging empty meshes. -- [merge_scopings](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/merge_scopings.md) +- [merge_meshes_containers](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/merge_meshes_containers.md) + + > 0.0.1: Skip merge for identical meshes based on hash comparison. + + +- [merge_scopings](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/merge_scopings.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [merge_time_freq_supports](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/merge_time_freq_supports.md) +- [merge_time_freq_supports](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/merge_time_freq_supports.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [producer_consumer_for_each](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/producer_consumer_for_each.md) +- [producer_consumer_for_each](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/producer_consumer_for_each.md) > 0.1.0: Addition of events to monitor the status of the operator. > 0.2.0: Moving event of progress bar at the beggining of the loop and changing input stream. -- [scalars_to_field](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/scalars_to_field.md) +- [scalars_to_field](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/scalars_to_field.md) > 0.0.1: Internal refactoring to use Scoping Iterators. -- [set_attribute](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/utility/set_attribute.md) +- [set_attribute](https://ansys-a.devportal.io/docs/dpf-framework-2027-r1/operator-specifications/utility/set_attribute.md) > 0.1.0: Add new supported property names 'base_name' and 'field_names'. @@ -4913,6 +5442,90 @@ Upgraded documentation ### Deleted operators +#### add_rigid_body_motion + +#### add_rigid_body_motion_fc + +#### cgns_result_provider + +#### cms_dst_table_provider + +#### cms_matrices_provider + +#### cms_subfile_info_provider + +#### compute_invariant_terms_motion + +#### compute_invariant_terms_rbd + +#### compute_stress + +#### compute_stress_1 + +#### compute_stress_2 + +#### compute_stress_3 + +#### compute_stress_von_mises + +#### compute_stress_X + +#### compute_stress_XY + +#### compute_stress_XZ + +#### compute_stress_Y + +#### compute_stress_YZ + +#### compute_stress_Z + +#### compute_total_strain + +#### compute_total_strain_1 + +#### compute_total_strain_2 + +#### compute_total_strain_3 + +#### compute_total_strain_X + +#### compute_total_strain_XY + +#### compute_total_strain_XZ + +#### compute_total_strain_Y + +#### compute_total_strain_YZ + +#### compute_total_strain_Z + +#### convertnum_bcs_to_nod + +#### convertnum_nod_to_bcs + +#### convertnum_op + +#### eigen_vectors + +#### eigen_vectors_fc + +#### elastic_strain_rotation_by_euler_nodes + +#### enf_rotation_by_euler_nodes + +#### expansion_psd + +#### fft + +#### fft_approx + +#### fft_eval + +#### fft_gradient_eval + +#### fft_multi_harmonic_minmax + #### gasket_deformation #### gasket_deformation_X @@ -4921,4 +5534,82 @@ Upgraded documentation #### gasket_deformation_XZ +#### mapdl.global_to_nodal + +#### mapdl.pres_to_field + +#### mapdl.prns_to_field + +#### mapdl.run + +#### mapdl_material_properties + +#### mapdl_section + +#### mapdl_split_on_facet_indices + +#### mapdl_split_to_acmo_facet_indices + +#### matrix_inverse + +#### modal_superposition + #### nodal_moment + +#### plastic_strain_rotation_by_euler_nodes + +#### prep_sampling_fft + +#### pretension + +#### qr_solve + +#### read_cms_rbd_file + +#### remove_rigid_body_motion + +#### remove_rigid_body_motion_fc + +#### rigid_transformation_provider + +#### rom_data_provider + +#### stress_rotation_by_euler_nodes + +#### svd + +#### time_derivation + +#### time_integration + +#### total_mass + +#### transform_invariant_terms_rbd + +#### window_bartlett + +#### window_bartlett_fc + +#### window_blackman + +#### window_blackman_fc + +#### window_hamming + +#### window_hamming_fc + +#### window_hanning + +#### window_hanning_fc + +#### window_triangular + +#### window_triangular_fc + +#### window_welch + +#### window_welch_fc + +#### write_cms_rbd_file + +#### write_motion_dfmf_file diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/force_summation.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/force_summation.md index 221d470ee..4856c9224 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/force_summation.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/force_summation.md @@ -28,6 +28,9 @@ Each parameter is detailed in the sections that follow the table. | 5 | [force_type](#input_5) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | 6 | [spoint](#input_6) | |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | | 9 | [scoping_filter](#input_9) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -99,6 +102,30 @@ Selected set of nodes. - 2: Sum all nodal forces for all selected nodes, including contact elements. + +### read_cyclic (Pin 14) + +- **Required:** No +- **Expected type(s):** `enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) + +if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) + + +### sectors_to_expand (Pin 18) + +- **Required:** No +- **Expected type(s):** [`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) + +sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. + + +### phi (Pin 19) + +- **Required:** No +- **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types) + +angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. + ## Outputs @@ -209,6 +236,9 @@ op.connect(4, my_data_sources); op.connect(5, my_force_type); op.connect(6, my_spoint); op.connect(9, my_scoping_filter); +op.connect(14, my_read_cyclic); +op.connect(18, my_sectors_to_expand); +op.connect(19, my_phi); ansys::dpf::FieldsContainer my_force_accumulation = op.getOutput(0); ansys::dpf::FieldsContainer my_moment_accumulation = op.getOutput(1); ansys::dpf::FieldsContainer my_heat_accumulation = op.getOutput(2); @@ -233,6 +263,9 @@ op.inputs.data_sources.connect(my_data_sources) op.inputs.force_type.connect(my_force_type) op.inputs.spoint.connect(my_spoint) op.inputs.scoping_filter.connect(my_scoping_filter) +op.inputs.read_cyclic.connect(my_read_cyclic) +op.inputs.sectors_to_expand.connect(my_sectors_to_expand) +op.inputs.phi.connect(my_phi) my_force_accumulation = op.outputs.force_accumulation() my_moment_accumulation = op.outputs.moment_accumulation() my_heat_accumulation = op.outputs.heat_accumulation() @@ -258,6 +291,9 @@ op.inputs.data_sources.Connect(my_data_sources) op.inputs.force_type.Connect(my_force_type) op.inputs.spoint.Connect(my_spoint) op.inputs.scoping_filter.Connect(my_scoping_filter) +op.inputs.read_cyclic.Connect(my_read_cyclic) +op.inputs.sectors_to_expand.Connect(my_sectors_to_expand) +op.inputs.phi.Connect(my_phi) my_force_accumulation = op.outputs.force_accumulation.GetData() my_moment_accumulation = op.outputs.moment_accumulation.GetData() my_heat_accumulation = op.outputs.heat_accumulation.GetData() diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/absolute_value_by_component.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/absolute_value_by_component.md index 11455d6cf..e4503995b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/absolute_value_by_component.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/absolute_value_by_component.md @@ -10,7 +10,11 @@ license: None ## Description -Computes the absolute value of each data value in the input field component-wise, without performing vector norm operations. + +Applies the [absolute value](https://en.wikipedia.org/wiki/Absolute_value) function component-wise +to each scalar data entry: $\mathrm{out}[i] = |\mathrm{in}[i]|$. +This is a per-component operation and does not compute a vector norm. + ## Inputs @@ -48,7 +52,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field with absolute values applied to each component +Field with $|\mathrm{in}[i]|$ applied to each data component, preserving the input unit and dimensionality. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/absolute_value_by_component_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/absolute_value_by_component_fc.md index 92d0e138e..d5056788c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/absolute_value_by_component_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/absolute_value_by_component_fc.md @@ -10,7 +10,11 @@ license: None ## Description -Computes the absolute value of each data value in the input field component-wise, without performing vector norm operations. + +Applies the [absolute value](https://en.wikipedia.org/wiki/Absolute_value) function component-wise +to each scalar data entry: $\mathrm{out}[i] = |\mathrm{in}[i]|$. +This is a per-component operation and does not compute a vector norm. + ## Inputs @@ -48,7 +52,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field with absolute values applied to each component +Field with $|\mathrm{in}[i]|$ applied to each data component, preserving the input unit and dimensionality. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate.md index ee31ee5ad..059fc3257 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate.md @@ -10,7 +10,13 @@ license: None ## Description -Sums all the elementary data of a field to produce one elementary data point. + +Reduces a field to a single entity by summing all entity data component-wise. +Without weights: $\mathrm{out}[c] = \sum_k \mathrm{field}[k, c]$ for each component $c$. +With an optional weights field (pin 1): $\mathrm{out}[c] = \sum_k w_k \cdot \mathrm{field}[k, c]$, +where $w_k$ is the weight for entity $k$. +The weights field must be a scalar (1D) field providing one weight per entity. + ## Inputs @@ -47,7 +53,7 @@ Field containing weights, one weight per entity - **Required:** No - **Expected type(s):** [`scoping`](../../core-concepts/dpf-types.md#scoping) -time_scoping +Optional scoping that sets the output entity's location and ID. ## Outputs @@ -66,7 +72,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field containing the (weighted) sum for each component in an elementary data +Field with one entity containing the (weighted) component sums $\sum_k w_k \cdot \mathrm{field}[k, c]$ for each component $c$. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate_fc.md index 730e6a39f..0ef106dc7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate_fc.md @@ -10,7 +10,13 @@ license: None ## Description -Sums all the elementary data of a field to produce one elementary data point. + +Reduces a field to a single entity by summing all entity data component-wise. +Without weights: $\mathrm{out}[c] = \sum_k \mathrm{field}[k, c]$ for each component $c$. +With an optional weights field (pin 1): $\mathrm{out}[c] = \sum_k w_k \cdot \mathrm{field}[k, c]$, +where $w_k$ is the weight for entity $k$. +The weights field must be a scalar (1D) field providing one weight per entity. + ## Inputs @@ -47,7 +53,7 @@ Field containing weights, one weight per entity - **Required:** No - **Expected type(s):** [`scoping`](../../core-concepts/dpf-types.md#scoping) -time_scoping +Optional scoping that sets the output entity's location and ID. ## Outputs @@ -66,7 +72,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field containing the (weighted) sum for each component in an elementary data +Field with one entity containing the (weighted) component sums $\sum_k w_k \cdot \mathrm{field}[k, c]$ for each component $c$. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/add.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/add.md index aefc9d9f4..7c91e89a4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/add.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/add.md @@ -10,7 +10,15 @@ license: None ## Description -Computes the sum of two fields. If one field's scoping has 'overall' location, then these field's values are applied on the entire other field. If one of the input field is empty, the remaining is forwarded to the output. When using a constant or 'work_by_index', it's possible to use 'inplace' to reuse one of the fields. + +Computes the entity-wise sum $\mathrm{out}[i] = A[i] + B[i]$, +also known as entity-wise addition. +If one field's scoping has the 'overall' location, its values are broadcast across all entities of the other field. +If either input is empty, the other is forwarded unchanged to the output. +When units differ but are homogeneous, pin B values are converted to pin A's unit before addition; +the output carries pin A's unit. +Inplace execution is supported when working with constants or using 'work_by_index'. + ## Inputs @@ -57,7 +65,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field containing the element-wise sum of the two input fields +Field whose data equals $A[i] + B[i]$, with pin A's unit. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/add_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/add_fc.md index df7d045fd..682620c9e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/add_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/add_fc.md @@ -10,7 +10,12 @@ license: None ## Description -Selects all fields with the same label space in the input fields container and add those together. If fields, doubles, or vectors of doubles, are put in input they are added to all the fields. + +Entity-wise addition across all input fields containers: +for each label space, sums the matching fields from every container. +Scalar inputs (field, double, or vector of doubles) are broadcast and added to every field in each container. +If only one fields container is provided and no scalar inputs are given, it is forwarded to the output unchanged. + ## Inputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -FieldsContainer with summed fields by label space +Fields container with fields summed by matching label space. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/amplitude.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/amplitude.md index 77e0d7cc4..3bfb0f7bb 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/amplitude.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/amplitude.md @@ -10,7 +10,12 @@ license: None ## Description -Computes amplitude of a real and an imaginary field. + +Computes the [complex modulus](https://en.wikipedia.org/wiki/Absolute_value#Complex_numbers) (amplitude) +of a complex quantity given as separate real and imaginary fields: +$\mathrm{out}[i] = \sqrt{A[i]^2 + B[i]^2}$. +The output carries the unit of pin A. + ## Inputs @@ -57,7 +62,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) - +Scalar field with $\sqrt{A[i]^2 + B[i]^2}$ for each data entry, carrying the unit of pin A. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/amplitude_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/amplitude_fc.md index 14b6f3700..ba68ab564 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/amplitude_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/amplitude_fc.md @@ -10,7 +10,12 @@ license: None ## Description -Computes the amplitude of a real and an imaginary field. + +Computes the [complex modulus](https://en.wikipedia.org/wiki/Absolute_value#Complex_numbers) (amplitude) +$\sqrt{\mathrm{Re}[i]^2 + \mathrm{Im}[i]^2}$ for each complex-valued field pair in the input fields container, +where pairs are matched by complex label. +If no imaginary part is found for a real field, that real field is returned unchanged. + ## Inputs @@ -29,7 +34,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Complex-valued fields container with paired real (complex label 0) and imaginary (complex label 1) fields. ## Outputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container with amplitude fields $\sqrt{\mathrm{Re}[i]^2 + \mathrm{Im}[i]^2}$, carrying the unit of the real input field. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/centroid.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/centroid.md index 92e99b9c1..c30eab281 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/centroid.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/centroid.md @@ -10,7 +10,13 @@ license: None ## Description -Computes centroid of field1 and field2, using fieldOut = field1*(1.-fact)+field2*(fact). Only works by index. + +Computes a [linear interpolation](https://en.wikipedia.org/wiki/Linear_interpolation) between two fields +using a scalar factor $t$: $\mathrm{out}[i] = (1 - t) \cdot A[i] + t \cdot B[i]$. +The interpolation is convex (no extrapolation) when $t \in [0, 1]$; +values outside this range extrapolate beyond the two input fields. +This operator works by index only. + ## Inputs @@ -47,7 +53,7 @@ field or fields container with only one field is expected - **Required:** Yes - **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types) -Scalar +Interpolation factor $t$: $t = 0$ returns fieldA unchanged, $t = 1$ returns fieldB unchanged. Values in $[0, 1]$ interpolate; values outside extrapolate. ## Outputs @@ -66,7 +72,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field with centroid calculation: fieldA*(1-factor) + fieldB*factor +Interpolated field $(1 - t) \cdot A + t \cdot B$, with the unit of pin A. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/centroid_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/centroid_fc.md index fb36065f7..4afe64e13 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/centroid_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/centroid_fc.md @@ -10,7 +10,13 @@ license: None ## Description -Computes the centroid of all the matching fields of a fields container at a given time or frequency, using fieldOut = field1*(1.-fact)+field2*(fact). + +Computes a [linear interpolation](https://en.wikipedia.org/wiki/Linear_interpolation) between the two fields +in the input fields container that bracket the requested time or frequency value $t$: +$\mathrm{out}[i] = (1 - s) \cdot f_1[i] + s \cdot f_2[i]$, +where $s = (t - t_1) / (t_2 - t_1)$ and $t_1$, $t_2$ are the bracketing time/frequency values. +If the requested value exactly matches an available one, that field is returned directly. + ## Inputs @@ -32,7 +38,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -FieldsContainer with fields for centroid calculation +Fields container with fields over time or frequency. ### time_freq (Pin 1) @@ -40,7 +46,7 @@ FieldsContainer with fields for centroid calculation - **Required:** Yes - **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types) -Time or frequency value for field selection +Time or frequency value at which to interpolate. ### step (Pin 2) @@ -48,7 +54,7 @@ Time or frequency value for field selection - **Required:** No - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) -Optional step specification +Optional step specification. ### time_freq_support (Pin 8) @@ -56,7 +62,7 @@ Optional step specification - **Required:** No - **Expected type(s):** [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) -Optional TimeFreqSupport for field resolution +Optional time/frequency support for field resolution. ## Outputs @@ -75,7 +81,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -FieldsContainer with centroid calculation results at specified time/frequency +Fields container with the interpolated fields at the requested time or frequency. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_divide.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_divide.md index c4cf03f25..95300e684 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_divide.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_divide.md @@ -10,7 +10,15 @@ license: None ## Description -Computes component-wise fraction between two fields of same dimensionality. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. When using a constant or 'work_by_index', you can use 'inplace' to reuse one of the fields. + +Computes the component-wise fraction $\mathrm{out}[k] = A[k] / B[k]$ +(also known as the [Hadamard division](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations)) +for fields of the same dimensionality. +If one field's scoping has the 'overall' location, its values are broadcast across all entities of the other field. +When $|B[k]| < 10^{-14}$ the corresponding output component is set to $0$. +Inplace execution is supported when working with constants or using 'work_by_index'. +The output unit is $u_A / u_B$. + ## Inputs @@ -57,7 +65,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) - +Field with $A[k] / B[k]$ for each component (zero where $|B[k]| < 10^{-14}$); unit is $u_A / u_B$. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_divide_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_divide_fc.md index fe1749a6c..a628754a2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_divide_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_divide_fc.md @@ -10,7 +10,12 @@ license: None ## Description -For every two fields with the same label space (from the two input fields containers), computes component-wise fraction between two fields of same dimensionality. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. + +For every pair of fields with matching label space in the two input fields containers, +computes the component-wise fraction $\mathrm{out}[k] = A[k] / B[k]$ +(also known as the [Hadamard division](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations)). +Both containers must have identical label spaces and the same number of fields. + ## Inputs @@ -57,7 +62,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container with the component-wise quotient fields; unit is $u_A / u_B$. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/conjugate.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/conjugate.md index 776d0486a..d4b79e451 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/conjugate.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/conjugate.md @@ -10,7 +10,12 @@ license: None ## Description -Computes element-wise conjugate of field containers containing complex fields. + +Computes the [complex conjugate](https://en.wikipedia.org/wiki/Complex_conjugate) +$\bar{z}[i] = \mathrm{Re}[i] - j \cdot \mathrm{Im}[i]$ for each value in a complex-valued fields container +(the imaginary part is negated). +Input and output containers have the same structure. + ## Inputs @@ -29,7 +34,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Complex-valued fields container with real (complex label 0) and imaginary (complex label 1) part fields. ## Outputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container with conjugate values; the imaginary-part fields carry negated data. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/cos.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/cos.md index c16ffb341..71bd84d50 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/cos.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/cos.md @@ -10,7 +10,13 @@ license: None ## Description -Computes element-wise cosine function on field data: cos(field[i]). + +Computes the entity-wise [cosine](https://en.wikipedia.org/wiki/Sine_and_cosine): +$\mathrm{out}[i] = \cos(\mathrm{in}[i])$. +The input must be dimensionless or carry an angle unit; any other unit raises an error. +When the input unit is an angle (e.g. degrees), values are automatically converted to radians +before the cosine is applied. The output is dimensionless. + ## Inputs @@ -29,7 +35,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field or fields container containing numeric data for cosine calculation +Dimensionless or angle-unit field or fields container. ## Outputs @@ -48,7 +54,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field with cosine values applied element-wise to input data +Dimensionless field with $\cos(\mathrm{in}[i])$ for each data entry. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/cos_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/cos_fc.md index 4f7e44a7b..f2d4650ef 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/cos_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/cos_fc.md @@ -10,7 +10,13 @@ license: None ## Description -Computes element-wise cosine function on field data: cos(field[i]). + +Computes the entity-wise [cosine](https://en.wikipedia.org/wiki/Sine_and_cosine): +$\mathrm{out}[i] = \cos(\mathrm{in}[i])$. +The input must be dimensionless or carry an angle unit; any other unit raises an error. +When the input unit is an angle (e.g. degrees), values are automatically converted to radians +before the cosine is applied. The output is dimensionless. + ## Inputs @@ -29,7 +35,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field or fields container containing numeric data for cosine calculation +Dimensionless or angle-unit field or fields container. ## Outputs @@ -48,7 +54,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field with cosine values applied element-wise to input data +Dimensionless field with $\cos(\mathrm{in}[i])$ for each data entry. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_derive.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_derive.md index d6bb140f3..13e99ef56 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_derive.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_derive.md @@ -10,7 +10,15 @@ license: None ## Description -Derives field containers containing complex fields. + +Computes the time derivative of a [phasor](https://en.wikipedia.org/wiki/Phasor) field +in the frequency domain by multiplying by $j\omega$, +where $\omega = 2\pi f$ and $f$ is taken from the fields container's time-frequency support. +The result components are: +$\mathrm{Re}(\dot{z})[i] = -\omega \cdot \mathrm{Im}(z)[i]$, +$\mathrm{Im}(\dot{z})[i] = \omega \cdot \mathrm{Re}(z)[i]$. +The output unit is the input field unit multiplied by the time-frequency support unit. + ## Inputs @@ -29,7 +37,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Complex-valued fields container with a time-frequency support defining the frequencies. ## Outputs @@ -48,7 +56,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container containing the frequency-domain time derivative $j\omega z$ (real and imaginary parts). ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_divide.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_divide.md index 37de81ae5..6ae3d538a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_divide.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_divide.md @@ -10,7 +10,13 @@ license: None ## Description -Computes division between two field containers containing complex fields. + +Computes the [complex division](https://en.wikipedia.org/wiki/Complex_number#Multiplicative_inverse) +$z_1 / z_2$ for matching fields in two complex-valued fields containers: +$\mathrm{Re}(z_\mathrm{out}[i]) = (\mathrm{Re}_1 \mathrm{Re}_2 + \mathrm{Im}_1 \mathrm{Im}_2) / D$, +$\mathrm{Im}(z_\mathrm{out}[i]) = (\mathrm{Im}_1 \mathrm{Re}_2 - \mathrm{Re}_1 \mathrm{Im}_2) / D$ +where $D = \mathrm{Re}_2^2 + \mathrm{Im}_2^2$. Raises an error if $D = 0$. + ## Inputs @@ -30,7 +36,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Numerator complex-valued fields container. ### fields_containerB (Pin 1) @@ -38,7 +44,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Denominator complex-valued fields container. ## Outputs @@ -57,7 +63,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container with the complex quotient $z_1 / z_2$ (real and imaginary parts). ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_dot.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_dot.md index cf6a90d23..d6e1dc9a2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_dot.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_dot.md @@ -10,7 +10,14 @@ license: None ## Description -Computes product between two field containers containing complex fields. + +Computes the real-valued inner product +$\mathrm{out}[i] = \mathrm{Re}_1[i] \cdot \mathrm{Re}_2[i] + \mathrm{Im}_1[i] \cdot \mathrm{Im}_2[i]$ +between matching fields in two complex-valued fields containers. +This equals the real part of the [Hermitian inner product](https://en.wikipedia.org/wiki/Dot_product#Complex_vectors) +$\mathrm{Re}(z_1 \cdot \overline{z_2})$. +Only the real-part result fields (complex label 0) are produced. + ## Inputs diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_multiply.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_multiply.md index 91f4de3bc..504ecc2d5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_multiply.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_multiply.md @@ -10,7 +10,13 @@ license: None ## Description -Computes multiplication between two field containers containing complex fields. + +Computes the standard [complex multiplication](https://en.wikipedia.org/wiki/Complex_number#Multiplication_and_square) +$z_1 \cdot z_2$ for matching fields in two complex-valued fields containers: +$\mathrm{Re}(z_\mathrm{out})[i] = \mathrm{Re}_1 \mathrm{Re}_2 - \mathrm{Im}_1 \mathrm{Im}_2$, +$\mathrm{Im}(z_\mathrm{out})[i] = \mathrm{Re}_1 \mathrm{Im}_2 + \mathrm{Im}_1 \mathrm{Re}_2$. +Both containers must have the same size. + ## Inputs @@ -57,7 +63,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container with the complex product fields (real and imaginary parts). ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/dot_tensor.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/dot_tensor.md index 9e0b35063..47dd400ec 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/dot_tensor.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/dot_tensor.md @@ -10,7 +10,7 @@ license: None ## Description -DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes element-wise dot product between two tensor fields. +DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes entity-wise dot product between two tensor fields. ## Inputs diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/exponential.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/exponential.md index 4ed4c3b68..36320391c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/exponential.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/exponential.md @@ -10,7 +10,12 @@ license: None ## Description -Computes element-wise exponential function on field data: exp(field[i]). + +Computes the entity-wise [exponential function](https://en.wikipedia.org/wiki/Exponential_function): +$\mathrm{out}[i] = e^{\mathrm{in}[i]}$. +The input must be dimensionless; a dimensional input raises an error. +The output is dimensionless. + ## Inputs @@ -29,7 +34,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) -Field, fields container, or numeric data for exponential calculation +Dimensionless field, fields container, or numeric data. ## Outputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field with exponential values applied element-wise to input data +Dimensionless field with $e^{\mathrm{in}[i]}$ for each data entry. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/exponential_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/exponential_fc.md index 7bd37af5a..c19f6147a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/exponential_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/exponential_fc.md @@ -10,7 +10,12 @@ license: None ## Description -Computes element-wise exponential function on field data: exp(field[i]). + +Computes the entity-wise [exponential function](https://en.wikipedia.org/wiki/Exponential_function): +$\mathrm{out}[i] = e^{\mathrm{in}[i]}$. +The input must be dimensionless; a dimensional input raises an error. +The output is dimensionless. + ## Inputs @@ -29,7 +34,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field, fields container, or numeric data for exponential calculation +Dimensionless field, fields container, or numeric data. ## Outputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field with exponential values applied element-wise to input data +Dimensionless field with $e^{\mathrm{in}[i]}$ for each data entry. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/generalized_inner_product.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/generalized_inner_product.md index 520bef7f2..ce6a32568 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/generalized_inner_product.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/generalized_inner_product.md @@ -10,7 +10,24 @@ license: None ## Description -Computes a general notion of inner product between two fields of possibly different dimensionality. + +Computes the generalized inner product between two fields, +dispatching the appropriate operation based on their dimensionalities: + +| Pin 0 | Pin 1 | Operation | Result | +|---|---|---|---| +| vector field | vector field | [dot product](https://en.wikipedia.org/wiki/Dot_product) | scalar field | +| scalar field | any field | scaling | field (same dimensionality as B) | +| matrix field | matrix field | [matrix product](https://en.wikipedia.org/wiki/Matrix_multiplication) | matrix field | +| matrix field | vector field | matrix-vector product | vector field | + +In Cartesian coordinates the vector $\cdot$ vector case is equivalent to the standard dot product. +An optional mesh (pin 2) is required when computing the finite-element dot product +between an elemental-nodal field and a nodal field. +If either input is empty, a dimensionless zero scalar field is returned. +The result covers the union of both field scopings; +entities present in only one field contribute zero. + ## Inputs @@ -22,6 +39,7 @@ Each parameter is detailed in the sections that follow the table. |------------|------|--------|------------------| | 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | 1 | [fieldB](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [mesh](#input_2) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -40,6 +58,14 @@ field or fields container with only one field is expected field or fields container with only one field is expected + +### mesh (Pin 2) + +- **Required:** No +- **Expected type(s):** [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) + +Mesh required when computing the finite-element dot product between an elemental-nodal field (pin 0 or 1) and a nodal field. + ## Outputs @@ -57,7 +83,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field containing the generalized inner product result +Inner product result field; dimensionality and unit are determined by the dispatched operation. ## Configurations @@ -146,6 +172,7 @@ Each example shows how to instantiate the operator, connect the required inputs, ansys::dpf::Operator op("generalized_inner_product"); // operator instantiation op.connect(0, my_fieldA); op.connect(1, my_fieldB); +op.connect(2, my_mesh); ansys::dpf::Field my_field = op.getOutput(0); ``` @@ -159,6 +186,7 @@ import ansys.dpf.core as dpf op = dpf.operators.math.generalized_inner_product() # operator instantiation op.inputs.fieldA.connect(my_fieldA) op.inputs.fieldB.connect(my_fieldB) +op.inputs.mesh.connect(my_mesh) my_field = op.outputs.field() ``` @@ -173,6 +201,7 @@ import Ans.DataProcessing as dpf op = dpf.operators.math.generalized_inner_product() # operator instantiation op.inputs.fieldA.Connect(my_fieldA) op.inputs.fieldB.Connect(my_fieldB) +op.inputs.mesh.Connect(my_mesh) my_field = op.outputs.field.GetData() ``` diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/generalized_inner_product_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/generalized_inner_product_fc.md index fa376f74d..04a6cfdb1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/generalized_inner_product_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/generalized_inner_product_fc.md @@ -10,7 +10,24 @@ license: None ## Description -Computes a general notion of inner product between two fields of possibly different dimensionality. + +Computes the generalized inner product between two fields, +dispatching the appropriate operation based on their dimensionalities: + +| Pin 0 | Pin 1 | Operation | Result | +|---|---|---|---| +| vector field | vector field | [dot product](https://en.wikipedia.org/wiki/Dot_product) | scalar field | +| scalar field | any field | scaling | field (same dimensionality as B) | +| matrix field | matrix field | [matrix product](https://en.wikipedia.org/wiki/Matrix_multiplication) | matrix field | +| matrix field | vector field | matrix-vector product | vector field | + +In Cartesian coordinates the vector $\cdot$ vector case is equivalent to the standard dot product. +An optional mesh (pin 2) is required when computing the finite-element dot product +between an elemental-nodal field and a nodal field. +If either input is empty, a dimensionless zero scalar field is returned. +The result covers the union of both field scopings; +entities present in only one field contribute zero. + ## Inputs @@ -22,6 +39,7 @@ Each parameter is detailed in the sections that follow the table. |------------|------|--------|------------------| | 0 | [field_or_fields_container_A](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | 1 | [field_or_fields_container_B](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [mesh](#input_2) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -40,6 +58,14 @@ field or fields container with only one field is expected field or fields container with only one field is expected + +### mesh (Pin 2) + +- **Required:** No +- **Expected type(s):** [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) + +Mesh required when computing the finite-element dot product between an elemental-nodal field (pin 0 or 1) and a nodal field. + ## Outputs @@ -57,7 +83,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field containing the generalized inner product result +Inner product result field; dimensionality and unit are determined by the dispatched operation. ## Configurations @@ -146,6 +172,7 @@ Each example shows how to instantiate the operator, connect the required inputs, ansys::dpf::Operator op("generalized_inner_product_fc"); // operator instantiation op.connect(0, my_field_or_fields_container_A); op.connect(1, my_field_or_fields_container_B); +op.connect(2, my_mesh); ansys::dpf::FieldsContainer my_fields_container = op.getOutput(0); ``` @@ -159,6 +186,7 @@ import ansys.dpf.core as dpf op = dpf.operators.math.generalized_inner_product_fc() # operator instantiation op.inputs.field_or_fields_container_A.connect(my_field_or_fields_container_A) op.inputs.field_or_fields_container_B.connect(my_field_or_fields_container_B) +op.inputs.mesh.connect(my_mesh) my_fields_container = op.outputs.fields_container() ``` @@ -173,6 +201,7 @@ import Ans.DataProcessing as dpf op = dpf.operators.math.generalized_inner_product_fc() # operator instantiation op.inputs.field_or_fields_container_A.Connect(my_field_or_fields_container_A) op.inputs.field_or_fields_container_B.Connect(my_field_or_fields_container_B) +op.inputs.mesh.Connect(my_mesh) my_fields_container = op.outputs.fields_container.GetData() ``` diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/img_part.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/img_part.md index b903adec0..0da5396b1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/img_part.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/img_part.md @@ -10,7 +10,10 @@ license: None ## Description -Extracts element-wise imaginary part of field containers containing complex fields. + +Extracts the imaginary-part fields (complex label 1) from a complex-valued fields container. +The output container preserves all labels except the complex label. + ## Inputs @@ -29,7 +32,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Complex-valued fields container with real (complex label 0) and imaginary (complex label 1) part fields. ## Outputs @@ -48,7 +51,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container containing only the imaginary-part fields, without the complex label. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/invert.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/invert.md index 112940a15..c505c1170 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/invert.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/invert.md @@ -10,7 +10,7 @@ license: None ## Description -DEPRECATED, PLEASE USE DIVIDE. Computes the element-wise and component-wise inverse of a field (1./x). +DEPRECATED, PLEASE USE DIVIDE. Computes the entity-wise and component-wise inverse of a field (1./x). ## Inputs @@ -48,7 +48,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field with inverse values (1/x) applied element-wise to input data +Field with inverse values (1/x) applied entity-wise to input data ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/invert_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/invert_fc.md index f5676972a..9ecd53431 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/invert_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/invert_fc.md @@ -10,7 +10,7 @@ license: None ## Description -DEPRECATED, PLEASE USE DIVIDE. Computes the element-wise and component-wise inverse of a field (1./x). +DEPRECATED, PLEASE USE DIVIDE. Computes the entity-wise and component-wise inverse of a field (1./x). ## Inputs @@ -48,7 +48,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field with inverse values (1/x) applied element-wise to input data +Field with inverse values (1/x) applied entity-wise to input data ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/kronecker_prod.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/kronecker_prod.md index 331d156cd..6481e18e6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/kronecker_prod.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/kronecker_prod.md @@ -10,7 +10,14 @@ license: None ## Description -Computes element-wise Kronecker product between two tensor fields. + +Computes the [Kronecker product](https://en.wikipedia.org/wiki/Kronecker_product) +of two matrix-valued fields per entity. +For each entity, if $A$ is an $(m \times n)$ matrix and $B$ is a $(p \times q)$ matrix, +the result is an $(mp \times nq)$ matrix: +$(A \otimes B)_{(ip+k),(jq+l)} = A_{i,j} \cdot B_{k,l}$. +Both input fields must have the same number of entities. + ## Inputs @@ -57,7 +64,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) - +Matrix field containing the Kronecker product $A \otimes B$ for each entity; unit is $u_A \cdot u_B$. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/linear_combination.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/linear_combination.md index 3a8306d1d..c5e025521 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/linear_combination.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/linear_combination.md @@ -10,7 +10,13 @@ license: None ## Description -Computes aXY + bZ where a,b (in 0, in 3) are scalar and X,Y,Z (in 1,2,4) are complex numbers. + +Computes the [linear combination](https://en.wikipedia.org/wiki/Linear_combination) +$a \cdot X \cdot Y + b \cdot Z$, +where $a$ (pin 0) and $b$ (pin 3) are real scalars, +and $X$ (pin 1), $Y$ (pin 2), $Z$ (pin 4) are complex-valued fields containers. +The product $X \cdot Y$ is a standard complex multiplication. + ## Inputs @@ -33,7 +39,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types) -Double +Real scalar factor $a$ applied to the complex product $X \cdot Y$. ### fields_containerA (Pin 1) @@ -57,7 +63,7 @@ Double - **Required:** Yes - **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types) -Double +Real scalar factor $b$ applied to the complex addend $Z$. ### fields_containerC (Pin 4) @@ -65,7 +71,7 @@ Double - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Third complex-valued fields container $Z$. ## Outputs @@ -84,7 +90,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container with the complex result $a \cdot X \cdot Y + b \cdot Z$ (real and imaginary parts). ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/ln.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/ln.md index d56b2df44..e2f1b5dc7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/ln.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/ln.md @@ -10,7 +10,12 @@ license: None ## Description -Computes element-wise ln(field[i]). + +Computes the entity-wise [natural logarithm](https://en.wikipedia.org/wiki/Natural_logarithm): +$\mathrm{out}[i] = \ln(\mathrm{in}[i])$. +The input must be dimensionless; a dimensional input raises an error. +The output is dimensionless. + ## Inputs @@ -29,7 +34,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) -field or fields container with only one field is expected +Dimensionless field, fields container, or numeric data. ## Outputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field with natural logarithm values applied element-wise +Dimensionless field with $\ln(\mathrm{in}[i])$ for each data entry. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/ln_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/ln_fc.md index c092f6ec6..6899f3cc4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/ln_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/ln_fc.md @@ -10,7 +10,12 @@ license: None ## Description -Computes element-wise ln(field[i]). + +Computes the entity-wise [natural logarithm](https://en.wikipedia.org/wiki/Natural_logarithm): +$\mathrm{out}[i] = \ln(\mathrm{in}[i])$. +The input must be dimensionless; a dimensional input raises an error. +The output is dimensionless. + ## Inputs @@ -29,7 +34,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -field or fields container with only one field is expected +Dimensionless field, fields container, or numeric data. ## Outputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field with natural logarithm values applied element-wise +Dimensionless field with $\ln(\mathrm{in}[i])$ for each data entry. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/math_category.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/math_category.md index 8d33ae6b0..52b7e1b86 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/math_category.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/math_category.md @@ -57,6 +57,8 @@ - [mac](mac.md) - [make one on comp](make_one_on_comp.md) - [matrix inverse](matrix_inverse.md) +- [matrix product](matrix_product.md) +- [matrix product fc](matrix_product_fc.md) - [mechanical min max over time](mechanical_min_max_over_time.md) - [minus](minus.md) - [minus fc](minus_fc.md) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/matrix_product.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/matrix_product.md new file mode 100644 index 000000000..4b2ca8c5b --- /dev/null +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/matrix_product.md @@ -0,0 +1,196 @@ +--- +category: math +plugin: core +license: None +--- + +# math:matrix product + +**Version: 0.0.0** + +## Description + + +Computes the product of two matrix or matrix-vector fields: + +| Pin 0 | Pin 1 | Operation | Result | +|---|---|---|---| +| matrix field | matrix field | [matrix product](https://en.wikipedia.org/wiki/Matrix_multiplication) | matrix field | +| matrix field | vector field | matrix-vector product | vector field | + +Raises an error if neither input is a matrix (second-order tensor) field, +or if an input is neither a matrix nor a vector. +For general inner products - including dot products and scaling - use the +`generalized_inner_product` operator instead. +If either input is empty, a dimensionless zero scalar field is returned. + + +## Inputs + +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [fieldB](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | + + + +### fieldA (Pin 0) + +- **Required:** Yes +- **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) + +Matrix field A (second-order tensor). Can also be a vector when pin 1 is the matrix. + + +### fieldB (Pin 1) + +- **Required:** Yes +- **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) + +Matrix field B (second-order tensor) or vector field B. + + +## Outputs + +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + +| Pin number | Name | Expected type(s) | +|-------|------|------------------| +| **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | + + + +### field (Pin 0) + +- **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) + +Result of the matrix product; a matrix field or a vector field depending on the inputs. + + +## Configurations + +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + + +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) + +- **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 1 + +This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. + +### [mutex](../../core-concepts/operator-configurations.md#mutex) + +- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** false + +If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. + +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +Number of threads to use to run in parallel + +### [permissive](../../core-concepts/operator-configurations.md#permissive) + +- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** false + +If this option is set to true, warning checks (like unit or data sizes) won't be done. + +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) + +- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** true + +Loops are allowed to run in parallel if the value of this config is set to true. + +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) + +- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** true + +Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. + +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) + +- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** false + +If this option is set to true, loops and comparisons by entity will be done by index instead of ids. + + + +## Scripting + +This operator can be accessed through scripting interfaces using these identifiers. + + **Category**: math + + **Plugin**: core + + **Scripting name**: matrix_product + + **Full name**: math.matrix_product + + **Internal name**: matrix_product + + **License**: None + +## Examples + +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. + +
+C++ + +```cpp +#include "dpf_api.h" + +ansys::dpf::Operator op("matrix_product"); // operator instantiation +op.connect(0, my_fieldA); +op.connect(1, my_fieldB); +ansys::dpf::Field my_field = op.getOutput(0); +``` +
+ +
+CPython + +```python +import ansys.dpf.core as dpf + +op = dpf.operators.math.matrix_product() # operator instantiation +op.inputs.fieldA.connect(my_fieldA) +op.inputs.fieldB.connect(my_fieldB) +my_field = op.outputs.field() +``` +
+ +
+IPython + +```python +import mech_dpf +import Ans.DataProcessing as dpf + +op = dpf.operators.math.matrix_product() # operator instantiation +op.inputs.fieldA.Connect(my_fieldA) +op.inputs.fieldB.Connect(my_fieldB) +my_field = op.outputs.field.GetData() +``` +
+
+ +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/matrix_product_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/matrix_product_fc.md new file mode 100644 index 000000000..8d55c0c9b --- /dev/null +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/matrix_product_fc.md @@ -0,0 +1,196 @@ +--- +category: math +plugin: core +license: None +--- + +# math:matrix product (fields container) + +**Version: 0.0.0** + +## Description + + +Computes the product of two matrix or matrix-vector fields: + +| Pin 0 | Pin 1 | Operation | Result | +|---|---|---|---| +| matrix field | matrix field | [matrix product](https://en.wikipedia.org/wiki/Matrix_multiplication) | matrix field | +| matrix field | vector field | matrix-vector product | vector field | + +Raises an error if neither input is a matrix (second-order tensor) field, +or if an input is neither a matrix nor a vector. +For general inner products - including dot products and scaling - use the +`generalized_inner_product` operator instead. +If either input is empty, a dimensionless zero scalar field is returned. + + +## Inputs + +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field_or_fields_container_A](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [field_or_fields_container_B](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | + + + +### field_or_fields_container_A (Pin 0) + +- **Required:** Yes +- **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) + +Matrix field A (second-order tensor). Can also be a vector when pin 1 is the matrix. + + +### field_or_fields_container_B (Pin 1) + +- **Required:** Yes +- **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) + +Matrix field B (second-order tensor) or vector field B. + + +## Outputs + +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + +| Pin number | Name | Expected type(s) | +|-------|------|------------------| +| **0**| [fields_container](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | + + + +### fields_container (Pin 0) + +- **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) + +Result of the matrix product; a matrix field or a vector field depending on the inputs. + + +## Configurations + +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + + +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) + +- **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 1 + +This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. + +### [mutex](../../core-concepts/operator-configurations.md#mutex) + +- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** false + +If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. + +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +Number of threads to use to run in parallel + +### [permissive](../../core-concepts/operator-configurations.md#permissive) + +- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** false + +If this option is set to true, warning checks (like unit or data sizes) won't be done. + +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) + +- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** true + +Loops are allowed to run in parallel if the value of this config is set to true. + +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) + +- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** true + +Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. + +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) + +- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** false + +If this option is set to true, loops and comparisons by entity will be done by index instead of ids. + + + +## Scripting + +This operator can be accessed through scripting interfaces using these identifiers. + + **Category**: math + + **Plugin**: core + + **Scripting name**: matrix_product_fc + + **Full name**: math.matrix_product_fc + + **Internal name**: matrix_product_fc + + **License**: None + +## Examples + +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. + +
+C++ + +```cpp +#include "dpf_api.h" + +ansys::dpf::Operator op("matrix_product_fc"); // operator instantiation +op.connect(0, my_field_or_fields_container_A); +op.connect(1, my_field_or_fields_container_B); +ansys::dpf::FieldsContainer my_fields_container = op.getOutput(0); +``` +
+ +
+CPython + +```python +import ansys.dpf.core as dpf + +op = dpf.operators.math.matrix_product_fc() # operator instantiation +op.inputs.field_or_fields_container_A.connect(my_field_or_fields_container_A) +op.inputs.field_or_fields_container_B.connect(my_field_or_fields_container_B) +my_fields_container = op.outputs.fields_container() +``` +
+ +
+IPython + +```python +import mech_dpf +import Ans.DataProcessing as dpf + +op = dpf.operators.math.matrix_product_fc() # operator instantiation +op.inputs.field_or_fields_container_A.Connect(my_field_or_fields_container_A) +op.inputs.field_or_fields_container_B.Connect(my_field_or_fields_container_B) +my_fields_container = op.outputs.fields_container.GetData() +``` +
+
+ +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/minus.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/minus.md index a05c9b807..9f6fd17b4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/minus.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/minus.md @@ -10,7 +10,15 @@ license: None ## Description -Computes the difference of two fields. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. When using a constant or 'work_by_index', you can use 'inplace' to reuse one of the fields. + +Computes the entity-wise difference $\mathrm{out}[i] = A[i] - B[i]$, +also known as entity-wise subtraction. +If one field's scoping has the 'overall' location, its values are broadcast across all entities of the other field. +If either input is empty, the other is forwarded unchanged. +When units differ but are homogeneous, pin B values are converted to pin A's unit before subtraction. +Subtracting two temperature fields automatically produces a temperature-difference quantity with the appropriate unit. +Inplace execution is supported when working with constants or using 'work_by_index'. + ## Inputs @@ -57,7 +65,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field containing the element-wise difference (fieldA - fieldB) +Field whose data equals $A[i] - B[i]$, carrying pin A's unit (or the corresponding temperature-difference unit when subtracting two temperature fields). ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/minus_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/minus_fc.md index 9e0fc7ccd..9c39354ec 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/minus_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/minus_fc.md @@ -10,7 +10,15 @@ license: None ## Description -Computes the difference of two fields. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. When using a constant or 'work_by_index', you can use 'inplace' to reuse one of the fields. + +Computes the entity-wise difference $\mathrm{out}[i] = A[i] - B[i]$, +also known as entity-wise subtraction. +If one field's scoping has the 'overall' location, its values are broadcast across all entities of the other field. +If either input is empty, the other is forwarded unchanged. +When units differ but are homogeneous, pin B values are converted to pin A's unit before subtraction. +Subtracting two temperature fields automatically produces a temperature-difference quantity with the appropriate unit. +Inplace execution is supported when working with constants or using 'work_by_index'. + ## Inputs @@ -57,7 +65,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field containing the element-wise difference (fieldA - fieldB) +Field whose data equals $A[i] - B[i]$, carrying pin A's unit (or the corresponding temperature-difference unit when subtracting two temperature fields). ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/modal_superposition.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/modal_superposition.md index b1c0d9e22..e66a79357 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/modal_superposition.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/modal_superposition.md @@ -20,10 +20,10 @@ Each parameter is detailed in the sections that follow the table. | Pin number | Name | Status | Expected type(s) | |------------|------|--------|------------------| -| 0 | [modal_basis](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 | [solution_in_modal_space](#input_1) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2 | [incremental_fc](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3 | [time_scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 0 | [modal_basis](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container) | +| 1 | [solution_in_modal_space](#input_1) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container) | +| 2 | [incremental_fc](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container) | +| 3 | [time_scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | | 4 | [mesh_scoping](#input_4) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | @@ -31,7 +31,7 @@ Each parameter is detailed in the sections that follow the table. ### modal_basis (Pin 0) - **Required:** Yes -- **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) +- **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container) One field by mode with each field representing a mode shape on nodes or elements. @@ -39,7 +39,7 @@ One field by mode with each field representing a mode shape on nodes or elements ### solution_in_modal_space (Pin 1) - **Required:** Yes -- **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) +- **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container) One field by time/frequency with each field having a ponderating coefficient for each mode of the modal_basis pin. @@ -47,7 +47,7 @@ One field by time/frequency with each field having a ponderating coefficient for ### incremental_fc (Pin 2) - **Required:** No -- **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) +- **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container) If a non-empty fields container is introduced, it is modified, and sent to the output, to add the contribution of the requested expansion. The label spaces produced from the multiplication must be the same as the incremental ones. @@ -55,7 +55,7 @@ If a non-empty fields container is introduced, it is modified, and sent to the o ### time_scoping (Pin 3) - **Required:** No -- **Expected type(s):** [`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) +- **Expected type(s):** [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) Compute the result on a subset of the time frequency domain defined in the solution_in_modal_space fields container. @@ -76,15 +76,15 @@ Each output is detailed in the sections that follow the table. | Pin number | Name | Expected type(s) | |-------|------|------------------| -| **0**| [fields_container](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| **0**| [fields_container](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container) | ### fields_container (Pin 0) -- **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +- **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container) +Expanded mode superposition solution. ## Configurations @@ -104,7 +104,7 @@ If this option is set to true, the shared memory is prevented from being simulta - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 -Number of threads to use to run in parallel + ### [read_inputs_in_parallel](../../core-concepts/operator-configurations.md#read_inputs_in_parallel) @@ -171,7 +171,7 @@ op.inputs.solution_in_modal_space.connect(my_solution_in_modal_space) op.inputs.incremental_fc.connect(my_incremental_fc) op.inputs.time_scoping.connect(my_time_scoping) op.inputs.mesh_scoping.connect(my_mesh_scoping) -my_fields_container = op.outputs.fields_container() +my_fields_container_as_fields_container = op.outputs.fields_container_as_fields_container() ``` diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/modulus.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/modulus.md index 99f19f9ed..ed557b618 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/modulus.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/modulus.md @@ -10,7 +10,12 @@ license: None ## Description -Computes element-wise modulus of field containers containing complex fields. + +Computes the [complex modulus](https://en.wikipedia.org/wiki/Absolute_value#Complex_numbers) +$|z[i]| = \sqrt{\mathrm{Re}[i]^2 + \mathrm{Im}[i]^2}$ for each value in a complex-valued fields container, +where $\mathrm{Re}$ and $\mathrm{Im}$ are the real and imaginary parts (complex labels 0 and 1 respectively). +The output container has no complex label. + ## Inputs @@ -29,7 +34,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Complex-valued fields container with real (complex label 0) and imaginary (complex label 1) part fields. ## Outputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container with the modulus $\sqrt{\mathrm{Re}^2 + \mathrm{Im}^2}$ for each entry, without the complex label. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/norm.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/norm.md index 7fd076dc1..05e34b7d8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/norm.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/norm.md @@ -10,7 +10,13 @@ license: None ## Description -Computes the element-wise Lp norm of the field elementary data. Default Lp=L2 + +Computes the [$L_p$ norm](https://en.wikipedia.org/wiki/Norm_(mathematics)#p-norm) of the component vector +for each entity in the field: +$\mathrm{out}[k] = \left(\sum_{j=0}^{n_c-1} |v_{k,j}|^p\right)^{1/p}$, +where $n_c$ is the number of components. Default is $p = 2$ (Euclidean norm). +The output is a scalar field with one value per entity. + ## Inputs @@ -38,7 +44,7 @@ field or fields container with only one field is expected - **Required:** No - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) -Lp normalisation type, p = 1, 2, ...n - Default Lp=L2 +$L_p$ norm order $p$ (positive integer, default is 2 for the Euclidean norm). ## Outputs @@ -57,7 +63,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Scalar field containing the Lp norm values for each element +Scalar field containing the $L_p$ norm value for each entity. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/norm_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/norm_fc.md index 1ea83c696..6af6fc225 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/norm_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/norm_fc.md @@ -10,7 +10,12 @@ license: None ## Description -Computes the element-wise L2 norm of the field elementary data. This process is applied on each field of the input fields container. + +Computes the [$L_p$ norm](https://en.wikipedia.org/wiki/Norm_(mathematics)#p-norm) of the component vector +for each entity in every field of the input fields container: +$\mathrm{out}[k] = \left(\sum_{j=0}^{n_c-1} |v_{k,j}|^p\right)^{1/p}$. +Default is $p = 2$ (Euclidean norm). Each output field is scalar. + ## Inputs @@ -30,7 +35,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -FieldsContainer containing fields for norm calculation +Fields container containing fields for norm calculation ### scalar_int (Pin 1) @@ -38,7 +43,7 @@ FieldsContainer containing fields for norm calculation - **Required:** No - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) -Lp normalisation type, p = 1, 2, ...n - Default Lp=2 +$L_p$ norm order $p$ (positive integer, default is 2 for the Euclidean norm). ## Outputs @@ -57,7 +62,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -FieldsContainer with computed norms for each field +Fields container of scalar fields, one per input field, each containing the $L_p$ norm per entity. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/phase.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/phase.md index d712a3c6d..c0f24d53e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/phase.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/phase.md @@ -10,7 +10,12 @@ license: None ## Description -Computes the phase (in rad) between a real and an imaginary field. + +Computes the [argument](https://en.wikipedia.org/wiki/Argument_(complex_analysis)) (phase angle) +of a complex quantity given as separate real and imaginary fields: +$\phi[i] = \mathrm{atan2}(B[i],\, A[i])$. +The output is in radians. + ## Inputs @@ -57,7 +62,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) - +Field containing the phase angle $\mathrm{atan2}(B[i],\, A[i])$ in radians for each data entry. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/phase_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/phase_fc.md index 42d23107a..c1fdd23c1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/phase_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/phase_fc.md @@ -10,7 +10,12 @@ license: None ## Description -Computes phase (in rad) between real and imaginary fields. + +Computes the [argument](https://en.wikipedia.org/wiki/Argument_(complex_analysis)) (phase angle) +$\mathrm{atan2}(\mathrm{Im}[i],\, \mathrm{Re}[i])$ in radians for each complex-valued field pair +in the input fields container, where pairs are matched by complex label. +If no imaginary part is found for a real field, a zero-valued field is produced. + ## Inputs @@ -29,7 +34,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Complex-valued fields container with paired real (complex label 0) and imaginary (complex label 1) fields. ## Outputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container with phase angle fields $\mathrm{atan2}(\mathrm{Im}[i],\, \mathrm{Re}[i])$ in radians; zero-valued fields are produced where no imaginary part is found. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/polar_to_cplx.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/polar_to_cplx.md index c051f222c..b24d649ef 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/polar_to_cplx.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/polar_to_cplx.md @@ -10,7 +10,14 @@ license: None ## Description -Converts a complex number from polar form to complex. + +Converts a complex-valued fields container from +[polar form](https://en.wikipedia.org/wiki/Complex_number#Polar_complex_plane) (amplitude, phase) +to rectangular form (real, imaginary): +$\mathrm{Re}[i] = A[i] \cdot \cos(\phi[i])$, $\mathrm{Im}[i] = A[i] \cdot \sin(\phi[i])$. +The input must contain amplitude fields tagged with complex label 2 +and phase fields tagged with complex label 3. + ## Inputs @@ -29,7 +36,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Complex-valued fields container with amplitude fields (complex label 2) paired with phase angle fields (complex label 3). ## Outputs @@ -48,7 +55,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container in rectangular form: real parts (complex label 0) and imaginary parts (complex label 1). ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/pow.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/pow.md index 2d67e87dd..8a3a56abe 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/pow.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/pow.md @@ -10,7 +10,7 @@ license: None ## Description -Computes element-wise field[i]^p. +Computes entity-wise field[i]^p. ## Inputs diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/pow_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/pow_fc.md index 9a7c2f865..a5b8ef3a0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/pow_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/pow_fc.md @@ -10,7 +10,7 @@ license: None ## Description -Computes element-wise field[i]^p. +Computes entity-wise field[i]^p. ## Inputs diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/real_part.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/real_part.md index b86753929..3c574e8f8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/real_part.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/real_part.md @@ -10,7 +10,10 @@ license: None ## Description -Extracts element-wise real part of field containers containing complex fields. + +Extracts the real-part fields (complex label 0) from a complex-valued fields container. +The output container preserves all labels except the complex label. + ## Inputs @@ -29,7 +32,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Complex-valued fields container with real (complex label 0) and imaginary (complex label 1) part fields. ## Outputs @@ -48,7 +51,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container containing only the real-part fields, without the complex label. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/scale.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/scale.md index 0b42e54e4..950d3b7c9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/scale.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/scale.md @@ -10,7 +10,16 @@ license: None ## Description -Scales a field by a constant factor. This factor can be a scalar or a vector, where each value of the vector represents a scaler per component. Number of the components are corresponding to the input field dimensionality + +Scales a field by a constant factor $k$: $\mathrm{out}[i] = k \cdot \mathrm{field}[i]$. +The factor can be a scalar (same $k$ for every component), +a vector of length $n_c$ (one $k_j$ per component, +applied as $\mathrm{out}[i \cdot n_c + j] = k_j \cdot \mathrm{field}[i \cdot n_c + j]$), +or a field whose values are matched by entity or location +(entity-wise multiplication, also known as the +[Hadamard product](https://en.wikipedia.org/wiki/Hadamard_product_(matrices))). +Setting pin 2 to true makes the output dimensionless. + ## Inputs diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/scale_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/scale_fc.md index af7453c35..39ee58319 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/scale_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/scale_fc.md @@ -10,7 +10,15 @@ license: None ## Description -Scales a fields container by a constant factor. This factor can be a scalar, a vector a field, a fields container, where each value of the vector represents a scaler per component. Number of the components are corresponding to the input field dimensionality + +Scales every field in a fields container by a constant factor. +The factor can be a scalar (same value applied to all components), +a vector of length $n_c$ (one value per component), +a field or a fields container (values matched by entity or label space), +in which case the operation is an entity-wise multiplication +(also known as the [Hadamard product](https://en.wikipedia.org/wiki/Hadamard_product_(matrices))). +Parallelised over fields. + ## Inputs diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/sin.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/sin.md index 8f6aeda76..d82187faa 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/sin.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/sin.md @@ -10,7 +10,13 @@ license: None ## Description -Computes element-wise sine function on field data: sin(field[i]). + +Computes the entity-wise [sine](https://en.wikipedia.org/wiki/Sine_and_cosine): +$\mathrm{out}[i] = \sin(\mathrm{in}[i])$. +The input must be dimensionless or carry an angle unit; any other unit raises an error. +When the input unit is an angle (e.g. degrees), values are automatically converted to radians +before the sine is applied. The output is dimensionless. + ## Inputs @@ -29,7 +35,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field containing numeric data for sine calculation +Dimensionless or angle-unit field. ## Outputs @@ -48,7 +54,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field with sine values applied element-wise to input data +Dimensionless field with $\sin(\mathrm{in}[i])$ for each data entry. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/sin_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/sin_fc.md index 57a34ef71..d7ae0851a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/sin_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/sin_fc.md @@ -10,7 +10,13 @@ license: None ## Description -Computes element-wise sine function on field data: sin(field[i]). + +Computes the entity-wise [sine](https://en.wikipedia.org/wiki/Sine_and_cosine): +$\mathrm{out}[i] = \sin(\mathrm{in}[i])$. +The input must be dimensionless or carry an angle unit; any other unit raises an error. +When the input unit is an angle (e.g. degrees), values are automatically converted to radians +before the sine is applied. The output is dimensionless. + ## Inputs @@ -29,7 +35,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field containing numeric data for sine calculation +Dimensionless or angle-unit field. ## Outputs @@ -48,7 +54,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field with sine values applied element-wise to input data +Dimensionless field with $\sin(\mathrm{in}[i])$ for each data entry. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/sqr.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/sqr.md index 47fa4c10d..06954f857 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/sqr.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/sqr.md @@ -10,7 +10,12 @@ license: None ## Description -Computes element-wise field[i]^2. + +Computes the entity-wise square +([Hadamard power](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations) of two): +$\mathrm{out}[i] = \mathrm{in}[i]^2$. +The output unit is $u^2$ where $u$ is the input unit. + ## Inputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field with squared values applied element-wise to input data +Field with $\mathrm{in}[i]^2$ for each data entry; unit is $u^2$, where $u$ is the input unit. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/sqr_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/sqr_fc.md index c4ec9cfb3..549778c12 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/sqr_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/sqr_fc.md @@ -10,7 +10,12 @@ license: None ## Description -Computes element-wise field[i]^2. + +Computes the entity-wise square +([Hadamard power](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations) of two): +$\mathrm{out}[i] = \mathrm{in}[i]^2$. +The output unit is $u^2$ where $u$ is the input unit. + ## Inputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field with squared values applied element-wise to input data +Field with $\mathrm{in}[i]^2$ for each data entry; unit is $u^2$, where $u$ is the input unit. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/sqrt.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/sqrt.md index 0187aaf89..9dae369b9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/sqrt.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/sqrt.md @@ -10,7 +10,13 @@ license: None ## Description -Computes element-wise square root function on field data: sqrt(field[i]). + +Computes the entity-wise square root +([Hadamard root](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations)): +$\mathrm{out}[i] = \sqrt{\mathrm{in}[i]}$. +All input values must be non-negative; a negative value raises an error. +The output unit is $\sqrt{u}$ where $u$ is the input unit. + ## Inputs @@ -29,7 +35,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field or fields container containing numeric data for square root calculation +Field or fields container containing non-negative numeric data. ## Outputs @@ -48,7 +54,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field with square root values applied element-wise to input data +Field with $\sqrt{\mathrm{in}[i]}$ for each data entry; unit is $\sqrt{u}$, where $u$ is the input unit. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/sqrt_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/sqrt_fc.md index ab1b4e29c..0f3db34a1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/sqrt_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/sqrt_fc.md @@ -10,7 +10,13 @@ license: None ## Description -Computes element-wise square root function on field data: sqrt(field[i]). + +Computes the entity-wise square root +([Hadamard root](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations)): +$\mathrm{out}[i] = \sqrt{\mathrm{in}[i]}$. +All input values must be non-negative; a negative value raises an error. +The output unit is $\sqrt{u}$ where $u$ is the input unit. + ## Inputs @@ -29,7 +35,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field or fields container containing numeric data for square root calculation +Field or fields container containing non-negative numeric data. ## Outputs @@ -48,7 +54,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field with square root values applied element-wise to input data +Field with $\sqrt{\mathrm{in}[i]}$ for each data entry; unit is $\sqrt{u}$, where $u$ is the input unit. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/sweeping_phase.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/sweeping_phase.md index e09e59e54..217565460 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/sweeping_phase.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/sweeping_phase.md @@ -10,7 +10,12 @@ license: None ## Description -Shifts the phase of a real and an imaginary field (in 0 and 1) of a given angle (in 3) of a unit (in 4). The resulting field is computed as field_out = real_field`*`cos(angle) - imaginary_field`*`sin(angle). + +Projects a [phasor](https://en.wikipedia.org/wiki/Phasor) field onto a given phase angle $\theta$: +$\mathrm{out}[i] = \mathrm{fieldReal}[i] \cdot \cos(\theta) - \mathrm{fieldImaginary}[i] \cdot \sin(\theta)$. +When pin 4 is true, the absolute value of the projection is returned instead. +If the imaginary field is absent and pin 5 is true, the imaginary part is treated as zero. + ## Inputs @@ -50,7 +55,7 @@ field or fields container with only one field is expected - **Required:** Yes - **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types) - +Phase angle $\theta$ to project onto, in the unit specified by pin 3 (default: radians). ### unit_name (Pin 3) @@ -66,7 +71,7 @@ String Unit. Supported values: "deg" or "rad". Default: "rad". - **Required:** Yes - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - +If true, the absolute value of the projection is returned (default: false). ### imaginary_part_null (Pin 5) @@ -93,7 +98,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) - +Projected field $\mathrm{fieldReal} \cdot \cos(\theta) - \mathrm{fieldImaginary} \cdot \sin(\theta)$, with the unit of pin 0. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/sweeping_phase_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/sweeping_phase_fc.md index 23f88d352..9b6c0ca90 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/sweeping_phase_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/sweeping_phase_fc.md @@ -10,7 +10,13 @@ license: None ## Description -Shifts the phase of all the corresponding real and imaginary fields of a fields container for a given angle (in 2) of a unit (in 4). An output field is computed for each pair of real and imaginary fields in the input fields_container as field_out = real_field`*`cos(angle) - imaginary_field`*`sin(angle). + +Projects every [phasor](https://en.wikipedia.org/wiki/Phasor) field pair in the input fields container +onto a given phase angle $\theta$: +$\mathrm{out}[i] = \mathrm{fieldReal}[i] \cdot \cos(\theta) - \mathrm{fieldImaginary}[i] \cdot \sin(\theta)$. +Pairs are matched by complex label. +When pin 4 is true, the absolute value of each projection is returned. + ## Inputs @@ -32,7 +38,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Complex-valued fields container with paired real and imaginary part fields. ### angle (Pin 2) @@ -40,7 +46,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types) - +Phase angle $\theta$ to project onto, in the unit specified by pin 3 (default: radians). ### unit_name (Pin 3) @@ -56,7 +62,7 @@ String Unit. Supported values: "deg" or "rad". Default: "rad". - **Required:** Yes - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - +If true, the absolute value of each projection is returned (default: false). ## Outputs @@ -75,7 +81,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container with the projected fields $\mathrm{fieldReal} \cdot \cos(\theta) - \mathrm{fieldImaginary} \cdot \sin(\theta)$, without the complex label. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/time_freq_interpolation.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/time_freq_interpolation.md index 9da2b22d2..7ef72b29b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/time_freq_interpolation.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/time_freq_interpolation.md @@ -10,7 +10,15 @@ license: None ## Description -Interpolates between all the matching fields of a fields container at given times or frequencies, using ramped: fieldOut = field1*(1.-fact)+field2*(fact), or stepped: fieldOut=field2. If the time freq is higher than the max available, the field at the max time freq is taken. Computes the output time freq support to support the fields container + +Interpolates the fields in a fields container at the requested times or frequencies +using [linear interpolation](https://en.wikipedia.org/wiki/Linear_interpolation). +Ramped interpolation ($p = 1$, default): $\mathrm{out}[i] = (1 - s) \cdot f_1[i] + s \cdot f_2[i]$ +where $s = (t - t_1) / (t_2 - t_1)$. +Stepped interpolation ($p = 2$): $\mathrm{out}[i] = f_2[i]$. +If the requested value exceeds the available range, the field at the maximum available value is used. +A new time-frequency support aligned with the requested values is produced as a second output. + ## Inputs @@ -86,6 +94,7 @@ Each output is detailed in the sections that follow the table. | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [fields_container](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| **1**| [time_freq_support](#output_1) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | @@ -93,7 +102,14 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -FieldsContainer with interpolated fields at specified time/frequency values +Fields container with one interpolated field set per requested time or frequency value. + + +### time_freq_support (Pin 1) + +- **Expected type(s):** [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) + +Time or frequency support aligned with the output fields container. ## Configurations @@ -152,6 +168,7 @@ op.connect(3, my_interpolation_type); op.connect(4, my_force_new_time_freq_support); op.connect(8, my_time_freq_support); ansys::dpf::FieldsContainer my_fields_container = op.getOutput(0); +ansys::dpf::TimeFreqSupport my_time_freq_support = op.getOutput(1); ``` @@ -169,6 +186,7 @@ op.inputs.interpolation_type.connect(my_interpolation_type) op.inputs.force_new_time_freq_support.connect(my_force_new_time_freq_support) op.inputs.time_freq_support.connect(my_time_freq_support) my_fields_container = op.outputs.fields_container() +my_time_freq_support = op.outputs.time_freq_support() ``` @@ -187,6 +205,7 @@ op.inputs.interpolation_type.Connect(my_interpolation_type) op.inputs.force_new_time_freq_support.Connect(my_force_new_time_freq_support) op.inputs.time_freq_support.Connect(my_time_freq_support) my_fields_container = op.outputs.fields_container.GetData() +my_time_freq_support = op.outputs.time_freq_support.GetData() ```
diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/unit_convert.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/unit_convert.md index 195d9ef92..fbb5692f2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/unit_convert.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/unit_convert.md @@ -10,7 +10,15 @@ license: None ## Description -Converts an input field/fields container or mesh of a given unit to another unit. + +Converts an input entity from one unit to another using the linear relation +$v_\mathrm{out}[i] = k \cdot v_\mathrm{in}[i] + \delta$, +where $k$ and $\delta$ are the unit conversion factor and shift. +Accepts fields, fields containers, meshes, and meshes containers. +For mesh inputs only the coordinate field is converted. +When the permissive option is enabled and units are not homogeneous with the target unit, +the conversion is silently skipped. + ## Inputs @@ -57,7 +65,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) -the output entity is the same as the input (inplace operator) +Converted entity of the same type as the input, modified in place. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/unit_convert_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/unit_convert_fc.md index d160d30e5..b59ed69e1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/unit_convert_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/unit_convert_fc.md @@ -10,7 +10,14 @@ license: None ## Description -Converts an input fields container of a given unit to another unit. + +Converts a fields container from one unit to another using the linear relation +$v_\mathrm{out}[i] = k \cdot v_\mathrm{in}[i] + \delta$, +where $k$ and $\delta$ are the unit conversion factor and shift. +All fields must be homogeneous with the target unit. +When the permissive option is enabled and units are not homogeneous, +the container is returned unchanged. + ## Inputs @@ -30,7 +37,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container to convert. All fields are converted in place. ### unit_name (Pin 1) @@ -57,7 +64,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -FieldsContainer with converted units (inplace operation) +Fields container with all field data converted to the requested unit, modified in place. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/beam_properties.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/beam_properties.md index b8e4b1fad..a86aa6ea4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/beam_properties.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/beam_properties.md @@ -12,12 +12,6 @@ license: None Reads the beam's properties from the result files contained in the streams or data sources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_provider.md index fce88ff18..93968207f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_provider.md @@ -2,6 +2,10 @@ category: mesh plugin: core license: None +namespaces: + cff: [cas, flprj] + hdf5: [h5dpf] + vtk: [vtk] --- # mesh:mesh provider @@ -21,9 +25,7 @@ If `permissive` is disabled (default), errors are thrown for invalid files. This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - cff: cas, flprj -- cgns: cgns - hdf5: h5dpf -- mapdl: cms, dsub, mode, rdsp, rfrq, rst, rstp, rth - vtk: vtk ## Inputs diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_to_pyvista.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_to_pyvista.md index b4b3850d6..baec2f4e6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_to_pyvista.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_to_pyvista.md @@ -10,7 +10,40 @@ license: None ## Description -Export a MeshedRegion in the pyVista format. + + Export a MeshedRegion to the pyVista format. + The mesh type is auto-detected and controls which pins are respected: + + | Mesh has Elements | Mesh has Faces | Detected type | Pins `as_poly`, `as_modified_connectivity`, `as_linear` handled? | + |-------------------|----------------|---------------|--------------------------------------------------------------------| + | yes | yes | FVM Mesh | No - the output is always built with the `as_poly=True` behavior. | + | no | yes | Face Mesh | No - the output is always built with the `as_poly=False` behavior | + | yes | no | FEM Mesh | Yes | + + For **FEM Mesh** only, the build behaviour depends on the input pins: + + | `as_poly` | `as_modified_connectivity` | `vtk_updated` | `as_linear` | Notes | + |-------------------|----------------------------|---------------|-------------|------------------------------------------------------------------------------| + | true | any | false | any | `as_modified_connectivity` and `as_linear` ignored; offsets written to pin 3 | + | true | any | true | any | `as_modified_connectivity` and `as_linear` ignored; no pin 3 | + | false | true | any | true | `vtk_updated` has no effect; quadratic elements are linearized | + | false | true | any | false | `vtk_updated` has no effect; quadratic elements kept quadratic | + | false | false | true | true | quadratic elements are linearized | + | false | false | true | false | quadratic elements kept quadratic | + | false | false | false | true | quadratic elements are linearized; offsets written to pin 3 | + | false | false | false | false | quadratic elements kept quadratic; offsets written to pin 3 | + + Output pins: + + | Pin | Content | Condition | + |-----|---------------------------------------------------------------------|--------------------------------------------------------------| + | 0 | Node coordinates | always | + | 1 | Modified connectivity (no node-count prefix) | `as_modified_connectivity = true` | + | 1 | Classic connectivity (legacy VTK flat format with node-count prefix)| `as_modified_connectivity = false` | + | 2 | Cell types array | always | + | 3 | Legacy offsets array | `vtk_updated = false` and `as_modified_connectivity = false` | + | 4 | Offsets into modified connectivity (CSR-style, size = nCells+1) | `as_modified_connectivity = true` | + ## Inputs @@ -20,12 +53,22 @@ Each parameter is detailed in the sections that follow the table. | Pin number | Name | Status | Expected type(s) | |------------|------|--------|------------------| +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | | 2 | [coordinates](#input_2) | |[`field`](../../core-concepts/dpf-types.md#field) | | 6 | [as_linear](#input_6) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | 7 | [mesh](#input_7) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | | 60 | [vtk_updated](#input_60) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | 200 | [as_poly](#input_200) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 201 | [as_modified_connectivity](#input_201) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | + + +### mesh_scoping (Pin 1) + +- **Required:** No +- **Expected type(s):** [`scoping`](../../core-concepts/dpf-types.md#scoping) + +if mesh scoping is connected then the output vtk mesh is build on the subset of the input mesh scoped on it. If not set, the whole input mesh is converted to the final vtk mesh. ### coordinates (Pin 2) @@ -57,7 +100,7 @@ mesh to export in pyVista format - **Required:** No - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) -True if the VTK version employed by pyVista is > VTK 9. Default true. +True if the VTK version employed by pyVista is > VTK 9. Default true.If false, an offset array to the cell connectivity is returned on pin 3.Incompatible with as_modified_connectivity=true. ### as_poly (Pin 200) @@ -67,6 +110,14 @@ True if the VTK version employed by pyVista is > VTK 9. Default true. Export elements as polyhedrons (cell-face-node representation). Default false. + +### as_modified_connectivity (Pin 201) + +- **Required:** No +- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) + +Returns VTK version>9 compatible connectivity representation consisting of an array of concatenated node indices for cells without node count headers and an offset array to it. Default false. Works only for FEM meshes with VTK version>9 and as poly=false.If as_linear is True, quadratic elements are linearized (dropping midside nodes) + ## Outputs @@ -80,6 +131,7 @@ Each output is detailed in the sections that follow the table. | **1**| [cells](#output_1) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | **2**| [cell_types](#output_2) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | | **3**| [offsets](#output_3) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| **4**| [offsets_concatenated_node_indices](#output_4) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | @@ -110,6 +162,13 @@ Cell types property int vector If vtk_updated=false, offsets int vector + +### offsets_concatenated_node_indices (Pin 4) + +- **Expected type(s):** [`vector`](../../core-concepts/dpf-types.md#standard-types) + +Offsets to concatenated cell connectivity without node count headers, type int vector + ## Configurations @@ -153,15 +212,18 @@ Each example shows how to instantiate the operator, connect the required inputs, #include "dpf_api.h" ansys::dpf::Operator op("mesh_to_pyvista"); // operator instantiation +op.connect(1, my_mesh_scoping); op.connect(2, my_coordinates); op.connect(6, my_as_linear); op.connect(7, my_mesh); op.connect(60, my_vtk_updated); op.connect(200, my_as_poly); +op.connect(201, my_as_modified_connectivity); ansys::dpf::Field my_nodes = op.getOutput(0); std::vector my_cells = op.getOutput>(1); std::vector my_cell_types = op.getOutput>(2); std::vector my_offsets = op.getOutput>(3); +std::vector my_offsets_concatenated_node_indices = op.getOutput>(4); ``` @@ -172,15 +234,18 @@ std::vector my_offsets = op.getOutput>(3); import ansys.dpf.core as dpf op = dpf.operators.mesh.None() # operator instantiation +op.inputs.mesh_scoping.connect(my_mesh_scoping) op.inputs.coordinates.connect(my_coordinates) op.inputs.as_linear.connect(my_as_linear) op.inputs.mesh.connect(my_mesh) op.inputs.vtk_updated.connect(my_vtk_updated) op.inputs.as_poly.connect(my_as_poly) +op.inputs.as_modified_connectivity.connect(my_as_modified_connectivity) my_nodes = op.outputs.nodes() my_cells = op.outputs.cells() my_cell_types = op.outputs.cell_types() my_offsets = op.outputs.offsets() +my_offsets_concatenated_node_indices = op.outputs.offsets_concatenated_node_indices() ``` @@ -192,15 +257,18 @@ import mech_dpf import Ans.DataProcessing as dpf op = dpf.operators.mesh.None() # operator instantiation +op.inputs.mesh_scoping.Connect(my_mesh_scoping) op.inputs.coordinates.Connect(my_coordinates) op.inputs.as_linear.Connect(my_as_linear) op.inputs.mesh.Connect(my_mesh) op.inputs.vtk_updated.Connect(my_vtk_updated) op.inputs.as_poly.Connect(my_as_poly) +op.inputs.as_modified_connectivity.Connect(my_as_modified_connectivity) my_nodes = op.outputs.nodes.GetData() my_cells = op.outputs.cells.GetData() my_cell_types = op.outputs.cell_types.GetData() my_offsets = op.outputs.offsets.GetData() +my_offsets_concatenated_node_indices = op.outputs.offsets_concatenated_node_indices.GetData() ```
diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/meshes_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/meshes_provider.md index f0cc8c163..9051c1fc1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/meshes_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/meshes_provider.md @@ -2,6 +2,9 @@ category: mesh plugin: core license: None +namespaces: + cff: [cas, flprj] + hdf5: [h5dpf] --- # mesh:meshes provider @@ -19,10 +22,7 @@ The operator attempts to read mesh data from the provided data sources. When the This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - cff: cas, flprj -- cgns: cgns - hdf5: h5dpf -- lsdyna: binout, d3acp, d3acs, d3atv, d3plot, d3psd, d3spcm, d3ssd, moddynout -- mapdl: cms, dsub, mode, rdsp, rfrq, rst ## Inputs diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/boundary_condition_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/boundary_condition_provider.md index 0e9aff4a4..82ef137aa 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/boundary_condition_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/boundary_condition_provider.md @@ -12,12 +12,6 @@ license: None Reads boundary conditions from the results files contained in the streams or data sources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: cms, mode, rdsp, rfrq, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/coordinate_system_data_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/coordinate_system_data_provider.md index 7cf6e13d0..23a542e1f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/coordinate_system_data_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/coordinate_system_data_provider.md @@ -12,12 +12,6 @@ license: None Reads coordinate systems data from the result files contained in the streams or data sources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/cyclic_support_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/cyclic_support_provider.md index ab310e0a3..6871a60da 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/cyclic_support_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/cyclic_support_provider.md @@ -12,13 +12,6 @@ license: None Read the cyclic support (DPF entity containing necessary information for expansions) and expands the mesh. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: cms, dsub, mode, rdsp, rfrq, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/element_types_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/element_types_provider.md index a6f2279f9..ae36728c6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/element_types_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/element_types_provider.md @@ -21,12 +21,6 @@ Reads element types data from the result files contained in the streams or data - new_gen_element: Element of new generation. - If the output is a PropertyField, it contains the 200 possible ElementTypesProperties for each solver element type id. These properties are in the order documented in ansys/customize/include/echprm.inc and have the meaning documented in ansys/customize/include/elccmt.inc. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/is_cyclic.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/is_cyclic.md index 41ca63b9a..84206c7ac 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/is_cyclic.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/is_cyclic.md @@ -2,6 +2,8 @@ category: metadata plugin: core license: None +namespaces: + hdf5: [h5dpf] --- # metadata:cyclic analysis? @@ -17,7 +19,6 @@ Reads if the model is cyclic from the result file. This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - hdf5: h5dpf -- mapdl: cms, dsub, mode, rdsp, rfrq, rst, rstp, rth ## Inputs diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/material_support_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/material_support_provider.md index 5df1ee1e8..774b26f2a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/material_support_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/material_support_provider.md @@ -12,12 +12,6 @@ license: None Reads the material support. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_info_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_info_provider.md index d9cd63eea..874f0a6d6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_info_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_info_provider.md @@ -2,6 +2,8 @@ category: metadata plugin: core license: None +namespaces: + cff: [cas, flprj] --- # metadata:mesh info provider @@ -17,8 +19,6 @@ Reads the mesh information, such as number of elements (common property), number This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - cff: cas, flprj -- cgns: cgns -- lsdyna: d3plot ## Inputs diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_property_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_property_provider.md index be3820834..de3be94e6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_property_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_property_provider.md @@ -2,6 +2,9 @@ category: metadata plugin: core license: None +namespaces: + cff: [cas, flprj] + hdf5: [h5dpf] --- # metadata:mesh property provider @@ -17,10 +20,7 @@ Reads a property related to the mesh, defined by its name, by calling the reader This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - cff: cas, flprj -- cgns: cgns - hdf5: h5dpf -- lsdyna: d3plot -- mapdl: cms, dsub, mode, rdsp, rfrq, rst, rstp, rth ## Inputs diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_selection_manager_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_selection_manager_provider.md index e53eac666..57ea11d14 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_selection_manager_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_selection_manager_provider.md @@ -12,12 +12,6 @@ license: None Reads mesh properties from the results files contained in the streams or data sources, and makes those properties available through a mesh selection manager in output. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: dsub, rdsp, rfrq, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/real_constants_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/real_constants_provider.md index 70cc312eb..9f0ba3f36 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/real_constants_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/real_constants_provider.md @@ -12,12 +12,6 @@ license: None Reads real constants from the result files contained in the streams or data sources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/result_info_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/result_info_provider.md index 7dace5f90..b9e1822d0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/result_info_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/result_info_provider.md @@ -2,6 +2,10 @@ category: metadata plugin: core license: None +namespaces: + cff: [cas, flprj] + hdf5: [h5dpf] + vtk: [vtk] --- # metadata:result info provider @@ -17,10 +21,7 @@ Reads the result information, such as available results or unit systems from the This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - cff: cas, flprj -- cgns: cgns - hdf5: h5dpf -- lsdyna: binout, d3acp, d3acs, d3atv, d3plot, d3psd, d3ssd, lsda, moddynout -- mapdl: cms, dsub, mode, rdsp, rfrq, rst, rstp, rth - vtk: vtk ## Inputs diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/time_freq_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/time_freq_provider.md index 1de586de0..a1a67c5be 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/time_freq_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/time_freq_provider.md @@ -12,16 +12,6 @@ license: None Reads the time/frequency support from the results files contained in the streams or data sources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj -- cgns: cgns -- hdf5: h5dpf -- lsdyna: binout, d3acp, d3acs, d3atv, d3plot, d3psd, d3ssd, lsda, moddynout -- mapdl: cms, dsub, mode, rdsp, rfrq, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration.md index 0f7255266..467d58457 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration.md @@ -12,14 +12,6 @@ license: None Read/compute nodal accelerations by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: d3plot, d3psd, d3ssd, lsda, moddynout -- mapdl: cms, mode, rdsp, rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -154,6 +146,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_X.md index 997f9e8a6..d3fdad288 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_X.md @@ -12,12 +12,6 @@ license: None Read/compute nodal accelerations X component of the vector (1st component) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_Y.md index 293d7d960..9b849f88d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_Y.md @@ -12,12 +12,6 @@ license: None Read/compute nodal accelerations Y component of the vector (2nd component) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_Z.md index e730241da..4ec6a15b3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_Z.md @@ -12,12 +12,6 @@ license: None Read/compute nodal accelerations Z component of the vector (3rd component) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/accu_eqv_creep_strain.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/accu_eqv_creep_strain.md index 277e1296a..0b729b9c4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/accu_eqv_creep_strain.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/accu_eqv_creep_strain.md @@ -43,12 +43,6 @@ Read/compute element nodal accumulated equivalent creep strain by calling the re | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -183,6 +177,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/accu_eqv_plastic_strain.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/accu_eqv_plastic_strain.md index 8e929b5a2..b0f836bdb 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/accu_eqv_plastic_strain.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/accu_eqv_plastic_strain.md @@ -43,13 +43,6 @@ Read/compute element nodal accumulated equivalent plastic strain by calling the | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -220,6 +213,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/acoustic_energy_density.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/acoustic_energy_density.md index c40084566..643240c0c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/acoustic_energy_density.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/acoustic_energy_density.md @@ -12,13 +12,6 @@ license: None Read/compute AED by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/acoustic_pressure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/acoustic_pressure.md index f3760e965..9426fa87d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/acoustic_pressure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/acoustic_pressure.md @@ -101,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/artificial_hourglass_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/artificial_hourglass_energy.md index 1b1bdcf81..506fbeb9e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/artificial_hourglass_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/artificial_hourglass_energy.md @@ -12,13 +12,6 @@ license: None Read/compute artificial hourglass energy by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/average_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/average_velocity.md index caa12dc75..9f4077b72 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/average_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/average_velocity.md @@ -12,13 +12,6 @@ license: None Read/compute average velocity by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_force.md index cfaf3d6f0..3c447785d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_force.md @@ -12,14 +12,6 @@ license: None Read Beam X Axial Force by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: d3plot -- mapdl: rst - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_plastic_strain.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_plastic_strain.md index c9ea9651e..1a74a754d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_plastic_strain.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_plastic_strain.md @@ -12,13 +12,6 @@ license: None Read Beam Axial Plastic strain (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: d3plot - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_stress.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_stress.md index 5cced7996..fcd42b4c5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_stress.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_stress.md @@ -12,14 +12,6 @@ license: None Read Beam X Axial Stress by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: d3plot -- mapdl: rst - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_total_strain.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_total_strain.md index 8facc4631..4edf1355f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_total_strain.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_total_strain.md @@ -12,14 +12,6 @@ license: None Read Beam X Axial Total strain by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: d3plot -- mapdl: rst - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_rs_shear_stress.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_rs_shear_stress.md index 7e03daf3e..a720193e3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_rs_shear_stress.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_rs_shear_stress.md @@ -12,13 +12,6 @@ license: None Read Beam RS Shear Stress (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: d3plot - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_s_bending_moment.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_s_bending_moment.md index e296360ce..73eea7fdb 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_s_bending_moment.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_s_bending_moment.md @@ -12,14 +12,6 @@ license: None Read Beam S/Y Bending Moment by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: d3plot -- mapdl: rst - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_s_shear_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_s_shear_force.md index 52d66f46d..3bb583a1c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_s_shear_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_s_shear_force.md @@ -12,14 +12,6 @@ license: None Read Beam S/Y Shear Force by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: d3plot -- mapdl: rst - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_t_bending_moment.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_t_bending_moment.md index 830330948..7ef61c860 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_t_bending_moment.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_t_bending_moment.md @@ -12,14 +12,6 @@ license: None Read Beam T/Z Bending Moment by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: d3plot -- mapdl: rst - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_t_shear_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_t_shear_force.md index f162901d8..a3bd3188c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_t_shear_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_t_shear_force.md @@ -12,14 +12,6 @@ license: None Read Beam T/Z Shear Force by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: d3plot -- mapdl: rst - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_torsional_moment.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_torsional_moment.md index 60b301e85..08308323c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_torsional_moment.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_torsional_moment.md @@ -12,14 +12,6 @@ license: None Read Beam Torsional Moment by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: d3plot -- mapdl: rst - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_tr_shear_stress.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_tr_shear_stress.md index 7ea501098..9c4cc44b1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_tr_shear_stress.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_tr_shear_stress.md @@ -12,13 +12,6 @@ license: None Read Beam TR Shear Stress (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: d3plot - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/co_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/co_energy.md index 0a7502763..87892d148 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/co_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/co_energy.md @@ -12,13 +12,6 @@ license: None Read/compute co-energy (magnetics) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_fluid_penetration_pressure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_fluid_penetration_pressure.md index 02c8f1bd4..2def77867 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_fluid_penetration_pressure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_fluid_penetration_pressure.md @@ -43,13 +43,6 @@ Read/compute element actual applied fluid penetration pressure by calling the re | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: mode, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -220,6 +213,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_friction_stress.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_friction_stress.md index 3730f8d93..afd3fe6aa 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_friction_stress.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_friction_stress.md @@ -43,13 +43,6 @@ Read/compute element contact friction stress by calling the readers defined by t | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: mode, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -220,6 +213,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_gap_distance.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_gap_distance.md index b1c4d2b82..e647ae832 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_gap_distance.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_gap_distance.md @@ -43,13 +43,6 @@ Read/compute element contact gap distance by calling the readers defined by the | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: mode, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -220,6 +213,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_penetration.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_penetration.md index 3b286214d..65d48c148 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_penetration.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_penetration.md @@ -43,14 +43,6 @@ Read/compute element contact penetration by calling the readers defined by the d | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: d3plot -- mapdl: mode, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -221,6 +213,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_pressure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_pressure.md index f10ef1321..e43b64a0b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_pressure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_pressure.md @@ -43,13 +43,6 @@ Read/compute element contact pressure by calling the readers defined by the data | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: mode, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -220,6 +213,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_sliding_distance.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_sliding_distance.md index 7d55f8e66..76e2910ff 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_sliding_distance.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_sliding_distance.md @@ -43,13 +43,6 @@ Read/compute element contact sliding distance by calling the readers defined by | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: mode, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -220,6 +213,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_status.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_status.md index 2a114fb36..5edddafa8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_status.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_status.md @@ -43,13 +43,6 @@ Read/compute element contact status by calling the readers defined by the dataso | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: mode, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -220,6 +213,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_surface_heat_flux.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_surface_heat_flux.md index 9b1ddfd2b..afe6e5533 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_surface_heat_flux.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_surface_heat_flux.md @@ -43,13 +43,6 @@ Read/compute element total heat flux at contact surface by calling the readers d | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: mode, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -220,6 +213,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_total_stress.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_total_stress.md index 8afa24d30..bc5de1388 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_total_stress.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_total_stress.md @@ -43,13 +43,6 @@ Read/compute element contact total stress (pressure plus friction) by calling th | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: mode, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -220,6 +213,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/coordinate_system.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/coordinate_system.md index 99999c41c..a2069fc75 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/coordinate_system.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/coordinate_system.md @@ -12,12 +12,6 @@ license: None Extracts the Rotation Matrix and Origin of a specific coordinate system. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/coordinates.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/coordinates.md index a450e099e..36f5f801f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/coordinates.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/coordinates.md @@ -12,13 +12,6 @@ license: None Read/compute Coordinates (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: d3plot - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -117,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain.md index 0a6c16a82..924e62751 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain.md @@ -43,13 +43,6 @@ Read/compute element nodal component creep strains by calling the readers define | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -193,6 +186,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_X.md index c36380954..a629d6cea 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_X.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component creep strains XX normal component (00 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_XY.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_XY.md index 2c5abc044..96b28c832 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_XY.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_XY.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component creep strains XY shear component (01 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_XZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_XZ.md index ee1042789..a98bbaafa 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_XZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_XZ.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component creep strains XZ shear component (02 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_Y.md index 52ee17b5f..b7a368100 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_Y.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component creep strains YY normal component (11 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_YZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_YZ.md index a6639394f..1d431e4d6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_YZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_YZ.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component creep strains YZ shear component (12 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_Z.md index b0e13d5b2..b14afde5d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_Z.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component creep strains ZZ normal component (22 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_energy_density.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_energy_density.md index 5037c6bb8..fa527fc00 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_energy_density.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_energy_density.md @@ -43,12 +43,6 @@ Read/compute element nodal creep strain energy density by calling the readers de | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -183,6 +177,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_eqv.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_eqv.md index f21410b02..941338644 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_eqv.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_eqv.md @@ -43,13 +43,6 @@ Read/compute element nodal equivalent component creep strains by calling the rea | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -184,6 +177,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_intensity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_intensity.md index 5ab648698..674c574c4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_intensity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_intensity.md @@ -13,12 +13,6 @@ license: None Reads/computes element nodal component creep strains, average it on nodes (by default) and computes its invariants. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_max_shear.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_max_shear.md index 42ca667bd..3adf72232 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_max_shear.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_max_shear.md @@ -13,12 +13,6 @@ license: None Reads/computes element nodal component creep strains, average it on nodes (by default) and computes its invariants. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_1.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_1.md index f456cc8c6..448d9b89e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_1.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_1.md @@ -13,12 +13,6 @@ license: None Read/compute element nodal component creep strains 1st principal component by calling the readers defined by the datasources and computing its eigen values. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_2.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_2.md index 12d6286c9..6a92a7883 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_2.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_2.md @@ -13,12 +13,6 @@ license: None Read/compute element nodal component creep strains 2nd principal component by calling the readers defined by the datasources and computing its eigen values. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_3.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_3.md index 79ec6f1cd..8c0ed6431 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_3.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_3.md @@ -13,12 +13,6 @@ license: None Read/compute element nodal component creep strains 3rd principal component by calling the readers defined by the datasources and computing its eigen values. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/current_density.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/current_density.md index f7f5545b9..fdcdd2ab7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/current_density.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/current_density.md @@ -20,12 +20,6 @@ This operator returns the elemental "Source current density", also named "JS" in To retrieve the result named "current density" in Mechanical or "JC" in MAPDL, use the solver specific operator: `mapdl::rth::JC`. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -124,6 +118,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/density.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/density.md index 26ffe1e39..eb6815355 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/density.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/density.md @@ -12,12 +12,6 @@ license: None Read Density by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement.md index b46a8832d..865772fbf 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement.md @@ -12,14 +12,6 @@ license: None Read/compute nodal displacements by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout, d3plot, d3psd, d3ssd, moddynout -- mapdl: cms, dsub, mode, rdsp, rfrq, rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -154,6 +146,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_X.md index efe1193d1..d5b17fe0d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_X.md @@ -12,12 +12,6 @@ license: None Read/compute nodal displacements X component of the vector (1st component) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_Y.md index 124f17eac..2675862b8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_Y.md @@ -12,12 +12,6 @@ license: None Read/compute nodal displacements Y component of the vector (2nd component) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_Z.md index 64fe04a88..16d4ee66e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_Z.md @@ -12,12 +12,6 @@ license: None Read/compute nodal displacements Z component of the vector (3rd component) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/div_lighthill_tensor.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/div_lighthill_tensor.md index d3b6f5c9f..8a098b746 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/div_lighthill_tensor.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/div_lighthill_tensor.md @@ -12,12 +12,6 @@ license: None Read Divergence of the Lighthill Tensor by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/dynamic_viscosity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/dynamic_viscosity.md index 55c4185ec..51c67c822 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/dynamic_viscosity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/dynamic_viscosity.md @@ -12,12 +12,6 @@ license: None Read Dynamic Viscosity by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain.md index 3ac7f53a8..6e3dea492 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain.md @@ -43,13 +43,6 @@ Read/compute element nodal component elastic strains by calling the readers defi | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: cms, mode, rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -229,6 +222,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_X.md index d184e20c9..e80faefdc 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_X.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component elastic strains XX normal component (00 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_XY.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_XY.md index efc01a217..7b3cbf809 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_XY.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_XY.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component elastic strains XY shear component (01 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_XZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_XZ.md index 07768aa2a..050d74e5a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_XZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_XZ.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component elastic strains XZ shear component (02 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_Y.md index b46818dad..6450382f8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_Y.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component elastic strains YY normal component (11 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_YZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_YZ.md index 755515c0a..1ceeedb6d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_YZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_YZ.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component elastic strains YZ shear component (12 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_Z.md index 36173d356..8448b000c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_Z.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component elastic strains ZZ normal component (22 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_energy_density.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_energy_density.md index d1b6eb0db..cd98bd6fa 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_energy_density.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_energy_density.md @@ -43,12 +43,6 @@ Read/compute element nodal elastic strain energy density by calling the readers | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -183,6 +177,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_eqv.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_eqv.md index 62f64a24c..f6a297be3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_eqv.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_eqv.md @@ -43,13 +43,6 @@ Read/compute element nodal equivalent elastic strain by calling the readers defi | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -184,6 +177,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_intensity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_intensity.md index 62d7f5482..eb5f344da 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_intensity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_intensity.md @@ -13,12 +13,6 @@ license: None Reads/computes element nodal component elastic strains, average it on nodes (by default) and computes its invariants. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_max_shear.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_max_shear.md index 231d2850e..269a60ef5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_max_shear.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_max_shear.md @@ -13,12 +13,6 @@ license: None Reads/computes element nodal component elastic strains, average it on nodes (by default) and computes its invariants. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_1.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_1.md index c090cd6e1..eaa0d2ab4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_1.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_1.md @@ -13,12 +13,6 @@ license: None Read/compute element nodal component elastic strains 1st principal component by calling the readers defined by the datasources and computing its eigen values. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_2.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_2.md index 48445963c..45d937896 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_2.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_2.md @@ -13,12 +13,6 @@ license: None Read/compute element nodal component elastic strains 2nd principal component by calling the readers defined by the datasources and computing its eigen values. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_3.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_3.md index 4ea1ab90b..52e9127c4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_3.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_3.md @@ -13,12 +13,6 @@ license: None Read/compute element nodal component elastic strains 3rd principal component by calling the readers defined by the datasources and computing its eigen values. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_field.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_field.md index 7946c1aff..ab9e92be3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_field.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_field.md @@ -43,12 +43,6 @@ Read/compute electric field by calling the readers defined by the datasources. | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -192,6 +186,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_flux_density.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_flux_density.md index e12236df8..f6ad6efd6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_flux_density.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_flux_density.md @@ -43,12 +43,6 @@ Read/compute Electric flux density by calling the readers defined by the datasou | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -192,6 +186,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_potential.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_potential.md index ea0d551b6..d179bda46 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_potential.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_potential.md @@ -12,12 +12,6 @@ license: None Read/compute electric Potential by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -107,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_centroids.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_centroids.md index ceea4b8b4..ebd74fd9d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_centroids.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_centroids.md @@ -12,12 +12,6 @@ license: None Read/compute coordinate of the undeformed mesh elemental centroids by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -107,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_nodal_forces.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_nodal_forces.md index ec9fa6e87..ece4c5671 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_nodal_forces.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_nodal_forces.md @@ -43,13 +43,6 @@ Read/compute element nodal forces by calling the readers defined by the datasour | 13 | Pretension | element_nodal_forces fields contain STATIC, DAMPING and INERTIA forces stored as components (when available). STATIC: components 0 -> 2. DAMPING: components 3 -> 5. INERTIA components 6 -> 8 -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: cms, mode, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -238,6 +231,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_nodal_heat.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_nodal_heat.md index 6253f858b..523258062 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_nodal_heat.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_nodal_heat.md @@ -43,13 +43,6 @@ Read/compute element nodal heat by calling the readers defined by the datasource | 13 | Pretension | element_nodal_heat fields contain STATIC and DAMPING forces stored as components (when available). STATIC: component 0. DAMPING: component 1. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -220,6 +213,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_nodal_moments.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_nodal_moments.md index 526229660..8cb229a75 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_nodal_moments.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_nodal_moments.md @@ -43,13 +43,6 @@ Read/compute element nodal moments by calling the readers defined by the datasou | 13 | Pretension | element_nodal_moments fields contain STATIC, DAMPING and INERTIA forces stored as components (when available). STATIC: components 0 -> 2. DAMPING: components 3 -> 5. INERTIA components 6 -> 8 -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: mode, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -229,6 +222,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_orientations.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_orientations.md index 41d0b2927..88be4cb45 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_orientations.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_orientations.md @@ -43,13 +43,6 @@ Read/compute element euler angles by calling the readers defined by the datasour | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: cms, mode, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -220,6 +213,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_heat_generation.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_heat_generation.md index d2e355372..430e63c65 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_heat_generation.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_heat_generation.md @@ -12,12 +12,6 @@ license: None Read/compute Elemental Heat Generation by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -107,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_mass.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_mass.md index 9a662ede0..83981d764 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_mass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_mass.md @@ -12,12 +12,6 @@ license: None Read/compute element mass by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -107,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_volume.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_volume.md index 808e214bc..7a14320c2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_volume.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_volume.md @@ -12,13 +12,6 @@ license: None Read/compute element volume by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: cms, mode, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +137,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/emissivity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/emissivity.md index 5b422ab6f..7d2c9d026 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/emissivity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/emissivity.md @@ -12,13 +12,6 @@ license: None Read/compute emissivity by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/emitted_radiation_heat_flux.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/emitted_radiation_heat_flux.md index 452861562..c4a151e1a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/emitted_radiation_heat_flux.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/emitted_radiation_heat_flux.md @@ -12,13 +12,6 @@ license: None Read/compute emitted radiation heat flux by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/enclosure_number.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/enclosure_number.md index acf432238..c57458d5f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/enclosure_number.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/enclosure_number.md @@ -12,13 +12,6 @@ license: None Read/compute enclosure number by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/enthalpy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/enthalpy.md index 3cdd1fe4e..2aa8fddf0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/enthalpy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/enthalpy.md @@ -12,12 +12,6 @@ license: None Read Enthalpy by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/entropy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/entropy.md index f7edb5cde..a17668754 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/entropy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/entropy.md @@ -12,12 +12,6 @@ license: None Read Entropy by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/epsilon.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/epsilon.md index 68db7b305..b802aa941 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/epsilon.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/epsilon.md @@ -12,12 +12,6 @@ license: None Read Turbulent Dissipation Rate (epsilon) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/equivalent_mass.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/equivalent_mass.md index 9b553fbb7..727e9d1f9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/equivalent_mass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/equivalent_mass.md @@ -12,12 +12,6 @@ license: None Read/compute equivalent dof mass by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -152,6 +146,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/eqv_stress_parameter.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/eqv_stress_parameter.md index 6e63cc1b4..f406c2dda 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/eqv_stress_parameter.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/eqv_stress_parameter.md @@ -43,12 +43,6 @@ Read/compute element nodal equivalent stress parameter by calling the readers de | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -183,6 +177,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/euler_nodes.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/euler_nodes.md index 2f3ac2f17..ce0a7efff 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/euler_nodes.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/euler_nodes.md @@ -12,13 +12,6 @@ license: None Reads a field made of 3 coordinates and 3 Euler angles (6 dofs) by node from the result file. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: cms, mode, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/film_coefficient.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/film_coefficient.md index fe3b768e9..fb4a4d42c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/film_coefficient.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/film_coefficient.md @@ -12,13 +12,6 @@ license: None Read/compute film coefficient by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/flow_rate.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/flow_rate.md index cdfa3ecad..1ff52535c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/flow_rate.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/flow_rate.md @@ -12,13 +12,6 @@ license: None Read/compute flow rate by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/fluid_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/fluid_velocity.md index d9836c355..b44093908 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/fluid_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/fluid_velocity.md @@ -12,13 +12,6 @@ license: None Read/compute FV by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -117,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure.md index 8bcd2e348..f44faf7e3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure.md @@ -43,13 +43,6 @@ Read/compute elemental gasket inelastic closure by calling the readers defined b | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -175,6 +168,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_X.md index 612f57c6b..594f6a132 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_X.md @@ -12,12 +12,6 @@ license: None Read/compute elemental gasket inelastic closure XX normal component (00 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_XY.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_XY.md index b0fbbd16c..e9917810e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_XY.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_XY.md @@ -12,12 +12,6 @@ license: None Read/compute elemental gasket inelastic closure XY shear component (01 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_XZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_XZ.md index fafd83255..d3d839250 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_XZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_XZ.md @@ -12,12 +12,6 @@ license: None Read/compute elemental gasket inelastic closure XZ shear component (02 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress.md index 3d555364b..359dea294 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress.md @@ -43,13 +43,6 @@ Read/compute elemental gasket stress by calling the readers defined by the datas | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -175,6 +168,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_X.md index 1870c4305..254c36904 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_X.md @@ -12,12 +12,6 @@ license: None Read/compute elemental gasket stress XX normal component (00 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_XY.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_XY.md index f55cda413..e96781eeb 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_XY.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_XY.md @@ -12,12 +12,6 @@ license: None Read/compute elemental gasket stress XY shear component (01 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_XZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_XZ.md index 0b1673cc3..af8e5f6dd 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_XZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_XZ.md @@ -12,12 +12,6 @@ license: None Read/compute elemental gasket stress XZ shear component (02 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure.md index 6ba8be4cb..9556d4f41 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure.md @@ -43,13 +43,6 @@ Read/compute elemental gasket thermal closure by calling the readers defined by | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -175,6 +168,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_X.md index 978b33e7e..15956818b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_X.md @@ -12,12 +12,6 @@ license: None Read/compute elemental gasket thermal closure XX normal component (00 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_XY.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_XY.md index f195e7a6e..fbf72f21f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_XY.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_XY.md @@ -12,12 +12,6 @@ license: None Read/compute elemental gasket thermal closure XY shear component (01 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_XZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_XZ.md index 8180896d5..d012639e3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_XZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_XZ.md @@ -12,12 +12,6 @@ license: None Read/compute elemental gasket thermal closure XZ shear component (02 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_added_mass.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_added_mass.md index f4042696f..4aeaabb8b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_added_mass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_added_mass.md @@ -12,13 +12,6 @@ license: None Read Global Added Mass (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_added_mass_pct.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_added_mass_pct.md index b98215fba..9675fb79f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_added_mass_pct.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_added_mass_pct.md @@ -12,13 +12,6 @@ license: None Read Global Added Mass (percentage) (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_center_mass.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_center_mass.md index e746c88b0..c4ac38691 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_center_mass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_center_mass.md @@ -12,13 +12,6 @@ license: None Read Global Center of Mass (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_energy_ratio.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_energy_ratio.md index 03d242f2c..3373ab90f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_energy_ratio.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_energy_ratio.md @@ -12,13 +12,6 @@ license: None Read Global Energy Ratio (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_energy_ratio_wo_eroded.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_energy_ratio_wo_eroded.md index ee3d4b805..04816fe0c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_energy_ratio_wo_eroded.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_energy_ratio_wo_eroded.md @@ -12,13 +12,6 @@ license: None Read Global Energy ratio without Eroded Energy (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_hourglass_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_hourglass_energy.md index 7c8502f27..532efa596 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_hourglass_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_hourglass_energy.md @@ -12,13 +12,6 @@ license: None Read Global Eroded Hourglass Energy (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_internal_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_internal_energy.md index ebe3cb94f..5127c8c37 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_internal_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_internal_energy.md @@ -12,13 +12,6 @@ license: None Read Global Eroded Internal Energy (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_kinetic_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_kinetic_energy.md index d249bd49f..224f8dbce 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_kinetic_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_kinetic_energy.md @@ -12,13 +12,6 @@ license: None Read Global Eroded Kinetic Energy (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_external_work.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_external_work.md index 0e373878a..041a7f159 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_external_work.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_external_work.md @@ -12,13 +12,6 @@ license: None Read Global External Work (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_hourglass_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_hourglass_energy.md index ac912a509..e055b6797 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_hourglass_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_hourglass_energy.md @@ -12,13 +12,6 @@ license: None Read Global Hourglass Energy (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_internal_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_internal_energy.md index 5a40a44ab..7641efcd7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_internal_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_internal_energy.md @@ -12,13 +12,6 @@ license: None Read Global Internal Energy (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout, d3plot - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_joint_internal_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_joint_internal_energy.md index 373eae02e..ed7097295 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_joint_internal_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_joint_internal_energy.md @@ -12,13 +12,6 @@ license: None Read Global Joint Internal Energy (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_kinetic_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_kinetic_energy.md index fdfb0921f..49fd5e5d4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_kinetic_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_kinetic_energy.md @@ -12,13 +12,6 @@ license: None Read Global Kinetic Energy (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout, d3plot - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_rigid_body_stopper_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_rigid_body_stopper_energy.md index 8d4a1a711..8aa55e40c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_rigid_body_stopper_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_rigid_body_stopper_energy.md @@ -12,13 +12,6 @@ license: None Read Global Rigid Body Stopper Energy (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_sliding_interface_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_sliding_interface_energy.md index b9bbed385..47da934f9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_sliding_interface_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_sliding_interface_energy.md @@ -12,13 +12,6 @@ license: None Read Global Sliding Interface Energy (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_spring_damper_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_spring_damper_energy.md index b69d8bb52..578d34bba 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_spring_damper_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_spring_damper_energy.md @@ -12,13 +12,6 @@ license: None Read Global Spring and Damper Energy (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_system_damping_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_system_damping_energy.md index d1f555290..41c4f521a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_system_damping_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_system_damping_energy.md @@ -12,13 +12,6 @@ license: None Read Global System Damping Energy (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_time_step.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_time_step.md index cd1d74ec1..bc629ccdf 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_time_step.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_time_step.md @@ -12,13 +12,6 @@ license: None Read Global Time Step (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_to_nodal.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_to_nodal.md new file mode 100644 index 000000000..ed96d8efb --- /dev/null +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_to_nodal.md @@ -0,0 +1,141 @@ +--- +category: result +plugin: core +license: None +--- + +# result:global_to_nodal + +**Version: 0.0.0** + +## Description + +Rotate results from global coordinate system to local coordinate system. + +## Inputs + +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [fieldB](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | + + + +### fieldA (Pin 0) + +- **Required:** Yes +- **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) + +Vector or tensor field that must be rotated, expressed in global coordinate system. + + +### fieldB (Pin 1) + +- **Required:** Yes +- **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) + +Nodal euler angles defined from a result file. Those must be the rotations from Nodal to Global. + + +## Outputs + +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + +| Pin number | Name | Expected type(s) | +|-------|------|------------------| +| **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | + + + +### field (Pin 0) + +- **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) + +Rotated field + + +## Configurations + +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + + +### [mutex](../../core-concepts/operator-configurations.md#mutex) + +- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** false + +If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. + + + +## Scripting + +This operator can be accessed through scripting interfaces using these identifiers. + + **Category**: result + + **Plugin**: core + + **Scripting name**: global_to_nodal + + **Full name**: result.global_to_nodal + + **Internal name**: GlobalToNodal + + **License**: None + +## Examples + +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. + +
+C++ + +```cpp +#include "dpf_api.h" + +ansys::dpf::Operator op("GlobalToNodal"); // operator instantiation +op.connect(0, my_fieldA); +op.connect(1, my_fieldB); +ansys::dpf::Field my_field = op.getOutput(0); +``` +
+ +
+CPython + +```python +import ansys.dpf.core as dpf + +op = dpf.operators.result.global_to_nodal() # operator instantiation +op.inputs.fieldA.connect(my_fieldA) +op.inputs.fieldB.connect(my_fieldB) +my_field = op.outputs.field() +``` +
+ +
+IPython + +```python +import mech_dpf +import Ans.DataProcessing as dpf + +op = dpf.operators.result.global_to_nodal() # operator instantiation +op.inputs.fieldA.Connect(my_fieldA) +op.inputs.fieldB.Connect(my_fieldB) +my_field = op.outputs.field.GetData() +``` +
+
+ +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_total_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_total_energy.md index f58b0c5dc..9de99e525 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_total_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_total_energy.md @@ -12,13 +12,6 @@ license: None Read Global Total Energy (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout, d3plot - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_total_mass.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_total_mass.md index 9161bb489..4a80cb467 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_total_mass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_total_mass.md @@ -12,13 +12,6 @@ license: None Read Global Total Mass (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_velocity.md index f8ca9cbaf..8428992c9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_velocity.md @@ -12,13 +12,6 @@ license: None Read Global Velocity (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout, d3plot - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_conductivity_rate.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_conductivity_rate.md index c6e3a5a92..f09373c22 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_conductivity_rate.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_conductivity_rate.md @@ -12,13 +12,6 @@ license: None Read/compute heat conductivity rate by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux.md index 702a95db2..ca479da3f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux.md @@ -43,14 +43,6 @@ Read/compute heat flux by calling the readers defined by the datasources. | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: d3plot -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -230,6 +222,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_X.md index 560d1a8c7..29de4a32f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_X.md @@ -12,12 +12,6 @@ license: None Read/compute heat flux X component of the vector (1st component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_Y.md index b125e3d1a..f9927ad65 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_Y.md @@ -12,12 +12,6 @@ license: None Read/compute heat flux Y component of the vector (2nd component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_Z.md index de2900240..44a18c717 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_Z.md @@ -12,12 +12,6 @@ license: None Read/compute heat flux Z component of the vector (3rd component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_transport_rate.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_transport_rate.md index b14dda0d3..e13563c8d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_transport_rate.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_transport_rate.md @@ -12,13 +12,6 @@ license: None Read/compute heat transport rate by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/hydrostatic_pressure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/hydrostatic_pressure.md index 9ffe77190..8c83e644b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/hydrostatic_pressure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/hydrostatic_pressure.md @@ -43,12 +43,6 @@ Read/compute element nodal hydrostatic pressure by calling the readers defined b | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -183,6 +177,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/incident_radiation_heat_flux.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/incident_radiation_heat_flux.md index 48367517c..5fb13aa8c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/incident_radiation_heat_flux.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/incident_radiation_heat_flux.md @@ -12,13 +12,6 @@ license: None Read/compute incident radiation heat flux by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/incremental_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/incremental_energy.md index e2f09070c..9f7853ee7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/incremental_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/incremental_energy.md @@ -12,13 +12,6 @@ license: None Read/compute incremental energy (magnetics) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/initial_coordinates.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/initial_coordinates.md index ff3a12308..3c94c5d78 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/initial_coordinates.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/initial_coordinates.md @@ -12,13 +12,6 @@ license: None Read/compute Initial Coordinates (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: d3plot - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -117,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/input_sound_power.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/input_sound_power.md index a7ef7180c..c077f4647 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/input_sound_power.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/input_sound_power.md @@ -12,13 +12,6 @@ license: None Read/compute PINC by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_area.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_area.md index d5bf1012a..0ee64481a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_area.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_area.md @@ -12,13 +12,6 @@ license: None Read Interface Contact Area (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_force.md index b7fe1f0eb..974d310e5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_force.md @@ -12,13 +12,6 @@ license: None Read Interface Contact Force (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_mass.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_mass.md index b06655363..902655217 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_mass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_mass.md @@ -12,13 +12,6 @@ license: None Read Interface Contact Mass (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_moment.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_moment.md index 61f7d3c5c..6b45b0d00 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_moment.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_moment.md @@ -12,13 +12,6 @@ license: None Read Interface Contact Moment (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_resultant_contact_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_resultant_contact_force.md index fb3fbcc8d..9dfd49a72 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_resultant_contact_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_resultant_contact_force.md @@ -12,13 +12,6 @@ license: None Read Interface Resultant Contact Force (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_force_reaction.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_force_reaction.md index 5fac7453c..8bb38d979 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_force_reaction.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_force_reaction.md @@ -110,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_moment_reaction.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_moment_reaction.md index 2f50bc653..b335c0fa1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_moment_reaction.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_moment_reaction.md @@ -110,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_acceleration.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_acceleration.md index 360c47114..7d28b9100 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_acceleration.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_acceleration.md @@ -110,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_angular_acceleration.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_angular_acceleration.md index 6075cf2d2..0b9984fc9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_angular_acceleration.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_angular_acceleration.md @@ -110,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_angular_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_angular_velocity.md index f3488f216..3f9f3f3db 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_angular_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_angular_velocity.md @@ -110,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_displacement.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_displacement.md index 6ffc8192f..f905a4de8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_displacement.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_displacement.md @@ -110,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_rotation.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_rotation.md index 8b7ce44b0..eafec4c3c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_rotation.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_rotation.md @@ -110,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_velocity.md index 8cbf87366..42ca76fb6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_velocity.md @@ -110,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/kinetic_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/kinetic_energy.md index 0a3831285..746a39e72 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/kinetic_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/kinetic_energy.md @@ -12,13 +12,6 @@ license: None Read/compute kinetic energy by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: mode, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +137,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/mach_number.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/mach_number.md index 58711397c..56374bd49 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/mach_number.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/mach_number.md @@ -12,12 +12,6 @@ license: None Read Mach Number by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_field.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_field.md index 5dcf6aec0..1cc981b8b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_field.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_field.md @@ -43,12 +43,6 @@ Read/compute Magnetic Field by calling the readers defined by the datasources. | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -192,6 +186,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_flux_density.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_flux_density.md index 633f80f6a..320041ae8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_flux_density.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_flux_density.md @@ -43,12 +43,6 @@ Read/compute Magnetic Flux Density by calling the readers defined by the datasou | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -192,6 +186,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_scalar_potential.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_scalar_potential.md index 1b58be668..ea4d28cf3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_scalar_potential.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_scalar_potential.md @@ -12,12 +12,6 @@ license: None Read/compute Magnetic Scalar Potential by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -107,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_vector_potential.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_vector_potential.md index 093ceae28..9b5604855 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_vector_potential.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_vector_potential.md @@ -12,12 +12,6 @@ license: None Read/compute Magnetic Vector Potential by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -107,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/mass_flow_rate.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/mass_flow_rate.md index 9476cf6be..53b66e225 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/mass_flow_rate.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/mass_flow_rate.md @@ -12,12 +12,6 @@ license: None Read Mass Flow Rate by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/mass_fraction.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/mass_fraction.md index 69b5f5b64..4c509977d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/mass_fraction.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/mass_fraction.md @@ -12,12 +12,6 @@ license: None Read Mass Fraction by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/material_property_of_element.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/material_property_of_element.md index 1bd52b9cf..2a5dba389 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/material_property_of_element.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/material_property_of_element.md @@ -12,12 +12,6 @@ license: None Loads the appropriate operator based on the data sources and retrieves material properties. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_static_pressure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_static_pressure.md index 85c854430..724bc1a2a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_static_pressure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_static_pressure.md @@ -12,12 +12,6 @@ license: None Read Mean Static Pressure by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_temperature.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_temperature.md index 7faec5fbc..282bf7aaf 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_temperature.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_temperature.md @@ -12,12 +12,6 @@ license: None Read Mean Temperature by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_velocity.md index a9f0530e9..f665ceddc 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_velocity.md @@ -12,12 +12,6 @@ license: None Read Mean Velocity by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_acceleration.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_acceleration.md index 084b3f5a0..8d4bfcf9b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_acceleration.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_acceleration.md @@ -12,12 +12,6 @@ license: None Read/compute modal acceleration by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: dsub, rdsp, rfrq - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -80,6 +74,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_basis.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_basis.md index 966618726..e75c8d55b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_basis.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_basis.md @@ -12,12 +12,6 @@ license: None Read/compute modal basis by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: cms, mode - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -116,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_coordinate.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_coordinate.md index 65ca63c81..7d51a1340 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_coordinate.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_coordinate.md @@ -12,13 +12,6 @@ license: None Read/compute modal coordinate by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: dsub, mode, rdsp, rfrq, rst - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -81,6 +74,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_velocity.md index f868941fd..bb7dc28b0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_velocity.md @@ -12,12 +12,6 @@ license: None Read/compute modal velocity by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: dsub, rdsp, rfrq - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -80,6 +74,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/net_radiation_heat_flux.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/net_radiation_heat_flux.md index 40a09bafd..749d3cc77 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/net_radiation_heat_flux.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/net_radiation_heat_flux.md @@ -12,13 +12,6 @@ license: None Read/compute net radiation heat flux by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/nmisc.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/nmisc.md index b39e03d9a..4432c4436 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/nmisc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/nmisc.md @@ -12,13 +12,6 @@ license: None Read/compute elemental non summable miscellaneous data by calling the readers defined by the datasources. Modal superposition (on demand expansion) and cyclic cxpansion procedures are not supported since results cannot be summed. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: cms, mode, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -153,6 +146,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_force.md index 4de5644d9..6f0b54662 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_force.md @@ -12,12 +12,6 @@ license: None Read/compute nodal forces by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- lsdyna: moddynout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -116,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotation.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotation.md index bc2ae9d93..e2f5b39d8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotation.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotation.md @@ -12,13 +12,6 @@ license: None Read/compute nodal rotation by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: cms, mode, rdsp, rfrq, rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -34,6 +27,10 @@ Each parameter is detailed in the sections that follow the table. | 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | | 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | | 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -90,7 +87,39 @@ Rotate the result to the global coordinate system if rotations are available (de - **Required:** No - **Expected type(s):** [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) -prevents from reading the mesh in the result files +mesh. If cylic expansion is to be done, mesh of the base sector + + +### read_cyclic (Pin 14) + +- **Required:** No +- **Expected type(s):** `enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) + +if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) + + +### expanded_meshed_region (Pin 15) + +- **Required:** No +- **Expected type(s):** [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) + +mesh expanded, use if cyclic expansion is to be done. + + +### sectors_to_expand (Pin 18) + +- **Required:** No +- **Expected type(s):** [`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) + +sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. + + +### phi (Pin 19) + +- **Required:** No +- **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types) + +angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. ## Outputs @@ -117,6 +146,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) @@ -175,6 +211,10 @@ op.connect(3, my_streams_container); op.connect(4, my_data_sources); op.connect(5, my_bool_rotate_to_global); op.connect(7, my_mesh); +op.connect(14, my_read_cyclic); +op.connect(15, my_expanded_meshed_region); +op.connect(18, my_sectors_to_expand); +op.connect(19, my_phi); ansys::dpf::FieldsContainer my_fields_container = op.getOutput(0); ``` @@ -193,6 +233,10 @@ op.inputs.streams_container.connect(my_streams_container) op.inputs.data_sources.connect(my_data_sources) op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) op.inputs.mesh.connect(my_mesh) +op.inputs.read_cyclic.connect(my_read_cyclic) +op.inputs.expanded_meshed_region.connect(my_expanded_meshed_region) +op.inputs.sectors_to_expand.connect(my_sectors_to_expand) +op.inputs.phi.connect(my_phi) my_fields_container = op.outputs.fields_container() ``` @@ -212,6 +256,10 @@ op.inputs.streams_container.Connect(my_streams_container) op.inputs.data_sources.Connect(my_data_sources) op.inputs.bool_rotate_to_global.Connect(my_bool_rotate_to_global) op.inputs.mesh.Connect(my_mesh) +op.inputs.read_cyclic.Connect(my_read_cyclic) +op.inputs.expanded_meshed_region.Connect(my_expanded_meshed_region) +op.inputs.sectors_to_expand.Connect(my_sectors_to_expand) +op.inputs.phi.Connect(my_phi) my_fields_container = op.outputs.fields_container.GetData() ``` diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_acceleration.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_acceleration.md index 5d5fa2071..af3ab97db 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_acceleration.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_acceleration.md @@ -12,13 +12,6 @@ license: None Read/compute nodal rotational acceleration by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: mode, rdsp, rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -117,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_velocity.md index 71b53efca..833fd8206 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_velocity.md @@ -12,13 +12,6 @@ license: None Read/compute nodal rotational velocity by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: mode, rdsp, rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -117,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/node_orientations.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/node_orientations.md index 2cf682648..024167c08 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/node_orientations.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/node_orientations.md @@ -12,13 +12,6 @@ license: None Read/compute node euler angles by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: cms, mode, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/normal_contact_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/normal_contact_force.md index 362b57d6b..dc60e3de2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/normal_contact_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/normal_contact_force.md @@ -110,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/normal_contact_moment.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/normal_contact_moment.md index 489c041a8..4263487ff 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/normal_contact_moment.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/normal_contact_moment.md @@ -110,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/num_surface_status_changes.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/num_surface_status_changes.md index bef3dd89a..d52875387 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/num_surface_status_changes.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/num_surface_status_changes.md @@ -43,13 +43,6 @@ Read/compute element total number of contact status changes during substep by ca | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: mode, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -220,6 +213,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/nusselt_number.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/nusselt_number.md index 98ec8e1b6..750d28100 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/nusselt_number.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/nusselt_number.md @@ -12,13 +12,6 @@ license: None Read/compute nusselt number by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/omega.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/omega.md index acc4b1f1e..b9212b534 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/omega.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/omega.md @@ -12,12 +12,6 @@ license: None Read Turbulent Specific Dissipation Rate (omega) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/output_sound_power.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/output_sound_power.md index afe3fec29..68001010c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/output_sound_power.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/output_sound_power.md @@ -12,13 +12,6 @@ license: None Read/compute POUT by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_added_mass.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_added_mass.md index 0caf7163b..26cc2fec2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_added_mass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_added_mass.md @@ -12,13 +12,6 @@ license: None Read Part Added Mass (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_eroded_internal_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_eroded_internal_energy.md index ae15da19a..9fc8217ac 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_eroded_internal_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_eroded_internal_energy.md @@ -12,13 +12,6 @@ license: None Read Part Eroded Internal Energy (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_eroded_kinetic_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_eroded_kinetic_energy.md index f34940c7b..5e8f54bf9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_eroded_kinetic_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_eroded_kinetic_energy.md @@ -12,13 +12,6 @@ license: None Read Part Eroded Kinetic Energy (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_hourglass_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_hourglass_energy.md index 9db921898..2d902d4ae 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_hourglass_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_hourglass_energy.md @@ -12,13 +12,6 @@ license: None Read Part Hourglass Energy (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_internal_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_internal_energy.md index fe460af6e..ed4a63689 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_internal_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_internal_energy.md @@ -12,13 +12,6 @@ license: None Read Part Internal Energy (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_kinetic_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_kinetic_energy.md index 8afae8764..2ff6cb6f5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_kinetic_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_kinetic_energy.md @@ -12,13 +12,6 @@ license: None Read Part Kinetic Energy (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_momentum.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_momentum.md index 87b9ae5b7..cc031c770 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_momentum.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_momentum.md @@ -12,13 +12,6 @@ license: None Read Part Momentum (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_rigid_body_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_rigid_body_velocity.md index 801f01c34..26b96b787 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_rigid_body_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_rigid_body_velocity.md @@ -12,13 +12,6 @@ license: None Read Part Rigid Body Velocity (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_state_variable.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_state_variable.md index cc72d6455..d8f5db963 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_state_variable.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_state_variable.md @@ -43,12 +43,6 @@ Read/compute element nodal plastic state variable by calling the readers defined | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -183,6 +177,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain.md index 44977656c..e757270a1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain.md @@ -43,13 +43,6 @@ Read/compute element nodal component plastic strains by calling the readers defi | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -229,6 +222,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_X.md index 39a1b0dfe..7a06a5716 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_X.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component plastic strains XX normal component (00 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_XY.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_XY.md index 37b86d583..e8d5048d8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_XY.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_XY.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component plastic strains XY shear component (01 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_XZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_XZ.md index 1978966bf..67bf620b8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_XZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_XZ.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component plastic strains XZ shear component (02 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_Y.md index 278013bd8..444d4be2b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_Y.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component plastic strains YY normal component (11 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_YZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_YZ.md index dac8794ed..eb54960e4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_YZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_YZ.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component plastic strains YZ shear component (12 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_Z.md index 0782346d0..adffee11d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_Z.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component plastic strains ZZ normal component (22 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_energy_density.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_energy_density.md index 5a161ffde..8fa6e2c8d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_energy_density.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_energy_density.md @@ -43,12 +43,6 @@ Read/compute element nodal plastic strain energy density by calling the readers | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -183,6 +177,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_eqv.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_eqv.md index 051ff86c4..2c223babe 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_eqv.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_eqv.md @@ -43,14 +43,6 @@ Read/compute element nodal equivalent plastic strain by calling the readers defi | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: d3plot -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -185,6 +177,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_intensity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_intensity.md index fab0ac7b1..305779065 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_intensity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_intensity.md @@ -13,12 +13,6 @@ license: None Reads/computes element nodal component plastic strains, average it on nodes (by default) and computes its invariants. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_max_shear.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_max_shear.md index 456fcabfd..7268a1662 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_max_shear.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_max_shear.md @@ -13,12 +13,6 @@ license: None Reads/computes element nodal component plastic strains, average it on nodes (by default) and computes its invariants. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_1.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_1.md index bff89a849..c270e1285 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_1.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_1.md @@ -13,12 +13,6 @@ license: None Read/compute element nodal component plastic strains 1st principal component by calling the readers defined by the datasources and computing its eigen values. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_2.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_2.md index c3b2ed1b2..2c5cf6fbb 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_2.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_2.md @@ -13,12 +13,6 @@ license: None Read/compute element nodal component plastic strains 2nd principal component by calling the readers defined by the datasources and computing its eigen values. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_3.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_3.md index 383bd96af..494f75fba 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_3.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_3.md @@ -13,12 +13,6 @@ license: None Read/compute element nodal component plastic strains 3rd principal component by calling the readers defined by the datasources and computing its eigen values. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/prandtl_number.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/prandtl_number.md index 83ee9c7cb..9bda8fe88 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/prandtl_number.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/prandtl_number.md @@ -12,13 +12,6 @@ license: None Read/compute prandtl number by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/pres_to_field.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/pres_to_field.md new file mode 100644 index 000000000..0ea733baf --- /dev/null +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/pres_to_field.md @@ -0,0 +1,141 @@ +--- +category: result +plugin: mapdl +license: None +--- + +# result:pres to field + +**Version: 0.0.0** + +## Description + +Read the presol generated file from mapdl. + +## Inputs + +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [filepath](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [columns_to_read](#input_1) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | + + + +### filepath (Pin 0) + +- **Required:** Yes +- **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types) + +filepath + + +### columns_to_read (Pin 1) + +- **Required:** No +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) + +columns_to_read + + +## Outputs + +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + +| Pin number | Name | Expected type(s) | +|-------|------|------------------| +| **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | + + + +### field (Pin 0) + +- **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) + + + + +## Configurations + +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + + +### [mutex](../../core-concepts/operator-configurations.md#mutex) + +- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** false + +If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. + + + +## Scripting + +This operator can be accessed through scripting interfaces using these identifiers. + + **Category**: result + + **Plugin**: mapdl + + **Scripting name**: pres_to_field + + **Full name**: result.pres_to_field + + **Internal name**: PRES_Reader + + **License**: None + +## Examples + +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. + +
+C++ + +```cpp +#include "dpf_api.h" + +ansys::dpf::Operator op("PRES_Reader"); // operator instantiation +op.connect(0, my_filepath); +op.connect(1, my_columns_to_read); +ansys::dpf::Field my_field = op.getOutput(0); +``` +
+ +
+CPython + +```python +import ansys.dpf.core as dpf + +op = dpf.operators.result.pres_to_field() # operator instantiation +op.inputs.filepath.connect(my_filepath) +op.inputs.columns_to_read.connect(my_columns_to_read) +my_field = op.outputs.field() +``` +
+ +
+IPython + +```python +import mech_dpf +import Ans.DataProcessing as dpf + +op = dpf.operators.result.pres_to_field() # operator instantiation +op.inputs.filepath.Connect(my_filepath) +op.inputs.columns_to_read.Connect(my_columns_to_read) +my_field = op.outputs.field.GetData() +``` +
+
+ +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/pressure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/pressure.md index 6acf9286c..331d8363c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/pressure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/pressure.md @@ -12,14 +12,6 @@ license: None Read/compute Pressure by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cgns: cgns -- hdf5: h5dpf -- mapdl: rst - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -109,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/prns_to_field.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/prns_to_field.md new file mode 100644 index 000000000..cad51368d --- /dev/null +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/prns_to_field.md @@ -0,0 +1,141 @@ +--- +category: result +plugin: mapdl +license: None +--- + +# result:prns to field + +**Version: 0.0.0** + +## Description + +Read the presol of nodal field generated file from mapdl. + +## Inputs + +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [filepath](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [columns_to_read](#input_1) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | + + + +### filepath (Pin 0) + +- **Required:** Yes +- **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types) + +filepath + + +### columns_to_read (Pin 1) + +- **Required:** No +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) + +columns_to_read + + +## Outputs + +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + +| Pin number | Name | Expected type(s) | +|-------|------|------------------| +| **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | + + + +### field (Pin 0) + +- **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) + + + + +## Configurations + +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + + +### [mutex](../../core-concepts/operator-configurations.md#mutex) + +- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** false + +If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. + + + +## Scripting + +This operator can be accessed through scripting interfaces using these identifiers. + + **Category**: result + + **Plugin**: mapdl + + **Scripting name**: prns_to_field + + **Full name**: result.prns_to_field + + **Internal name**: PRNS_Reader + + **License**: None + +## Examples + +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. + +
+C++ + +```cpp +#include "dpf_api.h" + +ansys::dpf::Operator op("PRNS_Reader"); // operator instantiation +op.connect(0, my_filepath); +op.connect(1, my_columns_to_read); +ansys::dpf::Field my_field = op.getOutput(0); +``` +
+ +
+CPython + +```python +import ansys.dpf.core as dpf + +op = dpf.operators.result.prns_to_field() # operator instantiation +op.inputs.filepath.connect(my_filepath) +op.inputs.columns_to_read.connect(my_columns_to_read) +my_field = op.outputs.field() +``` +
+ +
+IPython + +```python +import mech_dpf +import Ans.DataProcessing as dpf + +op = dpf.operators.result.prns_to_field() # operator instantiation +op.inputs.filepath.Connect(my_filepath) +op.inputs.columns_to_read.Connect(my_columns_to_read) +my_field = op.outputs.field.GetData() +``` +
+
+ +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/radiation_area.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/radiation_area.md index 7a30b1b2a..fb3ea948f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/radiation_area.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/radiation_area.md @@ -12,13 +12,6 @@ license: None Read/compute radiation area by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_acceleration.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_acceleration.md index 76c94373c..03dcef6e9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_acceleration.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_acceleration.md @@ -12,12 +12,6 @@ license: None Read/compute A vector from the finite element problem MA+CV+KU=F by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -107,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_displacement.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_displacement.md index 96dec61b0..caa74b4be 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_displacement.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_displacement.md @@ -12,13 +12,6 @@ license: None Read/compute U vector from the finite element problem KU=F by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: cms, mode, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_reaction_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_reaction_force.md index b9b1fc084..5fbbbcef6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_reaction_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_reaction_force.md @@ -12,12 +12,6 @@ license: None Read/compute F vector from the finite element problem KU=F by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -107,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_velocity.md index 3a7794337..4345676dc 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_velocity.md @@ -12,12 +12,6 @@ license: None Read/compute V vector from the finite element problem MA+CV+KU=F by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -107,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force.md index 5b423ed0c..b04872eec 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force.md @@ -12,13 +12,6 @@ license: None Read/compute nodal reaction forces by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -117,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_X.md index aee388cb7..97860480d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_X.md @@ -12,12 +12,6 @@ license: None Read/compute nodal reaction forces X component of the vector (1st component) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_Y.md index 41159529a..58ac49af9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_Y.md @@ -12,12 +12,6 @@ license: None Read/compute nodal reaction forces Y component of the vector (2nd component) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_Z.md index 671d776e7..552e7e3fd 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_Z.md @@ -12,12 +12,6 @@ license: None Read/compute nodal reaction forces Z component of the vector (3rd component) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_heat.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_heat.md index 0e514121a..066b146c7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_heat.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_heat.md @@ -12,13 +12,6 @@ license: None Read/compute nodal reaction heat by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_moment.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_moment.md index b721a9f29..97dde7665 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_moment.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_moment.md @@ -12,13 +12,6 @@ license: None Read/compute nodal reaction moments by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -117,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_moment_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_moment_X.md index 4e41e2e2c..a5cc97c86 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_moment_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_moment_X.md @@ -12,12 +12,6 @@ license: None Read/compute nodal reaction moments X component of the vector (1st component) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_moment_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_moment_Y.md index 8400ab41f..95c68e9fd 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_moment_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_moment_Y.md @@ -12,12 +12,6 @@ license: None Read/compute nodal reaction moments Y component of the vector (2nd component) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_moment_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_moment_Z.md index 10b2d0051..fbda0c3da 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_moment_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_moment_Z.md @@ -12,12 +12,6 @@ license: None Read/compute nodal reaction moments Z component of the vector (3rd component) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/record_reader.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/record_reader.md index 036882c6d..9e86cf44f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/record_reader.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/record_reader.md @@ -2,6 +2,8 @@ category: result plugin: mapdl license: None +namespaces: + mapdl: [rst, rstp, rth] --- # result:record reader diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/reflected_radiation_heat_flux.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/reflected_radiation_heat_flux.md index 84c711511..73af2079e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/reflected_radiation_heat_flux.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/reflected_radiation_heat_flux.md @@ -12,13 +12,6 @@ license: None Read/compute reflected radiation heat flux by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/result_category.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/result_category.md index ba6cb2c8a..3fdf694e5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/result_category.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/result_category.md @@ -174,6 +174,7 @@ - [global time step](global_time_step.md) - [global total energy](global_total_energy.md) - [global total mass](global_total_mass.md) +- [global to nodal](global_to_nodal.md) - [global velocity](global_velocity.md) - [heat conductivity rate](heat_conductivity_rate.md) - [heat flux](heat_flux.md) @@ -288,7 +289,9 @@ - [poynting vector surface](poynting_vector_surface.md) - [prandtl number](prandtl_number.md) - [pressure](pressure.md) +- [pres to field](pres_to_field.md) - [pretension](pretension.md) +- [prns to field](prns_to_field.md) - [radiation area](radiation_area.md) - [raw acceleration](raw_acceleration.md) - [raw displacement](raw_displacement.md) @@ -317,6 +320,7 @@ - [rms temperature](rms_temperature.md) - [rms velocity](rms_velocity.md) - [rom data provider](rom_data_provider.md) +- [run](run.md) - [smisc](smisc.md) - [specific heat](specific_heat.md) - [spectrum data](spectrum_data.md) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/result_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/result_provider.md index df3886798..dce94b72c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/result_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/result_provider.md @@ -12,12 +12,6 @@ license: None Read/compute user defined result by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cgns: cgns - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -134,6 +128,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/reynolds_number.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/reynolds_number.md index ec36215af..6a09d2660 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/reynolds_number.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/reynolds_number.md @@ -12,13 +12,6 @@ license: None Read/compute reynolds number by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/rigid_transformation.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/rigid_transformation.md index 6ccc3f4b6..e1f66761c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/rigid_transformation.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/rigid_transformation.md @@ -12,12 +12,6 @@ license: None Extracts rigid body motions from a displacement in input. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: dsub - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/rigid_transformation_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/rigid_transformation_provider.md index f38f44c7a..bf28239f7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/rigid_transformation_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/rigid_transformation_provider.md @@ -2,6 +2,8 @@ category: result plugin: mapdl license: None +namespaces: + mapdl: [dsub] --- # result:rigid transformation provider @@ -12,6 +14,12 @@ license: None Extracts rigid body transformation from dsub file. +## Supported file types + +This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): + +- mapdl: dsub + ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_static_pressure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_static_pressure.md index c5cfa1619..bea20e793 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_static_pressure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_static_pressure.md @@ -12,12 +12,6 @@ license: None Read RMS Static Pressure by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_temperature.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_temperature.md index 6800fed6a..f88563df3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_temperature.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_temperature.md @@ -12,12 +12,6 @@ license: None Read RMS Temperature by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_velocity.md index b55e13ff2..4dbf53b23 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_velocity.md @@ -12,12 +12,6 @@ license: None Read RMS Velocity by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/run.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/run.md new file mode 100644 index 000000000..47b2c1787 --- /dev/null +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/run.md @@ -0,0 +1,211 @@ +--- +category: result +plugin: mapdl +license: None +--- + +# result:mapdl run + +**Version: 0.0.0** + +## Description + +Solve in mapdl a dat/inp file and returns a datasources with the rst file. + +## Inputs + +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mapdl_exe_path](#input_0) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [working_dir](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [number_of_processes](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [number_of_threads](#input_3) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [server_mode](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | + + + +### mapdl_exe_path (Pin 0) + +- **Required:** No +- **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types) + + + + +### working_dir (Pin 1) + +- **Required:** No +- **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types) + + + + +### number_of_processes (Pin 2) + +- **Required:** No +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) + +Set the number of MPI processes used for resolution (default is 2) + + +### number_of_threads (Pin 3) + +- **Required:** No +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) + +Set the number of threads used for resolution (default is 1) + + +### data_sources (Pin 4) + +- **Required:** Yes +- **Expected type(s):** [`data_sources`](../../core-concepts/dpf-types.md#data-sources) + +data sources containing the input file. + + +### server_mode (Pin 5) + +- **Required:** No +- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) + +used when a user includes commands in the input file allowing to launch DPF server inside MAPDL to interact with MAPDL using DPF client API + + +## Outputs + +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + +| Pin number | Name | Expected type(s) | +|-------|------|------------------| +| **0**| [data_sources](#output_0) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| **1**| [ip](#output_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| **2**| [port](#output_2) |[`string`](../../core-concepts/dpf-types.md#standard-types) | + + + +### data_sources (Pin 0) + +- **Expected type(s):** [`data_sources`](../../core-concepts/dpf-types.md#data-sources) + +returns the data source if the server_mode pin is not set to yes + + +### ip (Pin 1) + +- **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types) + +returns the Ip if the server_mode pin is set to yes + + +### port (Pin 2) + +- **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types) + +returns a port when the server mode pin is set to yes + + +## Configurations + +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + + +### [mutex](../../core-concepts/operator-configurations.md#mutex) + +- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** false + +If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. + + + +## Scripting + +This operator can be accessed through scripting interfaces using these identifiers. + + **Category**: result + + **Plugin**: mapdl + + **Scripting name**: run + + **Full name**: result.run + + **Internal name**: mapdl::run + + **License**: None + +## Examples + +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. + +
+C++ + +```cpp +#include "dpf_api.h" + +ansys::dpf::Operator op("mapdl::run"); // operator instantiation +op.connect(0, my_mapdl_exe_path); +op.connect(1, my_working_dir); +op.connect(2, my_number_of_processes); +op.connect(3, my_number_of_threads); +op.connect(4, my_data_sources); +op.connect(5, my_server_mode); +ansys::dpf::DataSources my_data_sources = op.getOutput(0); +std::string my_ip = op.getOutput(1); +std::string my_port = op.getOutput(2); +``` +
+ +
+CPython + +```python +import ansys.dpf.core as dpf + +op = dpf.operators.result.run() # operator instantiation +op.inputs.mapdl_exe_path.connect(my_mapdl_exe_path) +op.inputs.working_dir.connect(my_working_dir) +op.inputs.number_of_processes.connect(my_number_of_processes) +op.inputs.number_of_threads.connect(my_number_of_threads) +op.inputs.data_sources.connect(my_data_sources) +op.inputs.server_mode.connect(my_server_mode) +my_data_sources = op.outputs.data_sources() +my_ip = op.outputs.ip() +my_port = op.outputs.port() +``` +
+ +
+IPython + +```python +import mech_dpf +import Ans.DataProcessing as dpf + +op = dpf.operators.result.run() # operator instantiation +op.inputs.mapdl_exe_path.Connect(my_mapdl_exe_path) +op.inputs.working_dir.Connect(my_working_dir) +op.inputs.number_of_processes.Connect(my_number_of_processes) +op.inputs.number_of_threads.Connect(my_number_of_threads) +op.inputs.data_sources.Connect(my_data_sources) +op.inputs.server_mode.Connect(my_server_mode) +my_data_sources = op.outputs.data_sources.GetData() +my_ip = op.outputs.ip.GetData() +my_port = op.outputs.port.GetData() +``` +
+
+ +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/smisc.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/smisc.md index 4164b73db..4b5fb13bd 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/smisc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/smisc.md @@ -12,13 +12,6 @@ license: None Read/compute elemental summable miscellaneous data by calling the readers defined by the datasources. Modal superposition (on demand expansion) and cyclic cxpansion procedures are supported, however, you should verify that the linear combination is applicable for the associated element according to the MAPDL documentation description of each item. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: cms, mode, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -153,6 +146,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/specific_heat.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/specific_heat.md index bd14b6c0e..3fc06859b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/specific_heat.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/specific_heat.md @@ -12,12 +12,6 @@ license: None Read Specific Heat by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/spectrum_data.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/spectrum_data.md index c7b60923f..f45e351aa 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/spectrum_data.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/spectrum_data.md @@ -12,12 +12,6 @@ license: None Read spectral data from the result files contained in the streams or data sources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: mode, prs - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/squared_l2norm_pressure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/squared_l2norm_pressure.md index df7b04a23..7895f7738 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/squared_l2norm_pressure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/squared_l2norm_pressure.md @@ -12,13 +12,6 @@ license: None Read/compute Square of the L2 norm of pressure over element volume by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/state_variable.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/state_variable.md index 1d635c0dd..457be17d4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/state_variable.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/state_variable.md @@ -43,13 +43,6 @@ Read/compute elemental state variable by calling the readers defined by the data | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -193,6 +186,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/static_pressure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/static_pressure.md index 3875e6716..7801c321e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/static_pressure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/static_pressure.md @@ -12,12 +12,6 @@ license: None Read Static Pressure by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stiffness_matrix_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stiffness_matrix_energy.md index 7fc0c9119..c0da9aa6f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stiffness_matrix_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stiffness_matrix_energy.md @@ -12,13 +12,6 @@ license: None Read/compute element energy associated with the stiffness matrix by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: mode, rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +137,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress.md index 0ba604dba..5e941bdde 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress.md @@ -43,14 +43,6 @@ Read/compute element nodal component stresses by calling the readers defined by | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout, d3plot, d3psd, d3ssd -- mapdl: cms, mode, rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -230,6 +222,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_X.md index 30c381800..fbb47d32f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_X.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component stresses XX normal component (00 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_XY.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_XY.md index 0d4c42169..72f83c0c2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_XY.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_XY.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component stresses XY shear component (01 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_XZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_XZ.md index 7011cfbbf..2ccd5c063 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_XZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_XZ.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component stresses XZ shear component (02 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_Y.md index abf1eaf6a..045824230 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_Y.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component stresses YY normal component (11 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_YZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_YZ.md index 1e775f4ce..1a36d6c2e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_YZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_YZ.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component stresses YZ shear component (12 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_Z.md index c8a634b6b..908b4e782 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_Z.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component stresses ZZ normal component (22 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_intensity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_intensity.md index 168d1614d..f6b0fb432 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_intensity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_intensity.md @@ -13,13 +13,6 @@ license: None Reads/computes element nodal component stresses, average it on nodes (by default) and computes its invariants. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -145,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_max_shear.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_max_shear.md index 3589e9d95..9efc6cd1a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_max_shear.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_max_shear.md @@ -13,12 +13,6 @@ license: None Reads/computes element nodal component stresses, average it on nodes (by default) and computes its invariants. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_1.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_1.md index 863b32789..7d064a69d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_1.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_1.md @@ -13,13 +13,6 @@ license: None Read/compute element nodal component stresses 1st principal component by calling the readers defined by the datasources and computing its eigen values. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -145,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_2.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_2.md index f16704a01..3ee509fba 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_2.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_2.md @@ -13,13 +13,6 @@ license: None Read/compute element nodal component stresses 2nd principal component by calling the readers defined by the datasources and computing its eigen values. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -145,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_3.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_3.md index 731398fbe..11a5f6805 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_3.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_3.md @@ -13,13 +13,6 @@ license: None Read/compute element nodal component stresses 3rd principal component by calling the readers defined by the datasources and computing its eigen values. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -145,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_ratio.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_ratio.md index 1cb251fdf..9eb1e8d3c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_ratio.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_ratio.md @@ -43,12 +43,6 @@ Read/compute element nodal stress ratio by calling the readers defined by the da | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -183,6 +177,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_von_mises.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_von_mises.md index 6db97a730..7ab772e39 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_von_mises.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_von_mises.md @@ -13,14 +13,6 @@ license: None Reads/computes element nodal component stresses, average it on nodes (by default) and computes its invariants. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: d3plot, d3ssd -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -146,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/structural_temperature.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/structural_temperature.md index 82fc392b7..d0e455400 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/structural_temperature.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/structural_temperature.md @@ -43,13 +43,6 @@ Read/compute element structural nodal temperatures by calling the readers define | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -184,6 +177,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/superficial_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/superficial_velocity.md index c062a2ac0..c9d32d6c1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/superficial_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/superficial_velocity.md @@ -12,12 +12,6 @@ license: None Read Superficial Velocity by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/surface_heat_rate.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/surface_heat_rate.md index d6e36ca78..ea1abe240 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/surface_heat_rate.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/surface_heat_rate.md @@ -12,12 +12,6 @@ license: None Read Surface Heat Rate by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/swelling_strains.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/swelling_strains.md index 63416e5f0..43babbd68 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/swelling_strains.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/swelling_strains.md @@ -43,13 +43,6 @@ Read/compute element nodal swelling strains by calling the readers defined by th | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -184,6 +177,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/tangential_contact_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/tangential_contact_force.md index 3843dccac..f74978eac 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/tangential_contact_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/tangential_contact_force.md @@ -110,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/tangential_contact_moment.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/tangential_contact_moment.md index 06ed0ccc3..230126343 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/tangential_contact_moment.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/tangential_contact_moment.md @@ -110,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature.md index 2a60059ee..edfaee641 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature.md @@ -12,15 +12,6 @@ license: None Read/compute temperature field by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj -- hdf5: h5dpf -- lsdyna: d3plot -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -164,6 +155,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad.md index 6d5fe8574..441c8a47f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad.md @@ -43,13 +43,6 @@ Read/compute Temperature Gradient by calling the readers defined by the datasour | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -193,6 +186,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_X.md index 6cd0642a2..9cfa9c37d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_X.md @@ -12,12 +12,6 @@ license: None Read/compute Temperature Gradient X component of the vector (1st component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_Y.md index 8b8997eab..a81bf7109 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_Y.md @@ -12,12 +12,6 @@ license: None Read/compute Temperature Gradient Y component of the vector (2nd component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_Z.md index 0f6f8a42c..8e0b0db68 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_Z.md @@ -12,12 +12,6 @@ license: None Read/compute Temperature Gradient Z component of the vector (3rd component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_conductivity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_conductivity.md index 92d322292..2f61a8ef7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_conductivity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_conductivity.md @@ -12,12 +12,6 @@ license: None Read Thermal Conductivity by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_dissipation_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_dissipation_energy.md index f5716e1ee..a49dd806e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_dissipation_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_dissipation_energy.md @@ -12,13 +12,6 @@ license: None Read/compute thermal dissipation energy by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain.md index 7f354df8c..f999c2d26 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain.md @@ -43,13 +43,6 @@ Read/compute element nodal component thermal strains by calling the readers defi | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -229,6 +222,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_X.md index 5f48ac93c..3d17a8331 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_X.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component thermal strains XX normal component (00 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_XY.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_XY.md index 1c0b33fdd..4490d99af 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_XY.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_XY.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component thermal strains XY shear component (01 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_XZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_XZ.md index e7f685cb1..afe5f8a9c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_XZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_XZ.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component thermal strains XZ shear component (02 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_Y.md index a47e43f18..ece05f4b9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_Y.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component thermal strains YY normal component (11 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_YZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_YZ.md index d0bff0ddf..a15ac24cd 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_YZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_YZ.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component thermal strains YZ shear component (12 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_Z.md index 78ee15a80..6363acab9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_Z.md @@ -12,12 +12,6 @@ license: None Read/compute element nodal component thermal strains ZZ normal component (22 component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_1.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_1.md index b13369d9a..e20cc2c10 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_1.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_1.md @@ -13,12 +13,6 @@ license: None Read/compute element nodal component thermal strains 1st principal component by calling the readers defined by the datasources and computing its eigen values. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_2.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_2.md index 2da071dbe..f75b7b196 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_2.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_2.md @@ -13,12 +13,6 @@ license: None Read/compute element nodal component thermal strains 2nd principal component by calling the readers defined by the datasources and computing its eigen values. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_3.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_3.md index fc9951916..be5a0ced8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_3.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_3.md @@ -13,12 +13,6 @@ license: None Read/compute element nodal component thermal strains 3rd principal component by calling the readers defined by the datasources and computing its eigen values. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -144,6 +138,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strains_eqv.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strains_eqv.md index 292e48d52..a631d6fd5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strains_eqv.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strains_eqv.md @@ -43,13 +43,6 @@ Read/compute element nodal equivalent component thermal strains by calling the r | 13 | Pretension | -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -184,6 +177,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thickness.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thickness.md index 73c1348c9..8186e9591 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thickness.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thickness.md @@ -12,13 +12,6 @@ license: None Read/compute thickness by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- lsdyna: d3plot -- mapdl: rst, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_contact_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_contact_force.md index f79985cb9..fa17038a4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_contact_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_contact_force.md @@ -110,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_contact_moment.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_contact_moment.md index 2ba74c52b..53fd6a9ee 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_contact_moment.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_contact_moment.md @@ -110,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_mass.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_mass.md index 920e537cc..091c64d98 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_mass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_mass.md @@ -2,6 +2,8 @@ category: result plugin: mapdl license: None +namespaces: + mapdl: [mode] --- # result:total mass @@ -12,6 +14,12 @@ license: None Reads total mass from mode file. +## Supported file types + +This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): + +- mapdl: mode + ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_pressure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_pressure.md index b7de56726..6119a6c00 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_pressure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_pressure.md @@ -12,12 +12,6 @@ license: None Read Total Pressure by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_strain.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_strain.md index b576e38a3..84fe93787 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_strain.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_strain.md @@ -12,13 +12,6 @@ license: None Read/compute Total strain (LSDyna) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- lsdyna: binout, d3plot, d3psd, d3ssd - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -117,6 +110,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_temperature.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_temperature.md index efe73c23d..59530b59c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_temperature.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_temperature.md @@ -12,12 +12,6 @@ license: None Read Total Temperature by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/turbulent_kinetic_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/turbulent_kinetic_energy.md index af62514b6..61b3b5cd5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/turbulent_kinetic_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/turbulent_kinetic_energy.md @@ -12,12 +12,6 @@ license: None Read Turbulent Kinetic Energy (k) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/turbulent_viscosity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/turbulent_viscosity.md index 9ffda022e..8f667ca7b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/turbulent_viscosity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/turbulent_viscosity.md @@ -12,12 +12,6 @@ license: None Read Turbulent Viscosity by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity.md index c5081f3ef..1cfc479dd 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity.md @@ -12,15 +12,6 @@ license: None Read/compute nodal velocities by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj -- hdf5: h5dpf -- lsdyna: d3plot, d3psd, d3ssd, lsda, moddynout -- mapdl: cms, mode, rdsp, rst, rstp - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -173,6 +164,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_X.md index 8b01f0b8a..f2b33a3ff 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_X.md @@ -12,12 +12,6 @@ license: None Read/compute nodal velocities X component of the vector (1st component) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_Y.md index 852c565f2..9c61a048b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_Y.md @@ -12,12 +12,6 @@ license: None Read/compute nodal velocities Y component of the vector (2nd component) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_Z.md index 746448fb2..d1723e848 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_Z.md @@ -12,12 +12,6 @@ license: None Read/compute nodal velocities Z component of the vector (3rd component) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/view_factor_sum.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/view_factor_sum.md index 8c279173c..0ab09354a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/view_factor_sum.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/view_factor_sum.md @@ -12,13 +12,6 @@ license: None Read/compute view factor sum by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- hdf5: h5dpf -- mapdl: rst, rth - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. @@ -108,6 +101,13 @@ Each output is detailed in the sections that follow the table. This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. +### [allow_ansys_element_library_computation](../../core-concepts/operator-configurations.md#allow_ansys_element_library_computation) + +- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** 0 + +BETA: User authorizes DPF to compute elemental results through the Ansys Element Library.Material and geometric nonlinearities are not allowed. Only linear analysis are supported.0: Not Authorized (default), 1: Only if result is not present, 2: Always use AEL. + ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/volume_fraction.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/volume_fraction.md index 7ace397d4..f798e4efc 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/volume_fraction.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/volume_fraction.md @@ -12,12 +12,6 @@ license: None Read Volume Fraction by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/wall_shear_stress.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/wall_shear_stress.md index 130fd1f05..450033f93 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/wall_shear_stress.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/wall_shear_stress.md @@ -12,12 +12,6 @@ license: None Read Wall Shear Stress by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/y_plus.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/y_plus.md index 398eb1d79..0673e1d97 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/y_plus.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/y_plus.md @@ -12,12 +12,6 @@ license: None Read Y Plus (y+) by calling the readers defined by the datasources. -## Supported file types - -This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - -- cff: cas, flprj - ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/export_symbolic_workflow.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/export_symbolic_workflow.md index f35c15994..c62d2ea39 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/export_symbolic_workflow.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/export_symbolic_workflow.md @@ -21,7 +21,7 @@ Each parameter is detailed in the sections that follow the table. | Pin number | Name | Status | Expected type(s) | |------------|------|--------|------------------| | 0 | [workflow](#input_0) | Required|[`workflow`](../../core-concepts/dpf-types.md#workflow) | -| 1 | [path](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [workflow_path](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | | 2 | [format](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | | 3 | [options](#input_3) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -35,7 +35,7 @@ Each parameter is detailed in the sections that follow the table. -### path (Pin 1) +### workflow_path (Pin 1) - **Required:** No - **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types) @@ -121,7 +121,7 @@ Each example shows how to instantiate the operator, connect the required inputs, ansys::dpf::Operator op("export_symbolic_workflow"); // operator instantiation op.connect(0, my_workflow); -op.connect(1, my_path); +op.connect(1, my_workflow_path); op.connect(2, my_format); op.connect(3, my_options); ansys::dpf::DataSources my_data_sources = op.getOutput(0); @@ -136,7 +136,7 @@ import ansys.dpf.core as dpf op = dpf.operators.serialization.None() # operator instantiation op.inputs.workflow.connect(my_workflow) -op.inputs.path.connect(my_path) +op.inputs.workflow_path.connect(my_workflow_path) op.inputs.format.connect(my_format) op.inputs.options.connect(my_options) my_data_sources_as_data_sources = op.outputs.data_sources_as_data_sources() @@ -152,7 +152,7 @@ import Ans.DataProcessing as dpf op = dpf.operators.serialization.None() # operator instantiation op.inputs.workflow.Connect(my_workflow) -op.inputs.path.Connect(my_path) +op.inputs.workflow_path.Connect(my_workflow_path) op.inputs.format.Connect(my_format) op.inputs.options.Connect(my_options) my_data_sources = op.outputs.data_sources.GetData() diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/import_symbolic_workflow.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/import_symbolic_workflow.md index 4de5d705d..b51e3a84b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/import_symbolic_workflow.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/import_symbolic_workflow.md @@ -10,7 +10,7 @@ license: any_dpf_supported_increments ## Description -Reads a file or string holding a Symbolic Workflow and instantiate a WorkFlow with its data. +Reads a file or string holding a Symbolic Workflow and instantiates a WorkFlow with its data. Pin 'workflow_path' refers to a file path, either as a string or as DataSources. Pin 'workflow_as_string' refers to the string representation of the workflow itself. Both pins are mutually exclusive. ## Inputs @@ -20,17 +20,26 @@ Each parameter is detailed in the sections that follow the table. | Pin number | Name | Status | Expected type(s) | |------------|------|--------|------------------| -| 0 | [string_or_path](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types), [`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 0 | [workflow_path](#input_0) | |[`string`](../../core-concepts/dpf-types.md#standard-types), [`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 1 | [workflow_as_string](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | | 2 | [format](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -### string_or_path (Pin 0) +### workflow_path (Pin 0) -- **Required:** Yes +- **Required:** No - **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types), [`data_sources`](../../core-concepts/dpf-types.md#data-sources) +File path (string) or DataSources pointing to a workflow file. Pin 'format' is used only if this pin is connected. + + +### workflow_as_string (Pin 1) + +- **Required:** No +- **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types) +String representation of the workflow as provided by the 'export_symbolic_workflow' operator with string output or the 'writeToString' Workflow API. ### format (Pin 2) @@ -102,7 +111,8 @@ Each example shows how to instantiate the operator, connect the required inputs, #include "dpf_api.h" ansys::dpf::Operator op("import_symbolic_workflow"); // operator instantiation -op.connect(0, my_string_or_path); +op.connect(0, my_workflow_path); +op.connect(1, my_workflow_as_string); op.connect(2, my_format); ansys::dpf::Workflow my_workflow = op.getOutput(0); ``` @@ -115,7 +125,8 @@ ansys::dpf::Workflow my_workflow = op.getOutput(0); import ansys.dpf.core as dpf op = dpf.operators.serialization.None() # operator instantiation -op.inputs.string_or_path.connect(my_string_or_path) +op.inputs.workflow_path.connect(my_workflow_path) +op.inputs.workflow_as_string.connect(my_workflow_as_string) op.inputs.format.connect(my_format) my_workflow = op.outputs.workflow() ``` @@ -129,7 +140,8 @@ import mech_dpf import Ans.DataProcessing as dpf op = dpf.operators.serialization.None() # operator instantiation -op.inputs.string_or_path.Connect(my_string_or_path) +op.inputs.workflow_path.Connect(my_workflow_path) +op.inputs.workflow_as_string.Connect(my_workflow_as_string) op.inputs.format.Connect(my_format) my_workflow = op.outputs.workflow.GetData() ``` diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/csharp_generator.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/csharp_generator.md new file mode 100644 index 000000000..e03f88de7 --- /dev/null +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/csharp_generator.md @@ -0,0 +1,166 @@ +--- +category: utility +plugin: core +license: None +--- + +# utility:C# generator + +**Version: 0.0.0** + +## Description + + +Generates a C# wrapper file (.cs) containing a class for each public operator +found in a loaded plugin DLL. +The DLL is loaded using the given `load_symbol` and `library_key`. +All non-private operators discovered in the plugin are written to the single +file at `output_path`. + +> **Note:** Operators whose exposure property is set to `private` are silently +> excluded from the generated output. + +Inputs & outputs of each operator are represented as typed `LinkableInput` +and `LinkableOutput` properties on the generated class. + + +## Inputs + +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [dll_source_path](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [output_path](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [load_symbol](#input_2) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [library_key](#input_3) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | + + + +### dll_source_path (Pin 0) + +- **Required:** Yes +- **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types) + +Path to the plugin DLL to load. + + +### output_path (Pin 1) + +- **Required:** Yes +- **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types) + +Path where the .cs wrapper file will be written. + + +### load_symbol (Pin 2) + +- **Required:** No +- **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types) + +Symbol name used to load operators from the DLL. Defaults to "LoadOperators". + + +### library_key (Pin 3) + +- **Required:** Yes +- **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types) + +Key used to identify the plugin library when loading. + + +## Outputs + +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + +| Pin number | Name | Expected type(s) | +|-------|------|------------------| + + + +## Configurations + +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + + +### [mutex](../../core-concepts/operator-configurations.md#mutex) + +- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) +- **Default value:** false + +If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. + + + +## Scripting + +This operator can be accessed through scripting interfaces using these identifiers. + + **Category**: utility + + **Plugin**: core + + **Scripting name**: None + + **Full name**: None + + **Internal name**: csharp_generator + + **License**: None + +## Examples + +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. + +
+C++ + +```cpp +#include "dpf_api.h" + +ansys::dpf::Operator op("csharp_generator"); // operator instantiation +op.connect(0, my_dll_source_path); +op.connect(1, my_output_path); +op.connect(2, my_load_symbol); +op.connect(3, my_library_key); +``` +
+ +
+CPython + +```python +import ansys.dpf.core as dpf + +op = dpf.operators.utility.None() # operator instantiation +op.inputs.dll_source_path.connect(my_dll_source_path) +op.inputs.output_path.connect(my_output_path) +op.inputs.load_symbol.connect(my_load_symbol) +op.inputs.library_key.connect(my_library_key) +``` +
+ +
+IPython + +```python +import mech_dpf +import Ans.DataProcessing as dpf + +op = dpf.operators.utility.None() # operator instantiation +op.inputs.dll_source_path.Connect(my_dll_source_path) +op.inputs.output_path.Connect(my_output_path) +op.inputs.load_symbol.Connect(my_load_symbol) +op.inputs.library_key.Connect(my_library_key) +``` +
+
+ +## Changelog + +- Version 0.0.0: Initial release. \ No newline at end of file diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/utility_category.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/utility_category.md index 2fd717e6d..416bb47a6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/utility_category.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/utility_category.md @@ -11,6 +11,7 @@ - [compute time scoping](compute_time_scoping.md) - [concatenate fields](concatenate_fields.md) - [concatenate fields containers](concatenate_fields_containers.md) +- [csharp generator](csharp_generator.md) - [customtypefield get attribute](customtypefield_get_attribute.md) - [cyclic support get attribute](cyclic_support_get_attribute.md) - [default value](default_value.md) diff --git a/2027R1/dpf-framework-27-r1/toc.yml b/2027R1/dpf-framework-27-r1/toc.yml index 768be002a..eae30e619 100644 --- a/2027R1/dpf-framework-27-r1/toc.yml +++ b/2027R1/dpf-framework-27-r1/toc.yml @@ -465,6 +465,10 @@ href: operator-specifications/math/make_one_on_comp.md - name: matrix inverse href: operator-specifications/math/matrix_inverse.md + - name: matrix product + href: operator-specifications/math/matrix_product.md + - name: matrix product fc + href: operator-specifications/math/matrix_product_fc.md - name: mechanical min max over time href: operator-specifications/math/mechanical_min_max_over_time.md - name: minus @@ -1065,6 +1069,8 @@ href: operator-specifications/result/global_total_energy.md - name: global total mass href: operator-specifications/result/global_total_mass.md + - name: global to nodal + href: operator-specifications/result/global_to_nodal.md - name: global velocity href: operator-specifications/result/global_velocity.md - name: heat conductivity rate @@ -1293,8 +1299,12 @@ href: operator-specifications/result/prandtl_number.md - name: pressure href: operator-specifications/result/pressure.md + - name: pres to field + href: operator-specifications/result/pres_to_field.md - name: pretension href: operator-specifications/result/pretension.md + - name: prns to field + href: operator-specifications/result/prns_to_field.md - name: radiation area href: operator-specifications/result/radiation_area.md - name: raw acceleration @@ -1351,6 +1361,8 @@ href: operator-specifications/result/rms_velocity.md - name: rom data provider href: operator-specifications/result/rom_data_provider.md + - name: run + href: operator-specifications/result/run.md - name: smisc href: operator-specifications/result/smisc.md - name: specific heat @@ -1625,6 +1637,8 @@ href: operator-specifications/utility/concatenate_fields.md - name: concatenate fields containers href: operator-specifications/utility/concatenate_fields_containers.md + - name: csharp generator + href: operator-specifications/utility/csharp_generator.md - name: customtypefield get attribute href: operator-specifications/utility/customtypefield_get_attribute.md - name: cyclic support get attribute diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/Field.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/Field.md index 52139f9ea..ebe75da34 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/Field.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/Field.md @@ -134,13 +134,35 @@ Property `Data`access the data container row values #### *property* ScopingIds: list -Property `ScopingIds` ids belonging to the scoping, identical to my_field.Scoping.Ids +Gets or sets the entity IDs belonging to the scoping, identical to `Scoping.Ids`. + +Metadata-only setter: assigning a new list of IDs replaces the scoping + +index only - it does not filter, resize, or reorder the underlying data buffer. + +After the assignment, the scoping length and the data length may be inconsistent, + +leading to silent incorrect results or errors in downstream operators.To produce a correctly-sized field for a subset of entities, use the + +`rescope` operator instead of setting this property directly. *get/set* #### *property* Scoping: Scoping -Property `Scoping` entities ids representing a subset of the model and on which the data container is scoped +Gets or sets the scoping: entity IDs representing the subset of the model on which + +the data container is defined. + +Metadata-only setter: assigning a new `Scoping` replaces the + +index only - it does not filter, resize, or reorder the underlying data buffer. + +After the assignment, the scoping length and the data length may be inconsistent, + +leading to silent incorrect results or errors in downstream operators.To produce a correctly-sized field for a subset of entities, use the + +`rescope` operator instead of setting this property directly. *get/set* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/MeshedRegion.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/MeshedRegion.md index 18a844dd0..bc61653ea 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/MeshedRegion.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/MeshedRegion.md @@ -268,7 +268,19 @@ Allows to access their id, their element type, connectivity... #### *property* CoordinatesField: Field -Property `CoordinatesField` field of nodes coordinates. Its scoping is the NodeScoping +Gets the field of nodes coordinates. + +Its scoping is the `NodeScoping` of this meshed region. + +Live reference: this property returns a direct reference to the + +mesh's internal field object, not an independent copy. + +Mutating the returned field's scoping or data modifies the mesh's internal + +state; subsequent accesses to this property will reflect those mutations.To obtain an independent copy, call `GetHardCopy()`: + +`Field snapshot = mesh.CoordinatesField.GetHardCopy();` *get* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/averaging/force_summation.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/averaging/force_summation.md index ddeb907dd..3514dfb81 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/averaging/force_summation.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/averaging/force_summation.md @@ -1,114 +1,143 @@ ---- -uid: Ans.DataProcessing.operators.averaging.force_summation ---- - -# *class* force_summation(time_scoping: object = None, nodal_scoping: object = None, elemental_scoping: object = None, streams_container: object = None, data_sources: object = None, force_type: object = None, spoint: object = None, scoping_filter: object = None, config: OperatorConfig = None) - -force_summation() -force_summation(time_scoping: object, nodal_scoping: object, elemental_scoping: object, streams_container: object, data_sources: object, force_type: object, spoint: object, scoping_filter: object, config: OperatorConfig) -force_summation(config: OperatorConfig) - - -**DPF Framework Reference:** [force_summation operator specification](https://developer.ansys.com/docs/dpf-framework-2027-r1/operator-specifications/averaging/force_summation.md) - -**Parameters:** - -* **time_scoping** -* **nodal_scoping** -* **elemental_scoping** -* **streams_container** -* **data_sources** -* **force_type** -* **spoint** -* **scoping_filter** -* **config** - -## Inputs - -### time_scoping - -default = all time steps - -**Type:** *LinkableInput* - -### nodal_scoping - -Nodal Scoping or Scopings Container with a single label. Set of nodes in which elemental contribution forces will be accumulated (default = all nodes) - -**Type:** *LinkableInput* - -### elemental_scoping - -Elemental Scoping or Scopings Container with a single label. Set of elements contributing to the force calculation. (default = all elements) - -**Type:** *LinkableInput* - -### streams_container - -Streams container. Optional if using data sources. - -**Type:** *LinkableInput* - -### data_sources - -Data sources. Optional if using a streams container. - -**Type:** *LinkableInput* - -### force_type - -Type of force to be processed (0: Total forces (static, damping, and inertia)., 1 (default): Static forces, 2: Damping forces, 3: Inertia forces) - -**Type:** *LinkableInput* - -### spoint - -Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0). If unitless, it is assumed to be in meters. - -**Type:** *LinkableInput* - -### scoping_filter - -**Type:** *LinkableInput* - -## Outputs - -### force_accumulation - -**Type:** *LinkableOutput* - -### moment_accumulation - -**Type:** *LinkableOutput* - -### heat_accumulation - -**Type:** *LinkableOutput* - -### forces_on_nodes - -**Type:** *LinkableOutput* - -### moments_on_nodes - -**Type:** *LinkableOutput* - -### heats_on_nodes - -**Type:** *LinkableOutput* - -## Methods - -## Properties - -#### *property* inputs: InputSpec - -*get/set* - -#### *property* outputs: OutputSpec - -*get/set* - -#### *property* defaultConfig: Config - -*get* +--- +uid: Ans.DataProcessing.operators.averaging.force_summation +--- + +# *class* force_summation(time_scoping: object = None, nodal_scoping: object = None, elemental_scoping: object = None, streams_container: object = None, data_sources: object = None, force_type: object = None, spoint: object = None, scoping_filter: object = None, sectors_to_expand: object = None, phi: object = None, config: OperatorConfig = None) + +Computes the sum of elemental forces contribution on a set of nodes in Global Coordinate System. Equivalent to MAPDL FSUM & NFORCE commands. Supports Static, Transient, Modal & Harmonic analysis for thermal and structural degrees of freedom. The moment is computed in the unit system of the data source. + +available inputs: `time_scoping` (Scoping, IList int, System.Collections.IEnumerable) (optional), `nodal_scoping` (Scoping, ScopingsContainer) (optional), `elemental_scoping` (Scoping, ScopingsContainer) (optional), `streams_container` (StreamsContainer) (optional), `data_sources` (DataSources), `force_type` (Int32) (optional), `spoint` (Field, FieldsContainer) (optional), `scoping_filter` (Int32) (optional), `read_cyclic` (Int32) (optional), `sectors_to_expand` (IList int, Scoping, ScopingsContainer, System.Collections.IEnumerable) (optional), `phi` (double) (optional) + +available outputs: `force_accumulation` (FieldsContainer), `moment_accumulation` (FieldsContainer), `heat_accumulation` (FieldsContainer), `forces_on_nodes` (FieldsContainer), `moments_on_nodes` (FieldsContainer), `heats_on_nodes` (FieldsContainer) + +**DPF Framework Reference:** [force_summation operator specification](https://developer.ansys.com/docs/dpf-framework-2027-r1/operator-specifications/averaging/force_summation.md) + +**Parameters:** + +* **time_scoping** +* **nodal_scoping** +* **elemental_scoping** +* **streams_container** +* **data_sources** +* **force_type** +* **spoint** +* **scoping_filter** +* **sectors_to_expand** +* **phi** +* **config** + +**Example:** + +```python +op = force_summation() + +op = force_summation(time_scoping=my_time_scoping,nodal_scoping=my_nodal_scoping,elemental_scoping=my_elemental_scoping,streams_container=my_streams_container,data_sources=my_data_sources,force_type=my_force_type,spoint=my_spoint,scoping_filter=my_scoping_filter,sectors_to_expand=my_sectors_to_expand,phi=my_phi) +``` + +## Inputs + +### time_scoping + +default = all time steps + +**Type:** *LinkableInput* + +### nodal_scoping + +Nodal Scoping or Scopings Container with a single label. Set of nodes in which elemental contribution forces will be accumulated (default = all nodes) + +**Type:** *LinkableInput* + +### elemental_scoping + +Elemental Scoping or Scopings Container with a single label. Set of elements contributing to the force calculation. (default = all elements) + +**Type:** *LinkableInput* + +### streams_container + +Streams container. Optional if using data sources. + +**Type:** *LinkableInput* + +### data_sources + +Data sources. Optional if using a streams container. + +**Type:** *LinkableInput* + +### force_type + +Type of force to be processed (0: Total forces (static, damping, and inertia)., 1 (default): Static forces, 2: Damping forces, 3: Inertia forces) + +**Type:** *LinkableInput* + +### spoint + +Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0). If unitless, it is assumed to be in meters. + +**Type:** *LinkableInput* + +### scoping_filter + +**Type:** *LinkableInput* + +### read_cyclic + +if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) + +**Type:** *LinkableInput* + +### sectors_to_expand + +sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. + +**Type:** *LinkableInput* + +### phi + +angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. + +**Type:** *LinkableInput* + +## Outputs + +### force_accumulation + +**Type:** *LinkableOutput* + +### moment_accumulation + +**Type:** *LinkableOutput* + +### heat_accumulation + +**Type:** *LinkableOutput* + +### forces_on_nodes + +**Type:** *LinkableOutput* + +### moments_on_nodes + +**Type:** *LinkableOutput* + +### heats_on_nodes + +**Type:** *LinkableOutput* + +## Methods + +## Properties + +#### *property* inputs: InputSpec + +*get/set* + +#### *property* outputs: OutputSpec + +*get/set* + +#### *property* defaultConfig: Config + +*get* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/averaging/index.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/averaging/index.md index ed8d44bfc..d6b68bfca 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/averaging/index.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/averaging/index.md @@ -23,7 +23,7 @@ uid: Ans.DataProcessing.operators.averaging | [elemental_to_nodal_fc](Ans_DataProcessing_operators_averaging_elemental_to_nodal_fc.md) | Transforms Elemental Nodal fields to Nodal fields. The result is computed on a given node's scoping.1. For a finite element mesh, the value on a node is the average of the values of the neighbour elements. | | [extend_to_mid_nodes](Ans_DataProcessing_operators_averaging_extend_to_mid_nodes.md) | Extends an Elemental Nodal or Nodal field defined on corner nodes to a field defined also on the mid nodes. ///available inputs: field (Field, FieldsContainer), mesh (MeshedRegion) (optional) | | [extend_to_mid_nodes_fc](Ans_DataProcessing_operators_averaging_extend_to_mid_nodes_fc.md) | Extends Elemental Nodal or Nodal fields defined on corner nodes to Elemental Nodal fields defined also on the mid nodes. ///available inputs: fields_container (FieldsContainer), mesh (MeshedRegion) (optional) | -| [force_summation](Ans_DataProcessing_operators_averaging_force_summation.md) | force_summation() | +| [force_summation](Ans_DataProcessing_operators_averaging_force_summation.md) | Computes the sum of elemental forces contribution on a set of nodes in Global Coordinate System. Equivalent to MAPDL FSUM & NFORCE commands. Supports Static, Transient, Modal & Harmonic analysis for thermal and structural degrees of freedom. The moment is computed in the unit system of the data source. ///available inputs: time_scoping (Scoping, IList int, System.Collections.IEnumerable) (optional), nodal_scoping (Scoping, ScopingsContainer) (optional), elemental_scoping (Scoping, ScopingsContainer) (optional), streams_container (StreamsContainer) (optional), data_sources (DataSources), force_type (Int32) (optional), spoint (Field, FieldsContainer) (optional), scoping_filter (Int32) (optional), read_cyclic (Int32) (optional), sectors_to_expand (IList int, Scoping, ScopingsContainer, System.Collections.IEnumerable) (optional), phi (double) (optional) | | [force_summation_psd](Ans_DataProcessing_operators_averaging_force_summation_psd.md) | Computes the sum of elemental forces contribution on a set of nodes in Global Coordinate System for a PSD analysis. Equivalent to MAPDL FSUM/NFORCE. The moment is computed in the unit system of the data source. ///available inputs: nodal_scoping (Scoping, ScopingsContainer) (optional), elemental_scoping (Scoping, ScopingsContainer) (optional), streams (StreamsContainer) (optional), data_sources (DataSources), spoint (Field, FieldsContainer) (optional), abs_rel_key (Int32) (optional), signif (double) (optional) | | [gauss_to_node_fc](Ans_DataProcessing_operators_averaging_gauss_to_node_fc.md) | Extrapolates results available at Gauss or quadrature points to nodal points for a field container. The available elements are: Linear quadrangle, parabolic quadrangle, linear hexagonal, quadratic hexagonal, linear tetrahedral, and quadratic tetrahedral. ///available inputs: fields_container (FieldsContainer), mesh (MeshedRegion, MeshesContainer) (optional), scoping (Scoping) (optional) | | [nodal_difference](Ans_DataProcessing_operators_averaging_nodal_difference.md) | Transforms an Elemental Nodal field into a Nodal field. Each nodal value is the maximum difference between the unaveraged computed result for all elements that share this particular node. The result is computed on a given node's scoping. ///available inputs: field (Field, FieldsContainer), mesh_scoping (Scoping) (optional), mesh (MeshedRegion) (optional) | diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/compression/apply_zfp.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/compression/apply_zfp.md index 44eb46951..0e58a14c2 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/compression/apply_zfp.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/compression/apply_zfp.md @@ -71,6 +71,8 @@ Double positive small value. All the values smaller than max(small value, max(vi ### double_relthreshold +Double relative threshold. Values smaller than (v1 - v2) < max(small value, v1 * relativeTol) are considered identical (default value: 1.0e-10). + **Type:** *LinkableInput* ## Outputs diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/geo/ans_mat_property_field_provider.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/geo/ans_mat_property_field_provider.md index 440c47b74..43ea5f938 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/geo/ans_mat_property_field_provider.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/geo/ans_mat_property_field_provider.md @@ -83,6 +83,8 @@ scoping: VUUID, VUUID is the equivalent to the DataTransferID in the ENGD's mate ### property_name +using the user can find out the available property scripting names,then define one of those names at this input + **Type:** *LinkableInput* ### location diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/identical_anys.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/identical_anys.md index de4c93e1a..709909cca 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/identical_anys.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/identical_anys.md @@ -47,6 +47,8 @@ Double positive small value. Smallest value considered during the comparison ste ### double_tolerance +Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1-v2)/v2 < relativeTol. Default is 0.001. + **Type:** *LinkableInput* ### compare_auxiliary diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/identical_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/identical_fc.md index 55d713bb9..7993f001a 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/identical_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/identical_fc.md @@ -46,6 +46,8 @@ Double positive small value. Smallest value which will be considered during the ### tolerance +Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical (v1-v2)/v2 < relativeTol (default is 0.001). + **Type:** *LinkableInput* ## Outputs diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/identical_fields.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/identical_fields.md index 59944a43b..1e9e54311 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/identical_fields.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/identical_fields.md @@ -54,6 +54,8 @@ Double positive small value. Smallest value considered during the comparison ste ### double_tolerance +Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1 - v2) / v2 < double_tolerance. Default is 0.001. + **Type:** *LinkableInput* ## Outputs diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/identical_generic_data_containers.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/identical_generic_data_containers.md index d79dc0fbf..c28040102 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/identical_generic_data_containers.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/identical_generic_data_containers.md @@ -47,6 +47,8 @@ Double positive small value. Smallest value considered during the comparison ste ### double_tolerance +Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1-v2)/v2 < relativeTol. Default is 0.001. + **Type:** *LinkableInput* ### compare_auxiliary diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/identical_mc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/identical_mc.md index f53c39d37..f0b757ce3 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/identical_mc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/identical_mc.md @@ -47,6 +47,8 @@ Double positive small value. Smallest value which will be considered during the ### tolerance +Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical (v1-v2)/v2 < relativeTol (default is 0.001). + **Type:** *LinkableInput* ### compare_auxiliary diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/included_fields.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/included_fields.md index 6018d2a4c..0cf09227a 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/included_fields.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/logic/included_fields.md @@ -46,6 +46,8 @@ Double positive small value. Smallest value considered during the comparison ste ### double_tolerance +Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1-v2)/v2 < relativeTol. Default is 0.001. + **Type:** *LinkableInput* ## Outputs diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mapping/prepare_mechanical_native_mapping.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mapping/prepare_mechanical_native_mapping.md index d0d293a0e..72a6832b6 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mapping/prepare_mechanical_native_mapping.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mapping/prepare_mechanical_native_mapping.md @@ -119,6 +119,8 @@ Default is empty string. The string contains either "2D" or "3D" which specifies ### wb_external_data_info +Default is empty. This data tree contains the Rigid & Analytical transformations specified in the workbench external data system + **Type:** *LinkableInput* ### target_dimension diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mapping/prepare_mechanical_native_mapping_kriging.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mapping/prepare_mechanical_native_mapping_kriging.md index 0d0528c1b..13258deef 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mapping/prepare_mechanical_native_mapping_kriging.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mapping/prepare_mechanical_native_mapping_kriging.md @@ -160,6 +160,8 @@ Default is empty string. The string contains either "2D" or "3D" which specifies ### wb_external_data_info +Default is empty. This data tree contains the Rigid & Analytical transformations specified in the workbench external data system + **Type:** *LinkableInput* ### target_dimension diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mapping/prepare_mechanical_native_mapping_point_cloud.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mapping/prepare_mechanical_native_mapping_point_cloud.md index cc1aee521..029c5248d 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mapping/prepare_mechanical_native_mapping_point_cloud.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mapping/prepare_mechanical_native_mapping_point_cloud.md @@ -181,6 +181,8 @@ Default is empty string. The string contains either "2D" or "3D" which specifies ### wb_external_data_info +Default is empty. This data tree contains the Rigid & Analytical transformations specified in the workbench external data system + **Type:** *LinkableInput* ### target_dimension diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mapping/prepare_mechanical_native_mapping_shape_functions_for_surfaces.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mapping/prepare_mechanical_native_mapping_shape_functions_for_surfaces.md index ef32c86bd..486034147 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mapping/prepare_mechanical_native_mapping_shape_functions_for_surfaces.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mapping/prepare_mechanical_native_mapping_shape_functions_for_surfaces.md @@ -220,6 +220,8 @@ Default is empty string. The string contains either "2D" or "3D" which specifies ### wb_external_data_info +Default is empty. This data tree contains the Rigid & Analytical transformations specified in the workbench external data system + **Type:** *LinkableInput* ### target_dimension diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mapping/prepare_mechanical_native_mapping_shape_functions_for_volume.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mapping/prepare_mechanical_native_mapping_shape_functions_for_volume.md index fe0edb464..7fee9f37a 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mapping/prepare_mechanical_native_mapping_shape_functions_for_volume.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mapping/prepare_mechanical_native_mapping_shape_functions_for_volume.md @@ -147,6 +147,8 @@ Default is empty string. The string contains either "2D" or "3D" which specifies ### wb_external_data_info +Default is empty. This data tree contains the Rigid & Analytical transformations specified in the workbench external data system + **Type:** *LinkableInput* ### target_dimension diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/absolute_value_by_component.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/absolute_value_by_component.md index 548562a73..b74cce670 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/absolute_value_by_component.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/absolute_value_by_component.md @@ -28,7 +28,7 @@ Field, fields container, or numeric data for which to compute absolute values ### field -Field with absolute values applied to each component +Field with $|\mathrm{in}[i]|$ applied to each data component, preserving the input unit and dimensionality. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/absolute_value_by_component_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/absolute_value_by_component_fc.md index 05f0a2fa6..fe7f51246 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/absolute_value_by_component_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/absolute_value_by_component_fc.md @@ -4,7 +4,11 @@ uid: Ans.DataProcessing.operators.math.absolute_value_by_component_fc # *class* absolute_value_by_component_fc(fields_container: object = None, config: OperatorConfig = None) -Computes the absolute value of each data value in the input field component-wise, without performing vector norm operations. +Applies the [absolute value](https://en.wikipedia.org/wiki/Absolute_value) function component-wise + +to each scalar data entry: $\mathrm{out}[i] = |\mathrm{in}[i]|$. + +This is a per-component operation and does not compute a vector norm. available inputs: `fields_container` (FieldsContainer) @@ -37,7 +41,7 @@ Field, fields container, or numeric data for which to compute absolute values ### fields_container -Field with absolute values applied to each component +Field with $|\mathrm{in}[i]|$ applied to each data component, preserving the input unit and dimensionality. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/accumulate.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/accumulate.md index 0b83bb913..0a1fdbe99 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/accumulate.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/accumulate.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.accumulate # *class* accumulate(fieldA: object = None, weights: object = None, time_scoping: object = None, config: OperatorConfig = None) -Sums all the elementary data of a field to produce one elementary data point. +Reduces a field to a single entity by summing all entity data component-wise. + +Without weights: $\mathrm{out}[c] = \sum_k \mathrm{field}[k, c]$ for each component $c$. + +With an optional weights field (pin 1): $\mathrm{out}[c] = \sum_k w_k \cdot \mathrm{field}[k, c]$, + +where $w_k$ is the weight for entity $k$. + +The weights field must be a scalar (1D) field providing one weight per entity. available inputs: `fieldA` (Field, FieldsContainer), `weights` (Field) (optional), `time_scoping` (Scoping) (optional) @@ -49,7 +57,7 @@ Deprecated alias of: weights ### time_scoping -time_scoping +Optional scoping that sets the output entity's location and ID. **Type:** *LinkableInput* @@ -57,7 +65,7 @@ time_scoping ### field -Field containing the (weighted) sum for each component in an elementary data +Field with one entity containing the (weighted) component sums $\sum_k w_k \cdot \mathrm{field}[k, c]$ for each component $c$. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/accumulate_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/accumulate_fc.md index 2528eace2..279839686 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/accumulate_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/accumulate_fc.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.accumulate_fc # *class* accumulate_fc(fields_container: object = None, weights: object = None, time_scoping: object = None, config: OperatorConfig = None) -Sums all the elementary data of a field to produce one elementary data point. +Reduces a field to a single entity by summing all entity data component-wise. + +Without weights: $\mathrm{out}[c] = \sum_k \mathrm{field}[k, c]$ for each component $c$. + +With an optional weights field (pin 1): $\mathrm{out}[c] = \sum_k w_k \cdot \mathrm{field}[k, c]$, + +where $w_k$ is the weight for entity $k$. + +The weights field must be a scalar (1D) field providing one weight per entity. available inputs: `fields_container` (FieldsContainer), `weights` (Field) (optional), `time_scoping` (Scoping) (optional) @@ -49,7 +57,7 @@ Deprecated alias of: weights ### time_scoping -time_scoping +Optional scoping that sets the output entity's location and ID. **Type:** *LinkableInput* @@ -57,7 +65,7 @@ time_scoping ### fields_container -Field containing the (weighted) sum for each component in an elementary data +Field with one entity containing the (weighted) component sums $\sum_k w_k \cdot \mathrm{field}[k, c]$ for each component $c$. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/add.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/add.md index b7b496653..f72281b3d 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/add.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/add.md @@ -35,7 +35,7 @@ field or fields container with only one field is expected ### field -Field containing the element-wise sum of the two input fields +Field whose data equals $A[i] + B[i]$, with pin A's unit. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/add_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/add_fc.md index 6cac74828..26c6c8787 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/add_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/add_fc.md @@ -31,7 +31,7 @@ add_fc(config: OperatorConfig) ### fields_container -FieldsContainer with summed fields by label space +Fields container with fields summed by matching label space. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/amplitude.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/amplitude.md index 6f687adc3..2ddd1cc85 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/amplitude.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/amplitude.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.amplitude # *class* amplitude(fieldA: object = None, fieldB: object = None, config: OperatorConfig = None) -Computes amplitude of a real and an imaginary field. +Computes the [complex modulus](https://en.wikipedia.org/wiki/Absolute_value#Complex_numbers) (amplitude) + +of a complex quantity given as separate real and imaginary fields: + +$\mathrm{out}[i] = \sqrt{A[i]^2 + B[i]^2}$. + +The output carries the unit of pin A. available inputs: `fieldA` (Field, FieldsContainer), `fieldB` (Field, FieldsContainer) @@ -44,6 +50,8 @@ field or fields container with only one field is expected ### field +Scalar field with $\sqrt{A[i]^2 + B[i]^2}$ for each data entry, carrying the unit of pin A. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/amplitude_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/amplitude_fc.md index 4484fbcd7..83d2fc494 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/amplitude_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/amplitude_fc.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.amplitude_fc # *class* amplitude_fc(fields_container: object = None, config: OperatorConfig = None) -Computes the amplitude of a real and an imaginary field. +Computes the [complex modulus](https://en.wikipedia.org/wiki/Absolute_value#Complex_numbers) (amplitude) + +$\sqrt{\mathrm{Re}[i]^2 + \mathrm{Im}[i]^2}$ for each complex-valued field pair in the input fields container, + +where pairs are matched by complex label. + +If no imaginary part is found for a real field, that real field is returned unchanged. available inputs: `fields_container` (FieldsContainer) @@ -29,12 +35,16 @@ op = amplitude_fc(fields_container=my_fields_container) ### fields_container +Complex-valued fields container with paired real (complex label 0) and imaginary (complex label 1) fields. + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container with amplitude fields $\sqrt{\mathrm{Re}[i]^2 + \mathrm{Im}[i]^2}$, carrying the unit of the real input field. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/centroid.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/centroid.md index 37c10b984..d5d3040ab 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/centroid.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/centroid.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.centroid # *class* centroid(fieldA: object = None, fieldB: object = None, factor: object = None, config: OperatorConfig = None) -Computes centroid of field1 and field2, using fieldOut = field1*(1.-fact)+field2*(fact). Only works by index. +Computes a [linear interpolation](https://en.wikipedia.org/wiki/Linear_interpolation) between two fields + +using a scalar factor $t$: $\mathrm{out}[i] = (1 - t) \cdot A[i] + t \cdot B[i]$. + +The interpolation is convex (no extrapolation) when $t \in [0, 1]$; + +values outside this range extrapolate beyond the two input fields. + +This operator works by index only. available inputs: `fieldA` (Field, FieldsContainer), `fieldB` (Field, FieldsContainer), `factor` (double) @@ -43,7 +51,7 @@ field or fields container with only one field is expected ### factor -Scalar +Interpolation factor $t$: $t = 0$ returns fieldA unchanged, $t = 1$ returns fieldB unchanged. Values in $[0, 1]$ interpolate; values outside extrapolate. **Type:** *LinkableInput* @@ -51,7 +59,7 @@ Scalar ### field -Field with centroid calculation: fieldA*(1-factor) + fieldB*factor +Interpolated field $(1 - t) \cdot A + t \cdot B$, with the unit of pin A. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/centroid_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/centroid_fc.md index 4dfb35825..7215d2579 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/centroid_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/centroid_fc.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.centroid_fc # *class* centroid_fc(fields_container: object = None, time_freq: object = None, step: object = None, time_freq_support: object = None, config: OperatorConfig = None) -Computes the centroid of all the matching fields of a fields container at a given time or frequency, using fieldOut = field1*(1.-fact)+field2*(fact). +Computes a [linear interpolation](https://en.wikipedia.org/wiki/Linear_interpolation) between the two fields + +in the input fields container that bracket the requested time or frequency value $t$: + +$\mathrm{out}[i] = (1 - s) \cdot f_1[i] + s \cdot f_2[i]$, + +where $s = (t - t_1) / (t_2 - t_1)$ and $t_1$, $t_2$ are the bracketing time/frequency values. + +If the requested value exactly matches an available one, that field is returned directly. available inputs: `fields_container` (FieldsContainer), `time_freq` (double), `step` (Int32) (optional), `time_freq_support` (TimeFreqSupport) (optional) @@ -32,25 +40,25 @@ op = centroid_fc(fields_container=my_fields_container,time_freq=my_time_freq,ste ### fields_container -FieldsContainer with fields for centroid calculation +Fields container with fields over time or frequency. **Type:** *LinkableInput* ### time_freq -Time or frequency value for field selection +Time or frequency value at which to interpolate. **Type:** *LinkableInput* ### step -Optional step specification +Optional step specification. **Type:** *LinkableInput* ### time_freq_support -Optional TimeFreqSupport for field resolution +Optional time/frequency support for field resolution. **Type:** *LinkableInput* @@ -58,7 +66,7 @@ Optional TimeFreqSupport for field resolution ### fields_container -FieldsContainer with centroid calculation results at specified time/frequency +Fields container with the interpolated fields at the requested time or frequency. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/component_wise_divide.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/component_wise_divide.md index 6487b7515..0517f92bf 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/component_wise_divide.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/component_wise_divide.md @@ -4,7 +4,19 @@ uid: Ans.DataProcessing.operators.math.component_wise_divide # *class* component_wise_divide(fieldA: object = None, fieldB: object = None, config: OperatorConfig = None) -Computes component-wise fraction between two fields of same dimensionality. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. When using a constant or 'work_by_index', you can use 'inplace' to reuse one of the fields. +Computes the component-wise fraction $\mathrm{out}[k] = A[k] / B[k]$ + +(also known as the [Hadamard division](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations)) + +for fields of the same dimensionality. + +If one field's scoping has the 'overall' location, its values are broadcast across all entities of the other field. + +When $|B[k]| < 10^{-14}$ the corresponding output component is set to $0$. + +Inplace execution is supported when working with constants or using 'work_by_index'. + +The output unit is $u_A / u_B$. available inputs: `fieldA` (Field, FieldsContainer), `fieldB` (Field, FieldsContainer) @@ -44,6 +56,8 @@ field or fields container with only one field is expected ### field +Field with $A[k] / B[k]$ for each component (zero where $|B[k]| < 10^{-14}$); unit is $u_A / u_B$. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/component_wise_divide_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/component_wise_divide_fc.md index dd5715c10..e6124d3c7 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/component_wise_divide_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/component_wise_divide_fc.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.component_wise_divide_fc # *class* component_wise_divide_fc(fields_containerA: object = None, fields_containerB: object = None, config: OperatorConfig = None) -For every two fields with the same label space (from the two input fields containers), computes component-wise fraction between two fields of same dimensionality. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. +For every pair of fields with matching label space in the two input fields containers, + +computes the component-wise fraction $\mathrm{out}[k] = A[k] / B[k]$ + +(also known as the [Hadamard division](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations)). + +Both containers must have identical label spaces and the same number of fields. available inputs: `fields_containerA` (FieldsContainer), `fields_containerB` (FieldsContainer) @@ -40,6 +46,8 @@ op = component_wise_divide_fc(fields_containerA=my_fields_containerA,fields_cont ### fields_container +Fields container with the component-wise quotient fields; unit is $u_A / u_B$. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/conjugate.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/conjugate.md index dc58d3745..ccd11b60b 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/conjugate.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/conjugate.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.conjugate # *class* conjugate(fields_container: object = None, config: OperatorConfig = None) -Computes element-wise conjugate of field containers containing complex fields. +Computes the [complex conjugate](https://en.wikipedia.org/wiki/Complex_conjugate) + +$\bar{z}[i] = \mathrm{Re}[i] - j \cdot \mathrm{Im}[i]$ for each value in a complex-valued fields container + +(the imaginary part is negated). + +Input and output containers have the same structure. available inputs: `fields_container` (FieldsContainer) @@ -29,12 +35,16 @@ op = conjugate(fields_container=my_fields_container) ### fields_container +Complex-valued fields container with real (complex label 0) and imaginary (complex label 1) part fields. + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container with conjugate values; the imaginary-part fields carry negated data. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cos.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cos.md index 5a6315ff3..9a8309af7 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cos.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cos.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.cos # *class* cos(field: object = None, config: OperatorConfig = None) -Computes element-wise cosine function on field data: cos(field[i]). +Computes the entity-wise [cosine](https://en.wikipedia.org/wiki/Sine_and_cosine): + +$\mathrm{out}[i] = \cos(\mathrm{in}[i])$. + +The input must be dimensionless or carry an angle unit; any other unit raises an error. + +When the input unit is an angle (e.g. degrees), values are automatically converted to radians + +before the cosine is applied. The output is dimensionless. available inputs: `field` (Field, FieldsContainer) @@ -29,7 +37,7 @@ op = cos(field=my_field) ### field -Field or fields container containing numeric data for cosine calculation +Dimensionless or angle-unit field or fields container. **Type:** *LinkableInput* @@ -37,7 +45,7 @@ Field or fields container containing numeric data for cosine calculation ### field -Field with cosine values applied element-wise to input data +Dimensionless field with $\cos(\mathrm{in}[i])$ for each data entry. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cos_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cos_fc.md index 6525bf81e..e499e91e7 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cos_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cos_fc.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.cos_fc # *class* cos_fc(fields_container: object = None, config: OperatorConfig = None) -Computes element-wise cosine function on field data: cos(field[i]). +Computes the entity-wise [cosine](https://en.wikipedia.org/wiki/Sine_and_cosine): + +$\mathrm{out}[i] = \cos(\mathrm{in}[i])$. + +The input must be dimensionless or carry an angle unit; any other unit raises an error. + +When the input unit is an angle (e.g. degrees), values are automatically converted to radians + +before the cosine is applied. The output is dimensionless. available inputs: `fields_container` (FieldsContainer) @@ -29,7 +37,7 @@ op = cos_fc(fields_container=my_fields_container) ### fields_container -Field or fields container containing numeric data for cosine calculation +Dimensionless or angle-unit field or fields container. **Type:** *LinkableInput* @@ -37,7 +45,7 @@ Field or fields container containing numeric data for cosine calculation ### fields_container -Field with cosine values applied element-wise to input data +Dimensionless field with $\cos(\mathrm{in}[i])$ for each data entry. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_derive.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_derive.md index fd2f87207..f006d9b34 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_derive.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_derive.md @@ -4,7 +4,19 @@ uid: Ans.DataProcessing.operators.math.cplx_derive # *class* cplx_derive(fields_container: object = None, config: OperatorConfig = None) -Derives field containers containing complex fields. +Computes the time derivative of a [phasor](https://en.wikipedia.org/wiki/Phasor) field + +in the frequency domain by multiplying by $j\omega$, + +where $\omega = 2\pi f$ and $f$ is taken from the fields container's time-frequency support. + +The result components are: + +$\mathrm{Re}(\dot{z})[i] = -\omega \cdot \mathrm{Im}(z)[i]$, + +$\mathrm{Im}(\dot{z})[i] = \omega \cdot \mathrm{Re}(z)[i]$. + +The output unit is the input field unit multiplied by the time-frequency support unit. available inputs: `fields_container` (FieldsContainer) @@ -29,12 +41,16 @@ op = cplx_derive(fields_container=my_fields_container) ### fields_container +Complex-valued fields container with a time-frequency support defining the frequencies. + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container containing the frequency-domain time derivative $j\omega z$ (real and imaginary parts). + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_divide.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_divide.md index ed0b17ea0..78daced41 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_divide.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_divide.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.cplx_divide # *class* cplx_divide(fields_containerA: object = None, fields_containerB: object = None, config: OperatorConfig = None) -Computes division between two field containers containing complex fields. +Computes the [complex division](https://en.wikipedia.org/wiki/Complex_number#Multiplicative_inverse) + +$z_1 / z_2$ for matching fields in two complex-valued fields containers: + +$\mathrm{Re}(z_\mathrm{out}[i]) = (\mathrm{Re}_1 \mathrm{Re}_2 + \mathrm{Im}_1 \mathrm{Im}_2) / D$, + +$\mathrm{Im}(z_\mathrm{out}[i]) = (\mathrm{Im}_1 \mathrm{Re}_2 - \mathrm{Re}_1 \mathrm{Im}_2) / D$ + +where $D = \mathrm{Re}_2^2 + \mathrm{Im}_2^2$. Raises an error if $D = 0$. available inputs: `fields_containerA` (FieldsContainer), `fields_containerB` (FieldsContainer) @@ -30,16 +38,22 @@ op = cplx_divide(fields_containerA=my_fields_containerA,fields_containerB=my_fie ### fields_containerA +Numerator complex-valued fields container. + **Type:** *LinkableInput* ### fields_containerB +Denominator complex-valued fields container. + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container with the complex quotient $z_1 / z_2$ (real and imaginary parts). + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_dot.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_dot.md index 578ef4825..56ef6a462 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_dot.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_dot.md @@ -4,7 +4,17 @@ uid: Ans.DataProcessing.operators.math.cplx_dot # *class* cplx_dot(fields_containerA: object = None, fields_containerB: object = None, config: OperatorConfig = None) -Computes product between two field containers containing complex fields. +Computes the real-valued inner product + +$\mathrm{out}[i] = \mathrm{Re}_1[i] \cdot \mathrm{Re}_2[i] + \mathrm{Im}_1[i] \cdot \mathrm{Im}_2[i]$ + +between matching fields in two complex-valued fields containers. + +This equals the real part of the [Hermitian inner product](https://en.wikipedia.org/wiki/Dot_product#Complex_vectors) + +$\mathrm{Re}(z_1 \cdot \overline{z_2})$. + +Only the real-part result fields (complex label 0) are produced. available inputs: `fields_containerA` (FieldsContainer), `fields_containerB` (FieldsContainer) diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_multiply.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_multiply.md index 5e20edd2f..f653a24e9 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_multiply.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_multiply.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.cplx_multiply # *class* cplx_multiply(fields_containerA: object = None, fields_containerB: object = None, config: OperatorConfig = None) -Computes multiplication between two field containers containing complex fields. +Computes the standard [complex multiplication](https://en.wikipedia.org/wiki/Complex_number#Multiplication_and_square) + +$z_1 \cdot z_2$ for matching fields in two complex-valued fields containers: + +$\mathrm{Re}(z_\mathrm{out})[i] = \mathrm{Re}_1 \mathrm{Re}_2 - \mathrm{Im}_1 \mathrm{Im}_2$, + +$\mathrm{Im}(z_\mathrm{out})[i] = \mathrm{Re}_1 \mathrm{Im}_2 + \mathrm{Im}_1 \mathrm{Re}_2$. + +Both containers must have the same size. available inputs: `fields_containerA` (FieldsContainer), `fields_containerB` (FieldsContainer) @@ -40,6 +48,8 @@ op = cplx_multiply(fields_containerA=my_fields_containerA,fields_containerB=my_f ### fields_container +Fields container with the complex product fields (real and imaginary parts). + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/dot_tensor.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/dot_tensor.md index c4eee9a38..fcc7fe792 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/dot_tensor.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/dot_tensor.md @@ -4,7 +4,7 @@ uid: Ans.DataProcessing.operators.math.dot_tensor # *class* dot_tensor(fieldA: object = None, fieldB: object = None, config: OperatorConfig = None) -DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes element-wise dot product between two tensor fields. +DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes entity-wise dot product between two tensor fields. available inputs: `fieldA` (Field, FieldsContainer), `fieldB` (Field, FieldsContainer) diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/exponential.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/exponential.md index 2b5eba7d2..cd7169342 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/exponential.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/exponential.md @@ -20,7 +20,7 @@ exponential(config: OperatorConfig) ### field -Field, fields container, or numeric data for exponential calculation +Dimensionless field, fields container, or numeric data. **Type:** *LinkableInput* @@ -28,7 +28,7 @@ Field, fields container, or numeric data for exponential calculation ### field -Field with exponential values applied element-wise to input data +Dimensionless field with $e^{\mathrm{in}[i]}$ for each data entry. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/exponential_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/exponential_fc.md index b699bf7a8..f71e1b285 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/exponential_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/exponential_fc.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.exponential_fc # *class* exponential_fc(fields_container: object = None, config: OperatorConfig = None) -Computes element-wise exponential function on field data: exp(field[i]). +Computes the entity-wise [exponential function](https://en.wikipedia.org/wiki/Exponential_function): + +$\mathrm{out}[i] = e^{\mathrm{in}[i]}$. + +The input must be dimensionless; a dimensional input raises an error. + +The output is dimensionless. available inputs: `fields_container` (FieldsContainer) @@ -29,7 +35,7 @@ op = exponential_fc(fields_container=my_fields_container) ### fields_container -Field, fields container, or numeric data for exponential calculation +Dimensionless field, fields container, or numeric data. **Type:** *LinkableInput* @@ -37,7 +43,7 @@ Field, fields container, or numeric data for exponential calculation ### fields_container -Field with exponential values applied element-wise to input data +Dimensionless field with $e^{\mathrm{in}[i]}$ for each data entry. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/generalized_inner_product.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/generalized_inner_product.md index ca04dd316..53195072f 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/generalized_inner_product.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/generalized_inner_product.md @@ -2,10 +2,10 @@ uid: Ans.DataProcessing.operators.math.generalized_inner_product --- -# *class* generalized_inner_product(fieldA: object = None, fieldB: object = None, config: OperatorConfig = None) +# *class* generalized_inner_product(fieldA: object = None, fieldB: object = None, mesh: object = None, config: OperatorConfig = None) generalized_inner_product() -generalized_inner_product(fieldA: object, fieldB: object, config: OperatorConfig) +generalized_inner_product(fieldA: object, fieldB: object, mesh: object, config: OperatorConfig) generalized_inner_product(config: OperatorConfig) @@ -15,6 +15,7 @@ generalized_inner_product(config: OperatorConfig) * **fieldA** * **fieldB** +* **mesh** * **config** ## Inputs @@ -31,11 +32,17 @@ field or fields container with only one field is expected **Type:** *LinkableInput* +### mesh + +Mesh required when computing the finite-element dot product between an elemental-nodal field (pin 0 or 1) and a nodal field. + +**Type:** *LinkableInput* + ## Outputs ### field -Field containing the generalized inner product result +Inner product result field; dimensionality and unit are determined by the dispatched operation. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/generalized_inner_product_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/generalized_inner_product_fc.md index 8e6aa9fe9..f7f4265d7 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/generalized_inner_product_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/generalized_inner_product_fc.md @@ -2,10 +2,10 @@ uid: Ans.DataProcessing.operators.math.generalized_inner_product_fc --- -# *class* generalized_inner_product_fc(field_or_fields_container_A: object = None, field_or_fields_container_B: object = None, config: OperatorConfig = None) +# *class* generalized_inner_product_fc(field_or_fields_container_A: object = None, field_or_fields_container_B: object = None, mesh: object = None, config: OperatorConfig = None) generalized_inner_product_fc() -generalized_inner_product_fc(field_or_fields_container_A: object, field_or_fields_container_B: object, config: OperatorConfig) +generalized_inner_product_fc(field_or_fields_container_A: object, field_or_fields_container_B: object, mesh: object, config: OperatorConfig) generalized_inner_product_fc(config: OperatorConfig) @@ -15,6 +15,7 @@ generalized_inner_product_fc(config: OperatorConfig) * **field_or_fields_container_A** * **field_or_fields_container_B** +* **mesh** * **config** ## Inputs @@ -31,11 +32,17 @@ field or fields container with only one field is expected **Type:** *LinkableInput* +### mesh + +Mesh required when computing the finite-element dot product between an elemental-nodal field (pin 0 or 1) and a nodal field. + +**Type:** *LinkableInput* + ## Outputs ### fields_container -Field containing the generalized inner product result +Inner product result field; dimensionality and unit are determined by the dispatched operation. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/img_part.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/img_part.md index da860a53a..8338a0900 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/img_part.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/img_part.md @@ -4,7 +4,9 @@ uid: Ans.DataProcessing.operators.math.img_part # *class* img_part(fields_container: object = None, config: OperatorConfig = None) -Extracts element-wise imaginary part of field containers containing complex fields. +Extracts the imaginary-part fields (complex label 1) from a complex-valued fields container. + +The output container preserves all labels except the complex label. available inputs: `fields_container` (FieldsContainer) @@ -29,12 +31,16 @@ op = img_part(fields_container=my_fields_container) ### fields_container +Complex-valued fields container with real (complex label 0) and imaginary (complex label 1) part fields. + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container containing only the imaginary-part fields, without the complex label. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/index.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/index.md index 01f29a1fa..fd4a0e4c6 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/index.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/index.md @@ -9,9 +9,9 @@ uid: Ans.DataProcessing.operators.math | Class | Description | |-------|-------------| | [absolute_value_by_component](Ans_DataProcessing_operators_math_absolute_value_by_component.md) | absolute_value_by_component() | -| [absolute_value_by_component_fc](Ans_DataProcessing_operators_math_absolute_value_by_component_fc.md) | Computes the absolute value of each data value in the input field component-wise, without performing vector norm operations. ///available inputs: fields_container (FieldsContainer) | -| [accumulate](Ans_DataProcessing_operators_math_accumulate.md) | Sums all the elementary data of a field to produce one elementary data point. ///available inputs: fieldA (Field, FieldsContainer), weights (Field) (optional), time_scoping (Scoping) (optional) | -| [accumulate_fc](Ans_DataProcessing_operators_math_accumulate_fc.md) | Sums all the elementary data of a field to produce one elementary data point. ///available inputs: fields_container (FieldsContainer), weights (Field) (optional), time_scoping (Scoping) (optional) | +| [absolute_value_by_component_fc](Ans_DataProcessing_operators_math_absolute_value_by_component_fc.md) | Applies the [absolute value](https://en.wikipedia.org/wiki/Absolute_value) function component-wise | +| [accumulate](Ans_DataProcessing_operators_math_accumulate.md) | Reduces a field to a single entity by summing all entity data component-wise. | +| [accumulate_fc](Ans_DataProcessing_operators_math_accumulate_fc.md) | Reduces a field to a single entity by summing all entity data component-wise. | | [accumulate_level_over_label_fc](Ans_DataProcessing_operators_math_accumulate_level_over_label_fc.md) | Compute the component-wise sum over all the fields that have the same ID as the label set as input in the fields container and apply 10.0xlog10(data/10xx-12) on the result. This computation can be incremental. If the input fields container is connected and the operator is run multiple times, the output field will be on all the connected inputs. ///available inputs: fields_container (FieldsContainer), label (string) (optional) | | [accumulate_min_over_label_fc](Ans_DataProcessing_operators_math_accumulate_min_over_label_fc.md) | Compute the component-wise sum over all the fields that have the same ID as the label set as input in the fields container and take its opposite. This computation can be incremental. If the input fields container is connected and the operator is run multiple times, the output field will be on all the connected inputs. ///available inputs: fields_container (FieldsContainer), label (string) (optional) | | [accumulate_over_label_fc](Ans_DataProcessing_operators_math_accumulate_over_label_fc.md) | Compute the component-wise sum over all the fields that have the same ID as the label set as input in the fields container. This computation can be incremental. If the input fields container is connected and the operator is run multiple times, the output field will be on all the connected inputs. ///available inputs: fields_container (FieldsContainer), label (string) (optional) | @@ -20,33 +20,33 @@ uid: Ans.DataProcessing.operators.math | [add_constant](Ans_DataProcessing_operators_math_add_constant.md) | add_constant() | | [add_constant_fc](Ans_DataProcessing_operators_math_add_constant_fc.md) | add_constant_fc() | | [add_fc](Ans_DataProcessing_operators_math_add_fc.md) | add_fc() | -| [amplitude](Ans_DataProcessing_operators_math_amplitude.md) | Computes amplitude of a real and an imaginary field. ///available inputs: fieldA (Field, FieldsContainer), fieldB (Field, FieldsContainer) | -| [amplitude_fc](Ans_DataProcessing_operators_math_amplitude_fc.md) | Computes the amplitude of a real and an imaginary field. ///available inputs: fields_container (FieldsContainer) | +| [amplitude](Ans_DataProcessing_operators_math_amplitude.md) | Computes the [complex modulus](https://en.wikipedia.org/wiki/Absolute_value#Complex_numbers) (amplitude) | +| [amplitude_fc](Ans_DataProcessing_operators_math_amplitude_fc.md) | Computes the [complex modulus](https://en.wikipedia.org/wiki/Absolute_value#Complex_numbers) (amplitude) | | [average_over_label_fc](Ans_DataProcessing_operators_math_average_over_label_fc.md) | Compute the component-wise average over all the fields that have the same ID as the label set as input in the fields container. This computation can be incremental. If the input fields container is connected and the operator is run multiple times, the output field will be on all the connected inputs. ///available inputs: fields_container (FieldsContainer), label (string) (optional) | -| [centroid](Ans_DataProcessing_operators_math_centroid.md) | Computes centroid of field1 and field2, using fieldOut = field1*(1.-fact)+field2*(fact). Only works by index. ///available inputs: fieldA (Field, FieldsContainer), fieldB (Field, FieldsContainer), factor (double) | -| [centroid_fc](Ans_DataProcessing_operators_math_centroid_fc.md) | Computes the centroid of all the matching fields of a fields container at a given time or frequency, using fieldOut = field1*(1.-fact)+field2*(fact). ///available inputs: fields_container (FieldsContainer), time_freq (double), step (Int32) (optional), time_freq_support (TimeFreqSupport) (optional) | -| [component_wise_divide](Ans_DataProcessing_operators_math_component_wise_divide.md) | Computes component-wise fraction between two fields of same dimensionality. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. When using a constant or 'work_by_index', you can use 'inplace' to reuse one of the fields. ///available inputs: fieldA (Field, FieldsContainer), fieldB (Field, FieldsContainer) | -| [component_wise_divide_fc](Ans_DataProcessing_operators_math_component_wise_divide_fc.md) | For every two fields with the same label space (from the two input fields containers), computes component-wise fraction between two fields of same dimensionality. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. ///available inputs: fields_containerA (FieldsContainer), fields_containerB (FieldsContainer) | +| [centroid](Ans_DataProcessing_operators_math_centroid.md) | Computes a [linear interpolation](https://en.wikipedia.org/wiki/Linear_interpolation) between two fields | +| [centroid_fc](Ans_DataProcessing_operators_math_centroid_fc.md) | Computes a [linear interpolation](https://en.wikipedia.org/wiki/Linear_interpolation) between the two fields | +| [component_wise_divide](Ans_DataProcessing_operators_math_component_wise_divide.md) | Computes the component-wise fraction $\mathrm{out}[k] = A[k] / B[k]$ | +| [component_wise_divide_fc](Ans_DataProcessing_operators_math_component_wise_divide_fc.md) | For every pair of fields with matching label space in the two input fields containers, | | [component_wise_product](Ans_DataProcessing_operators_math_component_wise_product.md) | Computes component-wise product between two fields of same dimensionality. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. When using a constant or 'work_by_index', you can use 'inplace' to reuse one of the fields. ///available inputs: fieldA (Field, FieldsContainer), fieldB (Field, FieldsContainer) | | [component_wise_product_fc](Ans_DataProcessing_operators_math_component_wise_product_fc.md) | Computes component-wise product between two fields of same dimensionality. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. When using a constant or 'work_by_index', you can use 'inplace' to reuse one of the fields. ///available inputs: fields_container (FieldsContainer), fieldB (Field, FieldsContainer) | | [compute_residual_and_error](Ans_DataProcessing_operators_math_compute_residual_and_error.md) | Computes the \\(L_p\\) norm of a normalized field or a field container. | -| [conjugate](Ans_DataProcessing_operators_math_conjugate.md) | Computes element-wise conjugate of field containers containing complex fields. ///available inputs: fields_container (FieldsContainer) | +| [conjugate](Ans_DataProcessing_operators_math_conjugate.md) | Computes the [complex conjugate](https://en.wikipedia.org/wiki/Complex_conjugate) | | [correlation](Ans_DataProcessing_operators_math_correlation.md) | correlation() | -| [cos](Ans_DataProcessing_operators_math_cos.md) | Computes element-wise cosine function on field data: cos(field[i]). ///available inputs: field (Field, FieldsContainer) | -| [cos_fc](Ans_DataProcessing_operators_math_cos_fc.md) | Computes element-wise cosine function on field data: cos(field[i]). ///available inputs: fields_container (FieldsContainer) | -| [cplx_derive](Ans_DataProcessing_operators_math_cplx_derive.md) | Derives field containers containing complex fields. ///available inputs: fields_container (FieldsContainer) | -| [cplx_divide](Ans_DataProcessing_operators_math_cplx_divide.md) | Computes division between two field containers containing complex fields. ///available inputs: fields_containerA (FieldsContainer), fields_containerB (FieldsContainer) | -| [cplx_dot](Ans_DataProcessing_operators_math_cplx_dot.md) | Computes product between two field containers containing complex fields. ///available inputs: fields_containerA (FieldsContainer), fields_containerB (FieldsContainer) | -| [cplx_multiply](Ans_DataProcessing_operators_math_cplx_multiply.md) | Computes multiplication between two field containers containing complex fields. ///available inputs: fields_containerA (FieldsContainer), fields_containerB (FieldsContainer) | +| [cos](Ans_DataProcessing_operators_math_cos.md) | Computes the entity-wise [cosine](https://en.wikipedia.org/wiki/Sine_and_cosine): | +| [cos_fc](Ans_DataProcessing_operators_math_cos_fc.md) | Computes the entity-wise [cosine](https://en.wikipedia.org/wiki/Sine_and_cosine): | +| [cplx_derive](Ans_DataProcessing_operators_math_cplx_derive.md) | Computes the time derivative of a [phasor](https://en.wikipedia.org/wiki/Phasor) field | +| [cplx_divide](Ans_DataProcessing_operators_math_cplx_divide.md) | Computes the [complex division](https://en.wikipedia.org/wiki/Complex_number#Multiplicative_inverse) | +| [cplx_dot](Ans_DataProcessing_operators_math_cplx_dot.md) | Computes the real-valued inner product | +| [cplx_multiply](Ans_DataProcessing_operators_math_cplx_multiply.md) | Computes the standard [complex multiplication](https://en.wikipedia.org/wiki/Complex_number#Multiplication_and_square) | | [cross_product](Ans_DataProcessing_operators_math_cross_product.md) | cross_product() | | [cross_product_fc](Ans_DataProcessing_operators_math_cross_product_fc.md) | cross_product_fc() | | [dot](Ans_DataProcessing_operators_math_dot.md) | DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes element - wise dot product between two vector fields. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely.When using a constant or 'work_by_index', you can use 'inplace' to reuse one of the fields, but only in the case where both fields are scalar. ///available inputs: fieldA (Field, FieldsContainer), fieldB (Field, FieldsContainer) | -| [dot_tensor](Ans_DataProcessing_operators_math_dot_tensor.md) | DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes element-wise dot product between two tensor fields. ///available inputs: fieldA (Field, FieldsContainer), fieldB (Field, FieldsContainer) | +| [dot_tensor](Ans_DataProcessing_operators_math_dot_tensor.md) | DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes entity-wise dot product between two tensor fields. ///available inputs: fieldA (Field, FieldsContainer), fieldB (Field, FieldsContainer) | | [eim_solver](Ans_DataProcessing_operators_math_eim_solver.md) | eim_solver() | | [entity_extractor](Ans_DataProcessing_operators_math_entity_extractor.md) | Extracts an entity from a field, based on its ID. ///available inputs: fieldA (Field), scalar_int (Int32) | | [expansion_psd](Ans_DataProcessing_operators_math_expansion_psd.md) | Computes the PSD response for one-sigma solution. ///available inputs: mode_shapes (FieldsContainer), static_shapes (FieldsContainer) (optional), rel_rel_covar_matrix (FieldsContainer), stat_stat_covar_matrix (FieldsContainer) (optional), rel_stat_covar_matrix (FieldsContainer) (optional) | | [exponential](Ans_DataProcessing_operators_math_exponential.md) | exponential() | -| [exponential_fc](Ans_DataProcessing_operators_math_exponential_fc.md) | Computes element-wise exponential function on field data: exp(field[i]). ///available inputs: fields_container (FieldsContainer) | +| [exponential_fc](Ans_DataProcessing_operators_math_exponential_fc.md) | Computes the entity-wise [exponential function](https://en.wikipedia.org/wiki/Exponential_function): | | [fastnvh_loadfile](Ans_DataProcessing_operators_math_fastnvh_loadfile.md) | fastnvh_loadfile() | | [fft_approx](Ans_DataProcessing_operators_math_fft_approx.md) | Computes the fitting curve using FFT filtering and cubic fitting in space (node i: x=time, y=data), with the possibility to compute the first and the second derivatives of the curve. ///available inputs: time_scoping (IList int, Scoping, System.Collections.IEnumerable) (optional), mesh_scoping (Scoping, ScopingsContainer) (optional), entity_to_fit (FieldsContainer), component_number (Int32), first_derivative (bool), second_derivative (bool), fit_data (bool), cutoff_fr (double, Int32) (optional) | | [fft_eval](Ans_DataProcessing_operators_math_fft_eval.md) | Evaluate the fast fourier transforms at a given set of fields. ///available inputs: field_t (Field), time_scoping (Scoping) (optional) | @@ -54,54 +54,56 @@ uid: Ans.DataProcessing.operators.math | [fft_multi_harmonic_minmax](Ans_DataProcessing_operators_math_fft_multi_harmonic_minmax.md) | Evaluate min max fields on multi harmonic solution. min and max fields are calculated based on evaluating a fourier series sum wrt rpms and using the gradient method for adaptive time steping ///available inputs: fields_container (FieldsContainer), rpm_scoping (Scoping) (optional), fs_ratio (Int32) (optional), num_subdivisions (Int32) (optional), max_num_subdivisions (Int32) (optional), num_cycles (Int32) (optional), use_harmonic_zero (bool) (optional), calculate_time_series (bool) (optional), substeps_selector (IList int, System.Collections.IEnumerable) (optional) | | [generalized_inner_product](Ans_DataProcessing_operators_math_generalized_inner_product.md) | generalized_inner_product() | | [generalized_inner_product_fc](Ans_DataProcessing_operators_math_generalized_inner_product_fc.md) | generalized_inner_product_fc() | -| [img_part](Ans_DataProcessing_operators_math_img_part.md) | Extracts element-wise imaginary part of field containers containing complex fields. ///available inputs: fields_container (FieldsContainer) | -| [invert](Ans_DataProcessing_operators_math_invert.md) | DEPRECATED, PLEASE USE DIVIDE. Computes the element-wise and component-wise inverse of a field (1./x). ///available inputs: field (Field, FieldsContainer) | -| [invert_fc](Ans_DataProcessing_operators_math_invert_fc.md) | DEPRECATED, PLEASE USE DIVIDE. Computes the element-wise and component-wise inverse of a field (1./x). ///available inputs: fields_container (FieldsContainer) | -| [kronecker_prod](Ans_DataProcessing_operators_math_kronecker_prod.md) | Computes element-wise Kronecker product between two tensor fields. ///available inputs: fieldA (Field, FieldsContainer), fieldB (Field, FieldsContainer) | -| [linear_combination](Ans_DataProcessing_operators_math_linear_combination.md) | Computes aXY + bZ where a,b (in 0, in 3) are scalar and X,Y,Z (in 1,2,4) are complex numbers. ///available inputs: a (double), fields_containerA (FieldsContainer), fields_containerB (FieldsContainer), b (double), fields_containerC (FieldsContainer) | +| [img_part](Ans_DataProcessing_operators_math_img_part.md) | Extracts the imaginary-part fields (complex label 1) from a complex-valued fields container. | +| [invert](Ans_DataProcessing_operators_math_invert.md) | DEPRECATED, PLEASE USE DIVIDE. Computes the entity-wise and component-wise inverse of a field (1./x). ///available inputs: field (Field, FieldsContainer) | +| [invert_fc](Ans_DataProcessing_operators_math_invert_fc.md) | DEPRECATED, PLEASE USE DIVIDE. Computes the entity-wise and component-wise inverse of a field (1./x). ///available inputs: fields_container (FieldsContainer) | +| [kronecker_prod](Ans_DataProcessing_operators_math_kronecker_prod.md) | Computes the [Kronecker product](https://en.wikipedia.org/wiki/Kronecker_product) | +| [linear_combination](Ans_DataProcessing_operators_math_linear_combination.md) | Computes the [linear combination](https://en.wikipedia.org/wiki/Linear_combination) | | [linearized_stress](Ans_DataProcessing_operators_math_linearized_stress.md) | get linearized stress ///available inputs: stress_comps (FieldsContainer), iComp (Int32), path_coords (Field), rho (double), kbr (Int32), ksxbzro (Int32), out_type (Int32) | | [ln](Ans_DataProcessing_operators_math_ln.md) | ln() | -| [ln_fc](Ans_DataProcessing_operators_math_ln_fc.md) | Computes element-wise ln(field[i]). ///available inputs: fields_container (FieldsContainer) | +| [ln_fc](Ans_DataProcessing_operators_math_ln_fc.md) | Computes the entity-wise [natural logarithm](https://en.wikipedia.org/wiki/Natural_logarithm): | | [mac](Ans_DataProcessing_operators_math_mac.md) | Computes MAC Matrix between two fields container, both for real and complex cases. For mixed cases (real-complex and complex) only the real part is considered. Providing inputs with the same component scoping is an user responsability. ///available inputs: fields_containerA (FieldsContainer), fields_containerB (FieldsContainer), weights (Field) | | [make_one_on_comp](Ans_DataProcessing_operators_math_make_one_on_comp.md) | Takes the input field's scoping and creates a field full of zeros, except for the indexes from pin 1 that will hold 1.0. ///available inputs: fieldA (Field), scalar_int (Int32) | | [matrix_inverse](Ans_DataProcessing_operators_math_matrix_inverse.md) | Computes the complex matrix inverse for each field in the given fields container. ///available inputs: fields_container (FieldsContainer) | +| [matrix_product](Ans_DataProcessing_operators_math_matrix_product.md) | matrix_product() | +| [matrix_product_fc](Ans_DataProcessing_operators_math_matrix_product_fc.md) | matrix_product_fc() | | [minus](Ans_DataProcessing_operators_math_minus.md) | minus() | | [minus_fc](Ans_DataProcessing_operators_math_minus_fc.md) | minus_fc() | | [modal_damping_ratio](Ans_DataProcessing_operators_math_modal_damping_ratio.md) | modal_damping_ratio() | | [modal_participation](Ans_DataProcessing_operators_math_modal_participation.md) | Compute the modal participation factor for a given vector field V, defined as sum_i ( V .dot. mode_shape_i * ponderation ). ///available inputs: v_real (Field), v_imag (Field), mode_shapes (FieldsContainer), ponderation (Field) (optional), force_label_space (LabelSpace) (optional) | -| [modal_superposition](Ans_DataProcessing_operators_math_modal_superposition.md) | Computes the solution in the time/frequency space from a modal solution by multiplying a modal basis (in 0)by the solution in this modal space (coefficients for each mode for each time/frequency) (in 1). ///available inputs: modal_basis (FieldsContainer), solution_in_modal_space (FieldsContainer), incremental_fc (FieldsContainer) (optional), time_scoping (Scoping, IList int, System.Collections.IEnumerable) (optional), mesh_scoping (Scoping, ScopingsContainer) (optional) | -| [modulus](Ans_DataProcessing_operators_math_modulus.md) | Computes element-wise modulus of field containers containing complex fields. ///available inputs: fields_container (FieldsContainer) | -| [norm](Ans_DataProcessing_operators_math_norm.md) | Computes the element-wise Lp norm of the field elementary data. Default Lp=L2 ///available inputs: field (Field, FieldsContainer), scalar_int (Int32) (optional) | -| [norm_fc](Ans_DataProcessing_operators_math_norm_fc.md) | Computes the element-wise L2 norm of the field elementary data. This process is applied on each field of the input fields container. ///available inputs: fields_container (FieldsContainer), scalar_int (Int32) (optional) | +| [modal_superposition](Ans_DataProcessing_operators_math_modal_superposition.md) | Computes the solution in the time/frequency space from a modal solution by multiplying a modal basis (in 0)by the solution in this modal space (coefficients for each mode for each time/frequency) (in 1). ///available inputs: modal_basis (FieldsContainer, CustomTypeFieldsContainer), solution_in_modal_space (FieldsContainer, CustomTypeFieldsContainer), incremental_fc (FieldsContainer, CustomTypeFieldsContainer) (optional), time_scoping (Scoping, ScopingsContainer) (optional), mesh_scoping (Scoping, ScopingsContainer) (optional) | +| [modulus](Ans_DataProcessing_operators_math_modulus.md) | Computes the [complex modulus](https://en.wikipedia.org/wiki/Absolute_value#Complex_numbers) | +| [norm](Ans_DataProcessing_operators_math_norm.md) | Computes the [$L_p$ norm](https://en.wikipedia.org/wiki/Norm_(mathematics)#p-norm) of the component vector | +| [norm_fc](Ans_DataProcessing_operators_math_norm_fc.md) | Computes the [$L_p$ norm](https://en.wikipedia.org/wiki/Norm_(mathematics)#p-norm) of the component vector | | [nvh_curve_fitting_solver](Ans_DataProcessing_operators_math_nvh_curve_fitting_solver.md) | nvh_curve_fitting_solver() | | [outer_product](Ans_DataProcessing_operators_math_outer_product.md) | outer_product() | | [overall_dot](Ans_DataProcessing_operators_math_overall_dot.md) | Computes a dot product between two fields (fields are seen like a single large vector) and returns a scalar. ///available inputs: fieldA (Field), fieldB (Field) | -| [phase](Ans_DataProcessing_operators_math_phase.md) | Computes the phase (in rad) between a real and an imaginary field. ///available inputs: fieldA (Field, FieldsContainer), fieldB (Field, FieldsContainer) | -| [phase_fc](Ans_DataProcessing_operators_math_phase_fc.md) | Computes phase (in rad) between real and imaginary fields. ///available inputs: fields_container (FieldsContainer) | -| [polar_to_cplx](Ans_DataProcessing_operators_math_polar_to_cplx.md) | Converts a complex number from polar form to complex. ///available inputs: fields_container (FieldsContainer) | -| [pow](Ans_DataProcessing_operators_math_pow.md) | Computes element-wise field[i]^p. ///available inputs: field (Field), factor (double), division_by_zero_value (double) (optional) | -| [pow_fc](Ans_DataProcessing_operators_math_pow_fc.md) | Computes element-wise field[i]^p. ///available inputs: fields_container (FieldsContainer), factor (double), division_by_zero_value (double) (optional) | +| [phase](Ans_DataProcessing_operators_math_phase.md) | Computes the [argument](https://en.wikipedia.org/wiki/Argument_(complex_analysis)) (phase angle) | +| [phase_fc](Ans_DataProcessing_operators_math_phase_fc.md) | Computes the [argument](https://en.wikipedia.org/wiki/Argument_(complex_analysis)) (phase angle) | +| [polar_to_cplx](Ans_DataProcessing_operators_math_polar_to_cplx.md) | Converts a complex-valued fields container from | +| [pow](Ans_DataProcessing_operators_math_pow.md) | Computes entity-wise field[i]^p. ///available inputs: field (Field), factor (double), division_by_zero_value (double) (optional) | +| [pow_fc](Ans_DataProcessing_operators_math_pow_fc.md) | Computes entity-wise field[i]^p. ///available inputs: fields_container (FieldsContainer), factor (double), division_by_zero_value (double) (optional) | | [qr_solve](Ans_DataProcessing_operators_math_qr_solve.md) | Computes the solution using QR factorization. ///available inputs: fields_container (FieldsContainer), rhs (FieldsContainer) | -| [real_part](Ans_DataProcessing_operators_math_real_part.md) | Extracts element-wise real part of field containers containing complex fields. ///available inputs: fields_container (FieldsContainer) | +| [real_part](Ans_DataProcessing_operators_math_real_part.md) | Extracts the real-part fields (complex label 0) from a complex-valued fields container. | | [relative_error](Ans_DataProcessing_operators_math_relative_error.md) | relative_error() | | [scale](Ans_DataProcessing_operators_math_scale.md) | scale() | | [scale_by_field](Ans_DataProcessing_operators_math_scale_by_field.md) | DEPRECATED, PLEASE USE SCALE. Scales a field (in 0) by a scalar field (in 1). If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. ///available inputs: fieldA (Field, FieldsContainer), fieldB (Field, FieldsContainer) | | [scale_by_field_fc](Ans_DataProcessing_operators_math_scale_by_field_fc.md) | DEPRECATED, PLEASE USE SCALE. Scales a field (in 0) by a scalar field (in 1). If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. ///available inputs: field_or_fields_container_A (Field, FieldsContainer), field_or_fields_container_B (Field, FieldsContainer) | | [scale_fc](Ans_DataProcessing_operators_math_scale_fc.md) | scale_fc() | -| [sin](Ans_DataProcessing_operators_math_sin.md) | Computes element-wise sine function on field data: sin(field[i]). ///available inputs: field (Field) | -| [sin_fc](Ans_DataProcessing_operators_math_sin_fc.md) | Computes element-wise sine function on field data: sin(field[i]). ///available inputs: fields_container (FieldsContainer) | -| [sqr](Ans_DataProcessing_operators_math_sqr.md) | Computes element-wise field[i]^2. ///available inputs: field (Field, FieldsContainer) | -| [sqr_fc](Ans_DataProcessing_operators_math_sqr_fc.md) | Computes element-wise field[i]^2. ///available inputs: fields_container (FieldsContainer) | -| [sqrt](Ans_DataProcessing_operators_math_sqrt.md) | Computes element-wise square root function on field data: sqrt(field[i]). ///available inputs: field (Field, FieldsContainer) | -| [sqrt_fc](Ans_DataProcessing_operators_math_sqrt_fc.md) | Computes element-wise square root function on field data: sqrt(field[i]). ///available inputs: fields_container (FieldsContainer) | +| [sin](Ans_DataProcessing_operators_math_sin.md) | Computes the entity-wise [sine](https://en.wikipedia.org/wiki/Sine_and_cosine): | +| [sin_fc](Ans_DataProcessing_operators_math_sin_fc.md) | Computes the entity-wise [sine](https://en.wikipedia.org/wiki/Sine_and_cosine): | +| [sqr](Ans_DataProcessing_operators_math_sqr.md) | Computes the entity-wise square | +| [sqr_fc](Ans_DataProcessing_operators_math_sqr_fc.md) | Computes the entity-wise square | +| [sqrt](Ans_DataProcessing_operators_math_sqrt.md) | Computes the entity-wise square root | +| [sqrt_fc](Ans_DataProcessing_operators_math_sqrt_fc.md) | Computes the entity-wise square root | | [svd](Ans_DataProcessing_operators_math_svd.md) | Computes the matrix singular value decomposition (SVD) for each field in the given fields container. ///available inputs: fields_container (FieldsContainer) | -| [sweeping_phase](Ans_DataProcessing_operators_math_sweeping_phase.md) | Shifts the phase of a real and an imaginary field (in 0 and 1) of a given angle (in 3) of a unit (in 4). The resulting field is computed as field_out = real_field`*`cos(angle) - imaginary_field`*`sin(angle). ///available inputs: real_field (Field, FieldsContainer), imaginary_field (Field, FieldsContainer), angle (double), unit_name (string) (optional), abs_value (bool), imaginary_part_null (bool) | -| [sweeping_phase_fc](Ans_DataProcessing_operators_math_sweeping_phase_fc.md) | Shifts the phase of all the corresponding real and imaginary fields of a fields container for a given angle (in 2) of a unit (in 4). An output field is computed for each pair of real and imaginary fields in the input fields_container as field_out = real_field`*`cos(angle) - imaginary_field`*`sin(angle). ///available inputs: fields_container (FieldsContainer), angle (double), unit_name (string) (optional), abs_value (bool) | +| [sweeping_phase](Ans_DataProcessing_operators_math_sweeping_phase.md) | Projects a [phasor](https://en.wikipedia.org/wiki/Phasor) field onto a given phase angle $\theta$: | +| [sweeping_phase_fc](Ans_DataProcessing_operators_math_sweeping_phase_fc.md) | Projects every [phasor](https://en.wikipedia.org/wiki/Phasor) field pair in the input fields container | | [time_derivation](Ans_DataProcessing_operators_math_time_derivation.md) | Derives a field of time varying quantities with respect to time ///available inputs: field (Field), spline_fitting (bool) (optional) | | [time_freq_interpolation](Ans_DataProcessing_operators_math_time_freq_interpolation.md) | time_freq_interpolation() | | [time_integration](Ans_DataProcessing_operators_math_time_integration.md) | Integrates a field of time varying quantities over time ///available inputs: field (Field), resample_output (bool) (optional), absolute_error (double) (optional), minimum_step_size (double) (optional), integration_constant (double) (optional) | -| [unit_convert](Ans_DataProcessing_operators_math_unit_convert.md) | Converts an input field/fields container or mesh of a given unit to another unit. ///available inputs: entity_to_convert (Field, FieldsContainer, MeshedRegion, MeshesContainer), unit_name (string, Int32, Field) | -| [unit_convert_fc](Ans_DataProcessing_operators_math_unit_convert_fc.md) | Converts an input fields container of a given unit to another unit. ///available inputs: fields_container (FieldsContainer), unit_name (string) | +| [unit_convert](Ans_DataProcessing_operators_math_unit_convert.md) | Converts an input entity from one unit to another using the linear relation | +| [unit_convert_fc](Ans_DataProcessing_operators_math_unit_convert_fc.md) | Converts a fields container from one unit to another using the linear relation | | [window_bartlett](Ans_DataProcessing_operators_math_window_bartlett.md) | Apply bartlett windowing on a given FieldsContainer having time label or a Field located on time. Assume that time sampling is evenly spaced (use time_freq_interpolation before otherwise). ///available inputs: field (Field, FieldsContainer) | | [window_bartlett_fc](Ans_DataProcessing_operators_math_window_bartlett_fc.md) | Apply bartlett windowing on a given FieldsContainer having time label or a Field located on time. Assume that time sampling is evenly spaced (use time_freq_interpolation before otherwise). ///available inputs: fields_container (FieldsContainer) | | [window_blackman](Ans_DataProcessing_operators_math_window_blackman.md) | Apply blackman windowing on a given FieldsContainer having time label or a Field located on time. Assume that time sampling is evenly spaced (use time_freq_interpolation before otherwise). ///available inputs: field (Field, FieldsContainer) | diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/invert.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/invert.md index 5a16d3152..dd97aef77 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/invert.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/invert.md @@ -4,7 +4,7 @@ uid: Ans.DataProcessing.operators.math.invert # *class* invert(field: object = None, config: OperatorConfig = None) -DEPRECATED, PLEASE USE DIVIDE. Computes the element-wise and component-wise inverse of a field (1./x). +DEPRECATED, PLEASE USE DIVIDE. Computes the entity-wise and component-wise inverse of a field (1./x). available inputs: `field` (Field, FieldsContainer) @@ -37,7 +37,7 @@ field or fields container with only one field is expected ### field -Field with inverse values (1/x) applied element-wise to input data +Field with inverse values (1/x) applied entity-wise to input data **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/invert_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/invert_fc.md index bbc906af7..87a4434ec 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/invert_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/invert_fc.md @@ -4,7 +4,7 @@ uid: Ans.DataProcessing.operators.math.invert_fc # *class* invert_fc(fields_container: object = None, config: OperatorConfig = None) -DEPRECATED, PLEASE USE DIVIDE. Computes the element-wise and component-wise inverse of a field (1./x). +DEPRECATED, PLEASE USE DIVIDE. Computes the entity-wise and component-wise inverse of a field (1./x). available inputs: `fields_container` (FieldsContainer) @@ -37,7 +37,7 @@ field or fields container with only one field is expected ### fields_container -Field with inverse values (1/x) applied element-wise to input data +Field with inverse values (1/x) applied entity-wise to input data **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/kronecker_prod.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/kronecker_prod.md index d55dd9dc9..6b34d8af9 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/kronecker_prod.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/kronecker_prod.md @@ -4,7 +4,17 @@ uid: Ans.DataProcessing.operators.math.kronecker_prod # *class* kronecker_prod(fieldA: object = None, fieldB: object = None, config: OperatorConfig = None) -Computes element-wise Kronecker product between two tensor fields. +Computes the [Kronecker product](https://en.wikipedia.org/wiki/Kronecker_product) + +of two matrix-valued fields per entity. + +For each entity, if $A$ is an $(m \times n)$ matrix and $B$ is a $(p \times q)$ matrix, + +the result is an $(mp \times nq)$ matrix: + +$(A \otimes B)_{(ip+k),(jq+l)} = A_{i,j} \cdot B_{k,l}$. + +Both input fields must have the same number of entities. available inputs: `fieldA` (Field, FieldsContainer), `fieldB` (Field, FieldsContainer) @@ -44,6 +54,8 @@ field or fields container with only one field is expected ### field +Matrix field containing the Kronecker product $A \otimes B$ for each entity; unit is $u_A \cdot u_B$. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/linear_combination.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/linear_combination.md index c0c25491a..711c8bf0f 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/linear_combination.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/linear_combination.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.linear_combination # *class* linear_combination(a: object = None, fields_containerA: object = None, fields_containerB: object = None, b: object = None, fields_containerC: object = None, config: OperatorConfig = None) -Computes aXY + bZ where a,b (in 0, in 3) are scalar and X,Y,Z (in 1,2,4) are complex numbers. +Computes the [linear combination](https://en.wikipedia.org/wiki/Linear_combination) + +$a \cdot X \cdot Y + b \cdot Z$, + +where $a$ (pin 0) and $b$ (pin 3) are real scalars, + +and $X$ (pin 1), $Y$ (pin 2), $Z$ (pin 4) are complex-valued fields containers. + +The product $X \cdot Y$ is a standard complex multiplication. available inputs: `a` (double), `fields_containerA` (FieldsContainer), `fields_containerB` (FieldsContainer), `b` (double), `fields_containerC` (FieldsContainer) @@ -33,7 +41,7 @@ op = linear_combination(a=my_a,fields_containerA=my_fields_containerA,fields_con ### a -Double +Real scalar factor $a$ applied to the complex product $X \cdot Y$. **Type:** *LinkableInput* @@ -47,18 +55,22 @@ Double ### b -Double +Real scalar factor $b$ applied to the complex addend $Z$. **Type:** *LinkableInput* ### fields_containerC +Third complex-valued fields container $Z$. + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container with the complex result $a \cdot X \cdot Y + b \cdot Z$ (real and imaginary parts). + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/ln.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/ln.md index 42738edb4..0b96d0bf6 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/ln.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/ln.md @@ -20,7 +20,7 @@ ln(config: OperatorConfig) ### field -field or fields container with only one field is expected +Dimensionless field, fields container, or numeric data. **Type:** *LinkableInput* @@ -28,7 +28,7 @@ field or fields container with only one field is expected ### field -Field with natural logarithm values applied element-wise +Dimensionless field with $\ln(\mathrm{in}[i])$ for each data entry. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/ln_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/ln_fc.md index 56e84707b..1fd383fc4 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/ln_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/ln_fc.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.ln_fc # *class* ln_fc(fields_container: object = None, config: OperatorConfig = None) -Computes element-wise ln(field[i]). +Computes the entity-wise [natural logarithm](https://en.wikipedia.org/wiki/Natural_logarithm): + +$\mathrm{out}[i] = \ln(\mathrm{in}[i])$. + +The input must be dimensionless; a dimensional input raises an error. + +The output is dimensionless. available inputs: `fields_container` (FieldsContainer) @@ -29,7 +35,7 @@ op = ln_fc(fields_container=my_fields_container) ### fields_container -field or fields container with only one field is expected +Dimensionless field, fields container, or numeric data. **Type:** *LinkableInput* @@ -37,7 +43,7 @@ field or fields container with only one field is expected ### fields_container -Field with natural logarithm values applied element-wise +Dimensionless field with $\ln(\mathrm{in}[i])$ for each data entry. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/matrix_product.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/matrix_product.md new file mode 100644 index 000000000..6c1dd4013 --- /dev/null +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/matrix_product.md @@ -0,0 +1,56 @@ +--- +uid: Ans.DataProcessing.operators.math.matrix_product +--- + +# *class* matrix_product(fieldA: object = None, fieldB: object = None, config: OperatorConfig = None) + +matrix_product() +matrix_product(fieldA: object, fieldB: object, config: OperatorConfig) +matrix_product(config: OperatorConfig) + + +**DPF Framework Reference:** [matrix_product operator specification](https://developer.ansys.com/docs/dpf-framework-2027-r1/operator-specifications/math/matrix_product.md) + +**Parameters:** + +* **fieldA** +* **fieldB** +* **config** + +## Inputs + +### fieldA + +Matrix field A (second-order tensor). Can also be a vector when pin 1 is the matrix. + +**Type:** *LinkableInput* + +### fieldB + +Matrix field B (second-order tensor) or vector field B. + +**Type:** *LinkableInput* + +## Outputs + +### field + +Result of the matrix product; a matrix field or a vector field depending on the inputs. + +**Type:** *LinkableOutput* + +## Methods + +## Properties + +#### *property* inputs: InputSpec + +*get/set* + +#### *property* outputs: OutputSpec + +*get/set* + +#### *property* defaultConfig: Config + +*get* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/matrix_product_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/matrix_product_fc.md new file mode 100644 index 000000000..21ce7a95c --- /dev/null +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/matrix_product_fc.md @@ -0,0 +1,56 @@ +--- +uid: Ans.DataProcessing.operators.math.matrix_product_fc +--- + +# *class* matrix_product_fc(field_or_fields_container_A: object = None, field_or_fields_container_B: object = None, config: OperatorConfig = None) + +matrix_product_fc() +matrix_product_fc(field_or_fields_container_A: object, field_or_fields_container_B: object, config: OperatorConfig) +matrix_product_fc(config: OperatorConfig) + + +**DPF Framework Reference:** [matrix_product_fc operator specification](https://developer.ansys.com/docs/dpf-framework-2027-r1/operator-specifications/math/matrix_product_fc.md) + +**Parameters:** + +* **field_or_fields_container_A** +* **field_or_fields_container_B** +* **config** + +## Inputs + +### field_or_fields_container_A + +Matrix field A (second-order tensor). Can also be a vector when pin 1 is the matrix. + +**Type:** *LinkableInput* + +### field_or_fields_container_B + +Matrix field B (second-order tensor) or vector field B. + +**Type:** *LinkableInput* + +## Outputs + +### fields_container + +Result of the matrix product; a matrix field or a vector field depending on the inputs. + +**Type:** *LinkableOutput* + +## Methods + +## Properties + +#### *property* inputs: InputSpec + +*get/set* + +#### *property* outputs: OutputSpec + +*get/set* + +#### *property* defaultConfig: Config + +*get* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/minus.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/minus.md index 3efcabdf9..a25a10842 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/minus.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/minus.md @@ -35,7 +35,7 @@ field or fields container with only one field is expected ### field -Field containing the element-wise difference (fieldA - fieldB) +Field whose data equals $A[i] - B[i]$, carrying pin A's unit (or the corresponding temperature-difference unit when subtracting two temperature fields). **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/minus_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/minus_fc.md index 90512812b..231ac81cf 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/minus_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/minus_fc.md @@ -35,7 +35,7 @@ field or fields container with only one field is expected ### fields_container -Field containing the element-wise difference (fieldA - fieldB) +Field whose data equals $A[i] - B[i]$, carrying pin A's unit (or the corresponding temperature-difference unit when subtracting two temperature fields). **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/modal_superposition.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/modal_superposition.md index e6c55ca0d..03a3251ba 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/modal_superposition.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/modal_superposition.md @@ -6,9 +6,9 @@ uid: Ans.DataProcessing.operators.math.modal_superposition Computes the solution in the time/frequency space from a modal solution by multiplying a modal basis (in 0)by the solution in this modal space (coefficients for each mode for each time/frequency) (in 1). -available inputs: `modal_basis` (FieldsContainer), `solution_in_modal_space` (FieldsContainer), `incremental_fc` (FieldsContainer) (optional), `time_scoping` (Scoping, IList int, System.Collections.IEnumerable) (optional), `mesh_scoping` (Scoping, ScopingsContainer) (optional) +available inputs: `modal_basis` (FieldsContainer, CustomTypeFieldsContainer), `solution_in_modal_space` (FieldsContainer, CustomTypeFieldsContainer), `incremental_fc` (FieldsContainer, CustomTypeFieldsContainer) (optional), `time_scoping` (Scoping, ScopingsContainer) (optional), `mesh_scoping` (Scoping, ScopingsContainer) (optional) -available outputs: `fields_container` (FieldsContainer) +available outputs: `fields_container` (FieldsContainer ,CustomTypeFieldsContainer) **DPF Framework Reference:** [modal_superposition operator specification](https://developer.ansys.com/docs/dpf-framework-2027-r1/operator-specifications/math/modal_superposition.md) @@ -65,6 +65,8 @@ Compute the result on a subset of the space domain defined in the modal_basis fi ### fields_container +Expanded mode superposition solution. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/modulus.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/modulus.md index 6bf576778..acbecbe52 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/modulus.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/modulus.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.modulus # *class* modulus(fields_container: object = None, config: OperatorConfig = None) -Computes element-wise modulus of field containers containing complex fields. +Computes the [complex modulus](https://en.wikipedia.org/wiki/Absolute_value#Complex_numbers) + +$|z[i]| = \sqrt{\mathrm{Re}[i]^2 + \mathrm{Im}[i]^2}$ for each value in a complex-valued fields container, + +where $\mathrm{Re}$ and $\mathrm{Im}$ are the real and imaginary parts (complex labels 0 and 1 respectively). + +The output container has no complex label. available inputs: `fields_container` (FieldsContainer) @@ -29,12 +35,16 @@ op = modulus(fields_container=my_fields_container) ### fields_container +Complex-valued fields container with real (complex label 0) and imaginary (complex label 1) part fields. + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container with the modulus $\sqrt{\mathrm{Re}^2 + \mathrm{Im}^2}$ for each entry, without the complex label. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/norm.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/norm.md index 28cbe23d6..160c164f4 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/norm.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/norm.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.norm # *class* norm(field: object = None, scalar_int: object = None, config: OperatorConfig = None) -Computes the element-wise Lp norm of the field elementary data. Default Lp=L2 +Computes the [$L_p$ norm](https://en.wikipedia.org/wiki/Norm_(mathematics)#p-norm) of the component vector + +for each entity in the field: + +$\mathrm{out}[k] = \left(\sum_{j=0}^{n_c-1} |v_{k,j}|^p\right)^{1/p}$, + +where $n_c$ is the number of components. Default is $p = 2$ (Euclidean norm). + +The output is a scalar field with one value per entity. available inputs: `field` (Field, FieldsContainer), `scalar_int` (Int32) (optional) @@ -36,7 +44,7 @@ field or fields container with only one field is expected ### scalar_int -Lp normalisation type, p = 1, 2, ...n - Default Lp=L2 +$L_p$ norm order $p$ (positive integer, default is 2 for the Euclidean norm). **Type:** *LinkableInput* @@ -44,7 +52,7 @@ Lp normalisation type, p = 1, 2, ...n - Default Lp=L2 ### field -Scalar field containing the Lp norm values for each element +Scalar field containing the $L_p$ norm value for each entity. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/norm_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/norm_fc.md index 1391a9b07..ae3a8e29f 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/norm_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/norm_fc.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.norm_fc # *class* norm_fc(fields_container: object = None, scalar_int: object = None, config: OperatorConfig = None) -Computes the element-wise L2 norm of the field elementary data. This process is applied on each field of the input fields container. +Computes the [$L_p$ norm](https://en.wikipedia.org/wiki/Norm_(mathematics)#p-norm) of the component vector + +for each entity in every field of the input fields container: + +$\mathrm{out}[k] = \left(\sum_{j=0}^{n_c-1} |v_{k,j}|^p\right)^{1/p}$. + +Default is $p = 2$ (Euclidean norm). Each output field is scalar. available inputs: `fields_container` (FieldsContainer), `scalar_int` (Int32) (optional) @@ -30,13 +36,13 @@ op = norm_fc(fields_container=my_fields_container,scalar_int=my_scalar_int) ### fields_container -FieldsContainer containing fields for norm calculation +Fields container containing fields for norm calculation **Type:** *LinkableInput* ### scalar_int -Lp normalisation type, p = 1, 2, ...n - Default Lp=2 +$L_p$ norm order $p$ (positive integer, default is 2 for the Euclidean norm). **Type:** *LinkableInput* @@ -44,7 +50,7 @@ Lp normalisation type, p = 1, 2, ...n - Default Lp=2 ### fields_container -FieldsContainer with computed norms for each field +Fields container of scalar fields, one per input field, each containing the $L_p$ norm per entity. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/phase.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/phase.md index 984564d6e..136f8efa2 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/phase.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/phase.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.phase # *class* phase(fieldA: object = None, fieldB: object = None, config: OperatorConfig = None) -Computes the phase (in rad) between a real and an imaginary field. +Computes the [argument](https://en.wikipedia.org/wiki/Argument_(complex_analysis)) (phase angle) + +of a complex quantity given as separate real and imaginary fields: + +$\phi[i] = \mathrm{atan2}(B[i],\, A[i])$. + +The output is in radians. available inputs: `fieldA` (Field, FieldsContainer), `fieldB` (Field, FieldsContainer) @@ -44,6 +50,8 @@ field or fields container with only one field is expected ### field +Field containing the phase angle $\mathrm{atan2}(B[i],\, A[i])$ in radians for each data entry. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/phase_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/phase_fc.md index c14266615..19355e3bd 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/phase_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/phase_fc.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.phase_fc # *class* phase_fc(fields_container: object = None, config: OperatorConfig = None) -Computes phase (in rad) between real and imaginary fields. +Computes the [argument](https://en.wikipedia.org/wiki/Argument_(complex_analysis)) (phase angle) + +$\mathrm{atan2}(\mathrm{Im}[i],\, \mathrm{Re}[i])$ in radians for each complex-valued field pair + +in the input fields container, where pairs are matched by complex label. + +If no imaginary part is found for a real field, a zero-valued field is produced. available inputs: `fields_container` (FieldsContainer) @@ -29,12 +35,16 @@ op = phase_fc(fields_container=my_fields_container) ### fields_container +Complex-valued fields container with paired real (complex label 0) and imaginary (complex label 1) fields. + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container with phase angle fields $\mathrm{atan2}(\mathrm{Im}[i],\, \mathrm{Re}[i])$ in radians; zero-valued fields are produced where no imaginary part is found. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/polar_to_cplx.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/polar_to_cplx.md index 2717cade9..7101f2749 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/polar_to_cplx.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/polar_to_cplx.md @@ -4,7 +4,17 @@ uid: Ans.DataProcessing.operators.math.polar_to_cplx # *class* polar_to_cplx(fields_container: object = None, config: OperatorConfig = None) -Converts a complex number from polar form to complex. +Converts a complex-valued fields container from + +[polar form](https://en.wikipedia.org/wiki/Complex_number#Polar_complex_plane) (amplitude, phase) + +to rectangular form (real, imaginary): + +$\mathrm{Re}[i] = A[i] \cdot \cos(\phi[i])$, $\mathrm{Im}[i] = A[i] \cdot \sin(\phi[i])$. + +The input must contain amplitude fields tagged with complex label 2 + +and phase fields tagged with complex label 3. available inputs: `fields_container` (FieldsContainer) @@ -29,12 +39,16 @@ op = polar_to_cplx(fields_container=my_fields_container) ### fields_container +Complex-valued fields container with amplitude fields (complex label 2) paired with phase angle fields (complex label 3). + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container in rectangular form: real parts (complex label 0) and imaginary parts (complex label 1). + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/pow.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/pow.md index d79537403..d7d5b4688 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/pow.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/pow.md @@ -4,7 +4,7 @@ uid: Ans.DataProcessing.operators.math.pow # *class* pow(field: object = None, factor: object = None, division_by_zero_value: object = None, config: OperatorConfig = None) -Computes element-wise field[i]^p. +Computes entity-wise field[i]^p. available inputs: `field` (Field), `factor` (double), `division_by_zero_value` (double) (optional) diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/pow_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/pow_fc.md index 529c2d42a..9053260b0 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/pow_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/pow_fc.md @@ -4,7 +4,7 @@ uid: Ans.DataProcessing.operators.math.pow_fc # *class* pow_fc(fields_container: object = None, factor: object = None, division_by_zero_value: object = None, config: OperatorConfig = None) -Computes element-wise field[i]^p. +Computes entity-wise field[i]^p. available inputs: `fields_container` (FieldsContainer), `factor` (double), `division_by_zero_value` (double) (optional) diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/real_part.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/real_part.md index cc069e52c..ccb9407ce 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/real_part.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/real_part.md @@ -4,7 +4,9 @@ uid: Ans.DataProcessing.operators.math.real_part # *class* real_part(fields_container: object = None, config: OperatorConfig = None) -Extracts element-wise real part of field containers containing complex fields. +Extracts the real-part fields (complex label 0) from a complex-valued fields container. + +The output container preserves all labels except the complex label. available inputs: `fields_container` (FieldsContainer) @@ -29,12 +31,16 @@ op = real_part(fields_container=my_fields_container) ### fields_container +Complex-valued fields container with real (complex label 0) and imaginary (complex label 1) part fields. + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container containing only the real-part fields, without the complex label. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sin.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sin.md index 1d50882f7..7b3729cef 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sin.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sin.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.sin # *class* sin(field: object = None, config: OperatorConfig = None) -Computes element-wise sine function on field data: sin(field[i]). +Computes the entity-wise [sine](https://en.wikipedia.org/wiki/Sine_and_cosine): + +$\mathrm{out}[i] = \sin(\mathrm{in}[i])$. + +The input must be dimensionless or carry an angle unit; any other unit raises an error. + +When the input unit is an angle (e.g. degrees), values are automatically converted to radians + +before the sine is applied. The output is dimensionless. available inputs: `field` (Field) @@ -29,7 +37,7 @@ op = sin(field=my_field) ### field -Field containing numeric data for sine calculation +Dimensionless or angle-unit field. **Type:** *LinkableInput* @@ -37,7 +45,7 @@ Field containing numeric data for sine calculation ### field -Field with sine values applied element-wise to input data +Dimensionless field with $\sin(\mathrm{in}[i])$ for each data entry. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sin_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sin_fc.md index 2c7c660c9..57ecee15f 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sin_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sin_fc.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.sin_fc # *class* sin_fc(fields_container: object = None, config: OperatorConfig = None) -Computes element-wise sine function on field data: sin(field[i]). +Computes the entity-wise [sine](https://en.wikipedia.org/wiki/Sine_and_cosine): + +$\mathrm{out}[i] = \sin(\mathrm{in}[i])$. + +The input must be dimensionless or carry an angle unit; any other unit raises an error. + +When the input unit is an angle (e.g. degrees), values are automatically converted to radians + +before the sine is applied. The output is dimensionless. available inputs: `fields_container` (FieldsContainer) @@ -29,7 +37,7 @@ op = sin_fc(fields_container=my_fields_container) ### fields_container -Field containing numeric data for sine calculation +Dimensionless or angle-unit field. **Type:** *LinkableInput* @@ -37,7 +45,7 @@ Field containing numeric data for sine calculation ### fields_container -Field with sine values applied element-wise to input data +Dimensionless field with $\sin(\mathrm{in}[i])$ for each data entry. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqr.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqr.md index 8008b62d2..99a2dd537 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqr.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqr.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.sqr # *class* sqr(field: object = None, config: OperatorConfig = None) -Computes element-wise field[i]^2. +Computes the entity-wise square + +([Hadamard power](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations) of two): + +$\mathrm{out}[i] = \mathrm{in}[i]^2$. + +The output unit is $u^2$ where $u$ is the input unit. available inputs: `field` (Field, FieldsContainer) @@ -37,7 +43,7 @@ field or fields container with only one field is expected ### field -Field with squared values applied element-wise to input data +Field with $\mathrm{in}[i]^2$ for each data entry; unit is $u^2$, where $u$ is the input unit. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqr_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqr_fc.md index 5c83ce4bd..3be512423 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqr_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqr_fc.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.sqr_fc # *class* sqr_fc(fields_container: object = None, config: OperatorConfig = None) -Computes element-wise field[i]^2. +Computes the entity-wise square + +([Hadamard power](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations) of two): + +$\mathrm{out}[i] = \mathrm{in}[i]^2$. + +The output unit is $u^2$ where $u$ is the input unit. available inputs: `fields_container` (FieldsContainer) @@ -37,7 +43,7 @@ field or fields container with only one field is expected ### fields_container -Field with squared values applied element-wise to input data +Field with $\mathrm{in}[i]^2$ for each data entry; unit is $u^2$, where $u$ is the input unit. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqrt.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqrt.md index d250b0a6e..3d76b7e9a 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqrt.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqrt.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.sqrt # *class* sqrt(field: object = None, config: OperatorConfig = None) -Computes element-wise square root function on field data: sqrt(field[i]). +Computes the entity-wise square root + +([Hadamard root](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations)): + +$\mathrm{out}[i] = \sqrt{\mathrm{in}[i]}$. + +All input values must be non-negative; a negative value raises an error. + +The output unit is $\sqrt{u}$ where $u$ is the input unit. available inputs: `field` (Field, FieldsContainer) @@ -29,7 +37,7 @@ op = sqrt(field=my_field) ### field -Field or fields container containing numeric data for square root calculation +Field or fields container containing non-negative numeric data. **Type:** *LinkableInput* @@ -37,7 +45,7 @@ Field or fields container containing numeric data for square root calculation ### field -Field with square root values applied element-wise to input data +Field with $\sqrt{\mathrm{in}[i]}$ for each data entry; unit is $\sqrt{u}$, where $u$ is the input unit. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqrt_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqrt_fc.md index 469b92e67..511080ded 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqrt_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqrt_fc.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.sqrt_fc # *class* sqrt_fc(fields_container: object = None, config: OperatorConfig = None) -Computes element-wise square root function on field data: sqrt(field[i]). +Computes the entity-wise square root + +([Hadamard root](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations)): + +$\mathrm{out}[i] = \sqrt{\mathrm{in}[i]}$. + +All input values must be non-negative; a negative value raises an error. + +The output unit is $\sqrt{u}$ where $u$ is the input unit. available inputs: `fields_container` (FieldsContainer) @@ -29,7 +37,7 @@ op = sqrt_fc(fields_container=my_fields_container) ### fields_container -Field or fields container containing numeric data for square root calculation +Field or fields container containing non-negative numeric data. **Type:** *LinkableInput* @@ -37,7 +45,7 @@ Field or fields container containing numeric data for square root calculation ### fields_container -Field with square root values applied element-wise to input data +Field with $\sqrt{\mathrm{in}[i]}$ for each data entry; unit is $\sqrt{u}$, where $u$ is the input unit. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sweeping_phase.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sweeping_phase.md index 060d41cd9..990ec26c0 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sweeping_phase.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sweeping_phase.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.sweeping_phase # *class* sweeping_phase(real_field: object = None, imaginary_field: object = None, angle: object = None, unit_name: object = None, abs_value: object = None, imaginary_part_null: object = None, config: OperatorConfig = None) -Shifts the phase of a real and an imaginary field (in 0 and 1) of a given angle (in 3) of a unit (in 4). The resulting field is computed as field_out = real_field`*`cos(angle) - imaginary_field`*`sin(angle). +Projects a [phasor](https://en.wikipedia.org/wiki/Phasor) field onto a given phase angle $\theta$: + +$\mathrm{out}[i] = \mathrm{fieldReal}[i] \cdot \cos(\theta) - \mathrm{fieldImaginary}[i] \cdot \sin(\theta)$. + +When pin 4 is true, the absolute value of the projection is returned instead. + +If the imaginary field is absent and pin 5 is true, the imaginary part is treated as zero. available inputs: `real_field` (Field, FieldsContainer), `imaginary_field` (Field, FieldsContainer), `angle` (double), `unit_name` (string) (optional), `abs_value` (bool), `imaginary_part_null` (bool) @@ -46,6 +52,8 @@ field or fields container with only one field is expected ### angle +Phase angle $\theta$ to project onto, in the unit specified by pin 3 (default: radians). + **Type:** *LinkableInput* ### unit_name @@ -56,6 +64,8 @@ String Unit. Supported values: "deg" or "rad". Default: "rad". ### abs_value +If true, the absolute value of the projection is returned (default: false). + **Type:** *LinkableInput* ### imaginary_part_null @@ -68,6 +78,8 @@ If the imaginary part field is empty and this pin is true, then the imaginary pa ### field +Projected field $\mathrm{fieldReal} \cdot \cos(\theta) - \mathrm{fieldImaginary} \cdot \sin(\theta)$, with the unit of pin 0. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sweeping_phase_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sweeping_phase_fc.md index ead381c5a..f070febda 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sweeping_phase_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sweeping_phase_fc.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.sweeping_phase_fc # *class* sweeping_phase_fc(fields_container: object = None, angle: object = None, unit_name: object = None, abs_value: object = None, config: OperatorConfig = None) -Shifts the phase of all the corresponding real and imaginary fields of a fields container for a given angle (in 2) of a unit (in 4). An output field is computed for each pair of real and imaginary fields in the input fields_container as field_out = real_field`*`cos(angle) - imaginary_field`*`sin(angle). +Projects every [phasor](https://en.wikipedia.org/wiki/Phasor) field pair in the input fields container + +onto a given phase angle $\theta$: + +$\mathrm{out}[i] = \mathrm{fieldReal}[i] \cdot \cos(\theta) - \mathrm{fieldImaginary}[i] \cdot \sin(\theta)$. + +Pairs are matched by complex label. + +When pin 4 is true, the absolute value of each projection is returned. available inputs: `fields_container` (FieldsContainer), `angle` (double), `unit_name` (string) (optional), `abs_value` (bool) @@ -32,10 +40,14 @@ op = sweeping_phase_fc(fields_container=my_fields_container,angle=my_angle,unit_ ### fields_container +Complex-valued fields container with paired real and imaginary part fields. + **Type:** *LinkableInput* ### angle +Phase angle $\theta$ to project onto, in the unit specified by pin 3 (default: radians). + **Type:** *LinkableInput* ### unit_name @@ -46,12 +58,16 @@ String Unit. Supported values: "deg" or "rad". Default: "rad". ### abs_value +If true, the absolute value of each projection is returned (default: false). + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container with the projected fields $\mathrm{fieldReal} \cdot \cos(\theta) - \mathrm{fieldImaginary} \cdot \sin(\theta)$, without the complex label. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/time_freq_interpolation.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/time_freq_interpolation.md index 24e56908b..6593aa4d4 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/time_freq_interpolation.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/time_freq_interpolation.md @@ -59,7 +59,13 @@ If set to true, the output fields container will always have a new time freq sup ### fields_container -FieldsContainer with interpolated fields at specified time/frequency values +Fields container with one interpolated field set per requested time or frequency value. + +**Type:** *LinkableOutput* + +### time_freq_support + +Time or frequency support aligned with the output fields container. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/unit_convert.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/unit_convert.md index 8373c55d6..9ecf430df 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/unit_convert.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/unit_convert.md @@ -4,7 +4,19 @@ uid: Ans.DataProcessing.operators.math.unit_convert # *class* unit_convert(entity_to_convert: object = None, unit_name: object = None, config: OperatorConfig = None) -Converts an input field/fields container or mesh of a given unit to another unit. +Converts an input entity from one unit to another using the linear relation + +$v_\mathrm{out}[i] = k \cdot v_\mathrm{in}[i] + \delta$, + +where $k$ and $\delta$ are the unit conversion factor and shift. + +Accepts fields, fields containers, meshes, and meshes containers. + +For mesh inputs only the coordinate field is converted. + +When the permissive option is enabled and units are not homogeneous with the target unit, + +the conversion is silently skipped. available inputs: `entity_to_convert` (Field, FieldsContainer, MeshedRegion, MeshesContainer), `unit_name` (string, Int32, Field) @@ -42,7 +54,7 @@ unit as a string, ex 'm' for meter, 'Pa' for pascal,... Or ansys unit system's I ### converted_entity -the output entity is the same as the input (inplace operator) +Converted entity of the same type as the input, modified in place. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/unit_convert_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/unit_convert_fc.md index ff2bd5d7f..bf945d0c6 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/unit_convert_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/unit_convert_fc.md @@ -4,7 +4,17 @@ uid: Ans.DataProcessing.operators.math.unit_convert_fc # *class* unit_convert_fc(fields_container: object = None, unit_name: object = None, config: OperatorConfig = None) -Converts an input fields container of a given unit to another unit. +Converts a fields container from one unit to another using the linear relation + +$v_\mathrm{out}[i] = k \cdot v_\mathrm{in}[i] + \delta$, + +where $k$ and $\delta$ are the unit conversion factor and shift. + +All fields must be homogeneous with the target unit. + +When the permissive option is enabled and units are not homogeneous, + +the container is returned unchanged. available inputs: `fields_container` (FieldsContainer), `unit_name` (string) @@ -30,6 +40,8 @@ op = unit_convert_fc(fields_container=my_fields_container,unit_name=my_unit_name ### fields_container +Fields container to convert. All fields are converted in place. + **Type:** *LinkableInput* ### unit_name @@ -42,7 +54,7 @@ unit as a string, ex 'm' for meter, 'Pa' for pascal,... ### fields_container -FieldsContainer with converted units (inplace operation) +Fields container with all field data converted to the requested unit, modified in place. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mesh/index.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mesh/index.md index 4ded88d8e..aaab775fb 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mesh/index.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mesh/index.md @@ -22,7 +22,7 @@ uid: Ans.DataProcessing.operators.mesh | [iso_surfaces](Ans_DataProcessing_operators_mesh_iso_surfaces.md) | iso_surfaces() | | [make_plane_levelset](Ans_DataProcessing_operators_mesh_make_plane_levelset.md) | Computes the level set for a plane using coordinates. ///available inputs: coordinates (MeshedRegion, Field), normal (Field), origin (Field) | | [make_sphere_levelset](Ans_DataProcessing_operators_mesh_make_sphere_levelset.md) | Computes the level set for a sphere using coordinates. ///available inputs: coordinates (MeshedRegion, Field), origin (Field), radius (double) | -| [mesh_clip](Ans_DataProcessing_operators_mesh_mesh_clip.md) | mesh_clip() | +| [mesh_clip](Ans_DataProcessing_operators_mesh_mesh_clip.md) | Clips a volume mesh along an iso value x, and construct the volume mesh defined by v < x. ///available inputs: field (Field), iso_value (double), closed_surface (Int32), mesh (MeshedRegion) (optional), slice_surfaces (bool) | | [mesh_cut](Ans_DataProcessing_operators_mesh_mesh_cut.md) | Extracts a skin of the mesh in triangles in a new meshed region. ///available inputs: field (Field), iso_value (double), closed_surface (Int32), mesh (MeshedRegion) (optional), slice_surfaces (bool) | | [mesh_extraction](Ans_DataProcessing_operators_mesh_mesh_extraction.md) | Take a mesh and a scoping (elemental or nodal) and create a new mesh that contains this selection only. ///available inputs: mesh (MeshedRegion), mesh_scoping (Scoping), extension (Int32) (optional) | | [mesh_get_attribute](Ans_DataProcessing_operators_mesh_mesh_get_attribute.md) | Uses the MeshedRegion APIs to return a given attribute of the mesh in input. ///available inputs: meshed_region (MeshedRegion), property_name (string), property_identifier (Int32, string) (optional) | @@ -30,8 +30,8 @@ uid: Ans.DataProcessing.operators.mesh | [mesh_provider](Ans_DataProcessing_operators_mesh_mesh_provider.md) | Reads a mesh from result files. | | [mesh_to_graphics](Ans_DataProcessing_operators_mesh_mesh_to_graphics.md) | Generate tessellation for input mesh ///available inputs: mesh_scoping (Scoping) (optional), node_normals (bool) (optional), mesh (MeshedRegion) | | [mesh_to_graphics_edges](Ans_DataProcessing_operators_mesh_mesh_to_graphics_edges.md) | Generate edges of surface elements for input mesh ///available inputs: mesh_scoping (Scoping) (optional), include_mid_nodes (bool) (optional), mesh (MeshedRegion) | -| [mesh_to_pyvista](Ans_DataProcessing_operators_mesh_mesh_to_pyvista.md) | Export a MeshedRegion in the pyVista format. ///available inputs: coordinates (Field) (optional), as_linear (bool) (optional), mesh (MeshedRegion), vtk_updated (bool) (optional), as_poly (bool) (optional) | -| [mesh_to_tetra](Ans_DataProcessing_operators_mesh_mesh_to_tetra.md) | mesh_to_tetra() | +| [mesh_to_pyvista](Ans_DataProcessing_operators_mesh_mesh_to_pyvista.md) | Export a MeshedRegion to the pyVista format. | +| [mesh_to_tetra](Ans_DataProcessing_operators_mesh_mesh_to_tetra.md) | Converts 3D meshes of arbitrary 3D element types into a tetrahedral mesh, output at pin (0). Non 3D elements are ignored. Scopings providing the mapping from resulting nodes & elements to their original ID in the input mesh are provided, output pins (1) & (2) respectively. ///available inputs: mesh (MeshedRegion) | | [meshes_provider](Ans_DataProcessing_operators_mesh_meshes_provider.md) | Reads meshes from result files. Meshes can be spatially or temporally varying. | | [node_coordinates](Ans_DataProcessing_operators_mesh_node_coordinates.md) | Returns the node coordinates of the mesh(es) in input. ///available inputs: mesh (MeshedRegion, MeshesContainer) | | [point_cloud_search](Ans_DataProcessing_operators_mesh_point_cloud_search.md) | point_cloud_search() | diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mesh/mesh_clip.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mesh/mesh_clip.md index db82ff651..84f972e5d 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mesh/mesh_clip.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mesh/mesh_clip.md @@ -1,75 +1,84 @@ ---- -uid: Ans.DataProcessing.operators.mesh.mesh_clip ---- - -# *class* mesh_clip(field: object = None, iso_value: object = None, closed_surface: object = None, mesh: object = None, slice_surfaces: object = None, config: OperatorConfig = None) - -mesh_clip() -mesh_clip(field: object, iso_value: object, closed_surface: object, mesh: object, slice_surfaces: object, config: OperatorConfig) -mesh_clip(config: OperatorConfig) - - -**DPF Framework Reference:** [mesh_clip operator specification](https://developer.ansys.com/docs/dpf-framework-2027-r1/operator-specifications/mesh/mesh_clip.md) - -**Parameters:** - -* **field** -* **iso_value** -* **closed_surface** -* **mesh** -* **slice_surfaces** -* **config** - -## Inputs - -### field - -**Type:** *LinkableInput* - -### iso_value - -iso value - -**Type:** *LinkableInput* - -### closed_surface - -1: closed surface, 0: iso surface. - -**Type:** *LinkableInput* - -### mesh - -**Type:** *LinkableInput* - -### slice_surfaces - -True: slicing will also take into account shell and skin elements. False: slicing will ignore shell and skin elements. The default is true. - -**Type:** *LinkableInput* - -## Outputs - -### field - -**Type:** *LinkableOutput* - -### mesh - -**Type:** *LinkableOutput* - -## Methods - -## Properties - -#### *property* inputs: InputSpec - -*get/set* - -#### *property* outputs: OutputSpec - -*get/set* - -#### *property* defaultConfig: Config - -*get* +--- +uid: Ans.DataProcessing.operators.mesh.mesh_clip +--- + +# *class* mesh_clip(field: object = None, iso_value: object = None, closed_surface: object = None, mesh: object = None, slice_surfaces: object = None, config: OperatorConfig = None) + +Clips a volume mesh along an iso value x, and construct the volume mesh defined by v < x. + +available inputs: `field` (Field), `iso_value` (double), `closed_surface` (Int32), `mesh` (MeshedRegion) (optional), `slice_surfaces` (bool) + +available outputs: `field` (Field), `mesh` (MeshedRegion) + +**DPF Framework Reference:** [mesh_clip operator specification](https://developer.ansys.com/docs/dpf-framework-2027-r1/operator-specifications/mesh/mesh_clip.md) + +**Parameters:** + +* **field** +* **iso_value** +* **closed_surface** +* **mesh** +* **slice_surfaces** +* **config** + +**Example:** + +```python +op = mesh_clip() + +op = mesh_clip(field=my_field,iso_value=my_iso_value,closed_surface=my_closed_surface,mesh=my_mesh,slice_surfaces=my_slice_surfaces) +``` + +## Inputs + +### field + +**Type:** *LinkableInput* + +### iso_value + +iso value + +**Type:** *LinkableInput* + +### closed_surface + +1: closed surface, 0: iso surface. + +**Type:** *LinkableInput* + +### mesh + +**Type:** *LinkableInput* + +### slice_surfaces + +True: slicing will also take into account shell and skin elements. False: slicing will ignore shell and skin elements. The default is true. + +**Type:** *LinkableInput* + +## Outputs + +### field + +**Type:** *LinkableOutput* + +### mesh + +**Type:** *LinkableOutput* + +## Methods + +## Properties + +#### *property* inputs: InputSpec + +*get/set* + +#### *property* outputs: OutputSpec + +*get/set* + +#### *property* defaultConfig: Config + +*get* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mesh/mesh_to_pyvista.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mesh/mesh_to_pyvista.md index eb20a6568..8bc9b4f9a 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mesh/mesh_to_pyvista.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mesh/mesh_to_pyvista.md @@ -2,23 +2,79 @@ uid: Ans.DataProcessing.operators.mesh.mesh_to_pyvista --- -# *class* mesh_to_pyvista(coordinates: object = None, as_linear: object = None, mesh: object = None, vtk_updated: object = None, as_poly: object = None, config: OperatorConfig = None) +# *class* mesh_to_pyvista(mesh_scoping: object = None, coordinates: object = None, as_linear: object = None, mesh: object = None, vtk_updated: object = None, as_poly: object = None, as_modified_connectivity: object = None, config: OperatorConfig = None) -Export a MeshedRegion in the pyVista format. + Export a MeshedRegion to the pyVista format. -available inputs: `coordinates` (Field) (optional), `as_linear` (bool) (optional), `mesh` (MeshedRegion), `vtk_updated` (bool) (optional), `as_poly` (bool) (optional) + The mesh type is auto-detected and controls which pins are respected: -available outputs: `nodes` (Field), `cells` (IList int ,System.Collections.IEnumerable), `cell_types` (IList int ,System.Collections.IEnumerable), `offsets` (IList int ,System.Collections.IEnumerable) + | Mesh has Elements | Mesh has Faces | Detected type | Pins `as_poly`, `as_modified_connectivity`, `as_linear` handled? | + + |-------------------|----------------|---------------|--------------------------------------------------------------------| + + | yes | yes | FVM Mesh | No - the output is always built with the `as_poly=True` behavior. | + + | no | yes | Face Mesh | No - the output is always built with the `as_poly=False` behavior | + + | yes | no | FEM Mesh | Yes | + + For **FEM Mesh** only, the build behaviour depends on the input pins: + + | `as_poly` | `as_modified_connectivity` | `vtk_updated` | `as_linear` | Notes | + + |-------------------|----------------------------|---------------|-------------|------------------------------------------------------------------------------| + + | true | any | false | any | `as_modified_connectivity` and `as_linear` ignored; offsets written to pin 3 | + + | true | any | true | any | `as_modified_connectivity` and `as_linear` ignored; no pin 3 | + + | false | true | any | true | `vtk_updated` has no effect; quadratic elements are linearized | + + | false | true | any | false | `vtk_updated` has no effect; quadratic elements kept quadratic | + + | false | false | true | true | quadratic elements are linearized | + + | false | false | true | false | quadratic elements kept quadratic | + + | false | false | false | true | quadratic elements are linearized; offsets written to pin 3 | + + | false | false | false | false | quadratic elements kept quadratic; offsets written to pin 3 | + + Output pins: + + + + | Pin | Content | Condition | + + |-----|---------------------------------------------------------------------|--------------------------------------------------------------| + + | 0 | Node coordinates | always | + + | 1 | Modified connectivity (no node-count prefix) | `as_modified_connectivity = true` | + + | 1 | Classic connectivity (legacy VTK flat format with node-count prefix)| `as_modified_connectivity = false` | + + | 2 | Cell types array | always | + + | 3 | Legacy offsets array | `vtk_updated = false` and `as_modified_connectivity = false` | + + | 4 | Offsets into modified connectivity (CSR-style, size = nCells+1) | `as_modified_connectivity = true` | + +available inputs: `mesh_scoping` (Scoping) (optional), `coordinates` (Field) (optional), `as_linear` (bool) (optional), `mesh` (MeshedRegion), `vtk_updated` (bool) (optional), `as_poly` (bool) (optional), `as_modified_connectivity` (bool) (optional) + +available outputs: `nodes` (Field), `cells` (IList int ,System.Collections.IEnumerable), `cell_types` (IList int ,System.Collections.IEnumerable), `offsets` (IList int ,System.Collections.IEnumerable), `offsets_concatenated_node_indices` (IList int ,System.Collections.IEnumerable) **DPF Framework Reference:** [mesh_to_pyvista operator specification](https://developer.ansys.com/docs/dpf-framework-2027-r1/operator-specifications/mesh/mesh_to_pyvista.md) **Parameters:** +* **mesh_scoping** * **coordinates** * **as_linear** * **mesh** * **vtk_updated** * **as_poly** +* **as_modified_connectivity** * **config** **Example:** @@ -26,11 +82,17 @@ available outputs: `nodes` (Field), `cells` (IList int ,System.Collections.IEnu ```python op = mesh_to_pyvista() -op = mesh_to_pyvista(coordinates=my_coordinates,as_linear=my_as_linear,mesh=my_mesh,vtk_updated=my_vtk_updated,as_poly=my_as_poly) +op = mesh_to_pyvista(mesh_scoping=my_mesh_scoping,coordinates=my_coordinates,as_linear=my_as_linear,mesh=my_mesh,vtk_updated=my_vtk_updated,as_poly=my_as_poly,as_modified_connectivity=my_as_modified_connectivity) ``` ## Inputs +### mesh_scoping + +if mesh scoping is connected then the output vtk mesh is build on the subset of the input mesh scoped on it. If not set, the whole input mesh is converted to the final vtk mesh. + +**Type:** *LinkableInput* + ### coordinates Node coordinates. If not set, the node coordinates of the mesh are employed. @@ -51,7 +113,7 @@ mesh to export in pyVista format ### vtk_updated -True if the VTK version employed by pyVista is > VTK 9. Default true. +True if the VTK version employed by pyVista is > VTK 9. Default true.If false, an offset array to the cell connectivity is returned on pin 3.Incompatible with as_modified_connectivity=true. **Type:** *LinkableInput* @@ -61,6 +123,12 @@ Export elements as polyhedrons (cell-face-node representation). Default false. **Type:** *LinkableInput* +### as_modified_connectivity + +Returns VTK version>9 compatible connectivity representation consisting of an array of concatenated node indices for cells without node count headers and an offset array to it. Default false. Works only for FEM meshes with VTK version>9 and as poly=false.If as_linear is True, quadratic elements are linearized (dropping midside nodes) + +**Type:** *LinkableInput* + ## Outputs ### nodes @@ -87,6 +155,12 @@ If vtk_updated=false, offsets int vector **Type:** *LinkableOutput* +### offsets_concatenated_node_indices + +Offsets to concatenated cell connectivity without node count headers, type int vector + +**Type:** *LinkableOutput* + ## Methods ## Properties diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mesh/mesh_to_tetra.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mesh/mesh_to_tetra.md index ee680a060..03a4401b6 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mesh/mesh_to_tetra.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/mesh/mesh_to_tetra.md @@ -1,61 +1,70 @@ ---- -uid: Ans.DataProcessing.operators.mesh.mesh_to_tetra ---- - -# *class* mesh_to_tetra(mesh: object = None, config: OperatorConfig = None) - -mesh_to_tetra() -mesh_to_tetra(mesh: object, config: OperatorConfig) -mesh_to_tetra(config: OperatorConfig) - - -**DPF Framework Reference:** [mesh_to_tetra operator specification](https://developer.ansys.com/docs/dpf-framework-2027-r1/operator-specifications/mesh/mesh_to_tetra.md) - -**Parameters:** - -* **mesh** -* **config** - -## Inputs - -### mesh - -Mesh with arbitrary element types. - -**Type:** *LinkableInput* - -## Outputs - -### mesh - -Tetrahedralized mesh. - -**Type:** *LinkableOutput* - -### node_mapping - -Node mapping. - -**Type:** *LinkableOutput* - -### element_mapping - -Element mapping. - -**Type:** *LinkableOutput* - -## Methods - -## Properties - -#### *property* inputs: InputSpec - -*get/set* - -#### *property* outputs: OutputSpec - -*get/set* - -#### *property* defaultConfig: Config - -*get* +--- +uid: Ans.DataProcessing.operators.mesh.mesh_to_tetra +--- + +# *class* mesh_to_tetra(mesh: object = None, config: OperatorConfig = None) + +Converts 3D meshes of arbitrary 3D element types into a tetrahedral mesh, output at pin (0). Non 3D elements are ignored. Scopings providing the mapping from resulting nodes & elements to their original ID in the input mesh are provided, output pins (1) & (2) respectively. + +available inputs: `mesh` (MeshedRegion) + +available outputs: `mesh` (MeshedRegion), `node_mapping` (Scoping), `element_mapping` (Scoping) + +**DPF Framework Reference:** [mesh_to_tetra operator specification](https://developer.ansys.com/docs/dpf-framework-2027-r1/operator-specifications/mesh/mesh_to_tetra.md) + +**Parameters:** + +* **mesh** +* **config** + +**Example:** + +```python +op = mesh_to_tetra() + +op = mesh_to_tetra(mesh=my_mesh) +``` + +## Inputs + +### mesh + +Mesh with arbitrary element types. + +**Type:** *LinkableInput* + +## Outputs + +### mesh + +Tetrahedralized mesh. + +**Type:** *LinkableOutput* + +### node_mapping + +Node mapping. + +**Type:** *LinkableOutput* + +### element_mapping + +Element mapping. + +**Type:** *LinkableOutput* + +## Methods + +## Properties + +#### *property* inputs: InputSpec + +*get/set* + +#### *property* outputs: OutputSpec + +*get/set* + +#### *property* defaultConfig: Config + +*get* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/mapdl/global_to_nodal.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/global_to_nodal.md similarity index 94% rename from Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/mapdl/global_to_nodal.md rename to Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/global_to_nodal.md index 5ca64cf05..0d6105898 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/mapdl/global_to_nodal.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/global_to_nodal.md @@ -1,5 +1,5 @@ --- -uid: Ans.DataProcessing.operators.result.mapdl.global_to_nodal +uid: Ans.DataProcessing.operators.result.global_to_nodal --- # *class* global_to_nodal(fieldA: object = None, fieldB: object = None, config: OperatorConfig = None) diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/index.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/index.md index c02bbaca8..7efdf5fe3 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/index.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/index.md @@ -180,6 +180,7 @@ uid: Ans.DataProcessing.operators.result | [global_spring_damper_energy](Ans_DataProcessing_operators_result_global_spring_damper_energy.md) | Read Global Spring and Damper Energy (LSDyna) by calling the readers defined by the datasources. ///available inputs: streams_container (StreamsContainer) (optional), data_sources (DataSources), unit_system (Int32, string) (optional) | | [global_system_damping_energy](Ans_DataProcessing_operators_result_global_system_damping_energy.md) | Read Global System Damping Energy (LSDyna) by calling the readers defined by the datasources. ///available inputs: streams_container (StreamsContainer) (optional), data_sources (DataSources), unit_system (Int32, string) (optional) | | [global_time_step](Ans_DataProcessing_operators_result_global_time_step.md) | Read Global Time Step (LSDyna) by calling the readers defined by the datasources. ///available inputs: streams_container (StreamsContainer) (optional), data_sources (DataSources), unit_system (Int32, string) (optional) | +| [global_to_nodal](Ans_DataProcessing_operators_result_global_to_nodal.md) | Rotate results from global coordinate system to local coordinate system. ///available inputs: fieldA (Field), fieldB (Field) | | [global_total_energy](Ans_DataProcessing_operators_result_global_total_energy.md) | Read Global Total Energy (LSDyna) by calling the readers defined by the datasources. ///available inputs: streams_container (StreamsContainer) (optional), data_sources (DataSources), unit_system (Int32, string) (optional) | | [global_total_mass](Ans_DataProcessing_operators_result_global_total_mass.md) | Read Global Total Mass (LSDyna) by calling the readers defined by the datasources. ///available inputs: streams_container (StreamsContainer) (optional), data_sources (DataSources), unit_system (Int32, string) (optional) | | [global_velocity](Ans_DataProcessing_operators_result_global_velocity.md) | Read Global Velocity (LSDyna) by calling the readers defined by the datasources. ///available inputs: streams_container (StreamsContainer) (optional), data_sources (DataSources), unit_system (Int32, string) (optional) | @@ -291,8 +292,10 @@ uid: Ans.DataProcessing.operators.result | [poynting_vector](Ans_DataProcessing_operators_result_poynting_vector.md) | Compute the Poynting Vector ///available inputs: fields_containerA (FieldsContainer), fields_containerB (FieldsContainer), fields_containerC (FieldsContainer), fields_containerD (FieldsContainer), meshed_region (MeshedRegion) (optional), int32 (Int32) (optional) | | [poynting_vector_surface](Ans_DataProcessing_operators_result_poynting_vector_surface.md) | Compute the Poynting Vector surface integral ///available inputs: fields_containerA (FieldsContainer), fields_containerB (FieldsContainer), fields_containerC (FieldsContainer), fields_containerD (FieldsContainer), meshed_region (MeshedRegion) (optional), int32 (Int32) (optional) | | [prandtl_number](Ans_DataProcessing_operators_result_prandtl_number.md) | prandtl_number() | +| [pres_to_field](Ans_DataProcessing_operators_result_pres_to_field.md) | Read the presol generated file from mapdl. ///available inputs: filepath (string), columns_to_read (Int32) (optional) | | [pressure](Ans_DataProcessing_operators_result_pressure.md) | pressure() | | [pretension](Ans_DataProcessing_operators_result_pretension.md) | Reads the pretension adjustment and tension force. Rotation is not allowed for these results. ///available inputs: time_scoping (ScopingsContainer, Scoping) (optional), mesh_scoping (ScopingsContainer, Scoping) (optional), fields_container (FieldsContainer) (optional), streams_container (StreamsContainer, Stream), data_sources (DataSources), mesh (MeshedRegion, MeshesContainer) (optional), read_cyclic (Int32) (optional), expanded_meshed_region (MeshedRegion, MeshesContainer) (optional), sectors_to_expand (IList int, Scoping, ScopingsContainer, System.Collections.IEnumerable) (optional), phi (double) (optional) | +| [prns_to_field](Ans_DataProcessing_operators_result_prns_to_field.md) | Read the presol of nodal field generated file from mapdl. ///available inputs: filepath (string), columns_to_read (Int32, IList int, System.Collections.IEnumerable) (optional) | | [radiation_area](Ans_DataProcessing_operators_result_radiation_area.md) | radiation_area() | | [raw_acceleration](Ans_DataProcessing_operators_result_raw_acceleration.md) | raw_acceleration() | | [raw_displacement](Ans_DataProcessing_operators_result_raw_displacement.md) | raw_displacement() | @@ -321,6 +324,7 @@ uid: Ans.DataProcessing.operators.result | [rms_temperature](Ans_DataProcessing_operators_result_rms_temperature.md) | rms_temperature() | | [rms_velocity](Ans_DataProcessing_operators_result_rms_velocity.md) | rms_velocity() | | [rom_data_provider](Ans_DataProcessing_operators_result_rom_data_provider.md) | Set the required data for the invariant terms computation (reduced matrices, lumped mass matrix, modes ...) ///available inputs: rom_type (bool), reduced_stiff_matrix (FieldsContainer), reduced_damping_matrix (FieldsContainer), reduced_mass_matrix (FieldsContainer), data_sources (DataSources), reduced_rhs_vector (FieldsContainer), lumped_mass_matrix (FieldsContainer), mode_shapes (FieldsContainer) | +| [run](Ans_DataProcessing_operators_result_run.md) | Solve in mapdl a dat/inp file and returns a datasources with the rst file. ///available inputs: mapdl_exe_path (string) (optional), working_dir (string) (optional), number_of_processes (Int32) (optional), number_of_threads (Int32) (optional), data_sources (DataSources), server_mode (bool) (optional) | | [smisc](Ans_DataProcessing_operators_result_smisc.md) | smisc() | | [specific_heat](Ans_DataProcessing_operators_result_specific_heat.md) | specific_heat() | | [spectrum_data](Ans_DataProcessing_operators_result_spectrum_data.md) | Read spectral data from the result files contained in the streams or data sources. ///available inputs: streams (StreamsContainer) (optional), data_sources (DataSources) | diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/mapdl/index.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/mapdl/index.md deleted file mode 100644 index 926f6eee0..000000000 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/mapdl/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -uid: Ans.DataProcessing.operators.result.mapdl ---- - -# Ans.DataProcessing.operators.result.mapdl Namespace - -## Classes - -| Class | Description | -|-------|-------------| -| [global_to_nodal](Ans_DataProcessing_operators_result_mapdl_global_to_nodal.md) | Rotate results from global coordinate system to local coordinate system. ///available inputs: fieldA (Field), fieldB (Field) | -| [pres_to_field](Ans_DataProcessing_operators_result_mapdl_pres_to_field.md) | Read the presol generated file from mapdl. ///available inputs: filepath (string), columns_to_read (Int32) (optional) | -| [prns_to_field](Ans_DataProcessing_operators_result_mapdl_prns_to_field.md) | Read the presol of nodal field generated file from mapdl. ///available inputs: filepath (string), columns_to_read (Int32, IList int, System.Collections.IEnumerable) (optional) | -| [run](Ans_DataProcessing_operators_result_mapdl_run.md) | Solve in mapdl a dat/inp file and returns a datasources with the rst file. ///available inputs: mapdl_exe_path (string) (optional), working_dir (string) (optional), number_of_processes (Int32) (optional), number_of_threads (Int32) (optional), data_sources (DataSources), server_mode (bool) (optional) | diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/nodal_rotation.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/nodal_rotation.md index 919ea17b3..8c321d815 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/nodal_rotation.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/nodal_rotation.md @@ -2,10 +2,10 @@ uid: Ans.DataProcessing.operators.result.nodal_rotation --- -# *class* nodal_rotation(time_scoping: object = None, mesh_scoping: object = None, data_sources: object = None, config: OperatorConfig = None) +# *class* nodal_rotation(time_scoping: object = None, mesh_scoping: object = None, data_sources: object = None, expanded_meshed_region: object = None, sectors_to_expand: object = None, phi: object = None, config: OperatorConfig = None) nodal_rotation() -nodal_rotation(time_scoping: object, mesh_scoping: object, data_sources: object, config: OperatorConfig) +nodal_rotation(time_scoping: object, mesh_scoping: object, data_sources: object, expanded_meshed_region: object, sectors_to_expand: object, phi: object, config: OperatorConfig) nodal_rotation(config: OperatorConfig) @@ -16,6 +16,9 @@ nodal_rotation(config: OperatorConfig) * **time_scoping** * **mesh_scoping** * **data_sources** +* **expanded_meshed_region** +* **sectors_to_expand** +* **phi** * **config** ## Inputs @@ -58,7 +61,31 @@ Rotate the result to the global coordinate system if rotations are available (de ### mesh -prevents from reading the mesh in the result files +mesh. If cylic expansion is to be done, mesh of the base sector + +**Type:** *LinkableInput* + +### read_cyclic + +if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) + +**Type:** *LinkableInput* + +### expanded_meshed_region + +mesh expanded, use if cyclic expansion is to be done. + +**Type:** *LinkableInput* + +### sectors_to_expand + +sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. + +**Type:** *LinkableInput* + +### phi + +angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. **Type:** *LinkableInput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/mapdl/pres_to_field.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/pres_to_field.md similarity index 94% rename from Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/mapdl/pres_to_field.md rename to Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/pres_to_field.md index 77996fa96..b518ac92d 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/mapdl/pres_to_field.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/pres_to_field.md @@ -1,5 +1,5 @@ --- -uid: Ans.DataProcessing.operators.result.mapdl.pres_to_field +uid: Ans.DataProcessing.operators.result.pres_to_field --- # *class* pres_to_field(filepath: object = None, columns_to_read: object = None, config: OperatorConfig = None) diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/mapdl/prns_to_field.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/prns_to_field.md similarity index 94% rename from Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/mapdl/prns_to_field.md rename to Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/prns_to_field.md index 3fd14c2bb..5b5566663 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/mapdl/prns_to_field.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/prns_to_field.md @@ -1,5 +1,5 @@ --- -uid: Ans.DataProcessing.operators.result.mapdl.prns_to_field +uid: Ans.DataProcessing.operators.result.prns_to_field --- # *class* prns_to_field(filepath: object = None, columns_to_read: object = None, config: OperatorConfig = None) diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/mapdl/run.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/run.md similarity index 97% rename from Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/mapdl/run.md rename to Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/run.md index 97fac4fc6..f1a71f895 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/mapdl/run.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/run.md @@ -1,5 +1,5 @@ --- -uid: Ans.DataProcessing.operators.result.mapdl.run +uid: Ans.DataProcessing.operators.result.run --- # *class* run(mapdl_exe_path: object = None, working_dir: object = None, number_of_processes: object = None, number_of_threads: object = None, data_sources: object = None, server_mode: object = None, config: OperatorConfig = None) diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/spectrum_data.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/spectrum_data.md index 5acfbd8b2..dd98f5201 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/spectrum_data.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/result/spectrum_data.md @@ -62,6 +62,8 @@ Fields container holding damping ratios (PRS File). ### global_damping +Fields container holding for each spectrum: Global Damping Ratio, Damping Stiffness Coefficient & Damping Mass Coefficient (PRS File). + **Type:** *LinkableOutput* ### missing_mass diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/serialization/export_symbolic_workflow.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/serialization/export_symbolic_workflow.md index ae1c4acdf..cfb3e46ee 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/serialization/export_symbolic_workflow.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/serialization/export_symbolic_workflow.md @@ -2,11 +2,11 @@ uid: Ans.DataProcessing.operators.serialization.export_symbolic_workflow --- -# *class* export_symbolic_workflow(workflow: object = None, path: object = None, format: object = None, options: object = None, config: OperatorConfig = None) +# *class* export_symbolic_workflow(workflow: object = None, workflow_path: object = None, format: object = None, options: object = None, config: OperatorConfig = None) Transforms a Workflow into a symbolic Workflow and writes it to a file (if a path is set in input) or string -available inputs: `workflow` (Workflow), `path` (string) (optional), `format` (Int32) (optional), `options` (Int32) (optional) +available inputs: `workflow` (Workflow), `workflow_path` (string) (optional), `format` (Int32) (optional), `options` (Int32) (optional) available outputs: `data_sources` (DataSources ,string) @@ -15,7 +15,7 @@ available outputs: `data_sources` (DataSources ,string) **Parameters:** * **workflow** -* **path** +* **workflow_path** * **format** * **options** * **config** @@ -25,7 +25,7 @@ available outputs: `data_sources` (DataSources ,string) ```python op = export_symbolic_workflow() -op = export_symbolic_workflow(workflow=my_workflow,path=my_path,format=my_format,options=my_options) +op = export_symbolic_workflow(workflow=my_workflow,workflow_path=my_workflow_path,format=my_format,options=my_options) ``` ## Inputs @@ -34,6 +34,10 @@ op = export_symbolic_workflow(workflow=my_workflow,path=my_path,format=my_format **Type:** *LinkableInput* +### workflow_path + +**Type:** *LinkableInput* + ### path **Type:** *LinkableInput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/serialization/import_symbolic_workflow.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/serialization/import_symbolic_workflow.md index 90b7a0471..a65e19038 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/serialization/import_symbolic_workflow.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/serialization/import_symbolic_workflow.md @@ -2,11 +2,11 @@ uid: Ans.DataProcessing.operators.serialization.import_symbolic_workflow --- -# *class* import_symbolic_workflow(string_or_path: object = None, format: object = None, config: OperatorConfig = None) +# *class* import_symbolic_workflow(workflow_path: object = None, workflow_as_string: object = None, format: object = None, config: OperatorConfig = None) -Reads a file or string holding a Symbolic Workflow and instantiate a WorkFlow with its data. +Reads a file or string holding a Symbolic Workflow and instantiates a WorkFlow with its data. Pin 'workflow_path' refers to a file path, either as a string or as DataSources. Pin 'workflow_as_string' refers to the string representation of the workflow itself. Both pins are mutually exclusive. -available inputs: `string_or_path` (string, DataSources), `format` (Int32) (optional) +available inputs: `workflow_path` (string, DataSources) (optional), `workflow_as_string` (string) (optional), `format` (Int32) (optional) available outputs: `workflow` (Workflow) @@ -14,7 +14,8 @@ available outputs: `workflow` (Workflow) **Parameters:** -* **string_or_path** +* **workflow_path** +* **workflow_as_string** * **format** * **config** @@ -23,13 +24,27 @@ available outputs: `workflow` (Workflow) ```python op = import_symbolic_workflow() -op = import_symbolic_workflow(string_or_path=my_string_or_path,format=my_format) +op = import_symbolic_workflow(workflow_path=my_workflow_path,workflow_as_string=my_workflow_as_string,format=my_format) ``` ## Inputs +### workflow_path + +File path (string) or DataSources pointing to a workflow file. Pin 'format' is used only if this pin is connected. + +**Type:** *LinkableInput* + ### string_or_path +Deprecated alias of: workflow_path + +**Type:** *LinkableInput* + +### workflow_as_string + +String representation of the workflow as provided by the 'export_symbolic_workflow' operator with string output or the 'writeToString' Workflow API. + **Type:** *LinkableInput* ### format diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/serialization/index.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/serialization/index.md index 7ece002ee..127cbe05b 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/serialization/index.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/serialization/index.md @@ -12,11 +12,11 @@ uid: Ans.DataProcessing.operators.serialization | [data_tree_to_json](Ans_DataProcessing_operators_serialization_data_tree_to_json.md) | Writes a json file or string from a DataTree ///available inputs: data_tree (DataTree), path (string) (optional) | | [data_tree_to_txt](Ans_DataProcessing_operators_serialization_data_tree_to_txt.md) | Writes a txt file or string from a DataTree ///available inputs: data_tree (DataTree), path (string) (optional) | | [deserializer](Ans_DataProcessing_operators_serialization_deserializer.md) | Takes a file generated by the serializer and deserializes it into DPF's entities. ///available inputs: stream_type (Int32), file_path (string) | -| [export_symbolic_workflow](Ans_DataProcessing_operators_serialization_export_symbolic_workflow.md) | Transforms a Workflow into a symbolic Workflow and writes it to a file (if a path is set in input) or string ///available inputs: workflow (Workflow), path (string) (optional), format (Int32) (optional), options (Int32) (optional) | +| [export_symbolic_workflow](Ans_DataProcessing_operators_serialization_export_symbolic_workflow.md) | Transforms a Workflow into a symbolic Workflow and writes it to a file (if a path is set in input) or string ///available inputs: workflow (Workflow), workflow_path (string) (optional), format (Int32) (optional), options (Int32) (optional) | | [field_to_csv](Ans_DataProcessing_operators_serialization_field_to_csv.md) | Exports a field or a fields container into a csv file. Currently only homogenous Fields Definition of Fields Container are supported. ///available inputs: field_or_fields_container (FieldsContainer, Field), file_path (string), storage_type (Int32) (optional) | | [hdf5dpf_custom_read](Ans_DataProcessing_operators_serialization_hdf5dpf_custom_read.md) | Extract a custom result from an hdf5dpf file. This operator is deprecated, please use the 'custom' operator instead. ///available inputs: time_scoping (Scoping) (optional), mesh_scoping (Scoping) (optional), streams (StreamsContainer) (optional), data_sources (DataSources) (optional), meta_data (DataTree) (optional), result_name (Any) | | [hdf5dpf_generate_result_file](Ans_DataProcessing_operators_serialization_hdf5dpf_generate_result_file.md) | Generate a dpf result file from provided information. ///available inputs: h5_chunk_size (Int32) (optional), append_mode (bool) (optional), dataset_size_compression_threshold (Int32) (optional), h5_native_compression (Int32, DataTree) (optional), export_floats (bool) (optional), filename (string), mesh_provider_out (MeshedRegion) (optional), time_freq_support_out (TimeFreqSupport) (optional), ansys_unit_system_id (Int32, ResultInfo) (optional), input_name1 (string, Any) (optional), input_name2 (string, Any) (optional) | -| [import_symbolic_workflow](Ans_DataProcessing_operators_serialization_import_symbolic_workflow.md) | Reads a file or string holding a Symbolic Workflow and instantiate a WorkFlow with its data. ///available inputs: string_or_path (string, DataSources), format (Int32) (optional) | +| [import_symbolic_workflow](Ans_DataProcessing_operators_serialization_import_symbolic_workflow.md) | Reads a file or string holding a Symbolic Workflow and instantiates a WorkFlow with its data. Pin 'workflow_path' refers to a file path, either as a string or as DataSources. Pin 'workflow_as_string' refers to the string representation of the workflow itself. Both pins are mutually exclusive. ///available inputs: workflow_path (string, DataSources) (optional), workflow_as_string (string) (optional), format (Int32) (optional) | | [json_to_data_tree](Ans_DataProcessing_operators_serialization_json_to_data_tree.md) | Reads a json file or string to a DataTree ///available inputs: string_or_path (string, DataSources) | | [mechanical_csv_to_field](Ans_DataProcessing_operators_serialization_mechanical_csv_to_field.md) | Reads mechanical exported csv file ///available inputs: unit (), mesh (MeshedRegion) (optional), data_sources (DataSources), requested_location (string, FieldDefinition) | | [migrate_file_to_vtk](Ans_DataProcessing_operators_serialization_migrate_file_to_vtk.md) | Take an input data sources or streams and convert as much data as possible to vtk. ///available inputs: output_filename (string) (optional), streams_container (StreamsContainer) (optional), data_sources (DataSources) (optional) | diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/utility/csharp_generator.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/utility/csharp_generator.md new file mode 100644 index 000000000..f4a83a9b4 --- /dev/null +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/utility/csharp_generator.md @@ -0,0 +1,89 @@ +--- +uid: Ans.DataProcessing.operators.utility.csharp_generator +--- + +# *class* csharp_generator(dll_source_path: object = None, output_path: object = None, load_symbol: object = None, library_key: object = None, config: OperatorConfig = None) + +Generates a C# wrapper file (.cs) containing a class for each public operator + +found in a loaded plugin DLL. + +The DLL is loaded using the given `load_symbol` and `library_key`. + +All non-private operators discovered in the plugin are written to the single + +file at `output_path`. + +> **Note:** Operators whose exposure property is set to `private` are silently + +> excluded from the generated output. + +Inputs & outputs of each operator are represented as typed `LinkableInput` + +and `LinkableOutput` properties on the generated class. + +available inputs: `dll_source_path` (string), `output_path` (string), `load_symbol` (string) (optional), `library_key` (string) + +available outputs: + +**DPF Framework Reference:** [csharp_generator operator specification](https://developer.ansys.com/docs/dpf-framework-2027-r1/operator-specifications/utility/csharp_generator.md) + +**Parameters:** + +* **dll_source_path** +* **output_path** +* **load_symbol** +* **library_key** +* **config** + +**Example:** + +```python +op = csharp_generator() + +op = csharp_generator(dll_source_path=my_dll_source_path,output_path=my_output_path,load_symbol=my_load_symbol,library_key=my_library_key) +``` + +## Inputs + +### dll_source_path + +Path to the plugin DLL to load. + +**Type:** *LinkableInput* + +### output_path + +Path where the .cs wrapper file will be written. + +**Type:** *LinkableInput* + +### load_symbol + +Symbol name used to load operators from the DLL. Defaults to "LoadOperators". + +**Type:** *LinkableInput* + +### library_key + +Key used to identify the plugin library when loading. + +**Type:** *LinkableInput* + +## Outputs + +## Methods + +## Properties + +#### *property* inputs: InputSpec + +*get/set* + +#### *property* outputs: OutputSpec + +*get/set* + +#### *property* defaultConfig: Config + +*get* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/utility/index.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/utility/index.md index 812d7b27b..db88fbf59 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/utility/index.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/utility/index.md @@ -19,6 +19,7 @@ uid: Ans.DataProcessing.operators.utility | [compute_time_scoping](Ans_DataProcessing_operators_utility_compute_time_scoping.md) | compute_time_scoping() | | [concatenate_fields](Ans_DataProcessing_operators_utility_concatenate_fields.md) | Concatenates fields into a unique one by incrementing the number of components. | | [concatenate_fields_containers](Ans_DataProcessing_operators_utility_concatenate_fields_containers.md) | Concatenates fields containers into a unique one by concatenating each of their fields. | +| [csharp_generator](Ans_DataProcessing_operators_utility_csharp_generator.md) | Generates a C# wrapper file (.cs) containing a class for each public operator | | [customtypefield_get_attribute](Ans_DataProcessing_operators_utility_customtypefield_get_attribute.md) | Gets a property from an input field/field container. A CustomTypeFieldin pin 0, a property name (string) in pin 1 are expected as inputs ///available inputs: custom_type_field (CustomTypeField, CustomTypeFieldsContainer), property_name (string) | | [cyclic_support_get_attribute](Ans_DataProcessing_operators_utility_cyclic_support_get_attribute.md) | A CyclicSupport in pin 0 and a property name (string) in pin 1 are expected in input. ///available inputs: cyclic_support (CyclicSupport), property_name (string) | | [default_value](Ans_DataProcessing_operators_utility_default_value.md) | Returns the value from pin 0 if provided, otherwise returns the default value from pin 1. This operator acts as a fallback mechanism for optional inputs. ///available inputs: forced_value (Any) (optional), default_value (Any) | diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/utility/txt_file_to_dpf.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/utility/txt_file_to_dpf.md index 4d0970c4a..79190dd23 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/utility/txt_file_to_dpf.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/utility/txt_file_to_dpf.md @@ -29,6 +29,8 @@ op = txt_file_to_dpf(input_string=my_input_string) ### input_string +ex: 'double:1.0', 'int:1', 'vector:1.0;1.0' + **Type:** *LinkableInput* ## Outputs diff --git a/Markdown/dpf_mechanical_27r1/api/index.md b/Markdown/dpf_mechanical_27r1/api/index.md index d1e47cbf7..907580d6a 100644 --- a/Markdown/dpf_mechanical_27r1/api/index.md +++ b/Markdown/dpf_mechanical_27r1/api/index.md @@ -25,7 +25,6 @@ uid: index - [Ans.DataProcessing.operators.min_max](Ans.DataProcessing/operators/min_max/index.md) - [Ans.DataProcessing.operators.other](Ans.DataProcessing/operators/other/index.md) - [Ans.DataProcessing.operators.result](Ans.DataProcessing/operators/result/index.md) -- [Ans.DataProcessing.operators.result.mapdl](Ans.DataProcessing/operators/result/mapdl/index.md) - [Ans.DataProcessing.operators.scoping](Ans.DataProcessing/operators/scoping/index.md) - [Ans.DataProcessing.operators.serialization](Ans.DataProcessing/operators/serialization/index.md) - [Ans.DataProcessing.operators.server](Ans.DataProcessing/operators/server/index.md) diff --git a/Markdown/dpf_mechanical_27r1/api/toc.yml b/Markdown/dpf_mechanical_27r1/api/toc.yml index c147b74d8..604108b06 100644 --- a/Markdown/dpf_mechanical_27r1/api/toc.yml +++ b/Markdown/dpf_mechanical_27r1/api/toc.yml @@ -515,6 +515,10 @@ href: Ans.DataProcessing/operators/math/make_one_on_comp.md - name: matrix_inverse href: Ans.DataProcessing/operators/math/matrix_inverse.md + - name: matrix_product + href: Ans.DataProcessing/operators/math/matrix_product.md + - name: matrix_product_fc + href: Ans.DataProcessing/operators/math/matrix_product_fc.md - name: minus href: Ans.DataProcessing/operators/math/minus.md - name: minus_fc @@ -1124,6 +1128,8 @@ href: Ans.DataProcessing/operators/result/global_system_damping_energy.md - name: global_time_step href: Ans.DataProcessing/operators/result/global_time_step.md + - name: global_to_nodal + href: Ans.DataProcessing/operators/result/global_to_nodal.md - name: global_total_energy href: Ans.DataProcessing/operators/result/global_total_energy.md - name: global_total_mass @@ -1346,10 +1352,14 @@ href: Ans.DataProcessing/operators/result/poynting_vector_surface.md - name: prandtl_number href: Ans.DataProcessing/operators/result/prandtl_number.md + - name: pres_to_field + href: Ans.DataProcessing/operators/result/pres_to_field.md - name: pressure href: Ans.DataProcessing/operators/result/pressure.md - name: pretension href: Ans.DataProcessing/operators/result/pretension.md + - name: prns_to_field + href: Ans.DataProcessing/operators/result/prns_to_field.md - name: radiation_area href: Ans.DataProcessing/operators/result/radiation_area.md - name: raw_acceleration @@ -1406,6 +1416,8 @@ href: Ans.DataProcessing/operators/result/rms_velocity.md - name: rom_data_provider href: Ans.DataProcessing/operators/result/rom_data_provider.md + - name: run + href: Ans.DataProcessing/operators/result/run.md - name: smisc href: Ans.DataProcessing/operators/result/smisc.md - name: specific_heat @@ -1554,17 +1566,6 @@ href: Ans.DataProcessing/operators/result/write_motion_dfmf_file.md - name: y_plus href: Ans.DataProcessing/operators/result/y_plus.md - - name: result.mapdl - href: Ans.DataProcessing/operators/result/mapdl/index.md - items: - - name: global_to_nodal - href: Ans.DataProcessing/operators/result/mapdl/global_to_nodal.md - - name: pres_to_field - href: Ans.DataProcessing/operators/result/mapdl/pres_to_field.md - - name: prns_to_field - href: Ans.DataProcessing/operators/result/mapdl/prns_to_field.md - - name: run - href: Ans.DataProcessing/operators/result/mapdl/run.md - name: scoping href: Ans.DataProcessing/operators/scoping/index.md items: @@ -1689,6 +1690,8 @@ href: Ans.DataProcessing/operators/utility/concatenate_fields.md - name: concatenate_fields_containers href: Ans.DataProcessing/operators/utility/concatenate_fields_containers.md + - name: csharp_generator + href: Ans.DataProcessing/operators/utility/csharp_generator.md - name: customtypefield_get_attribute href: Ans.DataProcessing/operators/utility/customtypefield_get_attribute.md - name: cyclic_support_get_attribute diff --git a/Markdown/dpf_mechanical_27r1/docfx.json b/Markdown/dpf_mechanical_27r1/docfx.json index e5b6da399..f6008692e 100644 --- a/Markdown/dpf_mechanical_27r1/docfx.json +++ b/Markdown/dpf_mechanical_27r1/docfx.json @@ -7,7 +7,8 @@ "product": "DPF", "programming language": "IronPython", "product collection": "Structures", - "physics": "Structures" + "physics": "Multiphysics, Structures, Fluids", + "is dpf context": true } } } diff --git a/Markdown/dpf_mechanical_27r1/docfx_local.json b/Markdown/dpf_mechanical_27r1/docfx_local.json index 03628bc81..09ac9ec50 100644 --- a/Markdown/dpf_mechanical_27r1/docfx_local.json +++ b/Markdown/dpf_mechanical_27r1/docfx_local.json @@ -9,7 +9,8 @@ "product": "DPF", "programming language": "IronPython", "product collection": "Structures", - "physics": "Structures", + "physics": "Multiphysics, Structures, Fluids", + "is dpf context": true, "_disableNavbar": false, "_disableToc": false, "_disableTocFilter": false, diff --git a/Markdown/dpf_mechanical_27r1/index.md b/Markdown/dpf_mechanical_27r1/index.md index 8c337addd..faec64d9c 100644 --- a/Markdown/dpf_mechanical_27r1/index.md +++ b/Markdown/dpf_mechanical_27r1/index.md @@ -6,6 +6,8 @@ uid: index Welcome to the DPF Mechanical ||DPF_VERSION|| documentation for Ansys Mechanical. +> **New to DPF?** If you are new to the Data Processing Framework and prefer a guided, step-by-step learning path, consider starting with [DPF Onboarding](https://developer.ansys.com/docs/dpf-onboarding-||DPF_VERSION_SLUG||/index.md), which covers foundational concepts and architecture before diving into MechDPF specifics. + ## Overview The Ansys Data Processing Framework (DPF) provides a modern, comprehensive infrastructure for accessing and manipulating simulation data. DPF enables you to process large amounts of simulation data efficiently through a client-server architecture. diff --git a/Markdown/dpf_mechanical_27r1/toc.yml b/Markdown/dpf_mechanical_27r1/toc.yml index d5506933c..8c57007a8 100644 --- a/Markdown/dpf_mechanical_27r1/toc.yml +++ b/Markdown/dpf_mechanical_27r1/toc.yml @@ -541,6 +541,10 @@ href: api/Ans.DataProcessing/operators/math/make_one_on_comp.md - name: matrix_inverse href: api/Ans.DataProcessing/operators/math/matrix_inverse.md + - name: matrix_product + href: api/Ans.DataProcessing/operators/math/matrix_product.md + - name: matrix_product_fc + href: api/Ans.DataProcessing/operators/math/matrix_product_fc.md - name: minus href: api/Ans.DataProcessing/operators/math/minus.md - name: minus_fc @@ -1150,6 +1154,8 @@ href: api/Ans.DataProcessing/operators/result/global_system_damping_energy.md - name: global_time_step href: api/Ans.DataProcessing/operators/result/global_time_step.md + - name: global_to_nodal + href: api/Ans.DataProcessing/operators/result/global_to_nodal.md - name: global_total_energy href: api/Ans.DataProcessing/operators/result/global_total_energy.md - name: global_total_mass @@ -1372,10 +1378,14 @@ href: api/Ans.DataProcessing/operators/result/poynting_vector_surface.md - name: prandtl_number href: api/Ans.DataProcessing/operators/result/prandtl_number.md + - name: pres_to_field + href: api/Ans.DataProcessing/operators/result/pres_to_field.md - name: pressure href: api/Ans.DataProcessing/operators/result/pressure.md - name: pretension href: api/Ans.DataProcessing/operators/result/pretension.md + - name: prns_to_field + href: api/Ans.DataProcessing/operators/result/prns_to_field.md - name: radiation_area href: api/Ans.DataProcessing/operators/result/radiation_area.md - name: raw_acceleration @@ -1432,6 +1442,8 @@ href: api/Ans.DataProcessing/operators/result/rms_velocity.md - name: rom_data_provider href: api/Ans.DataProcessing/operators/result/rom_data_provider.md + - name: run + href: api/Ans.DataProcessing/operators/result/run.md - name: smisc href: api/Ans.DataProcessing/operators/result/smisc.md - name: specific_heat @@ -1580,17 +1592,6 @@ href: api/Ans.DataProcessing/operators/result/write_motion_dfmf_file.md - name: y_plus href: api/Ans.DataProcessing/operators/result/y_plus.md - - name: result.mapdl - href: api/Ans.DataProcessing/operators/result/mapdl/index.md - items: - - name: global_to_nodal - href: api/Ans.DataProcessing/operators/result/mapdl/global_to_nodal.md - - name: pres_to_field - href: api/Ans.DataProcessing/operators/result/mapdl/pres_to_field.md - - name: prns_to_field - href: api/Ans.DataProcessing/operators/result/mapdl/prns_to_field.md - - name: run - href: api/Ans.DataProcessing/operators/result/mapdl/run.md - name: scoping href: api/Ans.DataProcessing/operators/scoping/index.md items: @@ -1715,6 +1716,8 @@ href: api/Ans.DataProcessing/operators/utility/concatenate_fields.md - name: concatenate_fields_containers href: api/Ans.DataProcessing/operators/utility/concatenate_fields_containers.md + - name: csharp_generator + href: api/Ans.DataProcessing/operators/utility/csharp_generator.md - name: customtypefield_get_attribute href: api/Ans.DataProcessing/operators/utility/customtypefield_get_attribute.md - name: cyclic_support_get_attribute diff --git a/Markdown/dpf_mechanical_27r1/user-guide/index.md b/Markdown/dpf_mechanical_27r1/user-guide/index.md index 8d76e8dc5..c2d221a48 100644 --- a/Markdown/dpf_mechanical_27r1/user-guide/index.md +++ b/Markdown/dpf_mechanical_27r1/user-guide/index.md @@ -6,6 +6,8 @@ uid: user-guide Comprehensive guides for working with DPF IronPython. +> **New to DPF?** If you are new to the Data Processing Framework, start with [DPF Onboarding](https://developer.ansys.com/docs/dpf-onboarding-||DPF_VERSION_SLUG||/index.md) to understand foundational concepts, then return here for MechDPF-specific guidance. + ## Core Concepts ### [Understanding DPF](core-concepts.md)