IRockyGeometryTriangle Struct Reference
Last update: 08.07.2024
IRockyGeometryTriangle Struct Reference
#include <rocky_boundary_api.hpp>
Inherits IRockyGeometryTriangleImpl< SDeviceModel >.
Public Member Functions | |
| ROCKY_FUNCTIONS IRockyMaterial | get_material () const |
| ROCKY_FUNCTIONS double3 | get_normal_unit_vector () const |
| ROCKY_FUNCTIONS double | get_area () const |
| ROCKY_FUNCTIONS double3 | get_centroid () const |
| ROCKY_FUNCTIONS int | get_geometry_index () const |
| ROCKY_FUNCTIONS int | get_material_index () const |
| ROCKY_FUNCTIONS double3 | get_translational_velocity (double current_time) const |
| ROCKY_FUNCTIONS double3 | get_geometry_rotational_velocity () const |
| ROCKY_FUNCTIONS double3 | get_geometry_rotation_center () const |
| ROCKY_FUNCTIONS double | get_temperature () const |
| ROCKY_FUNCTIONS void | set_temperature (double value) |
| ROCKY_FUNCTIONS bool | is_adiabatic () const |
| ROCKY_FUNCTIONS double | get_thermal_conductivity () const |
| ROCKY_FUNCTIONS void | set_thermal_conductivity (double value) |
| ROCKY_FUNCTIONS double | get_poisson_ratio () const |
| ROCKY_FUNCTIONS void | set_poisson_ratio (double value) |
| ROCKY_FUNCTIONS IRockyTriangleScalars | get_scalars () |
Detailed Description
IRockyGeometryTriangle is an interface for the internal geometry triangle object in Rocky. A geometry triangle is a code representation of an individual triangle making up a geometry. IRockyGeometryTriangle is intended for use in all the operations performed during the time iterative process, involving geometry triangles. It has access methods to some geometric properties, as well as triangle scalars, which are special variables that store values per triangle that are preserved between time iterations. Values of triangle scalars can be displayed in a 3D window as any other built-in geometry triangle property in Rocky. All property and variable values made available through IRockyGeometryTriangle are dimensionless.
- Attention
IRockyGeometryTrianglereplacesIRockyBoundaryTrianglein Rocky v4.5 or newer.
Member Function Documentation
◆ get_area()
| ROCKY_FUNCTIONS double IRockyGeometryTriangle::get_area | ( | ) | const |
- Returns
- The unsigned area of the geometry triangle.
◆ get_centroid()
| ROCKY_FUNCTIONS double3 IRockyGeometryTriangle::get_centroid | ( | ) | const |
- Returns
- The centroid point of the geometry triangle in Cartesian coordinates.
◆ get_geometry_index()
| ROCKY_FUNCTIONS int IRockyGeometryTriangle::get_geometry_index | ( | ) | const |
- Returns
- The index that uniquely identifies the geometry to which the geometry triangle belongs.
◆ get_geometry_rotation_center()
| ROCKY_FUNCTIONS double3 IRockyGeometryTriangle::get_geometry_rotation_center | ( | ) | const |
- Returns
- The Cartesian coordinates of the rotation center of the motion frame attached to the geometry to which the triangle belongs.
◆ get_geometry_rotational_velocity()
| ROCKY_FUNCTIONS double3 IRockyGeometryTriangle::get_geometry_rotational_velocity | ( | ) | const |
- Returns
- The rotational velocity vector of the geometry to which the triangle belongs, expressed in Cartesian coordinates.
◆ get_material()
| ROCKY_FUNCTIONS IRockyMaterial IRockyGeometryTriangle::get_material | ( | ) | const |
- Returns
- An
IRockyMaterialobject that gives access to the values of physical properties associated to the material from which the geometry triangle is made.
◆ get_material_index()
| ROCKY_FUNCTIONS int IRockyGeometryTriangle::get_material_index | ( | ) | const |
- Returns
- The material index that uniquely identifies the material associated to the geometry triangle.
◆ get_normal_unit_vector()
| ROCKY_FUNCTIONS double3 IRockyGeometryTriangle::get_normal_unit_vector | ( | ) | const |
- Returns
- A unit vector in the normal direction to the geometry triangle, in Cartesian coordinates. The orientation of this vector is arbitrary, since collision with particles can potentially happen on either side of the geometry triangle.
◆ get_poisson_ratio()
| ROCKY_FUNCTIONS double IRockyGeometryTriangle::get_poisson_ratio | ( | ) | const |
- Returns
- The triangle's Poisson's ratio. If this property was defined as variable for triangles in the module's specification file, this method will return the value set specifically for the geometry triangle. Otherwise, the returned value will be the one specified for the triangle's material in the Rocky UI.
◆ get_scalars()
| ROCKY_FUNCTIONS IRockyTriangleScalars IRockyGeometryTriangle::get_scalars | ( | ) |
- Returns
- A
IRockyTriangleScalarsobject that gives access to all triangle scalars variables defined in the project.
◆ get_temperature()
| ROCKY_FUNCTIONS double IRockyGeometryTriangle::get_temperature | ( | ) | const |
- Returns
- The temperature associated to the triangle. If that temperature was defined as a variable property in the module's specification file, each triangle in a geometry may have a different temperature value, set by a module using the
IRockyGeometryTriangle::set_temperaturemethod. Otherwise, this method will return the temperature value specified in the UI for the geometry to which the geometry triangle belongs.
◆ get_thermal_conductivity()
| ROCKY_FUNCTIONS double IRockyGeometryTriangle::get_thermal_conductivity | ( | ) | const |
- Returns
- The triangle's thermal conductivity. If this property was defined as variable for triangles in the module's specification file, this method will return the value set specifically for the geometry triangle. Otherwise, the returned value will be the one specified for the triangle's material in the Rocky UI.
◆ get_translational_velocity()
| ROCKY_FUNCTIONS double3 IRockyGeometryTriangle::get_translational_velocity | ( | double | current_time | ) | const |
- Parameters
-
current_time The current value of the simulation time.
- Returns
- The instantaneous triangle's translational velocity vector, expressed in Cartesian coordinates.
◆ is_adiabatic()
| ROCKY_FUNCTIONS bool IRockyGeometryTriangle::is_adiabatic | ( | ) | const |
- Returns
- True if the geometry to which the boundary triangle belongs is adiabatic (i.e. it is not enabled to exchange heat with particles).
◆ set_poisson_ratio()
| ROCKY_FUNCTIONS void IRockyGeometryTriangle::set_poisson_ratio | ( | double | value | ) |
- This method sets the triangle's Poisson's ratio, if this property
- was defined as variable in the module's specification file. If this method is used otherwise, a segmentation fault will occur.
- Parameters
-
value The Poisson's ratio to be set.
◆ set_temperature()
| ROCKY_FUNCTIONS void IRockyGeometryTriangle::set_temperature | ( | double | value | ) |
- This method can be used only if the temperature was defined as a variable property
- for geometry triangles in the module's specification file. A segmentation fault will occur if this method is used otherwise. The temperature value specified with this method will be used by Rocky when solving the thermal balance equations for the particles in contact with the geometry triangle.
- Parameters
-
value The temperature value to be assigned to the geometry triangle.
◆ set_thermal_conductivity()
| ROCKY_FUNCTIONS void IRockyGeometryTriangle::set_thermal_conductivity | ( | double | value | ) |
- This method sets the triangle's thermal conductivity, if this property
- was defined as variable in the module's specification file. If this method is used otherwise, a segmentation fault will occur.
- Parameters
-
value The thermal conductivity to be set.