rocky_api.h | Ansys Developer Portal

#pragma once
 
// Includes =======================================================================================
#include "dll_export.h"
 
#ifdef ROCKY_CUDA_API
 
#define ROCKY_FUNCTIONS __host__ __device__
 
#else
 
//#define ROCKY_FUNCTIONS
 
#endif
 
#include "rocky_contact_api.hpp"
#include "rocky_contact_scalars.hpp"
#include "rocky_fluid_scalars.hpp"
#include "rocky_joint_api.hpp"
#include "rocky_model_api.hpp"
#include "rocky_particle_api.hpp"
#include "rocky_particle_scalars.hpp"
#include "rocky_joint_scalars.hpp"
#include "rocky_pair_scalars.hpp"
#include "rocky_boundary_scalars.hpp"
#include "rocky_triangle_scalars.hpp"
#include "rocky_plugin_data.h"
#include "rocky_output_collections_api.hpp"
#include "rocky_timestep_api.h"
#include "rocky_contact_data_recorder_api.h"
#include "rocky_statistics_data.hpp"
 
// Forward declarations ===========================================================================
class cuda_host;
typedef cuda_host RockyModel;
struct RockyParticle;
struct RockyContact;
 
struct SDeviceModel;
 
struct cuda_material;
struct MaterialInteraction;
 
// ================================================================================================
// IRockyModel
// ================================================================================================
 
struct IRockyModel
{
 
    // Physics--------------------------------------------------------------
 
    double get_softening_factor() const;
 
    double get_timestep() const;
 
    void trigger_update_timestep() const;
 
    bool is_thermal_simulation() const;
 
    bool has_adhesion() const;
 
    void set_adhesive_distance(int home_index, int near_index, double adhesive_distance);
 
    void set_minimum_restitution_coefficient(int home_index, int near_index, double minimum_restitution);
 
    // Auxiliary objects --------------------------------------------------------------
     
    IRockyInteractionCalculationsData get_interactions_data() const;
 
    IRockyContactDataRecorder get_contact_data_recorder() const;
 
    // Entities ------------------------------------------------------------
 
    int get_number_of_particle_groups() const;
 
    int get_number_of_particles() const;
 
    int get_number_of_geometries() const;
 
    int get_number_of_materials() const;
 
    int get_number_of_material_interactions() const;
 
    std::string get_geometry_name(int geometry_index) const;
 
    std::string get_particle_group_name(int particle_group_index) const;
 
    EBoundaryType get_geometry_type(int geometry_index) const;
 
    // Scalars ------------------------------------------------------------
 
    IRockyParticleScalarsModel get_particle_scalars() const;
 
    IRockyParticleTransferScalarsModel get_particle_transfer_scalars() const;
 
    IRockyParticleBreakageScalarsModel get_particle_breakage_scalars() const;
 
    IRockyJointScalarsModel get_joint_scalars() const;
 
    IRockyPairScalarsModel get_pair_scalars() const;
 
    IRockyGeometryScalarsModel get_geometry_scalars() const;
 
    IRockyTriangleScalarsModel get_triangle_scalars() const;
 
    IRockyContactScalarsModel get_particle_contact_scalars() const;
 
    IRockyContactScalarsModel get_triangle_contact_scalars() const;
 
    // Transient --------------------------------------------------------------
    
    double get_current_time() const;
 
    double get_output_interval() const;
 
    int get_number_of_active_particles() const;
 
    int get_number_of_active_triangles();
 
    // OMP --------------------------------------------------------------
 
    int get_number_of_processes() const;
 
    // CUDA --------------------------------------------------------------
 
    int get_number_of_devices() const;
 
    int get_device_id(int device_index) const;
 
    // Point Cloud --------------------------------------------------------------
 
    int find_point_cloud(const std::string &name);
 
    int find_point_cloud_property(int point_cloud_index, const std::string &property_name);
 
    void set_point_cloud_property_dimension(int point_cloud_index, int property_index, double dimension);
 
    // Curves and datasets -------------------------------------------------------------------------
 
    IRockyCurveCollectionData get_curve_collections() const;
 
    // Nondimensionalization -----------------------------------------------------------------------
 
    double get_length_factor() const;
 
    double get_mass_factor() const;
 
    double get_time_factor() const;
 
    double get_temperature_factor() const;
 
    double get_force_factor() const;
 
    double get_pressure_factor() const;
 
    double get_energy_factor() const;
 
    [[deprecated("Use IRockyCFDModel::get_coupling_mode() instead.")]]
    ECFDCouplingMode get_coupling_mode() const;
 
    [[deprecated("Use IRockyCFDModel::get_fluid_scalars() instead.")]]
    IRockyFluidScalarsModel get_fluid_scalars() const;
 
    SDeviceModel *get_device_data(int device_index);
    RockyModel *_impl;
    rocky20::addins::RockyAddinsController* addins;
    ~IRockyModel();
    bool update_device_data = false;
};
 
#include "rocky_api_functions.h"
#include "rocky_timestep_api.h"
#include "device/api_backend.hpp"
 
// Implementation ==================================================================================
#include <rocky20/api/device/api_omp_contacts.hpp>
 
#ifdef ROCKY_CUDA_API
 
#include <rocky20/api/device/api_cuda_particles.hpp>
#include <rocky20/api/device/api_cuda_triangles.hpp>
#include <rocky20/api/device/api_cuda_contacts.hpp>
#include <rocky20/api/device/api_cuda_joints.hpp>
 
#else
 
#include <rocky20/api/device/api_device_contacts.hpp>
 
#endif
Rocky Solver SDK 2025 R1

rocky_api

Connect with Ansys
