MaterialLib::Fracture::Permeability Namespace Reference

Classes
class	ConstantPermeability
	A constant permeability model. More...
class	CubicLaw
class	Permeability
struct	PermeabilityState

Functions
std::unique_ptr< Permeability >	createConstantPermeability (BaseLib::ConfigTree const &config)
std::unique_ptr< Permeability >	createCubicLaw (BaseLib::ConfigTree const &config)
std::unique_ptr< Permeability >	createPermeabilityModel (BaseLib::ConfigTree const &config)

Function Documentation

createConstantPermeability()

std::unique_ptr< Permeability > MaterialLib::Fracture::Permeability::createConstantPermeability

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

material__fracture_properties__permeability_model__type

Input File Parameter

material__fracture_properties__permeability_model__ConstantPermeability__value

Definition at line 18 of file CreateConstantPermeability.cpp.

{
    config.checkConfigParameter("type", "ConstantPermeability");
 
    auto const permeability =
        config.getConfigParameter<double>("value");
 
    if (permeability < 0)
    {
        OGS_FATAL(
            "The permeability parameter must be non-negative. Given value "
            "{:g}.",
            permeability);
    }
 
    return std::make_unique<ConstantPermeability>(permeability);
}

References BaseLib::ConfigTree::checkConfigParameter(), BaseLib::ConfigTree::getConfigParameter(), and OGS_FATAL.

Referenced by createPermeabilityModel().

createCubicLaw()

std::unique_ptr< Permeability > MaterialLib::Fracture::Permeability::createCubicLaw

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

material__fracture_properties__permeability_model__type

Input File Parameter

material__fracture_properties__permeability_model__CubicLaw

Definition at line 17 of file CreateCubicLaw.cpp.

{
    config.checkConfigParameter("type", "CubicLaw");
 
    return std::make_unique<CubicLaw>();
}

References BaseLib::ConfigTree::checkConfigParameter().

Referenced by createPermeabilityModel().

createPermeabilityModel()

std::unique_ptr< Permeability > MaterialLib::Fracture::Permeability::createPermeabilityModel

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

material__fracture_properties__permeability_model__type

Definition at line 19 of file CreatePermeabilityModel.cpp.

{
    auto const permeability_model_type =
        config.peekConfigParameter<std::string>("type");
    if (permeability_model_type == "ConstantPermeability")
    {
        return MaterialLib::Fracture::Permeability::createConstantPermeability(
            config);
    }
    if (permeability_model_type == "CubicLaw")
    {
        return MaterialLib::Fracture::Permeability::createCubicLaw(config);
    }
    OGS_FATAL("Unknown fracture permeability model type \"{:s}\".",
              permeability_model_type);
}

References createConstantPermeability(), createCubicLaw(), OGS_FATAL, and BaseLib::ConfigTree::peekConfigParameter().