Common Fluids Format 2023 R2

RunOutputAttr

Last update: 16.07.2025
1#ifndef RUNOUTPUTATTRIBUTES_H
2#define RUNOUTPUTATTRIBUTES_H
3
4#include "Project/LibraryType.hpp"
5#include "Project/Types.hpp"
6#include "Project/Iterator.hpp"
7#include <string>
8#include <vector>
9
10namespace ansys {
11namespace Project {
12
13class ANSYS_PROJECT_DLL RunOutputAttr {
14public:
15 virtual ~RunOutputAttr() {};
16
17 //
18 virtual bool hasValue(const std::string& pVar,bool pFlagInherited) const = 0;
19 virtual std::string getValue(const std::string& pVar,bool pFlagInherited) const = 0;
20 virtual MetaVariableType getValueType(const std::string& pVar,bool pFlagInherited) const = 0;
21 virtual void setValue(const std::string& pVar,const std::string& pValue) = 0;
22
23 virtual int getValueInt(const std::string& pVar,bool pFlagInherited) const = 0;
24 virtual double getValueDouble(const std::string& pVar,bool pFlagInherited) const = 0;
25 virtual void setValueInt(const std::string& pVar,int pValue) = 0;
26 virtual void setValueDouble(const std::string& pVar,double pValue) = 0;
27
28 std::vector<std::string> getValues(const std::vector<std::string>& pVars,bool pFlagInherited) const;
29
30 static const std::string sVarTime;
31 static const std::string sVarSolverIteration;
32 static const std::string sVarIndex;
33
34 static const std::string sVarCrankAngle;
35
36 static const std::string sVarCaseId;
37 static const std::string sVarInputSettingsId;
38 static const std::string sVarDomainTransformationId;
39 static const std::string sVarPhysicsId;
40 static const std::string sVarOutputSettingsId;
41
42 static const std::string sVarMeshId;
43 static const std::string sVarTopologyId;
44 static const std::string sVarConnectivityId;
45 static const std::string sVarCoordinatesId;
46
47 static const std::string sVarLocationId;
48
49 // Convenience API
50 int getIndex() const;
51 int getSolverIteration() const;
52 double getTime() const;
53 void setIndex(int pValue);
54 void setSolverIteration(int pValue);
55 void setTime(double pValue);
56
57 double getCrankAngle() const;
58 void setCrankAngle(double pValue);
59
60 int getCaseId() const; // deprecated
61 int getInputSettingsId() const;
62 int getDomainTransformationId() const;
63 int getPhysicsId() const;
64 int getOutputSettingsId() const;
65 int getMeshId() const;
66 int getTopologyId() const;
67 int getConnectivityId() const;
68 int getCoordinatesId() const;
69 int getLocationId() const;
70 void setCaseId(int pValue); // deprecated
71 void setInputSettingsId(int pValue);
72 void setDomainTransformationId(int pValue);
73 void setPhysicsId(int pValue);
74 void setOutputSettingsId(int pValue);
75 void setMeshId(int pValue);
76 void setTopologyId(int pValue);
77 void setConnectivityId(int pValue);
78 void setCoordinatesId(int pValue);
79 void setLocationId(int pValue);
80
81 Iterator getFirstIteratorForCurrentCaseId() const;
82 Iterator getFirstIteratorForCurrentPhysicsId() const;
83 Iterator getFirstIteratorForCurrentInputSettingsId() const;
84 Iterator getFirstIteratorForCurrentDomainTransformationId() const;
85 Iterator getFirstIteratorForCurrentMeshId() const;
86 Iterator getFirstIteratorForCurrentTopologyId() const;
87 Iterator getFirstIteratorForCurrentConnectivityId() const;
88 Iterator getFirstIteratorForCurrentCoordinatesId() const;
89 Iterator getFirstIteratorForCurrentLocationId() const;
90 Iterator getFirstIteratorForCurrent(const std::string& pVar) const;
91
92protected:
93 virtual Iterator getIterator() const = 0;
94
95};
96
97}
98}
99
100#endif // RUNOUTPUTATTRIBUTES_H
ansys::Project::Iterator
Pointer to a project location.
Definition: Iterator.hpp:20
ansys::Project::RunOutputAttr
Base class for Run, Output, Result - provide built-in variable set/get functions.
Definition: RunOutputAttr.hpp:13
ansys
Definition: API.dox:1

Connect with Ansys