SurfaceFluxCalculator.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_SURFACE_FLUX_CALCULATOR_HPP
#define OPENSWMM_ENGINE_2D_SURFACE_FLUX_CALCULATOR_HPP
 
#include "../data/MeshData.hpp"
#include "../data/SurfaceStateData.hpp"
#include "../data/SolverOptions2D.hpp"
 
namespace openswmm::twoD {

void computeUnlimitedGradients(const MeshData& mesh, SurfaceStateData& state,
                                int nthreads = 1);

void computeLimitedGradients(const MeshData& mesh, SurfaceStateData& state,
                              double epsilon, int nthreads = 1);

inline double evapSink(double rate, double depth, double dry_depth) noexcept {
    if (rate <= 0.0 || depth <= 0.0) return 0.0;
    if (depth >= dry_depth) return rate;
    double t = depth / dry_depth;
    return rate * t * t * (3.0 - 2.0 * t);
}

inline double infilSink(double rate, double depth, double dry_depth) noexcept {
    if (rate <= 0.0 || depth <= 0.0) return 0.0;
    if (depth >= dry_depth) return rate;
    double t = depth / dry_depth;
    return rate * t * t * (3.0 - 2.0 * t);
}

double computeBoundaryEdgeFlux(const MeshData& mesh,
                               const SurfaceStateData& state,
                               const SolverOptions2D& opts,
                               double dh_eps, int i, int idx) noexcept;

void computeCellContinuity(const MeshData& mesh, SurfaceStateData& state,
                            const SolverOptions2D& opts, double dt);

void computeFaceVelocity(const MeshData& mesh, SurfaceStateData& state,
                          const SolverOptions2D& opts);
 
} // namespace openswmm::twoD
 
#endif // OPENSWMM_ENGINE_2D_SURFACE_FLUX_CALCULATOR_HPP