meshinfil.h

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
//
// Copyright 2026 Caleb Buahin
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#ifndef OPENSWMMVIS_MESHINFIL_H
#define OPENSWMMVIS_MESHINFIL_H
 
#include <QByteArray>
#include <QHash>
#include <QString>
#include <QStringList>
#include <QVector>
#include <QtGlobal>
#include <QtNumeric>
 
namespace mesh {
 
struct MeshResult;
 
enum class InfilMethod : int {
    None          = -1,
    Horton        = 0,
    ModHorton     = 1,
    GreenAmpt     = 2,
    ModGreenAmpt  = 3,
    CurveNumber   = 4,
    Constant      = 5
};
 
enum class InfilDest : int {
    Lost            = 0,   
    SubcatchAquifer = 1,   
    Aquifer2D       = 2    
};
 
inline constexpr int kInfilMaxParams = 5;
 
struct InfilRow
{
    InfilMethod method = InfilMethod::None;
    double      p[kInfilMaxParams] = {qQNaN(), qQNaN(), qQNaN(), qQNaN(), qQNaN()};
    InfilDest   dest   = InfilDest::Lost;
 
    bool isNone() const { return method == InfilMethod::None; }
    bool operator==(const InfilRow &o) const;
    bool operator!=(const InfilRow &o) const { return !(*this == o); }
};
 
struct InfilDefaultRow
{
    QString  tag;
    InfilRow row;
};
 
struct InfilOptions
{
    double infilStep = 0.0;
};
 
enum class InfilProvenance : int {
    None     = 0,   
    Star     = 1,   
    Tag      = 2,   
    Override = 3    
};
 
struct ResolvedInfil
{
    InfilRow        row;
    InfilProvenance provenance = InfilProvenance::None;
    QString         sourceTag;              
 
    bool isOverride() const { return provenance == InfilProvenance::Override; }
    bool isInherited() const
    { return provenance == InfilProvenance::Tag || provenance == InfilProvenance::Star; }
};
 
// ---------------------------------------------------------------------------
// Resolution
// ---------------------------------------------------------------------------
 
ResolvedInfil resolveInfil(const MeshResult &mesh, int tri);
 
InfilRow starDefault(const MeshResult &mesh);
 
int indexOfDefault(const MeshResult &mesh, const QString &tag);
 
// ---------------------------------------------------------------------------
// Method ↔ parameter masks
// ---------------------------------------------------------------------------
 
bool infilUsesParam(InfilMethod method, int slot);
 
int infilParamCount(InfilMethod method);
 
QString infilParamLabel(InfilMethod method, int slot);
 
QByteArray infilParamKey(InfilMethod method, int slot);
 
int infilSlotForKey(InfilMethod method, const QByteArray &key);
 
const QVector<QByteArray> &infilParamKeys();
 
// ---------------------------------------------------------------------------
// Tokens (must match the engine exactly)
// ---------------------------------------------------------------------------
 
QString     infilMethodToken(InfilMethod m);      
InfilMethod infilMethodFromToken(const QString &token, bool *ok = nullptr);
QString     infilMethodLabel(InfilMethod m);      
QStringList infilMethodLabels();                  
 
QString   infilDestToken(InfilDest d);            
InfilDest infilDestFromToken(const QString &token, bool *ok = nullptr);
QString   infilDestLabel(InfilDest d);
QStringList infilDestLabels();
 
QString infilDestHint(InfilDest d);
 
// ---------------------------------------------------------------------------
// Classified-lookup tables (GUI plan §3.4(a))
// ---------------------------------------------------------------------------
 
struct InfilLookupEntry
{
    QString  key1;
    QString  key2;    
    InfilRow row;
};
 
struct InfilLookupTable
{
    QString                   name;
    bool                      twoKey = false;
    QString                   key1Label;
    QString                   key2Label;
    QVector<InfilLookupEntry> entries;
    InfilRow                  fallback;   
 
    InfilRow lookup(const QString &k1, const QString &k2, bool *matched = nullptr) const;
};
 
bool saveLookupTableCsv(const InfilLookupTable &table, const QString &path, QString *err);
bool loadLookupTableCsv(InfilLookupTable *table, const QString &path, QString *err);
 
} // namespace mesh
 
#endif // OPENSWMMVIS_MESHINFIL_H