Source code for ogs5py.fileclasses.mmp.core

# -*- coding: utf-8 -*-
"""Class for the ogs MEDIUM_PROPERTIES file."""
from ogs5py.fileclasses.base import BlockFile


[docs]class MMP(BlockFile): """ Class for the ogs MEDIUM_PROPERTIES file. Parameters ---------- task_root : str, optional Path to the destiny model folder. Default: cwd+"ogs5model" task_id : str, optional Name for the ogs task. Default: "model" Notes ----- Main-Keywords (#): - MEDIUM_PROPERTIES Sub-Keywords ($) per Main-Keyword: - MEDIUM_PROPERTIES - CAPILLARY_PRESSURE - CHANNEL - COMPOUND_DEPENDENT_DT - CONDUCTIVITY_MODEL - CONVERSION_FACTOR - DATA - DIFFUSION - DIS_TYPE - ELEMENT_VOLUME_MULTIPLYER - EVAPORATION - FLOWLINEARITY - GEOMETRY_AREA - GEOMETRY_DIMENSION - GEOMETRY_INCLINATION - GEO_TYPE - HEAT_DISPERSION - HEAT_TRANSFER - INTERPHASE_FRICTION - MASS_DISPERSION - MMP_TYPE - MSH_TYPE - NAME - ORGANIC_CARBON - PARTICLE_DIAMETER - PCS_TYPE - PERMEABILITY_FUNCTION_DEFORMATION - PERMEABILITY_FUNCTION_EFFSTRESS - PERMEABILITY_FUNCTION_POROSITY - PERMEABILITY_FUNCTION_PRESSURE - PERMEABILITY_FUNCTION_STRAIN - PERMEABILITY_FUNCTION_STRESS - PERMEABILITY_FUNCTION_VELOCITY - PERMEABILITY_SATURATION - PERMEABILITY_TENSOR - PERMEABILITY_DISTRIBUTION - POROSITY - POROSITY_DISTRIBUTION - RILL - SPECIFIC_STORAGE - STORAGE - STORAGE_FUNCTION_EFFSTRESS - SURFACE_FRICTION - TORTUOSITY - TRANSFER_COEFFICIENT - UNCONFINED - VOL_BIO - VOL_MAT - WIDTH Standard block: :GEOMETRY_DIMENSION: 2, :STORAGE: [1, 1.0e-4], :PERMEABILITY_TENSOR: ["ISOTROPIC", 1.0e-4], :POROSITY: [1, 0.2] Keyword documentation: https://ogs5-keywords.netlify.com/ogs/wiki/public/doc-auto/by_ext/mmp Reading routines: https://github.com/ufz/ogs5/blob/master/FEM/rf_mmp_new.cpp#L281 See Also -------- add_block """ MKEYS = ["MEDIUM_PROPERTIES"] # sorted SKEYS = [ [ "PCS_TYPE", "NAME", "GEO_TYPE", "GEOMETRY_DIMENSION", "GEOMETRY_INCLINATION", "GEOMETRY_AREA", "POROSITY", "VOL_MAT", "VOL_BIO", "TORTUOSITY", "FLOWLINEARITY", "ORGANIC_CARBON", "STORAGE", "CONDUCTIVITY_MODEL", "UNCONFINED", "PERMEABILITY_TENSOR", "PERMEABILITY_FUNCTION_DEFORMATION", "PERMEABILITY_FUNCTION_STRAIN", "PERMEABILITY_FUNCTION_PRESSURE", "PERMEABILITY_SATURATION", "PERMEABILITY_FUNCTION_STRESS", "PERMEABILITY_FUNCTION_EFFSTRESS", "PERMEABILITY_FUNCTION_VELOCITY", "PERMEABILITY_FUNCTION_POROSITY", "CAPILLARY_PRESSURE", "TRANSFER_COEFFICIENT", "SPECIFIC_STORAGE", "STORAGE_FUNCTION_EFFSTRESS", "MASS_DISPERSION", "COMPOUND_DEPENDENT_DT", "HEAT_DISPERSION", "DIFFUSION", "EVAPORATION", "SURFACE_FRICTION", "WIDTH", "RILL", "CHANNEL", "PERMEABILITY_DISTRIBUTION", "POROSITY_DISTRIBUTION", "HEAT_TRANSFER", "PARTICLE_DIAMETER", "INTERPHASE_FRICTION", "ELEMENT_VOLUME_MULTIPLYER", "MEDIUM_TYPE", # really? "DENSITY", # really? ] ] STD = { "GEOMETRY_DIMENSION": 2, "STORAGE": [1, 1.0e-4], "PERMEABILITY_TENSOR": ["ISOTROPIC", 1.0e-4], "POROSITY": [1, 0.2], } def __init__(self, **OGS_Config): super().__init__(**OGS_Config) self.file_ext = ".mmp" self.force_writing = True