ProcessLib::LiquidFlow Namespace Reference

Classes
struct	IntegrationPointData
struct	LiquidFlowData
class	LiquidFlowLocalAssembler
class	LiquidFlowLocalAssemblerInterface
class	LiquidFlowProcess
	A class to simulate the single phase flow process in porous media described by the governing equation: More...

Enumerations
enum class	EquationBalanceType { volume , mass }
	Governing equation balance type. More...

Functions
void	checkMPLProperties (MeshLib::Mesh const &mesh, MaterialPropertyLib::MaterialSpatialDistributionMap const &media_map, bool const is_equation_type_volume)
EquationBalanceType	covertEquationBalanceTypeFromString (std::string_view const type_in_string)
std::unique_ptr< Process >	createLiquidFlowProcess (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::vector< std::unique_ptr< MeshLib::Mesh > > const &meshes, std::map< int, std::shared_ptr< MaterialPropertyLib::Medium > > const &media)

Variables
const unsigned	NUM_NODAL_DOF = 1

Enumeration Type Documentation

EquationBalanceType

enum class ProcessLib::LiquidFlow::EquationBalanceType

strong

Governing equation balance type.

Enumerator
volume
mass

Definition at line 19 of file LiquidFlowData.h.

{
    volume,
    mass
};

Function Documentation

checkMPLProperties()

void ProcessLib::LiquidFlow::checkMPLProperties	(	MeshLib::Mesh const &	mesh,
		MaterialPropertyLib::MaterialSpatialDistributionMap const &	media_map,
		bool const	is_equation_type_volume )

Definition at line 24 of file CreateLiquidFlowProcess.cpp.

{
    MaterialPropertyLib::checkMPLPhasesForSinglePhaseFlow(mesh, media_map);
 
    std::array const required_medium_properties = {
        MaterialPropertyLib::reference_temperature,
        MaterialPropertyLib::PropertyType::permeability,
        MaterialPropertyLib::PropertyType::porosity,
        MaterialPropertyLib::PropertyType::storage};
 
    std::array const required_liquid_properties = {
        MaterialPropertyLib::PropertyType::viscosity,
        MaterialPropertyLib::PropertyType::density};
 
    // Check Constant-type density.
    if (is_equation_type_volume)
    {
        for (auto const& medium : media_map.media())
        {
            // auto const& medium = *media_map.getMedium(element_id);
            auto const& fluid_phase_density =
                fluidPhase(*medium)[MaterialPropertyLib::PropertyType::density];
            if (typeid(fluid_phase_density) !=
                typeid(MaterialPropertyLib::Constant))
            {
                OGS_FATAL(
                    "Since `equation_balance_type` is set to `volume`,the "
                    "phase density type must be `Constant`. Note: by "
                    "default, `equation_balance_type` is set to `volume`.");
            }
        }
    }
 
    for (auto const& medium : media_map.media())
    {
        checkRequiredProperties(*medium, required_medium_properties);
        checkRequiredProperties(fluidPhase(*medium),
                                required_liquid_properties);
    }
    DBUG("Media properties verified.");
}

References MaterialPropertyLib::checkMPLPhasesForSinglePhaseFlow(), DBUG(), MaterialPropertyLib::density, MaterialPropertyLib::MaterialSpatialDistributionMap::media(), OGS_FATAL, MaterialPropertyLib::permeability, MaterialPropertyLib::porosity, MaterialPropertyLib::reference_temperature, MaterialPropertyLib::storage, and MaterialPropertyLib::viscosity.

Referenced by createLiquidFlowProcess().

covertEquationBalanceTypeFromString()

EquationBalanceType ProcessLib::LiquidFlow::covertEquationBalanceTypeFromString

(

std::string_view const

type_in_string

)

Definition at line 69 of file CreateLiquidFlowProcess.cpp.

{
    if (type_in_string == "volume")
    {
        return EquationBalanceType::volume;
    }
    if (type_in_string == "mass")
    {
        return EquationBalanceType::mass;
    }
    OGS_FATAL(
        "The value of `equation_balance_type` must be either `volume` or "
        "`mass`");
};

References mass, OGS_FATAL, and volume.

Referenced by createLiquidFlowProcess().

createLiquidFlowProcess()

std::unique_ptr< Process > ProcessLib::LiquidFlow::createLiquidFlowProcess	(	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::vector< std::unique_ptr< MeshLib::Mesh > > const &	meshes,
		std::map< int, std::shared_ptr< MaterialPropertyLib::Medium > > const &	media )

Input File Parameter

prj__processes__process__type

Process Variables

Input File Parameter

prj__processes__process__LIQUID_FLOW__process_variables

Primary process variables as they appear in the global component vector:

Input File Parameter

prj__processes__process__LIQUID_FLOW__process_variables__process_variable

Process Parameters

Input File Parameter

prj__processes__process__LIQUID_FLOW__specific_body_force

Input File Parameter

prj__processes__process__calculatesurfaceflux

