Get MOC_GridCalc_BDE.cpp to compile

[khartmansjsu]

Goal: compile MOC_GridCalc_BDE.cpp

Summary

So far I have commented out a number of include statements which are to Windows-specific header files. The latest Attempt at compiling (see below) resulted in a large number of errors stemming from both the main file being compiled and a number of its dependencies. I am currently in the process of determining if those dependencies are still worth keeping. It seems that MOC_GridDlg.h is not entirely necessary (it defines many classes for Windows-specific dialogue boxes), but it has some hard-coded values in those classes. I need to find out if these values need to be re-defined in the main script, MOC_GridCalc_BDE.cpp once I remove the include call to MOC_GridDlg.h.

Attempt 1:

[khartm12@integrity MOC_Grid_BDE]$ gcc MOC_GridCalc_BDE.cpp -o MOCGridCalc_BDE_test
In file included from MOC_GridCalc_BDE.h:34,
                 from MOC_GridCalc_BDE.cpp:30:
Chart.h:9:10: fatal error: afxwin.h: No such file or directory
    9 | #include "afxwin.h"
      |          ^~~~~~~~~~
compilation terminated.
[khartm12@integrity MOC_Grid_BDE]$

• Change: On line 9 of Chart.h, comment out dependency on afxwin.h
• Reason: afxwin.h is a windows-specific header file that does not exist in the files that have been provided. It does not contain code necessary for the calculation of the MOC nozzle contours, so we should be able to gut the application of this file and move forward.
• Result: No fatal error for afxwin.h

Attempt 2:

[khartm12@integrity MOC_Grid_BDE]$ gcc MOC_GridCalc_BDE.cpp -o MOCGridCalc_BDE_test
MOC_GridCalc_BDE.cpp:32:10: fatal error: afx.h: No such file or directory
   32 | #include "afx.h"
      |          ^~~~~~~
compilation terminated.
[khartm12@integrity MOC_Grid_BDE]$

• Change: On line 32 in MOC_GridCalc_BDE.cpp, comment out dependency on afx.h
• Reason: By this, afx.h and other MFC libraries are Microsoft-specific header files. As such, we must remove them and keep on working.
• Result: No fatal error for afx.h

Attempt 3:

[khartm12@integrity MOC_Grid_BDE]$ gcc MOC_GridCalc_BDE.cpp -o MOCGridCalc_BDE_test

MOC_GridCalc_BDE.cpp:39:10: fatal error: Resource.h: No such file or directory
   39 | #include "Resource.h"
      |          ^~~~~~~~~~~~
compilation terminated.
[khartm12@integrity MOC_Grid_BDE]$

Note/context: A number of custom header files have a lowercase leading character in their names while their respective include statements have an uppercase.

• Change(s): Duplicate and capitalize resource.h in the MOC_GRID_BDE subdirectory; Duplicate and lowercase Chart.h in the MOC_GRID_BDE subdirectory;
• Reason: Resource.h does not exist, but resource.h does exist. By this and further by this, I hypothesize that capitalizing/lowercasing any of the custom header files which have include statements with a capital will fix these compilation errors. TLDR: In Windows, one can compile this code because references to headers are not case sensitive, but in Linux systems, they are case-sensitive.
• Result: No more issues calling to chart.h and Resource.h from the files which depend on them.

Attempt 4:

See: compile_errors1.txt Description: A lot of type errors in Chart.h for the following:

1. BOOL
2. COLORREF
3. CBitmap
4. CString
5. CDC
6. CPoint
7. CRect
8. CFont
9. afx_msg
10. DECLARE_MESSAGE_MAP() A lot of errors in MOC_GridDlg.h
11. DECLAR_DYNAMIC()
12. Syntax error with CWnd*
13. CEdit
14. CButton
15. CComboBox
16. afx_msg
17. DECLAR_MESSAGE_MAP() no type and syntax error
18. AfxMessageBox not declared errors in MOCPlotDialog.h
19. No declaration of CDataExchange
20. Syntax errors
21. DECLARE_MESSAGE_MAP no type errors in MOC_GridCalc_BDE.cpp are numerous an probably can be handled by addressing the above issues. Let's see...

[khartmansjsu]

