max/tug
1
0
Fork 0
mirror of https://git.gfz-potsdam.de/naaice/tug.git synced 2025-12-15 18:38:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

refactor: Change enums to scoped enums and simplify output option validation

Browse Source
This commit is contained in:
Max Luebke 2024-12-11 19:56:54 +01:00
parent 477d943bf0
commit 5c68f8b6b2
1 changed files with 20 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
include/tug/Core/BaseSimulation.hpp
View File

@ -1,10 +1,9 @@
#pragma once #pragma once
#include "tug/Core/TugUtils.hpp"
#include <cstddef> #include <cstddef>
#include <cstdint> #include <cstdint>
#include <iterator>
#include <tug/Core/Matrix.hpp> #include <tug/Core/Matrix.hpp>
#include <tug/Core/TugUtils.hpp>
namespace tug { namespace tug {
@ -12,11 +11,11 @@ namespace tug {
* @brief Enum holding different options for .csv output. * @brief Enum holding different options for .csv output.
* *
*/ */
enum CSV_OUTPUT { enum class CSV_OUTPUT {
CSV_OUTPUT_OFF, /*!< do not produce csv output */ OFF, /*!< do not produce csv output */
CSV_OUTPUT_ON, /*!< produce csv output with last concentration matrix */ ON, /*!< produce csv output with last concentration matrix */
CSV_OUTPUT_VERBOSE, /*!< produce csv output with all concentration matrices */ VERBOSE, /*!< produce csv output with all concentration matrices */
CSV_OUTPUT_XTREME /*!< csv output like VERBOSE but additional boundary XTREME /*!< csv output like VERBOSE but additional boundary
conditions at beginning */ conditions at beginning */
}; };
@ -24,26 +23,26 @@ enum CSV_OUTPUT {
* @brief Enum holding different options for console output. * @brief Enum holding different options for console output.
* *
*/ */
enum CONSOLE_OUTPUT { enum class CONSOLE_OUTPUT {
CONSOLE_OUTPUT_OFF, /*!< do not print any output to console */ OFF, /*!< do not print any output to console */
CONSOLE_OUTPUT_ON, /*!< print before and after concentrations to console */ ON, /*!< print before and after concentrations to console */
CONSOLE_OUTPUT_VERBOSE /*!< print all concentration matrices to console */ VERBOSE /*!< print all concentration matrices to console */
}; };
/** /**
* @brief Enum holding different options for time measurement. * @brief Enum holding different options for time measurement.
* *
*/ */
enum TIME_MEASURE { enum class TIME_MEASURE {
TIME_MEASURE_OFF, /*!< do not print any time measures */ OFF, /*!< do not print any time measures */
TIME_MEASURE_ON /*!< print time measure after last iteration */ ON /*!< print time measure after last iteration */
}; };
template <typename T> class BaseSimulationGrid { template <typename T> class BaseSimulationGrid {
protected: protected:
CSV_OUTPUT csv_output{CSV_OUTPUT_OFF}; CSV_OUTPUT csv_output{CSV_OUTPUT::OFF};
CONSOLE_OUTPUT console_output{CONSOLE_OUTPUT_OFF}; CONSOLE_OUTPUT console_output{CONSOLE_OUTPUT::OFF};
TIME_MEASURE time_measure{TIME_MEASURE_OFF}; TIME_MEASURE time_measure{TIME_MEASURE::OFF};
int iterations{1}; int iterations{1};
RowMajMatMap<T> concentration_matrix; RowMajMatMap<T> concentration_matrix;
@ -109,13 +108,7 @@ public:
* - CSV_OUTPUT_XTREME: produce csv output with all * - CSV_OUTPUT_XTREME: produce csv output with all
* concentration matrices and simulation environment * concentration matrices and simulation environment
*/ */
void setOutputCSV(CSV_OUTPUT csv_output) { void setOutputCSV(CSV_OUTPUT csv_output) { this->csv_output = csv_output; }
if (csv_output < CSV_OUTPUT_OFF && csv_output > CSV_OUTPUT_VERBOSE) {
throw std::invalid_argument("Invalid CSV output option given!");
}
this->csv_output = csv_output;
}
/** /**
* @brief Set the options for outputting information to the console. Off by * @brief Set the options for outputting information to the console. Off by
@ -131,11 +124,6 @@ public:
* matrices to console * matrices to console
*/ */
void setOutputConsole(CONSOLE_OUTPUT console_output) { void setOutputConsole(CONSOLE_OUTPUT console_output) {
if (console_output < CONSOLE_OUTPUT_OFF &&
console_output > CONSOLE_OUTPUT_VERBOSE) {
throw std::invalid_argument("Invalid console output option given!");
}
this->console_output = console_output; this->console_output = console_output;
} }
@ -149,10 +137,6 @@ public:
* console * console
*/ */
void setTimeMeasure(TIME_MEASURE time_measure) { void setTimeMeasure(TIME_MEASURE time_measure) {
if (time_measure < TIME_MEASURE_OFF && time_measure > TIME_MEASURE_ON) {
throw std::invalid_argument("Invalid time measure option given!");
}
this->time_measure = time_measure; this->time_measure = time_measure;
} }
@ -163,10 +147,9 @@ public:
* @param iterations Number of iterations to be simulated. * @param iterations Number of iterations to be simulated.
*/ */
void setIterations(int iterations) { void setIterations(int iterations) {
if (iterations <= 0) { tug_assert(iterations > 0,
throw std::invalid_argument( "Number of iterations must be greater than zero.");
"Number of iterations must be greater than zero.");
}
this->iterations = iterations; this->iterations = iterations;
} }