CreateThermalTwoPhaseFlowWithPPProcess.cpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#include "CreateThermalTwoPhaseFlowWithPPProcess.h"
 
#include <cassert>
 
#include "MaterialLib/MPL/CheckMaterialSpatialDistributionMap.h"
#include "MaterialLib/MPL/CreateMaterialSpatialDistributionMap.h"
#include "ParameterLib/ConstantParameter.h"
#include "ParameterLib/Utils.h"
#include "ProcessLib/Output/CreateSecondaryVariables.h"
#include "ProcessLib/Utils/ProcessUtils.h"
#include "ThermalTwoPhaseFlowWithPPProcess.h"
#include "ThermalTwoPhaseFlowWithPPProcessData.h"
 
namespace ProcessLib
{
namespace ThermalTwoPhaseFlowWithPP
{
void checkMPLProperties(
    std::map<int, std::shared_ptr<MaterialPropertyLib::Medium>> const& media)
{
    std::array const required_property_medium = {
        MaterialPropertyLib::PropertyType::porosity,
        MaterialPropertyLib::PropertyType::permeability,
        MaterialPropertyLib::PropertyType::saturation,
        MaterialPropertyLib::PropertyType::relative_permeability,
        MaterialPropertyLib::PropertyType::
            relative_permeability_nonwetting_phase,
        MaterialPropertyLib::PropertyType::longitudinal_dispersivity,
        MaterialPropertyLib::PropertyType::transversal_dispersivity};
 
    std::array const required_property_solid_phase = {
        MaterialPropertyLib::PropertyType::specific_heat_capacity,
        MaterialPropertyLib::PropertyType::density};
 
    std::array const required_property_liquid_phase = {
        MaterialPropertyLib::PropertyType::viscosity,
        MaterialPropertyLib::PropertyType::specific_heat_capacity,
        MaterialPropertyLib::PropertyType::density};
 
    std::array const required_property_gas_phase = {
        MaterialPropertyLib::PropertyType::viscosity};
 
    std::array const required_property_vapour_component = {
        MaterialPropertyLib::specific_heat_capacity,
        MaterialPropertyLib::pore_diffusion, MaterialPropertyLib::molar_mass,
        MaterialPropertyLib::specific_latent_heat,
        MaterialPropertyLib::vapour_pressure};
 
    std::array const required_property_dry_air_component = {
        MaterialPropertyLib::specific_heat_capacity,
        MaterialPropertyLib::molar_mass};
 
    std::array const required_property_contaminant_vapour_component = {
        MaterialPropertyLib::pore_diffusion,
        MaterialPropertyLib::specific_heat_capacity,
        MaterialPropertyLib::henry_coefficient,
        MaterialPropertyLib::molar_mass};
 
    std::array const required_property_dissolved_contaminant_component = {
        MaterialPropertyLib::pore_diffusion};
 
    for (auto const& m : media)
    {
        auto const& gas_phase =
            m.second->phase(MaterialPropertyLib::PhaseName::Gas);
        auto const& liquid_phase =
            m.second->phase(MaterialPropertyLib::PhaseName::AqueousLiquid);
        checkRequiredProperties(*m.second, required_property_medium);
        checkRequiredProperties(gas_phase, required_property_gas_phase);
        checkRequiredProperties(liquid_phase, required_property_liquid_phase);
        checkRequiredProperties(
            m.second->phase(MaterialPropertyLib::PhaseName::Solid),
            required_property_solid_phase);
 
        // TODO (BM): should use index to identify components (same for impl.h)
        checkRequiredProperties(gas_phase.component("w"),
                                required_property_vapour_component);
        checkRequiredProperties(gas_phase.component("a"),
                                required_property_dry_air_component);
        checkRequiredProperties(gas_phase.component("c"),
                                required_property_contaminant_vapour_component);
        checkRequiredProperties(
            liquid_phase.component("c"),
            required_property_dissolved_contaminant_component);
    }
}
 
std::unique_ptr<Process> createThermalTwoPhaseFlowWithPPProcess(
    std::string const& 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)
{
    config.checkConfigParameter("type", "THERMAL_TWOPHASE_WITH_PP");

    DBUG("Create nonisothermal two-phase flow model.");
    auto const pv_config = config.getConfigSubtree("process_variables");

    auto per_process_variables = findProcessVariables(
        variables, pv_config,
        {
         "gas_pressure",
         "capillary_pressure",
         "total_molar_fraction_contaminant",
         "temperature"});
    std::vector<std::vector<std::reference_wrapper<ProcessVariable>>>
        process_variables;
    process_variables.push_back(std::move(per_process_variables));
 
    SecondaryVariableCollection secondary_variables;
 
    ProcessLib::createSecondaryVariables(config, secondary_variables);
    // Specific body force
    std::vector<double> const b =
        config.getConfigParameter<std::vector<double>>("specific_body_force");
    assert(!b.empty() && b.size() < 4);
    Eigen::VectorXd specific_body_force(b.size());
    bool const has_gravity = MathLib::toVector(b).norm() > 0;
    if (has_gravity)
    {
        std::copy_n(b.data(), b.size(), specific_body_force.data());
    }

    auto mass_lumping = config.getConfigParameter<bool>("mass_lumping");
 
    auto media_map =
        MaterialPropertyLib::createMaterialSpatialDistributionMap(media, mesh);
 
    DBUG("Check the media properties of ThermalTwoPhaseFlowWithPP process ...");
    checkMPLProperties(media);
    DBUG("Media properties verified.");
 
    ThermalTwoPhaseFlowWithPPProcessData process_data{
        std::move(media_map), specific_body_force, has_gravity, mass_lumping};
 
    return std::make_unique<ThermalTwoPhaseFlowWithPPProcess>(
        std::move(name), mesh, std::move(jacobian_assembler), parameters,
        integration_order, std::move(process_variables),
        std::move(process_data), std::move(secondary_variables));
}
 
}  // namespace ThermalTwoPhaseFlowWithPP
}  // namespace ProcessLib