Notes on MOC_GridCalc_BDE.cpp

• This file appears to be only a class definition with public and private methods as well as constructor/deconstructors
• It is accompanied by MOC_GridCalc_BDE.h, its sister file which contains function declarations
  • MOC_GridCalc_BDE.h contains an include statement to dummyStruct.h and Chart.h. afx.h inclusion has been commented out.

    Conclusion

• When we arrive at a final code base which can be compiled on the cluster and which is designed to return an MOC nozzle contour and solution, we'll want our main script to refer to MOC_GridCalc_BDE.cpp, but we will not be compiling this script.
• Perhaps there is a main() function somewhere else in the code base

  Plan

• Find a file which includes MOC_GridCalc_BDE.cpp; this will likely be the main file and a good starting point.

[khartmansjsu]

Plan of action

The MOC_GridCalc_BDE.cpp file contains the definitions of class methods that do the method of characteristics calculations. Similarly, the MOC_GridCalc_BDE_IO.cpp file contains he definitions of class methods that output all the calculation results. This is an indication that we need to have some main.cpp script which includes the aforementioned MOC_GridCalc method definitions and makes calls to them. These calls would have normally been made in a GUI.

Let's look at an example. The method MOC_GridCalc::CalcMOC_Grid is defined in MOC_GridCalc_BDE.cpp. We ask ourselves, "Where, outside of MOC_GridCalc method functions, is this method ever called?" The answer is, "Nowhere. This is a private method function." Verification:

