ExtractScalars< TYPE > Class Template Reference
Last update: 16.07.2025Creates as many scalar quantites as samples for all field indices given in indices as well as all field quantities found within the dataobject filter. More...
Public Types | |
| typedef std::vector< std::pair< std::size_t, std::size_t > > | index_type |
| A sequential index container storing the part and entity index. A sequential index container storing the part index as first argument and the entity index of this part as second argument. | |
| typedef std::vector< DataObjectContainer::string_vector_type > | quantity_map_type |
| A vector of vectors containing default quantity idents for each quantity (row) and each index (column) passed to the constructor. | |
Public Member Functions | |
| compute (Structure database) | |
| Performs the action using the defined settings. More... | |
| std::vector< string > | determineObjectsToBeReplaced (Structure database) |
| Determines if any result objects already exist in the database. More... | |
| ExtractScalars (DataObjectContainer the_data, index_type indices) | |
| Constructor which sets suitable defaults for all members. More... | |
Public Attributes | |
| DataObjectContainer | data |
| the data set to be analyzed | |
| bool | overwrite_existing |
| is true if already existing output data objects will be replaced. If true, also all depending objects of the already existing one will be deleted. | |
| DataObjectContainer::string_vector_type | quantity_idents |
| the quantities to be analyzed. If a quantity ident does not exist in data, no error appears. | |
Detailed Description
template<dataobject_types TYPE>
class ExtractScalars< TYPE >
Creates as many scalar quantites as samples for all field indices given in indices as well as all field quantities found within the dataobject filter.
- Date
- -2015
- Template Parameters
-
TYPE the field data type
Constructor & Destructor Documentation
◆ ExtractScalars()
| ExtractScalars | ( | DataObjectContainer | the_data, |
| index_type | indices | ||
| ) |
Constructor which sets suitable defaults for all members.
All quantity idents of the dataobject filter are extracted. Then for each quantity and each id in the given part a new sclar result object will be created.
- Parameters
-
the_data The subset of field data to be token as input. indices A vector of tuples of part and element/node indices
Member Function Documentation
◆ compute()
| compute | ( | Structure | database | ) |
Performs the action using the defined settings.
- Parameters
-
database the output object where new objects are added to
◆ determineObjectsToBeReplaced()
| std::vector< string > determineObjectsToBeReplaced | ( | Structure | database | ) |
Determines if any result objects already exist in the database.
- Parameters
-
database the SoS structure
- Returns
- It returns a list of human readable idents. This list is empty if no duplicates exist. The size of the list is the number of objects to be replaced.
