Structure IRockyGeometryTriangleHost
Last update: 09.03.2026
#include
IRockyGeometryTriangleHost is the counterpart of IRockyGeometryTriangleHost intended to be used during initialization operations, which is always performed on CPU. Both of them share the same methods.
Inherits from:
- IRockyGeometryTriangleImpl\ RockyModel >
Members
- get_area
- get_centroid
- get_geometry_index
- get_geometry_rotation_center
- get_geometry_rotational_velocity
- get_material
- get_material_index
- get_normal_unit_vector
- get_poisson_ratio
- get_scalars
- get_temperature
- get_thermal_conductivity
- get_translational_velocity
- is_adiabatic
- set_poisson_ratio
- set_temperature
- set_thermal_conductivity
Public functions
Function get_material
![][const]
ROCKY_FUNCTIONS IRockyMaterial IRockyGeometryTriangleHost::get_material() const
Returns:
An IRockyMaterial object that gives access to the values of physical properties associated to the material from which the geometry triangle is made.
Return type: ROCKY_FUNCTIONS IRockyMaterial
Function get_normal_unit_vector
![][const]
ROCKY_FUNCTIONS double3 IRockyGeometryTriangleHost::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.
Return type: ROCKY_FUNCTIONS double3
Function get_area
![][const]
ROCKY_FUNCTIONS double IRockyGeometryTriangleHost::get_area() const
Returns:
The unsigned area of the geometry triangle.
Return type: ROCKY_FUNCTIONS double
Function get_centroid
![][const]
ROCKY_FUNCTIONS double3 IRockyGeometryTriangleHost::get_centroid() const
Returns:
The centroid point of the geometry triangle in Cartesian coordinates.
Return type: ROCKY_FUNCTIONS double3
Function get_geometry_index
![][const]
ROCKY_FUNCTIONS int IRockyGeometryTriangleHost::get_geometry_index() const
Returns:
The index that uniquely identifies the geometry to which the geometry triangle belongs.
Return type: ROCKY_FUNCTIONS int
Function get_material_index
![][const]
ROCKY_FUNCTIONS int IRockyGeometryTriangleHost::get_material_index() const
Returns:
The material index that uniquely identifies the material associated to the geometry triangle.
Return type: ROCKY_FUNCTIONS int
Function get_translational_velocity
![][const]
ROCKY_FUNCTIONS double3 IRockyGeometryTriangleHost::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.
Parameters:
- double current_time
Return type: ROCKY_FUNCTIONS double3
Function get_geometry_rotational_velocity
![][const]
ROCKY_FUNCTIONS double3 IRockyGeometryTriangleHost::get_geometry_rotational_velocity() const
Returns:
The rotational velocity vector of the geometry to which the triangle belongs, expressed in Cartesian coordinates.
Return type: ROCKY_FUNCTIONS double3
Function get_geometry_rotation_center
![][const]
ROCKY_FUNCTIONS double3 IRockyGeometryTriangleHost::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.
Return type: ROCKY_FUNCTIONS double3
Function get_temperature
![][const]
ROCKY_FUNCTIONS double IRockyGeometryTriangleHost::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_temperature method. Otherwise, this method will return the temperature value specified in the UI for the geometry to which the geometry triangle belongs.
Return type: ROCKY_FUNCTIONS double
Function set_temperature
ROCKY_FUNCTIONS void IRockyGeometryTriangleHost::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.
Parameters:
- double value
Return type: ROCKY_FUNCTIONS void
Function is_adiabatic
![][const]
ROCKY_FUNCTIONS bool IRockyGeometryTriangleHost::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).
Return type: ROCKY_FUNCTIONS bool
Function get_thermal_conductivity
![][const]
ROCKY_FUNCTIONS double IRockyGeometryTriangleHost::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.
Return type: ROCKY_FUNCTIONS double
Function set_thermal_conductivity
ROCKY_FUNCTIONS void IRockyGeometryTriangleHost::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.
Parameters:
- double value
Return type: ROCKY_FUNCTIONS void
Function get_poisson_ratio
![][const]
ROCKY_FUNCTIONS double IRockyGeometryTriangleHost::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.
Return type: ROCKY_FUNCTIONS double
Function set_poisson_ratio
ROCKY_FUNCTIONS void IRockyGeometryTriangleHost::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.
Parameters:
- double value
Return type: ROCKY_FUNCTIONS void
Function get_scalars
ROCKY_FUNCTIONS IRockyTriangleScalars IRockyGeometryTriangleHost::get_scalars()
Returns:
A IRockyTriangleScalars object that gives access to all triangle scalars variables defined in the project.
Return type: ROCKY_FUNCTIONS IRockyTriangleScalars
[const]: https://img.shields.io/badge/-const-lightblue (const)