Input File Parameter

prj__processes__process__linear

Input File Parameter

prj__processes__process__LIQUID_FLOW__equation_balance_type

Input File Parameter

prj__processes__process__LIQUID_FLOW__aperture_size

Input File Parameter

prj__processes__process__LIQUID_FLOW__aperture_size__parameter

Definition at line 85 of file CreateLiquidFlowProcess.cpp.

{
    config.checkConfigParameter("type", "LIQUID_FLOW");
 
    DBUG("Create LiquidFlowProcess.");


    auto const pv_config = config.getConfigSubtree("process_variables");

    auto per_process_variables = findProcessVariables(
        variables, pv_config,
        {
         "process_variable"});
    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);

    std::vector<double> const b =
        config.getConfigParameter<std::vector<double>>("specific_body_force");
    int const mesh_space_dimension =
        MeshLib::getSpaceDimension(mesh.getNodes());
    if (static_cast<int>(b.size()) != mesh_space_dimension)
    {
        OGS_FATAL(
            "specific body force (gravity vector) has {:d} components, but the "
            "space dimension is {:d}.",
            b.size(), mesh_space_dimension);
    }
 
    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());
    }
 
    std::unique_ptr<ProcessLib::SurfaceFluxData> surfaceflux;
    auto calculatesurfaceflux_config =
        config.getConfigSubtreeOptional("calculatesurfaceflux");
    if (calculatesurfaceflux_config)
    {
        surfaceflux = ProcessLib::SurfaceFluxData::createSurfaceFluxData(
            *calculatesurfaceflux_config, meshes);
    }
 
    auto media_map =
        MaterialPropertyLib::createMaterialSpatialDistributionMap(media, mesh);
 
    auto const is_linear =
        config.getConfigParameter<bool>("linear", false);
    if (is_linear)
    {
        INFO("LiquidFlow process is set to be linear.");
    }
 
    auto const equation_balance_type_str =
        config.getConfigParameter<std::string>("equation_balance_type",
                                               "volume");
 
    DBUG("Check the media properties of LiquidFlow process ...");
    checkMPLProperties(mesh, media_map, equation_balance_type_str == "volume");
    DBUG("Media properties verified.");
 
    auto const* aperture_size_parameter = &ParameterLib::findParameter<double>(
        ProcessLib::Process::constant_one_parameter_name, parameters, 1);
 
    auto const aperture_config =
        config.getConfigSubtreeOptional("aperture_size");
    if (aperture_config)
    {
        aperture_size_parameter = &ParameterLib::findParameter<double>(
            *aperture_config, "parameter", parameters, 1);
    }
 
    // The uniqueness of phase has already been checked in
    // `checkMPLProperties`.
    MaterialPropertyLib::Variable const phase_variable =
        (*ranges::begin(media_map.media()))->hasPhase("Gas")
            ? MaterialPropertyLib::Variable::gas_phase_pressure
            : MaterialPropertyLib::Variable::liquid_phase_pressure;
 
    LiquidFlowData process_data{
        covertEquationBalanceTypeFromString(equation_balance_type_str),
        std::move(media_map),
        MeshLib::getElementRotationMatrices(
            mesh_space_dimension, mesh.getDimension(), mesh.getElements()),
        mesh_space_dimension,
        std::move(specific_body_force),
        has_gravity,
        *aperture_size_parameter,
        NumLib::ShapeMatrixCache{integration_order},
        phase_variable};
 
    return std::make_unique<LiquidFlowProcess>(
        std::move(name), mesh, std::move(jacobian_assembler), parameters,
        integration_order, std::move(process_variables),
        std::move(process_data), std::move(secondary_variables),
        std::move(surfaceflux), is_linear);
}

References BaseLib::ConfigTree::checkConfigParameter(), checkMPLProperties(), ProcessLib::Process::constant_one_parameter_name, covertEquationBalanceTypeFromString(), MaterialPropertyLib::createMaterialSpatialDistributionMap(), ProcessLib::createSecondaryVariables(), ProcessLib::SurfaceFluxData::createSurfaceFluxData(), DBUG(), ParameterLib::findParameter(), ProcessLib::findProcessVariables(), MaterialPropertyLib::gas_phase_pressure, BaseLib::ConfigTree::getConfigParameter(), BaseLib::ConfigTree::getConfigSubtree(), BaseLib::ConfigTree::getConfigSubtreeOptional(), MeshLib::Mesh::getDimension(), MeshLib::getElementRotationMatrices(), MeshLib::Mesh::getElements(), MeshLib::Mesh::getNodes(), MeshLib::getSpaceDimension(), INFO(), MaterialPropertyLib::liquid_phase_pressure, OGS_FATAL, and MathLib::toVector().

Referenced by ProjectData::parseProcesses().

Variable Documentation

NUM_NODAL_DOF

const unsigned ProcessLib::LiquidFlow::NUM_NODAL_DOF = 1

Definition at line 43 of file LiquidFlowLocalAssembler.h.