rocky_particle_api.hpp | Ansys Developer Portal

// (C) 2024 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.
#pragma once
 
// Includes =======================================================================================
#include "rocky_particle.hpp"
 
#include "rocky_material_api.hpp"
#include "rocky_particle_scalars.hpp"
 
 
// ================================================================================================
// IRockyParticle
// ================================================================================================
 
struct IRockyParticle
{
    ROCKY_FUNCTIONS IRockyMaterial get_material() const;
 
    ROCKY_FUNCTIONS double3 get_centroid_position() const;
 
    ROCKY_FUNCTIONS double get_mass() const;
 
    ROCKY_FUNCTIONS double get_original_mass() const;
 
    ROCKY_FUNCTIONS double get_size() const;
 
    ROCKY_FUNCTIONS double get_release_time() const;
 
    ROCKY_FUNCTIONS double get_cgm_scale_factor() const;
 
    ROCKY_FUNCTIONS double get_volume() const;
 
    ROCKY_FUNCTIONS double get_solid_volume() const;
 
    ROCKY_FUNCTIONS double get_surface_area() const;
 
    ROCKY_FUNCTIONS double get_equivalent_diameter() const;
 
    ROCKY_FUNCTIONS double get_sphericity() const;
 
    ROCKY_FUNCTIONS double3 get_translational_velocity() const;
 
    ROCKY_FUNCTIONS double3 get_rotational_velocity() const;
 
    ROCKY_FUNCTIONS double get_impact_energy() const;
 
    ROCKY_FUNCTIONS double get_strength() const;
 
    [[deprecated("Use IRockyDeviceModel::get_gravity() or IRockyModel::get_gravity() instead.")]]
    ROCKY_FUNCTIONS double3 get_gravity() const;
 
    ROCKY_FUNCTIONS int get_particle_group_index() const;
 
    ROCKY_FUNCTIONS int get_material_index() const;
 
    ROCKY_FUNCTIONS double get_rolling_resistance_coefficient() const;
 
    ROCKY_FUNCTIONS thrust::tuple<double3, double> get_orientation_axis_angle() const;
 
    ROCKY_FUNCTIONS double4 get_orientation_quaternion() const;
 
    ROCKY_FUNCTIONS double3 get_resultant_force() const;
 
    ROCKY_FUNCTIONS double3 get_resultant_moment() 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 double get_specific_heat() const;
 
    ROCKY_FUNCTIONS int get_tag() const;
 
    ROCKY_FUNCTIONS void set_specific_heat(double value);
 
    ROCKY_FUNCTIONS IRockyParticleScalars get_scalars();
 
    ROCKY_FUNCTIONS const IRockyParticleScalars get_scalars() const;
 
    ROCKY_FUNCTIONS IRockyParticleTransferScalars get_transfer_scalars();
 
    ROCKY_FUNCTIONS IRockyParticleBreakageScalars get_breakage_scalars();
 
    ROCKY_FUNCTIONS void remove();
 
    ROCKY_FUNCTIONS void add_force(const double3 &force);
 
    ROCKY_FUNCTIONS void add_moment(const double3& moment);
 
    ROCKY_FUNCTIONS void set_frozen(bool frozen);
 
    ROCKY_FUNCTIONS void disable_related_particle_contacts();
 
    ROCKY_FUNCTIONS void enable_related_particle_contacts();
 
    ROCKY_FUNCTIONS void disable_related_triangle_contacts();
 
    ROCKY_FUNCTIONS void enable_related_triangle_contacts();
 
    ROCKY_FUNCTIONS const double3 get_moment_of_inertia() const;
 
    ROCKY_FUNCTIONS bool is_element() const;
 
    ROCKY_FUNCTIONS bool is_assembly() const;
 
    ROCKY_FUNCTIONS size_t get_number_of_assembly_parts() const;
 
    ROCKY_FUNCTIONS IRockyMaterial get_assembly_part_material(size_t part_id) const;
    
    ROCKY_FUNCTIONS void remove_from_contacts_search();
 
    ROCKY_FUNCTIONS void add_to_contacts_search();
 
    ROCKY_FUNCTIONS IRockyParticle(int _index, SDeviceModel *_model);
 
    RockyParticle _impl;
};
 
inline ROCKY_FUNCTIONS IRockyParticle::IRockyParticle(int _index, SDeviceModel* _model)
    : _impl(_model, _index)
{
}
 
