Skip to content

w07-g02-CGsolver-inherited

Inherited Conjugate Gradient Solver (CGsolver) Class

Objective

The overall objective of this assignment is to implement a abstract nonlinear solver class NLsolver, and make the current conjugate gradient solver CGsolver inheritated from the parent class NLsolver. The newton-raphson solver class NRsolver will be another child class of NLsolver. This abstract solver class makes it possible to extend the project with more solvers without the need of modifying other classes.

Here, you need to implement an abstract nonlinear solver class NLsolver in tehpc/src/nonlinear_solver.hpp. Then you need to modify the conjugate gradient class CGsolver in tehpc/src/conjugate_gradient_solver (both .hpp and .cpp) into a child class of NLsolver. Move as much functionality as possible while keeping the NLsolver class general enough to allow also the NRsolver to inherit from it.

Implementation

  1. load appropriate modules by performing the following command in your terminal: source tehpc/tools/tehpc_load_modules.sh.

  2. If nonlinear_solver.hpp is not already included at the appropriate place in tehpc/src/CMakeLists.txt, add it. This makes sure that it is compiled.

  3. Add tehpc_add_test(NLsolver_test) in the tehpc/tests/CMakeLists.txt to include the NLsolver_test in compilation.

  4. Compile your code, use the following steps:

    a. go into tehpc/build/

    b. type: cmake -DCMAKE_BUILD_TYPE:STRING=Debug -DTEHPC_TESTS:STRING=ON .. or use ccmake .. to configure (you only have to do this the very first time).

    c. type: make (do this whenever you want to recompile).

  5. Implement the nonlinear solver class NLsolver in tehpc/src/nonlinear_solver.hpp and modify the conjugate gradient solver CGsolver into a child class of NLsolver. Correct all compilation errors.

    a. compare CGsolver and NRsolver, move the shared part into the NLsolver, including the #include directive, members and member functions.

    b. make CGsolver inheritated from NLsolver. The use of virtual function could help. Pay attention to the constructor and destructor.

    c. read tehpc/tests/NLsolver_test.cpp, especially the function that has a pointer to the abstract class as one of its arguments, and compare the way of creating an object to last week.

    d. If you have enough time, repeat the procees of making CGsolver inheritating from NLsolver by applying it also on NRsolver. Otherwise, you might need to comment the part regarding NRsolver in the NLsolver_test.cpp.

  6. If the code compiles without errors, run the test NLsolver_test:

    a. go into tehpc/build/tests/

    b. type: ./NLsolver_test cg

  7. Make sure that the test runs without error and returns success.

  8. run valgrind to check for memory leakage: valgrind --leak-check=full ./NLsolver_test cg. Correct memory leakage if you encounter this problem.

  9. Make sure that your code is well structured and commented.

  10. Generate the doxygen software catalogue for the entire project:

    a. go into tehpc/build/

    b. type: ccmake . and switch on the option for TEHPC_DOC, and configure with c and generate with g

    c. type: make

    d. download the generated catalogue files in tehpc/build/docs/doxygen to your local computer and view it.

    e. IMPORTANT: you can use the same approach for your project (i.e. stage II) for that, you need to copy the Doxygen part of tehpc/CMakeLists.txt to your-project/CMakeLists.txt, and copy the tehpc/docs/CMakeLists.txt and tehpc/docs/Doxyfile.in to the equivalent directories of your project.