dvs_client_interface.h | Ansys Developer Portal

Go to the documentation of this file.
/*  *************************************************************
 *   Copyright 2017-2024 ANSYS, Inc.
 *   All Rights Reserved.
 *
 *        Restricted Rights Legend
 *
 *   Use, duplication, or disclosure of this
 *   software and its documentation by the
 *   Government is subject to restrictions as
 *   set forth in subdivision [(b)(3)(ii)] of
 *   the Rights in Technical Data and Computer
 *   Software clause at 52.227-7013.
 *  *************************************************************
 */
 
#ifndef ___DVS_DYNAMIC_VISUALIZATION_STORE_CLIENT_INTERFACE___
#define ___DVS_DYNAMIC_VISUALIZATION_STORE_CLIENT_INTERFACE___
 
#include <string>
 
#include "dvs_server_interface.h"
#include "dynamic_visualization_store_api.h"
#include "logger_interface.h"
 
#include "include/dvs_import_export.h"
 
namespace DVS
{
    class IClient
    {
    public:
 
 
        IClient() = default; 
        virtual ~IClient() = default; 
        IClient(IClient&&) = default;  
        IClient& operator=(IClient&&) = default; 
        IClient(const IClient&) = default; 
        IClient& operator=(const IClient&) = default; 
 
        virtual void set_logger(ILogger* logger) = 0;
 
        virtual const char* get_version() = 0;
 
        virtual dvs_ret begin_init(const char* dataset_name, uint32_t current_rank, uint32_t total_ranks, uint32_t num_chunks) = 0;
 
        virtual dvs_ret set_unit_system(const char* system) = 0;
 
        virtual dvs_ret add_metadata(const char* const keys[], const char* const vals[], uint32_t num_metadata_pairs) = 0;
 
        virtual dvs_ret add_part_info(const dvs_part_info* part_info, uint32_t num_parts) = 0;
 
        virtual dvs_ret add_var_info(const dvs_var_info* var_info, uint32_t num_vars) = 0;
 
        virtual dvs_ret add_plot_info(const dvs_plot_info* plot_info, uint32_t num_plots) = 0;
 
        virtual uint32_t get_num_parts() const = 0;
 
        virtual uint32_t get_num_vars() const = 0;
 
        virtual uint32_t get_num_plots() const = 0;
 
        virtual const dvs_part_info* get_part_info(uint32_t index) const = 0;
 
        virtual dvs_ret get_part_id(const std::string& name, uint32_t& id) const = 0;
 
        virtual const dvs_var_info* get_var_info(uint32_t index) const = 0;
 
        virtual dvs_ret get_var_id(const std::string& name, uint32_t& id) const = 0;
 
        virtual const dvs_plot_info* get_plot_info(uint32_t index) const = 0;
 
        virtual dvs_ret get_plot_id(const std::string& name, uint32_t& id) const = 0;
 
        virtual dvs_ret end_init() = 0;
 
        virtual dvs_ret begin_update(uint32_t update_num, uint32_t rank, uint32_t chunk, float time) = 0;
 
        virtual dvs_ret update_copy_previous_part(uint32_t part_id, const char* options) = 0;
 
        virtual dvs_ret update_part_rigid_body_motion(
            uint32_t part_id,
            const std::vector<float>& quaternion,
            const std::vector<float>& displacement,
            const std::vector<float>& cg_offset
        ) = 0;
 
        virtual dvs_ret convert_rotation_to_quaternion(
            std::array<float, 3> axis_start,
            std::array<float, 3> axis_end,
            float relative_rotation_angle,
            std::array<float, 4>& quaternion
        ) = 0;
 
        virtual dvs_ret update_nodes(uint32_t part_id, const float* x, const float* y, const float* z, uint32_t num_values) = 0;
 
        virtual dvs_ret update_nodes_structured
        (
            uint32_t part_id,
            const uint32_t global_ijk_max[3],
            const uint32_t local_ijk_min[3],
            const uint32_t local_ijk_max[3],
            const float origin[3],
            const float dir_i[3],
            const float dir_j[3],
            const float dir_k[3],
            const float* i_vals,
            const float* j_vals,
            const float* k_vals
        ) = 0;
 
        virtual dvs_ret update_nodes_structured
        (
            uint32_t part_id,
            const uint32_t global_ijk_max[3],
            const uint32_t local_ijk_min[3],
            const uint32_t local_ijk_max[3],
            const float* x_vals,
            const float* y_vals,
            const float* z_vals
        ) = 0;
 
        virtual dvs_ret update_elements(uint32_t part_id, dvs_element_type type, const uint32_t* indices,  uint32_t num_indices) = 0;
 
        virtual dvs_ret update_elements_polygon
        (
            uint32_t part_id,
            dvs_element_type type,
            const uint32_t* nodes_per_polygon,
            uint32_t nodes_per_polygon_size,
            const uint32_t* indices,
            uint32_t indices_size
        ) = 0;
 
        virtual dvs_ret update_elements_polyhedral
        (
            uint32_t part_id,
            dvs_element_type type,
            const uint32_t* faces_per_element,
            uint32_t faces_per_element_size,
            const uint32_t* nodes_per_face,
            uint32_t nodes_per_face_size,
            const uint32_t* indices,
            uint32_t indices_size
        ) = 0;
 
 
        virtual dvs_ret update_var_case(dvs_var_type var_type, uint32_t var_id, const float* values, uint32_t num_values) = 0;
 
        virtual dvs_ret update_var_part(dvs_var_type var_type, uint32_t var_id, uint32_t part_id, const float* values, uint32_t num_values) = 0;
 
        virtual dvs_ret update_var_element(dvs_element_type elem_type, dvs_var_type var_type, uint32_t var_id, uint32_t part_id, const float* values, uint32_t num_values) = 0;
 
        virtual dvs_ret update_var_element(dvs_element_type elem_type, dvs_var_type var_type, uint32_t var_id, uint32_t part_id, const int64_t* values, uint32_t num_values) = 0;
 
        virtual dvs_ret update_var_node(dvs_var_type var_type, uint32_t var_id, uint32_t part_id, const float* values, uint32_t num_values) = 0;
        
        virtual dvs_ret update_var_node(dvs_var_type var_type, uint32_t var_id, uint32_t part_id, const int64_t* values, uint32_t num_values) = 0;
 
        virtual dvs_ret update_var_field(dvs_var_location location, dvs_element_type elem_type, dvs_var_type var_type, uint32_t var_id, uint32_t part_id, const float* values, uint32_t num_values) = 0;
        
        virtual dvs_ret update_var_field(dvs_var_location location, dvs_element_type elem_type, dvs_var_type var_type, uint32_t var_id, uint32_t part_id, const int64_t* values, uint32_t num_values) = 0;
 
        virtual dvs_ret update_plot(uint32_t plot_id, const float* x_values, const float* y_values, uint32_t num_values) = 0;
 
        virtual dvs_ret end_update() = 0;
 
        virtual dvs_ret delete_item(uint32_t update_num, uint32_t rank, const char* filter) = 0;
    };
 
    DVS_DLL_EXPORT DVS::IClient* CREATE_CLIENT_INSTANCE(DVS::IServer* server, dvs_client_flags flags, const char* secret);
 
    DVS_DLL_EXPORT void DESTROY_CLIENT_INSTANCE(DVS::IClient* destroy);
}
 
#endif //___DVS_DYNAMIC_VISUALIZATION_STORE_CLIENT_INTERFACE___
Post-processing tools 2025 R1

dvs_client_interface

Connect with Ansys