inline ROCKY_FUNCTIONS IRockyMaterial IRockyParticle::get_material() const
{
    return IRockyMaterial(this->_impl.get_material());
}
 
inline ROCKY_FUNCTIONS double3 IRockyParticle::get_centroid_position() const
{
    return double3{ this->_impl.particle->x, this->_impl.particle->y, this->_impl.particle->z };
}
 
inline ROCKY_FUNCTIONS double IRockyParticle::get_mass() const
{
    return this->_impl.get_mass();
}
 
inline ROCKY_FUNCTIONS double IRockyParticle::get_original_mass() const
{
    return this->_impl.get_original_mass();
}
 
inline ROCKY_FUNCTIONS double IRockyParticle::get_size() const
{
    return this->_impl.get_size();
}
 
inline ROCKY_FUNCTIONS double IRockyParticle::get_release_time() const
{
    return this->_impl.get_release_time();
}
 
inline ROCKY_FUNCTIONS double IRockyParticle::get_cgm_scale_factor() const
{
    return this->_impl.get_cgm_scale_factor();
}
 
inline ROCKY_FUNCTIONS double3 IRockyParticle::get_translational_velocity() const
{
    return this->_impl.get_translational_velocity();
}
 
inline ROCKY_FUNCTIONS double3 IRockyParticle::get_rotational_velocity() const
{
    return this->_impl.get_rotational_velocity();
}
 
inline ROCKY_FUNCTIONS double3 IRockyParticle::get_gravity() const
{
    return { this->_impl.model->gen->gx, this->_impl.model->gen->gy, this->_impl.model->gen->gz  };
}
 
inline ROCKY_FUNCTIONS double IRockyParticle::get_volume() const
{
    return this->_impl.get_bulk_volume();
}
 
inline ROCKY_FUNCTIONS double IRockyParticle::get_solid_volume() const
{
    return this->_impl.get_solid_volume();
}
 
inline ROCKY_FUNCTIONS double IRockyParticle::get_surface_area() const
{
    return this->_impl.get_area();
}
 
inline ROCKY_FUNCTIONS double IRockyParticle::get_impact_energy() const
{
    return this->_impl.get_impact_energy();
}
 
inline ROCKY_FUNCTIONS double IRockyParticle::get_strength() const
{
    return this->_impl.get_strength();
}
 
inline ROCKY_FUNCTIONS double IRockyParticle::get_equivalent_diameter() const
{
    return this->_impl.get_equivalent_diameter();
}
 
inline ROCKY_FUNCTIONS double IRockyParticle::get_sphericity() const
{
    return this->_impl.get_sphericity();
}
 
inline ROCKY_FUNCTIONS int IRockyParticle::get_particle_group_index() const
{
    return this->_impl.get_particle_group_index();
}
 
inline ROCKY_FUNCTIONS int IRockyParticle::get_material_index() const {
    return this->_impl.get_group().get_material_index();
}
 
inline ROCKY_FUNCTIONS double IRockyParticle::get_rolling_resistance_coefficient() const {
    return this->_impl.get_group().rol;
}
 
inline ROCKY_FUNCTIONS double4 IRockyParticle::get_orientation_quaternion() const
{
    return this->_impl.get_orientation_quaternion();
}
 
inline ROCKY_FUNCTIONS double3 IRockyParticle::get_resultant_force() const
{
    return this->_impl.get_forces();
}
 
inline ROCKY_FUNCTIONS double3 IRockyParticle::get_resultant_moment() const
{
    return this->_impl.get_moments();
}
 
inline ROCKY_FUNCTIONS thrust::tuple<double3, double> IRockyParticle::get_orientation_axis_angle() const
{
    const SVectorAngleD _va = this->_impl.get_orientation_axis_angle();
    return thrust::make_tuple(double3 { _va.x, _va.y, _va.z }, _va.angle);
}
 
inline ROCKY_FUNCTIONS double IRockyParticle::get_thermal_conductivity() const
{
    return this->_impl.get_thermal_conductivity();
}
 
inline ROCKY_FUNCTIONS void IRockyParticle::set_thermal_conductivity(double value)
{
    this->_impl.set_thermal_conductivity(value);
}
 
inline ROCKY_FUNCTIONS double IRockyParticle::get_poisson_ratio() const
{
    return this->_impl.get_poisson_ratio();
}
 
inline ROCKY_FUNCTIONS void IRockyParticle::set_poisson_ratio(double value)
{
    this->_impl.set_poisson_ratio(value);
}
 
