## On this page

  

 

 # rocky\_fluid\_scalars

 Last update: 16.07.2025 

<a id="l00001" name="l00001"></a> 1// (C) 2024 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

<a id="l00002" name="l00002"></a> 2\#pragma once

<a id="l00003" name="l00003"></a> 3 

<a id="l00004" name="l00004"></a> 4// Includes ========================================================================================

<a id="l00005" name="l00005"></a> 5\#include "rocky\_scalars.h"

<a id="l00006" name="l00006"></a> 6 

<a id="l00007" name="l00007"></a> 7// =================================================================================================

<a id="l00008" name="l00008"></a> 8// IRockyFluidScalarsModel

<a id="l00009" name="l00009"></a> 9// =================================================================================================

<a id="l00010" name="l00010"></a> 10 

<a id="l00017" name="l00017"></a>[ 17](structIRockyFluidScalarsModel.xhtml)struct [IRockyFluidScalarsModel](structIRockyFluidScalarsModel.xhtml) : ScalarsModel&lt;rocky20::FluidScalarsController&gt;

<a id="l00018" name="l00018"></a> 18{

<a id="l00022" name="l00022"></a> 22 void [enable\_storage\_cell\_volume](structIRockyFluidScalarsModel.xhtml#a6f1e21645261447c930050eff3ecb35b)();

<a id="l00023" name="l00023"></a> 23 

<a id="l00027" name="l00027"></a>[ 27](structIRockyFluidScalarsModel.xhtml#a1465371482cae63842154f22ab4ebbb4) enum [SpeciesVariableType](structIRockyFluidScalarsModel.xhtml#a1465371482cae63842154f22ab4ebbb4)

<a id="l00028" name="l00028"></a> 28 {

<a id="l00029" name="l00029"></a> 29 MoleFraction,

<a id="l00030" name="l00030"></a> 30 MassDiffusivity,

<a id="l00031" name="l00031"></a> 31 MolecularWeight,

<a id="l00032" name="l00032"></a> 32 MassSource,

<a id="l00033" name="l00033"></a> 33 };



<a id="l00034" name="l00034"></a> 34 

<a id="l00047" name="l00047"></a> 47 int [find\_species\_scalar](structIRockyFluidScalarsModel.xhtml#a427a7869774490548c1bf586eb982efd)(const [SpeciesVariableType](structIRockyFluidScalarsModel.xhtml#a1465371482cae63842154f22ab4ebbb4) type,const std::string species_name = "", const std::string phase_name = "");

<a id="l00048" name="l00048"></a> 48 

<a id="l00056" name="l00056"></a> 56 std::string [get\_scalar\_name](structIRockyFluidScalarsModel.xhtml#a42b5926c5293c2e9b6e1ae0bf6f3db2c)(int index);

<a id="l00057" name="l00057"></a> 57 

<a id="l00065" name="l00065"></a> 65 std::string [get\_scalar\_unit](structIRockyFluidScalarsModel.xhtml#a702ee4844ebadeb36f72564dd8b6a732)(int index);

<a id="l00066" name="l00066"></a> 66 

<a id="l00067" name="l00067"></a> 67 

<a id="l00068" name="l00068"></a> 68 

<a id="l00070" name="l00070"></a> 70 int [add](structIRockyFluidScalarsModel.xhtml#a9e0b69da64fd09543ff1b9a43c30e6b3)(const char *name, const char *unit, bool output = true);

<a id="l00071" name="l00071"></a> 71 

<a id="l00072" name="l00072"></a> 72 [IRockyFluidScalarsModel](structIRockyFluidScalarsModel.xhtml)(RockyModel* solver_model);

<a id="l00075" name="l00075"></a> 75\#ifdef ONLY\_FOR\_DOXYGEN

<a id="l00076" name="l00076"></a> 76 

<a id="l00078" name="l00078"></a>[ 78](structIRockyFluidScalarsModel.xhtml#a9b9a2807854efdeaea33d558210c3901) int [find](structIRockyFluidScalarsModel.xhtml#a9b9a2807854efdeaea33d558210c3901)(const char* name);

<a id="l00079" name="l00079"></a> 79 

<a id="l00081" name="l00081"></a> 81 int [add](structIRockyFluidScalarsModel.xhtml#a9e0b69da64fd09543ff1b9a43c30e6b3)(const char* name, const char* unit, bool output = true);

<a id="l00082" name="l00082"></a> 82 

<a id="l00084" name="l00084"></a>[ 84](structIRockyFluidScalarsModel.xhtml#a91892f2da14aaaf2473361223db628c4) void [reset](structIRockyFluidScalarsModel.xhtml#a91892f2da14aaaf2473361223db628c4)(int scalar_index);

<a id="l00085" name="l00085"></a> 85 

<a id="l00087" name="l00087"></a>[ 87](structIRockyFluidScalarsModel.xhtml#aceb74d48527a53376833f9336f0073cd) void [set\_dimension](structIRockyFluidScalarsModel.xhtml#aceb74d48527a53376833f9336f0073cd)(int scalar_index, double dimension_factor);

<a id="l00088" name="l00088"></a> 88 

<a id="l00089" name="l00089"></a> 89\#endif 

<a id="l00090" name="l00090"></a> 90};



<a id="l00091" name="l00091"></a> 91 

<a id="l00092" name="l00092"></a> 92// =================================================================================================

<a id="l00093" name="l00093"></a> 93// IRockyFluidScalars

<a id="l00094" name="l00094"></a> 94// =================================================================================================

<a id="l00095" name="l00095"></a> 95 

<a id="l00102" name="l00102"></a>[ 102](structIRockyFluidScalars.xhtml)struct [IRockyFluidScalars](structIRockyFluidScalars.xhtml) : EntityScalars&lt;rocky20::FluidScalars&gt;

<a id="l00103" name="l00103"></a> 103{

<a id="l00105" name="l00105"></a> 105 ROCKY_FUNCTIONS [IRockyFluidScalars](structIRockyFluidScalars.xhtml)(rocky20::FluidScalars&amp; _scalars, int _cfd_index)

<a id="l00106" name="l00106"></a> 106 : EntityScalars&lt;rocky20::FluidScalars&gt;(_scalars, _cfd_index)

<a id="l00107" name="l00107"></a> 107 {}

<a id="l00110" name="l00110"></a> 110\#ifdef ONLY\_FOR\_DOXYGEN

<a id="l00111" name="l00111"></a> 111 

<a id="l00113" name="l00113"></a>[ 113](structIRockyFluidScalars.xhtml#a75d5c92f06422a5d29704788404405d0) ROCKY_FUNCTIONS double [get\_scalar](structIRockyFluidScalars.xhtml#a75d5c92f06422a5d29704788404405d0)(int scalar_index) const;

<a id="l00114" name="l00114"></a> 114 

<a id="l00130" name="l00130"></a>[ 130](structIRockyFluidScalars.xhtml#aec66ca90576555d400f9c6d401b049e4) ROCKY_FUNCTIONS void [set\_scalar](structIRockyFluidScalars.xhtml#aec66ca90576555d400f9c6d401b049e4)(int scalar_index, double value) const;

<a id="l00131" name="l00131"></a> 131 

<a id="l00148" name="l00148"></a>[ 148](structIRockyFluidScalars.xhtml#a536c29f3a14dc5bbed6047f43baa37ec) ROCKY_FUNCTIONS void [add\_scalar](structIRockyFluidScalars.xhtml#a536c29f3a14dc5bbed6047f43baa37ec)(int scalar_index, double value) const;

<a id="l00150" name="l00150"></a>[ 150](structIRockyFluidScalars.xhtml#aaa969c416dea0ac4eb4721c5b8d75b24) ROCKY_FUNCTIONS void [max\_scalar](structIRockyFluidScalars.xhtml#aaa969c416dea0ac4eb4721c5b8d75b24)(int scalar_index, double value) const;

<a id="l00151" name="l00151"></a> 151 

<a id="l00152" name="l00152"></a> 152\#endif

<a id="l00153" name="l00153"></a> 153 

<a id="l00154" name="l00154"></a> 154};



[IRockyFluidScalarsModel](structIRockyFluidScalarsModel.xhtml)

**Definition** rocky_fluid_scalars.hpp:18



[IRockyFluidScalarsModel::SpeciesVariableType](structIRockyFluidScalarsModel.xhtml#a1465371482cae63842154f22ab4ebbb4)

SpeciesVariableType

**Definition** rocky_fluid_scalars.hpp:28



[IRockyFluidScalarsModel::find\_species\_scalar](structIRockyFluidScalarsModel.xhtml#a427a7869774490548c1bf586eb982efd)

int find_species_scalar(const SpeciesVariableType type, const std::string species_name="", const std::string phase_name="")

**Definition** rocky_fluid_scalars.cpp:32



[IRockyFluidScalarsModel::get\_scalar\_name](structIRockyFluidScalarsModel.xhtml#a42b5926c5293c2e9b6e1ae0bf6f3db2c)

std::string get_scalar_name(int index)

**Definition** rocky_fluid_scalars.cpp:55



[IRockyFluidScalarsModel::enable\_storage\_cell\_volume](structIRockyFluidScalarsModel.xhtml#a6f1e21645261447c930050eff3ecb35b)

void enable_storage_cell_volume()

**Definition** rocky_fluid_scalars.cpp:23



[IRockyFluidScalarsModel::get\_scalar\_unit](structIRockyFluidScalarsModel.xhtml#a702ee4844ebadeb36f72564dd8b6a732)

std::string get_scalar_unit(int index)

**Definition** rocky_fluid_scalars.cpp:65



[IRockyFluidScalarsModel::reset](structIRockyFluidScalarsModel.xhtml#a91892f2da14aaaf2473361223db628c4)

void reset(int scalar_index)



[IRockyFluidScalarsModel::find](structIRockyFluidScalarsModel.xhtml#a9b9a2807854efdeaea33d558210c3901)

int find(const char *name)



[IRockyFluidScalarsModel::add](structIRockyFluidScalarsModel.xhtml#a9e0b69da64fd09543ff1b9a43c30e6b3)

int add(const char *name, const char *unit, bool output=true)

**Definition** rocky_fluid_scalars.cpp:17



[IRockyFluidScalarsModel::set\_dimension](structIRockyFluidScalarsModel.xhtml#aceb74d48527a53376833f9336f0073cd)

void set_dimension(int scalar_index, double dimension_factor)



[IRockyFluidScalars](structIRockyFluidScalars.xhtml)

**Definition** rocky_fluid_scalars.hpp:103



[IRockyFluidScalars::add\_scalar](structIRockyFluidScalars.xhtml#a536c29f3a14dc5bbed6047f43baa37ec)

ROCKY_FUNCTIONS void add_scalar(int scalar_index, double value) const



[IRockyFluidScalars::get\_scalar](structIRockyFluidScalars.xhtml#a75d5c92f06422a5d29704788404405d0)

ROCKY_FUNCTIONS double get_scalar(int scalar_index) const



[IRockyFluidScalars::max\_scalar](structIRockyFluidScalars.xhtml#aaa969c416dea0ac4eb4721c5b8d75b24)

ROCKY_FUNCTIONS void max_scalar(int scalar_index, double value) const



[IRockyFluidScalars::set\_scalar](structIRockyFluidScalars.xhtml#aec66ca90576555d400f9c6d401b049e4)

ROCKY_FUNCTIONS void set_scalar(int scalar_index, double value) const