twodpage.h

Go to the documentation of this file.

 
#ifndef TWODPAGE_H
#define TWODPAGE_H
 
#ifdef OPENSWMM_HAS_2D
 
#include <functional>
 
#include "ui/dialogs/simoptions/simoptionspage.h"
 
class QCheckBox;
class QComboBox;
class QDoubleSpinBox;
class QGroupBox;
class QLabel;
class QLineEdit;
class QListWidget;
class QPushButton;
class QSpinBox;
class QTabWidget;
class QCustomTimespanEdit;
 
namespace openswmmvis::ui
{
 
class TwoDPage : public SimOptionsPage
{
    Q_OBJECT
 
public:
    explicit TwoDPage(SimOptionsContext &ctx, QWidget *parent = nullptr);
 
    [[nodiscard]] QString title() const override;
    void read() override;
    int  write() override;
    void refreshGates() override;
 
    enum Tab { TabHydrodynamics = 0, TabWetDry, TabCoupling, TabProcesses, TabOutput };
 
    [[nodiscard]] QTabWidget *tabs() const { return m_tabs; }
 
    struct ScheduleHooks {
        std::function<qint64()> wetStepSeconds;
        std::function<qint64()> reportStepSeconds;
        std::function<qint64()> durationSeconds;
    };
    void setScheduleHooks(ScheduleHooks hooks);
 
    [[nodiscard]] bool transport2DEnabled(int speciesClass) const;
    void setTransport2DEnabled(int speciesClass, bool on);
 
public slots:
    void scheduleChanged();
 
signals:
    void transportSelectionChanged();
    void engineEditedDirectly();
 
private:
    void buildUi();
    void tagWidgets();
    void updateOutputSizeEstimate();
    [[nodiscard]] unsigned reportVarsMask() const;
    void     setReportVarsMask(unsigned mask);
    [[nodiscard]] QString reportSpeciesText() const;   
    void     setReportSpeciesText(const QString &text);
 
    QTabWidget *m_tabs = nullptr;
    ScheduleHooks m_schedule;
 
    QDoubleSpinBox *m_maxTimestepSpin   = nullptr;
    QGroupBox      *m_marcherGroup      = nullptr;
    QDoubleSpinBox *m_thetaSpin         = nullptr;
    QDoubleSpinBox *m_cflNumberSpin     = nullptr;
    QSpinBox       *m_ltsTiersSpin      = nullptr;
    QDoubleSpinBox *m_hMoveSpin         = nullptr;
    QDoubleSpinBox *m_froudeMaxSpin     = nullptr;
    QComboBox      *m_momentum2DCombo   = nullptr;   
    QSpinBox       *m_reconOrder2DSpin  = nullptr;   
    QCheckBox      *m_advection2DBox    = nullptr;
    QComboBox      *m_backend2DCombo    = nullptr;   
    QCheckBox      *m_couplingAreaAutoBox = nullptr;
    QDoubleSpinBox *m_dryDepthSpin      = nullptr;
    QDoubleSpinBox *m_limiterEpsSpin    = nullptr;
    QDoubleSpinBox *m_fluxDhEpsSpin     = nullptr;
    QComboBox      *m_cellClosureCombo  = nullptr;
    QComboBox      *m_faceReconCombo    = nullptr;
    QDoubleSpinBox *m_vfrMinWetFracSpin = nullptr;
    QDoubleSpinBox *m_couplingCdSpin    = nullptr;
    QDoubleSpinBox *m_couplingSyncSpin  = nullptr;
    QComboBox      *m_rainfall2DModeCombo = nullptr;
    QCheckBox      *m_report2DBox       = nullptr;
    QLineEdit      *m_output2DFileEdit  = nullptr;
 
    // E1 — OUTPUT_PRECISION / OUTPUT_COMPRESSION / REPORT_2D_STEP /
    // REPORT_2D_VARIABLES / REPORT_2D_SPECIES.
    QComboBox      *m_output2DPrecisionCombo   = nullptr;
    QSpinBox       *m_output2DCompressionSpin  = nullptr;
    QCheckBox      *m_report2DStepSameBox      = nullptr;  
    QCustomTimespanEdit *m_report2DStepEdit    = nullptr;
    QListWidget    *m_report2DVarsList         = nullptr;  
    QCheckBox      *m_report2DAllSpeciesBox    = nullptr;  
    QListWidget    *m_report2DSpeciesList      = nullptr;  
    QLabel         *m_output2DSizeLabel        = nullptr;  
 
    // U1 — Processes group ([2D_OPTIONS] process keys, E2).
    QComboBox           *m_infil2DModeCombo    = nullptr;  
    QCheckBox           *m_infil2DStepSameBox  = nullptr;  
    QCustomTimespanEdit *m_infil2DStepEdit     = nullptr;
    QComboBox           *m_infil2DMethodCombo  = nullptr;
    QComboBox           *m_infil2DDestCombo    = nullptr;
    QPushButton         *m_editInfilCellsBtn   = nullptr;
    QComboBox           *m_evap2DCombo         = nullptr;  
    QCheckBox           *m_transport2DBox[4]   = {nullptr, nullptr, nullptr, nullptr};
 
    // U5 — the Groundwater group: [2D_OPTIONS] GROUNDWATER / GW_ET, plus the
    // Transport summary naming the [GW_*] authoring surface (U4).
    QGroupBox   *m_gw2DGroup       = nullptr;
    QComboBox   *m_gw2DEnableCombo = nullptr;
    QComboBox   *m_gw2DEtCombo     = nullptr;
    QLabel      *m_gw2DStatusLabel = nullptr;
    QPushButton *m_gw2DEditBtn     = nullptr;
};
 
} // namespace openswmmvis::ui
 
#endif // OPENSWMM_HAS_2D
 
#endif // TWODPAGE_H