Add a common function in COutput to keep "ITER", "CUR_TIME", "RMS_RES" consistent in history file.

kaleseed · kaleseed · commit 16d3f51da85c · 2023-10-03T15:17:45.000+08:00
diff --git a/SU2_CFD/include/output/COutput.hpp b/SU2_CFD/include/output/COutput.hpp
@@ -806,6 +806,11 @@ class COutput {
    */
   void SetCommonHistoryFields();
 
+  /*!
+   * \brief Request the history fields common for all solvers.
+   */
+  void RequestCommonHistory(bool dynamic);
+
   /*!
    * \brief Parses user-defined outputs.
    */
diff --git a/SU2_CFD/src/output/CAdjFlowCompOutput.cpp b/SU2_CFD/src/output/CAdjFlowCompOutput.cpp
@@ -36,9 +36,7 @@ CAdjFlowCompOutput::CAdjFlowCompOutput(CConfig *config, unsigned short nDim) : C
   /*--- Set the default history fields if nothing is set in the config file ---*/
 
   if (nRequestedHistoryFields == 0) {
-    requestedHistoryFields.emplace_back("ITER");
-    if (config->GetTime_Domain()) requestedHistoryFields.emplace_back("CUR_TIME");
-    requestedHistoryFields.emplace_back("RMS_RES");
+    RequestCommonHistory(config->GetTime_Domain());
     requestedHistoryFields.emplace_back("SENSITIVITY");
     nRequestedHistoryFields = requestedHistoryFields.size();
   }
diff --git a/SU2_CFD/src/output/CAdjFlowIncOutput.cpp b/SU2_CFD/src/output/CAdjFlowIncOutput.cpp
@@ -42,9 +42,7 @@ CAdjFlowIncOutput::CAdjFlowIncOutput(CConfig *config, unsigned short nDim) : CAd
   /*--- Set the default history fields if nothing is set in the config file ---*/
 
   if (nRequestedHistoryFields == 0) {
-    requestedHistoryFields.emplace_back("ITER");
-    if (config->GetTime_Domain()) requestedHistoryFields.emplace_back("CUR_TIME");
-    requestedHistoryFields.emplace_back("RMS_RES");
+    RequestCommonHistory(config->GetTime_Domain());
     requestedHistoryFields.emplace_back("SENSITIVITY");
     nRequestedHistoryFields = requestedHistoryFields.size();
   }
diff --git a/SU2_CFD/src/output/CAdjHeatOutput.cpp b/SU2_CFD/src/output/CAdjHeatOutput.cpp
@@ -36,9 +36,7 @@ CAdjHeatOutput::CAdjHeatOutput(CConfig *config, unsigned short nDim) : COutput(c
   /*--- Set the default history fields if nothing is set in the config file ---*/
 
   if (nRequestedHistoryFields == 0){
-    requestedHistoryFields.emplace_back("ITER");
-    if (config->GetTime_Domain()) requestedHistoryFields.emplace_back("CUR_TIME");
-    requestedHistoryFields.emplace_back("RMS_RES");
+    RequestCommonHistory(config->GetTime_Domain());
     requestedHistoryFields.emplace_back("SENSITIVITY");
     nRequestedHistoryFields = requestedHistoryFields.size();
   }
diff --git a/SU2_CFD/src/output/CElasticityOutput.cpp b/SU2_CFD/src/output/CElasticityOutput.cpp
@@ -43,9 +43,7 @@ CElasticityOutput::CElasticityOutput(CConfig *config, unsigned short nDim) : COu
 
   /*--- Default fields for screen output ---*/
   if (nRequestedHistoryFields == 0){
-    requestedHistoryFields.emplace_back("ITER");
-    if (dynamic) requestedHistoryFields.emplace_back("CUR_TIME");
-    requestedHistoryFields.emplace_back("RMS_RES");
+    RequestCommonHistory(dynamic);
     nRequestedHistoryFields = requestedHistoryFields.size();
   }
 
diff --git a/SU2_CFD/src/output/CFlowCompFEMOutput.cpp b/SU2_CFD/src/output/CFlowCompFEMOutput.cpp
@@ -38,9 +38,7 @@ CFlowCompFEMOutput::CFlowCompFEMOutput(CConfig *config, unsigned short nDim) : C
   /*--- Set the default history fields if nothing is set in the config file ---*/
 
   if (nRequestedHistoryFields == 0){
-    requestedHistoryFields.emplace_back("ITER");
-    if (config->GetTime_Domain()) requestedHistoryFields.emplace_back("CUR_TIME");
-    requestedHistoryFields.emplace_back("RMS_RES");
+    RequestCommonHistory(config->GetTime_Domain());
     nRequestedHistoryFields = requestedHistoryFields.size();
   }
   if (nRequestedScreenFields == 0){
diff --git a/SU2_CFD/src/output/CFlowCompOutput.cpp b/SU2_CFD/src/output/CFlowCompOutput.cpp
@@ -37,9 +37,7 @@ CFlowCompOutput::CFlowCompOutput(const CConfig *config, unsigned short nDim) : C
   /*--- Set the default history fields if nothing is set in the config file ---*/
 
   if (nRequestedHistoryFields == 0){
-    requestedHistoryFields.emplace_back("ITER");
-    if (config->GetTime_Domain()) requestedHistoryFields.emplace_back("CUR_TIME");
-    requestedHistoryFields.emplace_back("RMS_RES");
+    RequestCommonHistory(config->GetTime_Domain());
     nRequestedHistoryFields = requestedHistoryFields.size();
   }
   if (nRequestedScreenFields == 0){
diff --git a/SU2_CFD/src/output/CFlowIncOutput.cpp b/SU2_CFD/src/output/CFlowIncOutput.cpp
@@ -46,9 +46,7 @@ CFlowIncOutput::CFlowIncOutput(CConfig *config, unsigned short nDim) : CFlowOutp
   /*--- Set the default history fields if nothing is set in the config file ---*/
 
   if (nRequestedHistoryFields == 0){
-    requestedHistoryFields.emplace_back("ITER");
-    if (config->GetTime_Domain()) requestedHistoryFields.emplace_back("CUR_TIME");
-    requestedHistoryFields.emplace_back("RMS_RES");
+    RequestCommonHistory(config->GetTime_Domain());
     nRequestedHistoryFields = requestedHistoryFields.size();
   }
 
diff --git a/SU2_CFD/src/output/CHeatOutput.cpp b/SU2_CFD/src/output/CHeatOutput.cpp
@@ -35,9 +35,7 @@ CHeatOutput::CHeatOutput(CConfig *config, unsigned short nDim) : CFVMOutput(conf
   /*--- Set the default history fields if nothing is set in the config file ---*/
 
   if (nRequestedHistoryFields == 0){
-    requestedHistoryFields.emplace_back("ITER");
-    if (config->GetTime_Domain()) requestedHistoryFields.emplace_back("CUR_TIME");
-    requestedHistoryFields.emplace_back("RMS_RES");
+    RequestCommonHistory(config->GetTime_Domain());
     nRequestedHistoryFields = requestedHistoryFields.size();
   }
   if (nRequestedScreenFields == 0){
diff --git a/SU2_CFD/src/output/CNEMOCompOutput.cpp b/SU2_CFD/src/output/CNEMOCompOutput.cpp
@@ -38,9 +38,7 @@ CNEMOCompOutput::CNEMOCompOutput(const CConfig *config, unsigned short nDim) : C
   /*--- Set the default history fields if nothing is set in the config file ---*/
 
   if (nRequestedHistoryFields == 0){
-    requestedHistoryFields.emplace_back("ITER");
-    if (config->GetTime_Domain()) requestedHistoryFields.emplace_back("CUR_TIME");
-    requestedHistoryFields.emplace_back("RMS_RES");
+    RequestCommonHistory(config->GetTime_Domain());
     nRequestedHistoryFields = requestedHistoryFields.size();
   }
   if (nRequestedScreenFields == 0){
diff --git a/SU2_CFD/src/output/COutput.cpp b/SU2_CFD/src/output/COutput.cpp
@@ -2017,6 +2017,13 @@ void COutput::SetCommonHistoryFields() {
 
 }
 
+void COutput::RequestCommonHistory(bool dynamic) {
+
+  requestedHistoryFields.emplace_back("ITER");
+  if (dynamic) requestedHistoryFields.emplace_back("CUR_TIME");
+  requestedHistoryFields.emplace_back("RMS_RES");
+}
+
 void COutput::SetCustomOutputs(const CConfig* config) {
 
   const auto& inputString = config->GetCustomOutputs();

Original file line number	Diff line number	Diff line change
`@@ -43,9 +43,7 @@ CElasticityOutput::CElasticityOutput(CConfig *config, unsigned short nDim) : COu`
`43`	`43`
`44`	`44`	`/--- Default fields for screen output ---/`
`45`	`45`	`if (nRequestedHistoryFields == 0){`
`46`		`- requestedHistoryFields.emplace_back("ITER");`
`47`		`- if (dynamic) requestedHistoryFields.emplace_back("CUR_TIME");`
`48`		`- requestedHistoryFields.emplace_back("RMS_RES");`
	`46`	`+ RequestCommonHistory(dynamic);`
`49`	`47`	`nRequestedHistoryFields = requestedHistoryFields.size();`
`50`	`48`	`}`
`51`	`49`
Original file line number	Diff line number	Diff line change
`@@ -46,9 +46,7 @@ CFlowIncOutput::CFlowIncOutput(CConfig *config, unsigned short nDim) : CFlowOutp`
`46`	`46`	`/--- Set the default history fields if nothing is set in the config file ---/`
`47`	`47`
`48`	`48`	`if (nRequestedHistoryFields == 0){`
`49`		`- requestedHistoryFields.emplace_back("ITER");`
`50`		`- if (config->GetTime_Domain()) requestedHistoryFields.emplace_back("CUR_TIME");`
`51`		`- requestedHistoryFields.emplace_back("RMS_RES");`
	`49`	`+ RequestCommonHistory(config->GetTime_Domain());`
`52`	`50`	`nRequestedHistoryFields = requestedHistoryFields.size();`
`53`	`51`	`}`
`54`	`52`