IRockyOutputPropertyCollection Struct Reference
Last update: 16.07.2025#include <rocky_output_collections_api.hpp>
Public Member Functions | |
| int | create_particles_instantaneous_property (const std::string &name, const std::string &unit, double dimension=1.0) |
| int | create_particles_statistical_property (const std::string &name, const std::string &unit, double dimension=1.0) |
| int | create_triangles_instantaneous_property (const std::string &name, const std::string &unit, double dimension=1.0) |
| int | create_triangles_statistical_property (const std::string &name, const std::string &unit, double dimension=1.0) |
| int | create_vertex_triangles_instantaneous_property (const std::string &name, const std::string &unit, double dimension=1.0) |
| int | create_vertex_triangles_statistical_property (const std::string &name, const std::string &unit, double dimension=1.0) |
Detailed Description
IRockyOutputPropertyCollection is an auxiliary struct intended for setting up custom particle and boundary properties generated by custom modules. Those properties will be displayed in the Rocky UI along with the built-in output properties generated by Rocky itself.
Member Function Documentation
◆ create_particles_instantaneous_property()
| int IRockyOutputPropertyCollection::create_particles_instantaneous_property | ( | const std::string & | name, |
| const std::string & | unit, | ||
| double | dimension = 1.0 ) |
- This method registers a new instantaneous particle property. An instantaneous particle property
- consists of a value per particle, which is generated only at output times.
- Parameters
-
name A string that identifies the property. unit A string representing the unit associated to the property. dimension A dimensional factor used to nondimensionalize the values of the property.
◆ create_particles_statistical_property()
| int IRockyOutputPropertyCollection::create_particles_statistical_property | ( | const std::string & | name, |
| const std::string & | unit, | ||
| double | dimension = 1.0 ) |
- This method registers a new statistical particle property. A statistical particle property
- consists of a value per particle, which is obtained by processing a sequence of particle-related values recorded during an interval between two consecutive output times.
- Parameters
-
name A string that identifies the property. unit A string representing the unit associated to the property. dimension A dimensional factor used to nondimensionalize the values of the property.
◆ create_triangles_instantaneous_property()
| int IRockyOutputPropertyCollection::create_triangles_instantaneous_property | ( | const std::string & | name, |
| const std::string & | unit, | ||
| double | dimension = 1.0 ) |
- This method registers a new instantaneous triangle property. An instantaneous triangle property
- consists of a value per geometry triangle, which is generated only at output times.
- Parameters
-
name A string that identifies the property. unit A string representing the unit associated to the property. dimension A dimensional factor used to nondimensionalize the values of the property.
◆ create_triangles_statistical_property()
| int IRockyOutputPropertyCollection::create_triangles_statistical_property | ( | const std::string & | name, |
| const std::string & | unit, | ||
| double | dimension = 1.0 ) |
- This method registers a new statistical triangle property. A statistical triangle property
- consists of a value per geometry triangle, which is obtained by processing a sequence of triangle-related values recorded during an interval between two consecutive output times.
- Parameters
-
name A string that identifies the property. unit A string representing the unit associated to the property. dimension A dimensional factor used to nondimensionalize the values of the property.
◆ create_vertex_triangles_instantaneous_property()
| int IRockyOutputPropertyCollection::create_vertex_triangles_instantaneous_property | ( | const std::string & | name, |
| const std::string & | unit, | ||
| double | dimension = 1.0 ) |
- This method registers a new instantaneous vertex-triangle property. An instantaneous vertex triangle property
- consists of a value per vertex of a geometry, which is generated only at output times.
- Parameters
-
name A string that identifies the property. unit A string representing the unit associated to the property. dimension A dimensional factor used to nondimensionalize the values of the property.
◆ create_vertex_triangles_statistical_property()
| int IRockyOutputPropertyCollection::create_vertex_triangles_statistical_property | ( | const std::string & | name, |
| const std::string & | unit, | ||
| double | dimension = 1.0 ) |
- This method registers a new statistical vertex-triangle property. A statistical vertex-triangle property
- consists of a value per vertex of a geometry, which is obtained by processing a sequence of vertex-related values recorded during anS interval between two consecutive output times.
- Parameters
-
name A string that identifies the property. unit A string representing the unit associated to the property. dimension A dimensional factor used to nondimensionalize the values of the property.
