SigmaColumn.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_SIGMA_COLUMN_HPP
#define OPENSWMM_ENGINE_2D_SIGMA_COLUMN_HPP
 
#include "SoilCharacteristic.hpp"
#include <vector>
 
namespace openswmm::twoD::sigma {

struct ColumnTransfers {
    double old_length = 0, new_length = 0, infiltration = 0, evaporation = 0;
    std::vector<double> old_water, new_water, faces, compression, support, grid, contacts;
};

struct ColumnStep {
    // ---- in ----
    double L_old = 1.0;             
    double L_new = 1.0;             
    double dt = 1.0;                
    bool forward_euler = false;     
    double grid_rate = 0.0;         
    double q_in = 0.0;              
    double wilting_suction = 150.0; 
    double et_stress = 0.0;
    double q_et = 0.0; 
    double handover_theta =
        -1.0;               
    double q0_phys = 0.0;   
    bool capillary = false; 
 
    const std::vector<double>* layer_inflow =
        nullptr;                          
    ColumnTransfers* transfers = nullptr; 
 
    // ---- out ----
    double f_top = 0.0;       
    double rejected = 0.0;    
    double f_bot = 0.0;       
    double et_taken = 0.0;    
    double theta_bot = 0.0;   
    double dt_limit = 1.0e30; 
    double overflow_to_sat = 0.0;
    double deficit_from_sat = 0.0;
};

void advanceColumn(const soil::Params& p, double* theta, int m, int stride,
                   ColumnStep& st) noexcept;

struct ColumnPreparation {
    std::vector<double> psi, conductivity, diffusivity, celerity, diffusion_bound;
    bool fixed_velocity = false;
    double dt_limit = 1.0e30;
};

void prepareColumn(const soil::Params& p, const double* theta, int m, int stride,
                   const ColumnStep& st, ColumnPreparation& prepared) noexcept;

void advanceColumn(const soil::Params& p, double* theta, int m, int stride, ColumnStep& st,
                   const ColumnPreparation& prepared) noexcept;

double columnDtLimit(const soil::Params& p, const double* theta, int m, int stride, double L,
                     double Ldot, double c_col, bool capillary) noexcept;

void seedHydrostatic(const soil::Params& p, double* theta, int m, int stride, double L) noexcept;

double columnStorage(const double* theta, int m, int stride, double L) noexcept;
 
} // namespace openswmm::twoD::sigma
 
#endif // OPENSWMM_ENGINE_2D_SIGMA_COLUMN_HPP