added some commentary with questions and TODOs

This commit is contained in:
philippun 2023-05-31 13:49:13 +02:00
parent 165e72e978
commit 2d9d318981
2 changed files with 4 additions and 0 deletions

View File

@ -32,6 +32,7 @@ enum {
/**
* Defines the boundary condition type and according value.
* QUESTION: For what is the struct bc necessary?
*/
typedef struct boundary_condition_s {
bctype type; /**< Type of the boundary condition */
@ -197,6 +198,7 @@ private:
enum { X_DIM, Y_DIM };
// TODO combine the 'public' blocks
public:
/**
* Returns the left/right boundary condition for 1D grid.

View File

@ -15,6 +15,8 @@ constexpr uint8_t MAX_ARR_SIZE = 3;
/**
* Defines grid dimensions and boundary conditions.
* QUESTION: why is TugGrid a separate struct? For conceptual reasons?
* why not combine TugGrid and TugInput?
*/
typedef struct tug_grid_s {
std::array<uint32_t, MAX_ARR_SIZE>