#include <rocky_sph_model_api.hpp>

Public Member Functions
IRockySPHElementScalarsModel	get_sph_element_scalars () const

int	get_number_of_sph_elements () const

int	get_number_of_active_sph_elements () const

int	get_number_of_active_free_sph_elements () const

int	get_number_of_active_linked_sph_elements () const

ESPHKernelType	get_kernel_type () const

float	get_initial_element_spacing () const

float	get_smoothing_length () const

float	get_element_mass () const

ROCKY_FUNCTIONS float	get_fluid_viscosity () const

ROCKY_FUNCTIONS float	get_fluid_density () const

ROCKY_FUNCTIONS float	get_fluid_thermal_conductivity () const

ROCKY_FUNCTIONS float	get_fluid_specific_heat () const

ROCKY_FUNCTIONS float	get_speed_of_sound () const

ROCKY_FUNCTIONS float	get_surface_tension () const

bool	is_enabled () const

Detailed Description

IRockySPHModel includes some methods that provide basic information about the SPH model. The data associated to an IRockySPHModel object resides entirely on host memory, consequently, it can be accessed only within hooks executed host-side.

Member Function Documentation

◆ get_element_mass()

float IRockySPHModel::get_element_mass ( ) const

Returns: The mass associated to each one of the SPH elements in the simulation.

◆ get_fluid_density()

float IRockySPHModel::get_fluid_density ( ) const

Returns: The user-prescribed value of the fluid's density.

◆ get_fluid_specific_heat()

float IRockySPHModel::get_fluid_specific_heat ( ) const

Returns: The user-prescribed value of the fluid's specific heat.

◆ get_fluid_thermal_conductivity()

float IRockySPHModel::get_fluid_thermal_conductivity ( ) const

Returns: The user-prescribed value of the fluid's thermal conductivity.

◆ get_fluid_viscosity()

float IRockySPHModel::get_fluid_viscosity ( ) const

Returns: The user-prescribed value of the fluid's dynamic viscosity.

◆ get_initial_element_spacing()

float IRockySPHModel::get_initial_element_spacing ( ) const

Returns: The spacing between SPH elements when they enter into the simulation. This is a characteristic length considered in several expressions in the SPH model.

◆ get_kernel_type()

ESPHKernelType IRockySPHModel::get_kernel_type ( ) const

Returns: An ESPHKernelType enum indicating the kernel type used in the SPH model. Currently there are 3 kernel types implemented in Rocky:
ktCubic = 0
ktQuintic = 1
ktWendland = 2

◆ get_number_of_active_free_sph_elements()

int IRockySPHModel::get_number_of_active_free_sph_elements ( ) const

Returns: The number of free SPH elements that are currently active in the simulation. Free SPH elements are the ones that represent the fluid in the simulation.

◆ get_number_of_active_linked_sph_elements()

int IRockySPHModel::get_number_of_active_linked_sph_elements ( ) const

Returns: The number of linked SPH elements that are currently active in the simulation. Linked or DEM-coupled SPH elements are the ones inside the DEM particles, used to model the interaction between fluid and DEM particles.

◆ get_number_of_active_sph_elements()

int IRockySPHModel::get_number_of_active_sph_elements ( ) const

Returns: The number of SPH elements that are currently active in the simulation. This number includes both free and DEM-coupled SPH elements.

◆ get_number_of_sph_elements()

int IRockySPHModel::get_number_of_sph_elements ( ) const

Returns: The total number of SPH elements generated during the preprocessing phase of the simulation.

◆ get_smoothing_length()

float IRockySPHModel::get_smoothing_length ( ) const

Returns: The value of the smoothing length considered in the SPH discretization. The radius of the support region of the kernel function is normally an integer multiple of the smoothing length.

◆ get_speed_of_sound()

float IRockySPHModel::get_speed_of_sound ( ) const

Returns: The user-prescribed value of the speed of sound in the fluid.

◆ get_sph_element_scalars()

IRockySPHElementScalarsModel IRockySPHModel::get_sph_element_scalars ( ) const

Returns: An IRockySPHElementScalarsModel object, that allows users to add new SPH element scalars or activate SPH element scalars known to Rocky during the setup of a module. SPH element scalars are special variables attached to SPH elements that are able to store values per element that are preserved between time iterations.

◆ get_surface_tension()

float IRockySPHModel::get_surface_tension ( ) const

Returns: The user-prescribed value of the surface tension at a free surface.

◆ is_enabled()

bool IRockySPHModel::is_enabled ( ) const

Returns: A boolean value indicating whether the SPH model is enabled on the simulation or not.

Rocky Solver SDK 2024 R2

IRockySPHModel Struct Reference