inline ROCKY_FUNCTIONS double IRockyParticle::get_specific_heat() const
{
    return this->_impl.get_specific_heat();
}
 
inline ROCKY_FUNCTIONS void IRockyParticle::set_specific_heat(double value)
{
    this->_impl.set_specific_heat(value);
}
 
inline ROCKY_FUNCTIONS int IRockyParticle::get_tag() const
{
    return this->_impl.get_tag();
}
 
// Scalars
 
inline ROCKY_FUNCTIONS IRockyParticleScalars IRockyParticle::get_scalars()
{
    return this->_impl.get_scalars();
}
 
inline ROCKY_FUNCTIONS const IRockyParticleScalars IRockyParticle::get_scalars() const
{
    return this->_impl.get_scalars();
}
 
inline ROCKY_FUNCTIONS IRockyParticleTransferScalars IRockyParticle::get_transfer_scalars()
{
    return this->_impl.get_transfer_scalars();
}
 
inline ROCKY_FUNCTIONS IRockyParticleBreakageScalars IRockyParticle::get_breakage_scalars()
{
    return this->_impl.get_breakage_scalars();
}
 
// Operations
 
inline ROCKY_FUNCTIONS void IRockyParticle::remove()
{
    this->_impl.remove();
}
 
// Output
 
inline ROCKY_FUNCTIONS void IRockyParticle::add_force(const double3 &force)
{
    this->_impl.add_forces(force);
}
 
inline ROCKY_FUNCTIONS void IRockyParticle::add_moment(const double3& moment)
{
    this->_impl.add_moments(moment);
}
 
inline ROCKY_FUNCTIONS void IRockyParticle::set_frozen(bool frozen)
{
    this->_impl.particle->set_frozen(frozen);
}
 
inline ROCKY_FUNCTIONS void IRockyParticle::disable_related_particle_contacts()
{
    this->_impl.particle->set_particle_contact_disabled(true);
}
 
inline ROCKY_FUNCTIONS void IRockyParticle::enable_related_particle_contacts()
{
    this->_impl.particle->set_particle_contact_disabled(false);
}
 
inline ROCKY_FUNCTIONS void IRockyParticle::disable_related_triangle_contacts()
{
    this->_impl.particle->set_triangle_contact_disabled(true);
}
 
inline ROCKY_FUNCTIONS void IRockyParticle::enable_related_triangle_contacts()
{
    this->_impl.particle->set_triangle_contact_disabled(false);
}
 
inline ROCKY_FUNCTIONS const double3 IRockyParticle::get_moment_of_inertia() const
{
    return this->_impl.get_moment_of_inertia();
}
 
inline ROCKY_FUNCTIONS bool IRockyParticle::is_element() const
{
    return this->_impl.is_element();
}
 
inline ROCKY_FUNCTIONS bool IRockyParticle::is_assembly() const
{
    return this->_impl.is_assembly();
}
 
inline ROCKY_FUNCTIONS size_t IRockyParticle::get_number_of_assembly_parts() const
{
    return this->_impl.get_number_of_assembly_parts();
}
 
inline ROCKY_FUNCTIONS
IRockyMaterial IRockyParticle::get_assembly_part_material(size_t part_id) const
{
    return IRockyMaterial { this->_impl.get_assembly_part_material(part_id) };
}
 
inline ROCKY_FUNCTIONS void IRockyParticle::remove_from_contacts_search()
{
    this->_impl.particle->set_remove_from_contacts_search(true);
}
 
inline ROCKY_FUNCTIONS void IRockyParticle::add_to_contacts_search()
{
    this->_impl.particle->set_remove_from_contacts_search(false);
}
 
// ================================================================================================
// IRockyBreakableParticle
// ================================================================================================
 
struct IRockyBreakableParticle
{
    double get_minimum_fragment_size() const;
 
    double get_original_volume() const;
 
    int get_particle_group_index() const;
 
    double get_strength() const;
 
    double get_original_size() const;
 
    void set_as_unbreakable() const;
 
    IRockyParticleScalars get_scalars();
 
    IRockyParticleBreakageScalars get_breakage_scalars();
 
 
    IRockyBreakableParticle(int _index, RockyModel* _model);
 
    RockyParticleHost _impl;
};
 
inline IRockyBreakableParticle::IRockyBreakableParticle(int _index, RockyModel* _model)
    : _impl(RockyParticleHost(_model, _index))
{
}
 
