Access Nomenclature

Author: Zakariya Abugrin | Date: December 2023

In reservoirflow, similar to UNITS and FACTORS, NOMENCLATURE is defined as global dictionary. NOMENCLATURE is used to build the documentation and also to define the terms used to develop the mathematical models. This tutorial shows how to access this dictionary.

import reservoirflow as rf

print(rf.__version__)

0.1.0

Accessing NOMENCLATURE Dictionary

Since NOMENCLATURE is a dictionary, keys represent the 2 categories and can be accessed as following:

rf.NOMENCLATURE.keys()

dict_keys(['abbreviation', 'symbol'])

The 'abbreviation' key can be used as following:

rf.NOMENCLATURE["abbreviation"]

{'transmissibility': 'trans',
 'error': 'err',
 'pressure': 'press',
 'potential': 'poten',
 'time': 't',
 'rate': 'q',
 'length': 'L',
 'area': 'A',
 'volume': 'V',
 'permeability': 'perm',
 'viscosity': 'mu',
 'gas formation volume factor': 'FVFg',
 'liquid formation volume factor': 'FVFl',
 'water formation volume factor': 'FVFw',
 'oil formation volume factor': 'FVFo',
 'solution gas oil ratio': 'GORs',
 'phase gravity': 'gamma phase',
 'gas flow rate': 'Qg',
 'liquid flow rate': 'Ql',
 'water flow rate': 'Qw',
 'oil flow rate': 'Qo',
 'volumetric velocity': 'u',
 'density': 'rho',
 'compressibility': 'comp',
 'compressibility factor': 'z',
 'temperature': 'temp',
 'porosity': 'phi',
 'saturation': 'sat',
 'relative permeability': 'relperm',
 'angle': 'theta',
 'gravitational acceleration': 'g',
 'transmissibility conversion': 'beta constant',
 'gravity conversion': 'gamma constant',
 'volume conversion': 'alpha constant'}

while the 'symbol' key can be used as following:

rf.NOMENCLATURE["symbol"]

{'transmissibility': 'T',
 'error': 'e',
 'pressure': 'p',
 'potential': '\\Phi',
 'time': 't',
 'rate': 'q',
 'length': 'L',
 'area': 'A',
 'volume': 'V',
 'permeability': 'k',
 'viscosity': '\\mu',
 'gas formation volume factor': 'B_g',
 'liquid formation volume factor': 'B_l',
 'water formation volume factor': 'B_w',
 'oil formation volume factor': 'B_o',
 'solution gas oil ratio': 'R_s',
 'phase gravity': '\\gamma_p',
 'gas flow rate': 'q_g',
 'liquid flow rate': 'q_l',
 'water flow rate': 'q_w',
 'oil flow rate': 'q_o',
 'volumetric velocity': 'u',
 'density': '\\rho',
 'compressibility': 'c',
 'compressibility factor': 'z',
 'temperature': '-',
 'porosity': '\\phi',
 'saturation': 'S',
 'relative permeability': 'k_r',
 'angle': '\\theta',
 'gravitational acceleration': 'g',
 'transmissibility conversion': '\\beta_c',
 'gravity conversion': '\\gamma_c',
 'volume conversion': '\\alpha_c'}

Comments 💬

Feel free to make a comment, ask a question, or share your opinion about this specific content. Please keep in mind the Commenting Guidelines ⚖.