GwTransportData.hpp

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 OPENSWMM_ENGINE_2D_GW_TRANSPORT_DATA_HPP
#define OPENSWMM_ENGINE_2D_GW_TRANSPORT_DATA_HPP
 
#include <cstdint>
#include <string>
#include <vector>
 
namespace openswmm::twoD {

enum class GwZone : int8_t {
    SAT   = 0,   
    UNSAT = 1,   
    LAYER = 2    
};

enum class GwScope : int8_t {
    GLOBAL = 0,  
    TAG    = 1,  
    CELL   = 2   
};

struct GwTransportOptions {
    bool transport_pollutants  = true;
    bool transport_msx         = true;
    bool transport_age         = true;
    bool transport_temperature = true;
    bool dispersion            = true;   
    bool conduction            = true;   
    std::string surface_thermal_bc = "AIR";
    std::string surface_thermal_arg;
    std::string deep_thermal_bc = "GEOTHERMAL_FLUX";
    std::string deep_thermal_arg;
    double      deep_depth = 0.0;
    std::string thermal_mixing = "ARITHMETIC";
    double c_diff = 0.4;
    bool authored = false;
};

struct GwParamsRow {
    GwScope     scope = GwScope::GLOBAL;
    std::string tag;              
    int         cell = -1;        
    double rho_s    = 2650.0;     
    double c_s      = 880.0;      
    double lambda_s = 2.0;        
    double a_s      = 0.0;        
    double alpha_L  = 1.0;        
    double alpha_T  = 0.1;        
    double D_m      = 1.0e-9;     
    double D_v      = 1.0e-9;     
    double geo_flux = 0.065;      
};

struct GwSorptionRow {
    GwScope     scope = GwScope::GLOBAL;
    std::string tag;
    int         cell = -1;
    std::string species;
    double      kd    = 0.0;      
    double      decay = -1.0;     
};

struct GwInitialQualityRow {
    GwScope     scope = GwScope::GLOBAL;
    std::string tag;
    int         cell  = -1;
    GwZone      zone  = GwZone::SAT;
    int         layer = -1;       
    std::string species;
    double      value = 0.0;
};

struct GwBoundaryQualityRow {
    int         cell    = -1;     
    int         edge    = -1;     
    std::string species;
    std::string kind    = "CONC";
    double      value   = 0.0;    
    std::string ts_name;          
};

struct GwSourceSpeciesTerm {
    std::string species;
    std::string kind = "CONC";    
    double      value = 0.0;
    std::string ts_name;
};

struct GwSourceRow {
    std::string name;
    GwScope     scope = GwScope::CELL;   
    std::string tag;
    int         cell = -1;
    double      x = 0.0, y = 0.0;        
    bool        by_xy = false;
    double      flow = 0.0;              
    std::string flow_ts;                 
    std::vector<GwSourceSpeciesTerm> species;
};

struct GwTransportData {
    GwTransportOptions               options;
    std::vector<GwParamsRow>         params;
    std::vector<GwSorptionRow>       sorption;
    std::vector<GwInitialQualityRow> initial_quality;
    std::string                      initial_quality_file;
    std::vector<GwBoundaryQualityRow> boundary_quality;
    std::vector<GwSourceRow>         sources;
 
    bool empty() const noexcept {
        return !options.authored && params.empty() && sorption.empty() &&
               initial_quality.empty() && initial_quality_file.empty() &&
               boundary_quality.empty() && sources.empty();
    }
 
    void clear() { *this = GwTransportData{}; }
};
 
const char* gwZoneToken(GwZone z) noexcept;
bool        parseGwZone(const std::string& token, GwZone& z) noexcept;
const char* gwScopeToken(GwScope s) noexcept;
 
}  // namespace openswmm::twoD
 
#endif  // OPENSWMM_ENGINE_2D_GW_TRANSPORT_DATA_HPP