Skip to main content

Rocky Solver SDK 2025 R2

rocky_fluid_scalars

Last update: 16.07.2025
1// (C) 2024 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.
2#pragma once
3
4// Includes ========================================================================================
5#include "rocky_scalars.h"
6
7// =================================================================================================
8// IRockyFluidScalarsModel
9// =================================================================================================
10
17struct IRockyFluidScalarsModel : ScalarsModel<rocky20::FluidScalarsController>
18{
23
28 {
29 MoleFraction,
30 MassDiffusivity,
31 MolecularWeight,
32 MassSource,
33 };
34
47 int find_species_scalar(const SpeciesVariableType type,const std::string species_name = "", const std::string phase_name = "");
48
56 std::string get_scalar_name(int index);
57
65 std::string get_scalar_unit(int index);
66
67
68
70 int add(const char *name, const char *unit, bool output = true);
71
72 IRockyFluidScalarsModel(RockyModel* solver_model);
75#ifdef ONLY_FOR_DOXYGEN
76
78 int find(const char* name);
79
81 int add(const char* name, const char* unit, bool output = true);
82
84 void reset(int scalar_index);
85
87 void set_dimension(int scalar_index, double dimension_factor);
88
89#endif
90};
91
92// =================================================================================================
93// IRockyFluidScalars
94// =================================================================================================
95
102struct IRockyFluidScalars : EntityScalars<rocky20::FluidScalars>
103{
105 ROCKY_FUNCTIONS IRockyFluidScalars(rocky20::FluidScalars& _scalars, int _cfd_index)
106 : EntityScalars<rocky20::FluidScalars>(_scalars, _cfd_index)
107 {}
110#ifdef ONLY_FOR_DOXYGEN
111
113 ROCKY_FUNCTIONS double get_scalar(int scalar_index) const;
114
130 ROCKY_FUNCTIONS void set_scalar(int scalar_index, double value) const;
131
148 ROCKY_FUNCTIONS void add_scalar(int scalar_index, double value) const;
150 ROCKY_FUNCTIONS void max_scalar(int scalar_index, double value) const;
151
152#endif
153
154};
Definition rocky_fluid_scalars.hpp:18
SpeciesVariableType
Definition rocky_fluid_scalars.hpp:28
int find_species_scalar(const SpeciesVariableType type, const std::string species_name="", const std::string phase_name="")
Definition rocky_fluid_scalars.cpp:32
std::string get_scalar_name(int index)
Definition rocky_fluid_scalars.cpp:55
void enable_storage_cell_volume()
Definition rocky_fluid_scalars.cpp:23
std::string get_scalar_unit(int index)
Definition rocky_fluid_scalars.cpp:65
void reset(int scalar_index)
int find(const char *name)
int add(const char *name, const char *unit, bool output=true)
Definition rocky_fluid_scalars.cpp:17
void set_dimension(int scalar_index, double dimension_factor)
Definition rocky_fluid_scalars.hpp:103
ROCKY_FUNCTIONS void add_scalar(int scalar_index, double value) const
ROCKY_FUNCTIONS double get_scalar(int scalar_index) const
ROCKY_FUNCTIONS void max_scalar(int scalar_index, double value) const
ROCKY_FUNCTIONS void set_scalar(int scalar_index, double value) const

Connect with Ansys