rocky_sph_model_api.hpp | Ansys Developer Portal

// (C) 2024 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.
#pragma once
 
// Includes =======================================================================================
#include "rocky20/api/rocky_particle_api.hpp"
#include "rocky20/api/rocky_point_cloud_api.hpp"
 
#include "rocky_sph_element_scalars.hpp"
#include "rocky_sph_element_api.hpp"
#include "rocky_sph_model.hpp"
 
// ================================================================================================
// IRockySPHModel
// ================================================================================================
 
struct IRockySPHModel
{
    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;
 
    ROCKY_FUNCTIONS void set_htc_distance_factor(float htc_distance_factor) const;
 
    ROCKY_FUNCTIONS IRockySPHModel(SPHModel* impl, const std::vector<int>& device_ids);
 
    SPHModel* _impl;
    const std::vector<int>& _device_ids;
 
};
 
inline ROCKY_FUNCTIONS IRockySPHModel::IRockySPHModel(
    SPHModel* impl, const std::vector<int>& device_ids)
    : _impl(impl)
    , _device_ids(device_ids)
{
}
 
// ================================================================================================
// IRockySPHDeviceModel
// ================================================================================================
 
struct IRockySPHDeviceModel
{
    ROCKY_FUNCTIONS float get_sph_timestep() const;
    
    ROCKY_FUNCTIONS float get_element_mass() const;
 
    ROCKY_FUNCTIONS float get_initial_element_spacing() const;
 
    ROCKY_FUNCTIONS ESPHKernelType get_kernel_type() const;
 
    ROCKY_FUNCTIONS float get_kernel_weight(float distance) const;
 
    ROCKY_FUNCTIONS float get_kernel_derivative(float distance) const;
 
    ROCKY_FUNCTIONS float get_smoothing_length() const;
 
    ROCKY_FUNCTIONS float get_minimum_distance() const;
 
    ROCKY_FUNCTIONS float get_minimum_distance_squared() 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_turbulent_prandtl_number() const;
 
    ROCKY_FUNCTIONS float get_speed_of_sound() const;
 
    ROCKY_FUNCTIONS float get_surface_tension() const;
 
    ROCKY_FUNCTIONS float get_stiffness() const;
 
    ROCKY_FUNCTIONS float get_damping_coefficient() const;
 
    ROCKY_FUNCTIONS ESPHBoundaryType get_boundary_condition_type (int geometry_index) const;
 
    ROCKY_FUNCTIONS float get_wall_turbulent_thermal_conductance(
        float velocity, float distance) const;
 
    ROCKY_FUNCTIONS IRockyCloudPoint
    get_element_cloud_point(int point_cloud_index, const IRockySPHElement& element);
 
    ROCKY_FUNCTIONS bool has_turbulence_modeling() const;
 
 
    [[deprecated("Use get_element_mass() instead.")]]
    ROCKY_FUNCTIONS float get_mass() const;
 
    // (ROCKY - 15509) : candidates for removing from the API
    // reason: they are model-specific parameters, they are not general
 
    ROCKY_FUNCTIONS float get_les_smagorinsky_constant() const;
 
    ROCKY_FUNCTIONS float get_les_distance_factor() const;
 
    ROCKY_FUNCTIONS float get_stabilization_positive_factor() const;
 
    ROCKY_FUNCTIONS float get_stabilization_negative_factor() const;
 
    ROCKY_FUNCTIONS float get_stabilization_degree() const;
 
    ROCKY_FUNCTIONS float get_boundary_distance_normal_factor() const;
 
    ROCKY_FUNCTIONS float get_boundary_distance_tangential_factor() const;
 
    ROCKY_FUNCTIONS bool has_variable_molecular_viscosity() const;
 
    ROCKY_FUNCTIONS IRockySPHDeviceModel(
        SDeviceModel* model, cuda_general_sph* _gen_sph, SPHDeviceModel* _sph_model);
 
    RockySPHDeviceModel _impl;
    SDeviceModel* device_model;
 
};
 
inline ROCKY_FUNCTIONS IRockySPHDeviceModel::IRockySPHDeviceModel(
    SDeviceModel* model, cuda_general_sph* _gen_sph, SPHDeviceModel* _sph_model)
    : device_model(model)
    , _impl(_gen_sph, _sph_model)
{
}
 
