erf_forest_utils Namespace Reference

Functions
std::string	validate_cartesian_coordinates (bool has_x, bool has_y, bool has_lon, bool has_lat, const std::string &source)
std::string	validate_laimax (const amrex::Real laimax, const std::string &source)

Function Documentation

validate_cartesian_coordinates()

std::string erf_forest_utils::validate_cartesian_coordinates ( bool  has_x, bool  has_y, bool  has_lon, bool  has_lat, const std::string &  source  )

inline

{
    if (has_x != has_y) {
        return source + " must provide both projected Cartesian x and y coordinate variables";
    }
    if (!has_x && (has_lon || has_lat)) {
        return source + " provides lon/lat coordinates, but projected Cartesian x/y are required; "
               "no lon/lat-to-Cartesian projection is applied";
    }
    if (!has_x) {
        return source + " must provide projected Cartesian x and y coordinate variables";
    }
    return {};
}

validate_laimax()

std::string erf_forest_utils::validate_laimax ( const amrex::Real  laimax, const std::string &  source  )

inline

Return an actionable diagnostic for an invalid type-2 canopy LAI maximum. The caller supplies the source description so file-backed and input-backed errors can identify where the bad value came from without aborting here.

{
    if (std::isfinite(static_cast<double>(laimax)) &&
        laimax >= amrex::Real(0.0) && laimax < amrex::Real(1.0)) {
        return {};
    }
 
    std::ostringstream message;
    message << source << " must satisfy 0 <= laimax < 1 (got " << laimax << ")";
    return message.str();
}

Referenced by ForestDrag::ForestDrag().

Here is the caller graph for this function: