Classes
struct	IntegrationPointData

struct	ReservoirProperties

struct	WellboreGeometry

class	WellboreSimulatorFEM

class	WellboreSimulatorLocalAssemblerInterface

class	WellboreSimulatorProcess

struct	WellboreSimulatorProcessData

Functions
void	checkMPLProperties (MeshLib::Mesh const &mesh, MaterialPropertyLib::MaterialSpatialDistributionMap const &media_map)

std::unique_ptr< Process >	createWellboreSimulatorProcess (std::string name, MeshLib::Mesh &mesh, std::unique_ptr< ProcessLib::AbstractJacobianAssembler > &&jacobian_assembler, std::vector< ProcessVariable > const &variables, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters, unsigned const integration_order, BaseLib::ConfigTree const &config, std::map< int, std::shared_ptr< MaterialPropertyLib::Medium > > const &media)

ReservoirProperties	createReservoirProperties (BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)

WellboreGeometry	createWellboreGeometry (BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)

Variables
const unsigned	NUM_NODAL_DOF = 3

Function Documentation

◆ checkMPLProperties()

void ProcessLib::WellboreSimulator::checkMPLProperties	(	MeshLib::Mesh const &	mesh,
		MaterialPropertyLib::MaterialSpatialDistributionMap const &	media_map )

Definition at line 30 of file CreateWellboreSimulatorProcess.cpp.

{
    std::array<MaterialPropertyLib::PropertyType, 0> const
        required_property_medium{};
 
    std::array<MaterialPropertyLib::PropertyType, 0> const
        required_property_solid_phase{};
 
    std::array const required_property_liquid_phase = {
        MaterialPropertyLib::PropertyType::viscosity,
        MaterialPropertyLib::PropertyType::density,
        MaterialPropertyLib::PropertyType::saturation_density,
        MaterialPropertyLib::PropertyType::saturation_enthalpy,
        MaterialPropertyLib::PropertyType::temperature,
        MaterialPropertyLib::PropertyType::enthalpy};
 
    std::array const required_property_gas_phase = {
        MaterialPropertyLib::PropertyType::saturation_density,
        MaterialPropertyLib::PropertyType::saturation_enthalpy,
        MaterialPropertyLib::PropertyType::saturation_temperature,
        MaterialPropertyLib::PropertyType::viscosity};
 
    MaterialPropertyLib::checkMaterialSpatialDistributionMap(
        mesh, media_map, required_property_medium,
        required_property_solid_phase, required_property_liquid_phase,
        required_property_gas_phase);
}

References MaterialPropertyLib::checkMaterialSpatialDistributionMap(), MaterialPropertyLib::density, MaterialPropertyLib::enthalpy, MaterialPropertyLib::saturation_density, MaterialPropertyLib::saturation_enthalpy, MaterialPropertyLib::saturation_temperature, MaterialPropertyLib::temperature, and MaterialPropertyLib::viscosity.

Referenced by createWellboreSimulatorProcess().

◆ createReservoirProperties()

ReservoirProperties ProcessLib::WellboreSimulator::createReservoirProperties	(	BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Input File Parameter: prj__processes__process__WELLBORE_SIMULATOR__reservoir_properties__temperature

Input File Parameter: prj__processes__process__WELLBORE_SIMULATOR__reservoir_properties__thermal_conductivity

Input File Parameter: prj__processes__process__WELLBORE_SIMULATOR__reservoir_properties__density

Input File Parameter: prj__processes__process__WELLBORE_SIMULATOR__reservoir_properties__specific_heat_capacity

Input File Parameter: prj__processes__process__WELLBORE_SIMULATOR__reservoir_properties__pressure

Definition at line 20 of file ReservoirProperties.cpp.

{
    auto const& temperature = ParameterLib::findParameter<double>(
        config.getConfigParameter<std::string>("temperature"),
        parameters,
        1,
        nullptr);
 
    auto const& thermal_conductivity = ParameterLib::findParameter<double>(
        config.getConfigParameter<std::string>("thermal_conductivity"),
        parameters,
        1,
        nullptr);
 
    auto const& density = ParameterLib::findParameter<double>(
        config.getConfigParameter<std::string>("density"),
        parameters,
        1,
        nullptr);
 
    auto const& specific_heat_capacity = ParameterLib::findParameter<double>(
        config.getConfigParameter<std::string>("specific_heat_capacity"),
        parameters,
        1,
        nullptr);
 
    auto const& pressure = ParameterLib::findParameter<double>(
        config.getConfigParameter<std::string>("pressure"),
        parameters,
        1,
        nullptr);
 
    return {temperature, thermal_conductivity, density, specific_heat_capacity,
            pressure};
}

References ParameterLib::findParameter(), and BaseLib::ConfigTree::getConfigParameter().

Referenced by createWellboreSimulatorProcess().

◆ createWellboreGeometry()

WellboreGeometry ProcessLib::WellboreSimulator::createWellboreGeometry	(	BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Input File Parameter: prj__processes__process__WELLBORE_SIMULATOR__wellbore__length

Input File Parameter: prj__processes__process__WELLBORE_SIMULATOR__wellbore__diameter

Input File Parameter: prj__processes__process__WELLBORE_SIMULATOR__wellbore__casing_thickness

Input File Parameter: prj__processes__process__WELLBORE_SIMULATOR__wellbore__pipe_thickness

Input File Parameter: prj__processes__process__WELLBORE_SIMULATOR__wellbore__roughness

Definition at line 22 of file WellboreGeometry.cpp.

{
    double const length =
        config.getConfigParameter<double>("length");
 
    auto const& diameter = ParameterLib::findParameter<double>(
        config.getConfigParameter<std::string>("diameter"),
        parameters,
        1,
        nullptr);
 
    auto const& casing_thickness = ParameterLib::findParameter<double>(
        config.getConfigParameter<std::string>("casing_thickness"),
        parameters,
        1,
        nullptr);
 
    auto const& pipe_thickness = ParameterLib::findParameter<double>(
        config.getConfigParameter<std::string>("pipe_thickness"),
        parameters,
        1,
        nullptr);
 
    auto const& roughness = ParameterLib::findParameter<double>(
        config.getConfigParameter<std::string>("roughness"),
        parameters,
        1,
        nullptr);
 
    return {length, diameter, casing_thickness, pipe_thickness, roughness};
}

References ParameterLib::findParameter(), and BaseLib::ConfigTree::getConfigParameter().

Referenced by createWellboreSimulatorProcess().

◆ createWellboreSimulatorProcess()

std::unique_ptr< Process > ProcessLib::WellboreSimulator::createWellboreSimulatorProcess	(	std::string	name,
		MeshLib::Mesh &	mesh,
		std::unique_ptr< ProcessLib::AbstractJacobianAssembler > &&	jacobian_assembler,
		std::vector< ProcessVariable > const &	variables,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters,
		unsigned const	integration_order,
		BaseLib::ConfigTree const &	config,
		std::map< int, std::shared_ptr< MaterialPropertyLib::Medium > > const &	media )

Input File Parameter: prj__processes__process__type

Input File Parameter: prj__processes__process__WELLBORE_SIMULATOR__process_variables

Input File Parameter: prj__processes__process__WELLBORE_SIMULATOR__process_variables__pressure

Input File Parameter: prj__processes__process__WELLBORE_SIMULATOR__process_variables__velocity

Input File Parameter: prj__processes__process__WELLBORE_SIMULATOR__process_variables__enthalpy

Input File Parameter: prj__processes__process__WELLBORE_SIMULATOR__specific_body_force

Input File Parameter: prj__processes__process__WELLBORE_SIMULATOR__wellbore

Input File Parameter: prj__processes__process__WELLBORE_SIMULATOR__wellbore_ref_pressure

Input File Parameter: prj__processes__process__WELLBORE_SIMULATOR__wellbore_ref_enthalpy

Input File Parameter: prj__processes__process__WELLBORE_SIMULATOR__heat_exchange_with_formation

Input File Parameter: prj__processes__process__WELLBORE_SIMULATOR__reservoir_properties

Input File Parameter: prj__processes__process__WELLBORE_SIMULATOR__productivity_index

Definition at line 60 of file CreateWellboreSimulatorProcess.cpp.

{
    config.checkConfigParameter("type", "WELLBORE_SIMULATOR");
 
    DBUG("Create WellboreSimulatorProcess.");
 
    // Process variable.
 
    auto const pv_config = config.getConfigSubtree("process_variables");
 
    std::vector<std::vector<std::reference_wrapper<ProcessVariable>>>
        process_variables;
 
    auto collected_process_variables = findProcessVariables(
        variables, pv_config,
        {
         "pressure",
         "velocity",
         "specific_enthalpy"});
 
    process_variables.push_back(std::move(collected_process_variables));
 
    // Specific body force parameter.
    Eigen::VectorXd specific_body_force;
    std::vector<double> const b =
        config.getConfigParameter<std::vector<double>>("specific_body_force");
    assert(!b.empty() && b.size() < 4);
    if (b.size() < mesh.getDimension())
    {
        OGS_FATAL(
            "specific body force (gravity vector) has %d components, mesh "
            "dimension is %d",
            b.size(), mesh.getDimension());
    }
    bool const has_gravity = MathLib::toVector(b).norm() > 0;
    if (has_gravity)
    {
        specific_body_force.resize(b.size());
        std::copy_n(b.data(), b.size(), specific_body_force.data());
    }
 
    WellboreGeometry const wellbore_geometry =
        createWellboreGeometry(config.getConfigSubtree("wellbore"), parameters);
 
    auto const& well_ref_pressure = ParameterLib::findParameter<double>(
        config,
        "wellbore_ref_pressure", parameters, 1, &mesh);
    DBUG("Use '{:s}' as wellbore_ref_pressure parameter.",
         well_ref_pressure.name);
 
    auto const& well_ref_enthalpy = ParameterLib::findParameter<double>(
        config,
        "wellbore_ref_enthalpy", parameters, 1, &mesh);
    DBUG("Use '{:s}' as wellbore_ref_enthalpy parameter.",
         well_ref_enthalpy.name);
 
    auto const heat_exchange_with_formation =
        config.getConfigParameter<bool>("heat_exchange_with_formation", false);
 
    ReservoirProperties const reservoir_properties = createReservoirProperties(
        config.getConfigSubtree("reservoir_properties"), parameters);
 
    auto const& productivity_index = ParameterLib::findParameter<double>(
        config,
        "productivity_index", parameters, 1, &mesh);
    DBUG("Use '{:s}' as productivity_index parameter.",
         productivity_index.name);
 
    auto media_map =
        MaterialPropertyLib::createMaterialSpatialDistributionMap(media, mesh);
 
    DBUG("Check the media properties of WellboreSimulator process ...");
    checkMPLProperties(mesh, media_map);
    DBUG("Media properties verified.");
 
    WellboreSimulatorProcessData process_data{std::move(media_map),
                                              specific_body_force,
                                              std::move(wellbore_geometry),
                                              well_ref_pressure,
                                              well_ref_enthalpy,
                                              std::move(reservoir_properties),
                                              productivity_index,
                                              heat_exchange_with_formation,
                                              has_gravity};
 
    SecondaryVariableCollection secondary_variables;
 
    ProcessLib::createSecondaryVariables(config, secondary_variables);
 
    return std::make_unique<WellboreSimulatorProcess>(
        std::move(name), mesh, std::move(jacobian_assembler), parameters,
        integration_order, std::move(process_variables),
        std::move(process_data), std::move(secondary_variables));
}

References BaseLib::ConfigTree::checkConfigParameter(), checkMPLProperties(), MaterialPropertyLib::createMaterialSpatialDistributionMap(), createReservoirProperties(), ProcessLib::createSecondaryVariables(), createWellboreGeometry(), DBUG(), ParameterLib::findParameter(), ProcessLib::findProcessVariables(), BaseLib::ConfigTree::getConfigParameter(), BaseLib::ConfigTree::getConfigSubtree(), MeshLib::Mesh::getDimension(), OGS_FATAL, and MathLib::toVector().

Referenced by ProjectData::parseProcesses().

Variable Documentation

◆ NUM_NODAL_DOF

const unsigned ProcessLib::WellboreSimulator::NUM_NODAL_DOF = 3

Definition at line 35 of file WellboreSimulatorFEM.h.

Referenced by ProcessLib::WellboreSimulator::WellboreSimulatorFEM< ShapeFunction, GlobalDim >::assemble().

Classes

Functions

Variables

Function Documentation

◆ checkMPLProperties()

◆ createReservoirProperties()

◆ createWellboreGeometry()

◆ createWellboreSimulatorProcess()

Variable Documentation

◆ NUM_NODAL_DOF