[khartm12@integrity Three-Dimensional-Nozzle-Design-Code-master]$ grep -rnw './' -e 'CalcMOC_Grid'
./MOC_Grid_BDE/MOC_GridCalc_BDE.h:109:          int CalcMOC_Grid( double g, double pAmb, int tFlag, double mThroat, int nType,
./MOC_Grid_BDE/MOC_GridCalc_BDE.cpp:158:        else flag = CalcMOC_Grid(gamma_i, pAmbient, throatFlag,
./MOC_Grid_BDE/MOC_GridCalc_BDE.cpp:171:int MOC_GridCalc::CalcMOC_Grid( double g, double pAmb, int tFlag, double mT, int nType,
[khartm12@integrity Three-Dimensional-Nozzle-Design-Code-master]$

Okay, so ask ourselves this, "Where in the Public functions is the method MOC_GridCalc::CalcMOC_Grid called?" The answer is above: line 158 of MOC_GridCalc_BDE.cpp. This is in the public method function below (line 154):

int MOC_GridCalc::CreateMOCGrid(void)
{
        int flag = 0;
        if ( nC < 5) AfxMessageBox("Increase the number of starting characteristics > 5");
        else flag = CalcMOC_Grid(gamma_i, pAmbient, throatFlag,
                mThroat, nozzleType, designParam, nozzleGeom, nSLi, nSLj);
        return flag;
}

Ask another question: "Where in the code base is the method MOC_GridCalc::CreateMOCGrid called?

[khartm12@integrity Three-Dimensional-Nozzle-Design-Code-master]$ grep -rnw './' -e 'CreateMOCGrid'
./MOC_Grid_BDE/MOC_GridDlg.cpp:540:     flag = moc->CreateMOCGrid();
./MOC_Grid_BDE/MOC_GridCalc_BDE.h:61:           int CreateMOCGrid(void); // This is the main control function
./MOC_Grid_BDE/MOC_GridCalc_BDE.cpp:154:int MOC_GridCalc::CreateMOCGrid(void)
[khartm12@integrity Three-Dimensional-Nozzle-Design-Code-master]$

Here we have its declaration in MOC_GridCalc_BDE.h on line 61, its definition in MOC_GridCalc_BDE.cpp on line 154, and a call to it on line 540 of MOC_GridDlg.cpp. This seems consistent with the nature of the original software package (all calculations are initiated and sent from a GUI. Time to investigate MOC_GridDlg.cpp, as this file will likely give hints about how to write the new main.cpp file which will be used for compilation of this package on linux systems.

[khartmansjsu]

Goal: compile MOC_GridDlg.cpp

Summary

Changelog:

• On line 4 of MOC_GridDlg.cpp, comment out dependency on stdafx.h At first glance, and referring to the last comment on this issue (where CreatMOCGrid is seen to be called from only 'MOC_GridDlg.cpp on line 540), I identify a function method of the class CMOC_GridDlg, CMOC_GridDlg::OnCalcMOCBUTTON(). CreatMOCGrid is called from within this function. Additionally, this appears to be the only block of code thus far which could be run standalone, with the replacement of some lines of code, such as line 517, where AfxMessageBox() is used to print a fatal error message. I think that a main.cpp script which contains a form of lines 503-547 is a good path to take in implementing the above plan of action. Still, I will go through the steps to remove dependencies of MOC_GridDlg.cpp on packages which cannot exist in linux. Attempts 1 - ___ itemize these steps.

Attempt 1:

[khartm12@integrity MOC_Grid_BDE]$ g++ MOC_GridDlg.cpp -o MOC_GridDlgTest
MOC_GridDlg.cpp:4:10: fatal error: stdafx.h: No such file or directory
    4 | #include "stdafx.h"
      |          ^~~~~~~~~~
compilation terminated.
[khartm12@integrity MOC_Grid_BDE]$

• Change: On line 4 of MOC_GridDlg.cpp, comment out dependency on stdafx.h
• Reason: stdafx.h is another Windows MFC library. It doesn't exist, and we don't want it to in order for this code to compile.

Attempt 2:

[khartm12@integrity MOC_Grid_BDE]$ g++ MOC_GridDlg.cpp -o MOC_GridDlgTest
MOC_GridDlg.cpp:4:10: fatal error: stdafx.h: No such file or directory
    4 | #include "stdafx.h"
      |          ^~~~~~~~~~
compilation terminated.
[khartm12@integrity MOC_Grid_BDE]$ g++ MOC_GridDlg.cpp -o MOC_GridDlgTest
In file included from MOC_GridDlg.cpp:5:
MOC_Grid.h:12:3: error: #error include 'stdafx.h' before including this file for PCH
   12 |  #error include 'stdafx.h' before including this file for PCH
      |   ^~~~~
MOC_GridDlg.cpp:14:10: fatal error: direct.h: No such file or directory
   14 | #include "direct.h"
      |          ^~~~~~~~~~
compilation terminated.
[khartm12@integrity MOC_Grid_BDE]$

• Still getting a compile time issue related stdafx.h, but the issue is coming from MOC_Grid.h now instead of MOC_GridDlg.cpp.
• Change: On line 5 of MOC_GridDlg.cpp, comment out the include statement for MOC_Grid.h.
• Reason: MOC_Grid.h is the main header file for the application, but doesn't appear to contain any important code blocks for calculations of MOC contours or streamlines, etc. Rather, it declares a class CMOC_GridApp of type CWinApp. While this is useful for the GUI and application, it is not necessary for the linux version we are developing. Remove it.
• Change: On line 14 of MOC_GridDlg.cpp, comment out the include statement for direct.h.
• Reason: direct.h does not exist in any of this package's three subdirectories. This is why the compiler does not find it. Here, we see some stackoverflow contributors citing wikipeadia that direct.h is a Microsoft Windows specific header file, the utilities of which replaced by including unistd.h in a linux system. I will not do this just yet. I want to first confirm that direct.h is being used in a way that unistd.h can also be used.

Attempt 3:

see compile_errors2.txt tons of compile time error, unrelated to missing header files or undeclared header files.

• Below, we see the compiler complaining about DECLARE_DYNAMIC, an MFC object which is of course not available in linux.

  MOC_GridDlg.h:18:2: error: ISO C++ forbids declaration of ‘DECLARE_DYNAMIC’ with no type [-fpermissive]
  18 |  DECLARE_DYNAMIC(CMOC_GridDlg);
    |  ^~~~~~~~~~~~~~~

  The plethora of compile-time errors further supports the idea that I should try to extract lines 503-547 from MOC_GridDlg.cpp and make a script which can run in linux, not requiring all the windows dependencies that pop up in the header files' function declarations. There will undoubtedly be more windows dependencies buried in the aforementioned lines of code, but it will at least be a smaller code base to start, and will still ultimately generate output files as the original code does.