inline ROCKY_FUNCTIONS ESPHKernelType IRockySPHDeviceModel::get_kernel_type() const
{
    return this->_impl.get_kernel_type();
}
 
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_sph_timestep() const
{
    return this->_impl.get_timestep();
}
 
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_mass() const
{
    return this->_impl.get_mass();
}
 
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_element_mass() const
{
    return this->_impl.get_mass();
}
 
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_initial_element_spacing() const
{
    return this->_impl.get_general_size();
}
 
[[deprecated("Use "
             "IRockySPHElement::get_kernel instead")]]
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_kernel_weight(float distance) const
{
    return this->_impl.gen_sph->get_kernel_single(distance);;
}
 
[[deprecated("Use "
             "IRockySPHElement::get_kernel_derivative instead")]]
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_kernel_derivative(float distance) const
{
    return this->_impl.gen_sph->get_kernel_derivative(distance);
}
 
[[deprecated("Use "
             "IRockySPHElement::get_smoothing_length instead")]]
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_smoothing_length() const
{
    return this->_impl.gen_sph->dist_init * this->_impl.gen_sph->kern_factor;
}
 
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_minimum_distance() const
{
    return this->_impl.get_minimum_distance();
}
 
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_minimum_distance_squared() const
{
    return this->_impl.get_minimum_distance_squared();
}
 
[[deprecated("Use "
             "IRockySPHElement::get_molecular_viscosity instead")]]
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_fluid_viscosity() const
{
    return this->_impl.get_general_viscosity();
}
 
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_fluid_density() const
{
    return this->_impl.get_general_density();
}
 
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_fluid_thermal_conductivity() const
{
    return this->_impl.get_general_thermal_conductivity();
}
 
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_fluid_specific_heat() const
{
    return this->_impl.get_general_specific_heat();
}
 
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_turbulent_prandtl_number() const
{
    return this->_impl.get_turbulent_prandtl_number();
}
 
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_speed_of_sound() const
{
    return this->_impl.get_speed_of_sound();
}
 
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_surface_tension() const
{
    return this->_impl.get_surface_tension();
}
 
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_damping_coefficient() const
{
    return this->_impl.get_damping_coefficient();
}
 
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_stiffness() const
{
    return this->_impl.get_stiffness();
}
 
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_les_smagorinsky_constant() const
{
    return this->_impl.get_les_smagorinsky_constant();
}
 
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_les_distance_factor() const
{
    return this->_impl.get_les_distance_factor();
}
 
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_stabilization_positive_factor() const
{
    return this->_impl.get_stabilization_positive_factor();
}
 
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_stabilization_negative_factor() const
{
    return this->_impl.get_stabilization_negative_factor();
}
 
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_stabilization_degree() const
{
    return this->_impl.get_stabilization_degree();
}
 
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_boundary_distance_normal_factor() const
{
    return this->_impl.get_boundary_distance_normal_factor();
}
 
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_boundary_distance_tangential_factor() const
{
    return this->_impl.get_boundary_distance_tangential_factor();
}
 
inline ROCKY_FUNCTIONS ESPHBoundaryType IRockySPHDeviceModel::get_boundary_condition_type(int geometry_index) const
{
    return this->_impl.get_boundary_condition_type(geometry_index);
}
 
[[deprecated("Use "
             "IRockySPHTriangleInteraction::get_wall_turbulent_thermal_conductance instead")]]
inline ROCKY_FUNCTIONS float IRockySPHDeviceModel::get_wall_turbulent_thermal_conductance(
    float velocity, float distance) const
{
    return this->_impl.gen_sph->get_wall_turbulent_thermal_conductance(
        velocity, distance, this->_impl.get_general_viscosity(), this->get_initial_element_spacing(),
        false);
}
 
inline ROCKY_FUNCTIONS IRockyCloudPoint IRockySPHDeviceModel::get_element_cloud_point(
    int point_cloud_index, const IRockySPHElement& element)
{
    auto point_cloud = this->device_model->point_clouds + point_cloud_index;
    int point_index = this->_impl.device_model->sph_particle_scalars->get_scalar<int>(
        point_cloud->sph_scalars_index, element._impl.element_index);
    return IRockyCloudPoint(point_cloud, point_index);
}
 
inline ROCKY_FUNCTIONS bool IRockySPHDeviceModel::has_turbulence_modeling() const
{
    return this->_impl.gen_sph->turb_type != ttLaminar;
}
 
inline ROCKY_FUNCTIONS bool IRockySPHDeviceModel::has_variable_molecular_viscosity() const
{
    return this->_impl.gen_sph->has_variable_molecular_viscosity();
}
Rocky Solver SDK 2025 R2

rocky_sph_model_api

Connect with Ansys
