BHEParameterValidation.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
#include <string>
#include <string_view>
 
#include "ParameterLib/Parameter.h"
#include "ParameterLib/SpatialPosition.h"
 
namespace ProcessLib
{
namespace HeatTransportBHE
{
namespace BHE
{
struct Pipe;

double sampleStrictPositive(ParameterLib::Parameter<double> const& param,
                            double const t,
                            ParameterLib::SpatialPosition const& pos,
                            std::string_view const param_role);

std::string uTypeGeometryContext(ParameterLib::SpatialPosition const& pos,
                                 double const D,
                                 double const d0,
                                 double const distance,
                                 std::string_view const equation,
                                 std::string_view const cause);

void checkAcoshArg(double const arg, std::string_view const context);

void checkBoreholeVsPipeDiameter(double const D,
                                 double const min_diameter,
                                 ParameterLib::SpatialPosition const& pos,
                                 std::string_view const context);

double checkedGroutArea(double const borehole_area_fraction,
                        double const pipe_outside_area,
                        ParameterLib::SpatialPosition const& pos);

void checkEqualPipeOutsideDiameters(Pipe const& inlet, Pipe const& outlet,
                                    std::string_view const context);

void validateScalarTimeInvariantBHEParameter(
    ParameterLib::Parameter<double> const& param, std::string_view const role);
}  // namespace BHE
}  // namespace HeatTransportBHE
}  // namespace ProcessLib