inline double IRockyBreakableParticle::get_minimum_fragment_size() const
{
    return this->_impl.get_minimum_fragment_size();
}
 
inline double IRockyBreakableParticle::get_original_volume() const
{
    return this->_impl.get_original_bulk_volume();
}
 
inline int IRockyBreakableParticle::get_particle_group_index() const
{
    return this->_impl.get_particle_group_index();
}
 
inline double IRockyBreakableParticle::get_strength() const
{
    return this->_impl.get_strength();
}
 
inline double IRockyBreakableParticle::get_original_size() const
{
    return this->_impl.get_original_size();
}
 
inline void IRockyBreakableParticle::set_as_unbreakable() const
{
    this->_impl.set_as_unbreakable();
}
 
inline IRockyParticleScalars IRockyBreakableParticle::get_scalars()
{
    return this->_impl.get_scalars();
}
 
inline IRockyParticleBreakageScalars IRockyBreakableParticle::get_breakage_scalars()
{
    return this->_impl.get_breakage_scalars();
}
 
// ================================================================================================
// IRockyParticleHost
// ================================================================================================
 
struct IRockyParticleHost
{
    double get_original_volume() const;
 
    double get_original_solid_volume() const;
 
    int get_material_index() const;
 
    double get_equivalent_diameter() const;
 
    IRockyMaterial get_material() const;
 
    double3 get_centroid_position() const;
 
    double get_original_mass() const;
 
    double get_size() const;
 
    double get_release_time() const;
 
    double get_cgm_scale_factor() const;
 
    int get_tag() const;
 
    bool is_released() const;
 
    bool is_element() const;
 
    bool is_assembly() const;
 
    size_t get_number_of_assembly_parts() const;
 
    IRockyMaterial get_assembly_part_material(size_t part_id) const;
 
    IRockyParticleScalars get_scalars() const;
 
    int get_particle_group_index() const;
 
    IRockyParticleHost(int _index, RockyModel* _model);
 
    RockyParticleHost _impl;
};
 
inline IRockyParticleHost::IRockyParticleHost(int _index, RockyModel* _model)
    : _impl(RockyParticleHost(_model, _index))
{
}
 
inline double IRockyParticleHost::get_original_volume() const
{
    return this->_impl.get_original_bulk_volume();
}
 
inline double IRockyParticleHost::get_original_solid_volume() const
{
    return this->_impl.get_original_solid_volume();
}
 
inline IRockyParticleScalars IRockyParticleHost::get_scalars() const
{
    return this->_impl.get_scalars();
}
 
inline int IRockyParticleHost::get_material_index() const
{
    return this->_impl.get_group().get_material_index();
}
 
inline double IRockyParticleHost::get_equivalent_diameter() const
{
    return this->_impl.get_equivalent_diameter();
}
 
inline IRockyMaterial IRockyParticleHost::get_material() const
{
    return IRockyMaterial(this->_impl.get_material());
}
 
inline double3 IRockyParticleHost::get_centroid_position() const
{
    return double3{ this->_impl.particle->x, this->_impl.particle->y, this->_impl.particle->z };
}
 
inline double IRockyParticleHost::get_original_mass() const
{
    return this->_impl.get_original_mass();
}
 
inline double IRockyParticleHost::get_size() const
{
    return this->_impl.get_size();
}
 
inline double IRockyParticleHost::get_release_time() const
{
    return this->_impl.get_release_time();
}
 
inline double IRockyParticleHost::get_cgm_scale_factor() const
{
    return this->_impl.get_cgm_scale_factor();
}
 
inline bool IRockyParticleHost::is_released() const
{
    return this->_impl.is_released();
}
 
inline bool IRockyParticleHost::is_assembly() const
{
    return this->_impl.is_assembly();
}
 
inline bool IRockyParticleHost::is_element() const
{
    return this->_impl.is_element();
}
 
inline size_t IRockyParticleHost::get_number_of_assembly_parts() const
{
    return this->_impl.get_number_of_assembly_parts();
}
 
inline IRockyMaterial IRockyParticleHost::get_assembly_part_material(size_t part_id) const
{
    return IRockyMaterial { this->_impl.get_assembly_part_material(part_id) };
}
 
inline int IRockyParticleHost::get_tag() const
{
    return this->_impl.get_tag();
}
inline int IRockyParticleHost::get_particle_group_index() const
{
    return this->_impl.get_particle_group_index();
}
Rocky Solver SDK 2025 R2

rocky_particle_api

Connect with Ansys
