## On this page

  

 

 # CommonSettings

 Last update: 17.07.2025 

<a id="l00001" name="l00001"></a> 1/\*

<a id="l00002" name="l00002"></a> 2\* Copyright 2023 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

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

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

<a id="l00005" name="l00005"></a> 5\#pragma once

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

<a id="l00007" name="l00007"></a> 7\#include "SystemCouplingParticipant/ElementTypes.hpp"

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

<a id="l00009" name="l00009"></a> 9\#include &lt;string&gt;

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

<a id="l00011" name="l00011"></a> 11namespace sysc {

<a id="l00012" name="l00012"></a> 12 

<a id="l00018" name="l00018"></a>[ 18](group__SystemCouplingParticipantAPIs.xhtml#gaffd523474fbd708f481a712f1841a967)enum [AnalysisType](group__SystemCouplingParticipantAPIs.xhtml#gaffd523474fbd708f481a712f1841a967) {

<a id="l00019" name="l00019"></a> 19 Steady = 0,

<a id="l00020" name="l00020"></a> 20 Transient = 1

<a id="l00021" name="l00021"></a> 21};

<a id="l00022" name="l00022"></a> 22 

<a id="l00024" name="l00024"></a>[ 24](group__SystemCouplingParticipantAPIs.xhtml#ga47c8e4142175574918b84d336780cc7c)enum class [Dimension](group__SystemCouplingParticipantAPIs.xhtml#ga47c8e4142175574918b84d336780cc7c) {

<a id="l00025" name="l00025"></a> 25 D2 = 2,

<a id="l00026" name="l00026"></a> 26 D3 = 3

<a id="l00027" name="l00027"></a> 27};

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

<a id="l00030" name="l00030"></a>[ 30](group__SystemCouplingParticipantAPIs.xhtml#ga8f85e1fca4e3c3d086644ea6fb4b8fb7)enum [TensorType](group__SystemCouplingParticipantAPIs.xhtml#ga8f85e1fca4e3c3d086644ea6fb4b8fb7) {

<a id="l00031" name="l00031"></a> 31 Scalar = 0,

<a id="l00032" name="l00032"></a> 32 Vector = 1

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

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

<a id="l00036" name="l00036"></a>[ 36](group__SystemCouplingParticipantAPIs.xhtml#ga59080d26b5838a6c678ee5f0d6ff63a4)enum [RegionDiscretizationType](group__SystemCouplingParticipantAPIs.xhtml#ga59080d26b5838a6c678ee5f0d6ff63a4) {

<a id="l00037" name="l00037"></a> 37 MeshRegion = 0,

<a id="l00038" name="l00038"></a> 38 PointCloudRegion = 1

<a id="l00039" name="l00039"></a> 39};

<a id="l00040" name="l00040"></a> 40 

<a id="l00042" name="l00042"></a>[ 42](group__SystemCouplingParticipantAPIs.xhtml#gae8967650e49639319360bad6efc649a4)enum class [InterfaceSide](group__SystemCouplingParticipantAPIs.xhtml#gae8967650e49639319360bad6efc649a4) {

<a id="l00043" name="l00043"></a> 43 One = 1,

<a id="l00044" name="l00044"></a> 44 Two = 2

<a id="l00045" name="l00045"></a> 45};

<a id="l00046" name="l00046"></a> 46 

<a id="l00048" name="l00048"></a>[ 48](group__SystemCouplingParticipantAPIs.xhtml#gaced2664a481a6250f46140266dd38c2a)enum [Location](group__SystemCouplingParticipantAPIs.xhtml#gaced2664a481a6250f46140266dd38c2a) {

<a id="l00049" name="l00049"></a> 49 Node = 0,

<a id="l00050" name="l00050"></a> 50 Element = 1

<a id="l00051" name="l00051"></a> 51};

<a id="l00052" name="l00052"></a> 52 

<a id="l00061" name="l00061"></a>[ 61](group__SystemCouplingParticipantAPIs.xhtml#gab4cbdd3230a1cb38956f5b93f941f89b)enum [QuantityType](group__SystemCouplingParticipantAPIs.xhtml#gab4cbdd3230a1cb38956f5b93f941f89b) {

<a id="l00062" name="l00062"></a> 62 Unspecified = 0,

<a id="l00063" name="l00063"></a> 63 Force = 1,

<a id="l00064" name="l00064"></a> 64 IncrementalDisplacement = 2,

<a id="l00065" name="l00065"></a> 65 Temperature = 3,

<a id="l00066" name="l00066"></a> 66 HeatRate = 4,

<a id="l00067" name="l00067"></a> 67 HeatTransferCoefficient = 5,

<a id="l00068" name="l00068"></a> 68 ConvectionReferenceTemperature = 6,

<a id="l00069" name="l00069"></a> 69 ModeShape = 7,

<a id="l00070" name="l00070"></a> 70 ElectricalConductivity = 8

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

<a id="l00072" name="l00072"></a> 72 

<a id="l00074" name="l00074"></a>[ 74](structsysc_1_1Dimensionality.xhtml)struct [Dimensionality](structsysc_1_1Dimensionality.xhtml) {

<a id="l00076" name="l00076"></a>[ 76](structsysc_1_1Dimensionality.xhtml#adddff5b49bd877a2a5420c4bbcffca5a) [Dimensionality](structsysc_1_1Dimensionality.xhtml#adddff5b49bd877a2a5420c4bbcffca5a)(

<a id="l00077" name="l00077"></a> 77 double [length](structsysc_1_1Dimensionality.xhtml#a406a9caf93ba8e2b4b99224753f35b21),

<a id="l00078" name="l00078"></a> 78 double [time](structsysc_1_1Dimensionality.xhtml#ad39e8c24b910575506506cd6ed8d071c),

<a id="l00079" name="l00079"></a> 79 double [mass](structsysc_1_1Dimensionality.xhtml#a2c0c1f872bf38f54714f4d3c080a0722),

<a id="l00080" name="l00080"></a> 80 double [temperature](structsysc_1_1Dimensionality.xhtml#af8eb2b8fa9136d9804ecb5dcd7fe6d48),

<a id="l00081" name="l00081"></a> 81 double [amountOfSubstance](structsysc_1_1Dimensionality.xhtml#aa0de60275ce09315d344f2a96f397cca),

<a id="l00082" name="l00082"></a> 82 double [current](structsysc_1_1Dimensionality.xhtml#a5614457da4b582fd88fde901fa39e366),

<a id="l00083" name="l00083"></a> 83 double [luminousIntensity](structsysc_1_1Dimensionality.xhtml#a41e1c01e819899432d4a6e68959ac91d),

<a id="l00084" name="l00084"></a> 84 double [angle](structsysc_1_1Dimensionality.xhtml#a03f6d1e6e0ebb147b85242eb889572a7)) :

<a id="l00085" name="l00085"></a> 85 [length](structsysc_1_1Dimensionality.xhtml#a406a9caf93ba8e2b4b99224753f35b21)([length](structsysc_1_1Dimensionality.xhtml#a406a9caf93ba8e2b4b99224753f35b21)),

<a id="l00086" name="l00086"></a> 86 [time](structsysc_1_1Dimensionality.xhtml#ad39e8c24b910575506506cd6ed8d071c)([time](structsysc_1_1Dimensionality.xhtml#ad39e8c24b910575506506cd6ed8d071c)),

<a id="l00087" name="l00087"></a> 87 [mass](structsysc_1_1Dimensionality.xhtml#a2c0c1f872bf38f54714f4d3c080a0722)([mass](structsysc_1_1Dimensionality.xhtml#a2c0c1f872bf38f54714f4d3c080a0722)),

<a id="l00088" name="l00088"></a> 88 [temperature](structsysc_1_1Dimensionality.xhtml#af8eb2b8fa9136d9804ecb5dcd7fe6d48)([temperature](structsysc_1_1Dimensionality.xhtml#af8eb2b8fa9136d9804ecb5dcd7fe6d48)),

<a id="l00089" name="l00089"></a> 89 [amountOfSubstance](structsysc_1_1Dimensionality.xhtml#aa0de60275ce09315d344f2a96f397cca)([amountOfSubstance](structsysc_1_1Dimensionality.xhtml#aa0de60275ce09315d344f2a96f397cca)),

<a id="l00090" name="l00090"></a> 90 [current](structsysc_1_1Dimensionality.xhtml#a5614457da4b582fd88fde901fa39e366)([current](structsysc_1_1Dimensionality.xhtml#a5614457da4b582fd88fde901fa39e366)),

<a id="l00091" name="l00091"></a> 91 [luminousIntensity](structsysc_1_1Dimensionality.xhtml#a41e1c01e819899432d4a6e68959ac91d)([luminousIntensity](structsysc_1_1Dimensionality.xhtml#a41e1c01e819899432d4a6e68959ac91d)),

<a id="l00092" name="l00092"></a> 92 [angle](structsysc_1_1Dimensionality.xhtml#a03f6d1e6e0ebb147b85242eb889572a7)([angle](structsysc_1_1Dimensionality.xhtml#a03f6d1e6e0ebb147b85242eb889572a7))

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

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

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

<a id="l00097" name="l00097"></a>[ 97](structsysc_1_1Dimensionality.xhtml#ae1d350f2c40061754100d207d6dfa9be) [Dimensionality](structsysc_1_1Dimensionality.xhtml#ae1d350f2c40061754100d207d6dfa9be)() = default;

<a id="l00098" name="l00098"></a> 98 

<a id="l00100" name="l00100"></a>[ 100](structsysc_1_1Dimensionality.xhtml#af3ae9245cbd9cd284918b06d7ec33e3f) [Dimensionality](structsysc_1_1Dimensionality.xhtml#af3ae9245cbd9cd284918b06d7ec33e3f)(const [Dimensionality](structsysc_1_1Dimensionality.xhtml)&amp;) = default;

<a id="l00101" name="l00101"></a> 101 

<a id="l00103" name="l00103"></a>[ 103](structsysc_1_1Dimensionality.xhtml#aa3f6bc27ad7d1a9962a1aee74e1f55da) [Dimensionality](structsysc_1_1Dimensionality.xhtml#aa3f6bc27ad7d1a9962a1aee74e1f55da)([Dimensionality](structsysc_1_1Dimensionality.xhtml)&amp;&amp;) = default;

<a id="l00104" name="l00104"></a> 104 

<a id="l00106" name="l00106"></a>[ 106](structsysc_1_1Dimensionality.xhtml#a60973de8d61f071df111a1a625feecf3) [Dimensionality](structsysc_1_1Dimensionality.xhtml)&amp; [operator=](structsysc_1_1Dimensionality.xhtml#a60973de8d61f071df111a1a625feecf3)(const [Dimensionality](structsysc_1_1Dimensionality.xhtml)&amp;) = default;

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

<a id="l00109" name="l00109"></a>[ 109](structsysc_1_1Dimensionality.xhtml#a1b2438c29ded4d12f93986c281f67bbe) [Dimensionality](structsysc_1_1Dimensionality.xhtml)&amp; [operator=](structsysc_1_1Dimensionality.xhtml#a1b2438c29ded4d12f93986c281f67bbe)([Dimensionality](structsysc_1_1Dimensionality.xhtml)&amp;&amp;) = default;

<a id="l00110" name="l00110"></a> 110 

<a id="l00111" name="l00111"></a> 111 [~Dimensionality](structsysc_1_1Dimensionality.xhtml)() = default;

<a id="l00112" name="l00112"></a> 112 

<a id="l00113" name="l00113"></a>[ 113](structsysc_1_1Dimensionality.xhtml#a406a9caf93ba8e2b4b99224753f35b21) double [length](structsysc_1_1Dimensionality.xhtml#a406a9caf93ba8e2b4b99224753f35b21){0.0}; 

<a id="l00114" name="l00114"></a>[ 114](structsysc_1_1Dimensionality.xhtml#ad39e8c24b910575506506cd6ed8d071c) double [time](structsysc_1_1Dimensionality.xhtml#ad39e8c24b910575506506cd6ed8d071c){0.0}; 

<a id="l00115" name="l00115"></a>[ 115](structsysc_1_1Dimensionality.xhtml#a2c0c1f872bf38f54714f4d3c080a0722) double [mass](structsysc_1_1Dimensionality.xhtml#a2c0c1f872bf38f54714f4d3c080a0722){0.0}; 

<a id="l00116" name="l00116"></a>[ 116](structsysc_1_1Dimensionality.xhtml#af8eb2b8fa9136d9804ecb5dcd7fe6d48) double [temperature](structsysc_1_1Dimensionality.xhtml#af8eb2b8fa9136d9804ecb5dcd7fe6d48){0.0}; 

<a id="l00117" name="l00117"></a>[ 117](structsysc_1_1Dimensionality.xhtml#aa0de60275ce09315d344f2a96f397cca) double [amountOfSubstance](structsysc_1_1Dimensionality.xhtml#aa0de60275ce09315d344f2a96f397cca){0.0}; 

<a id="l00118" name="l00118"></a>[ 118](structsysc_1_1Dimensionality.xhtml#a5614457da4b582fd88fde901fa39e366) double [current](structsysc_1_1Dimensionality.xhtml#a5614457da4b582fd88fde901fa39e366){0.0}; 

<a id="l00119" name="l00119"></a>[ 119](structsysc_1_1Dimensionality.xhtml#a41e1c01e819899432d4a6e68959ac91d) double [luminousIntensity](structsysc_1_1Dimensionality.xhtml#a41e1c01e819899432d4a6e68959ac91d){0.0}; 

<a id="l00120" name="l00120"></a>[ 120](structsysc_1_1Dimensionality.xhtml#a03f6d1e6e0ebb147b85242eb889572a7) double [angle](structsysc_1_1Dimensionality.xhtml#a03f6d1e6e0ebb147b85242eb889572a7){0.0}; 

<a id="l00121" name="l00121"></a> 121};

<a id="l00122" name="l00122"></a> 122 

<a id="l00125" name="l00125"></a> 125} // namespace sysc

[sysc::Dimension](group__SystemCouplingParticipantAPIs.xhtml#ga47c8e4142175574918b84d336780cc7c)

Dimension

Provide an enum for participant dimension.

**Definition:** [CommonSettings.hpp:24](CommonSettings_8hpp_source.xhtml#l00024)



[sysc::RegionDiscretizationType](group__SystemCouplingParticipantAPIs.xhtml#ga59080d26b5838a6c678ee5f0d6ff63a4)

RegionDiscretizationType

Provide enum for region discretization types.

**Definition:** [CommonSettings.hpp:36](CommonSettings_8hpp_source.xhtml#l00036)



[sysc::TensorType](group__SystemCouplingParticipantAPIs.xhtml#ga8f85e1fca4e3c3d086644ea6fb4b8fb7)

TensorType

Provide enum for variable tensor types.

**Definition:** [CommonSettings.hpp:30](CommonSettings_8hpp_source.xhtml#l00030)



[sysc::QuantityType](group__SystemCouplingParticipantAPIs.xhtml#gab4cbdd3230a1cb38956f5b93f941f89b)

QuantityType

Provide an enum for variable quantity types.

**Definition:** [CommonSettings.hpp:61](CommonSettings_8hpp_source.xhtml#l00061)



[sysc::Location](group__SystemCouplingParticipantAPIs.xhtml#gaced2664a481a6250f46140266dd38c2a)

Location

Provide enum for variable mesh locations.

**Definition:** [CommonSettings.hpp:48](CommonSettings_8hpp_source.xhtml#l00048)



[sysc::InterfaceSide](group__SystemCouplingParticipantAPIs.xhtml#gae8967650e49639319360bad6efc649a4)

InterfaceSide

Provide enum for coupling interface side.

**Definition:** [CommonSettings.hpp:42](CommonSettings_8hpp_source.xhtml#l00042)



[sysc::AnalysisType](group__SystemCouplingParticipantAPIs.xhtml#gaffd523474fbd708f481a712f1841a967)

AnalysisType

Provide an enum for coupled analysis type.

**Definition:** [CommonSettings.hpp:18](CommonSettings_8hpp_source.xhtml#l00018)



[sysc::Dimensionality](structsysc_1_1Dimensionality.xhtml)

Provide a structure for dimensionality.

**Definition:** [CommonSettings.hpp:74](CommonSettings_8hpp_source.xhtml#l00074)



[sysc::Dimensionality::angle](structsysc_1_1Dimensionality.xhtml#a03f6d1e6e0ebb147b85242eb889572a7)

double angle

**Definition:** [CommonSettings.hpp:120](CommonSettings_8hpp_source.xhtml#l00120)



[sysc::Dimensionality::operator=](structsysc_1_1Dimensionality.xhtml#a1b2438c29ded4d12f93986c281f67bbe)

Dimensionality &amp; operator=(Dimensionality &amp;&amp;)=default

Provide a move-assign operator.



[sysc::Dimensionality::mass](structsysc_1_1Dimensionality.xhtml#a2c0c1f872bf38f54714f4d3c080a0722)

double mass

**Definition:** [CommonSettings.hpp:115](CommonSettings_8hpp_source.xhtml#l00115)



[sysc::Dimensionality::length](structsysc_1_1Dimensionality.xhtml#a406a9caf93ba8e2b4b99224753f35b21)

double length

**Definition:** [CommonSettings.hpp:113](CommonSettings_8hpp_source.xhtml#l00113)



[sysc::Dimensionality::luminousIntensity](structsysc_1_1Dimensionality.xhtml#a41e1c01e819899432d4a6e68959ac91d)

double luminousIntensity

**Definition:** [CommonSettings.hpp:119](CommonSettings_8hpp_source.xhtml#l00119)



[sysc::Dimensionality::current](structsysc_1_1Dimensionality.xhtml#a5614457da4b582fd88fde901fa39e366)

double current

**Definition:** [CommonSettings.hpp:118](CommonSettings_8hpp_source.xhtml#l00118)



[sysc::Dimensionality::operator=](structsysc_1_1Dimensionality.xhtml#a60973de8d61f071df111a1a625feecf3)

Dimensionality &amp; operator=(const Dimensionality &amp;)=default

Provide a copy-assign operator.



[sysc::Dimensionality::amountOfSubstance](structsysc_1_1Dimensionality.xhtml#aa0de60275ce09315d344f2a96f397cca)

double amountOfSubstance

**Definition:** [CommonSettings.hpp:117](CommonSettings_8hpp_source.xhtml#l00117)



[sysc::Dimensionality::Dimensionality](structsysc_1_1Dimensionality.xhtml#aa3f6bc27ad7d1a9962a1aee74e1f55da)

Dimensionality(Dimensionality &amp;&amp;)=default

Provide a move-constructor.



[sysc::Dimensionality::time](structsysc_1_1Dimensionality.xhtml#ad39e8c24b910575506506cd6ed8d071c)

double time

**Definition:** [CommonSettings.hpp:114](CommonSettings_8hpp_source.xhtml#l00114)



[sysc::Dimensionality::Dimensionality](structsysc_1_1Dimensionality.xhtml#adddff5b49bd877a2a5420c4bbcffca5a)

Dimensionality(double length, double time, double mass, double temperature, double amountOfSubstance, double current, double luminousIntensity, double angle)

Provide a constructor that provides exponents for each dimension.

**Definition:** [CommonSettings.hpp:76](CommonSettings_8hpp_source.xhtml#l00076)



[sysc::Dimensionality::Dimensionality](structsysc_1_1Dimensionality.xhtml#ae1d350f2c40061754100d207d6dfa9be)

Dimensionality()=default

Provide a default constructor.



[sysc::Dimensionality::Dimensionality](structsysc_1_1Dimensionality.xhtml#af3ae9245cbd9cd284918b06d7ec33e3f)

Dimensionality(const Dimensionality &amp;)=default

Provide a copy-constructor.



[sysc::Dimensionality::temperature](structsysc_1_1Dimensionality.xhtml#af8eb2b8fa9136d9804ecb5dcd7fe6d48)

double temperature

**Definition:** [CommonSettings.hpp:116](CommonSettings_8hpp_source.xhtml#l00116)