Model

class reservoirflow.models.Model(unit, dtype, verbose)

Bases: ABC, Base

Abstract model class.

Model class used to create a reservoir simulation model. Model class represents the fluid flow process in a reservoir due to pressure change cause by boundary conditions and/or by (production or injection) wells.

Attention

This is an abstract class and can’t be instantiated. This class is only used as a parent for other classes of models module.

Returns:

Model object.

Return type:

Model

Construct model object.

Parameters:

• unit (str ('field', 'metric', 'lab'), optional) – unit used in input and output. Both units and factors attributes will be updated based on the selected unit and can be accessed directly from this class.

• dtype (str or np.dtype, optional) – data type used in all arrays. Numpy dtype such as np.single or np.double can be used.

• verbose (bool, optional) – print information for debugging.

Attributes

factors	Returns class factors.
name	Returns class name.
unit	Returns class unit.
units	Returns class units.

Methods

allow_synonyms()	Allow full descriptions.
compile(stype, method[, sparse])	Build a solution (equation system) for the model.
get_solutions()
report([prop, showindex, ifmt])	Print class report.
run(**kwargs)	Solve multiple timesteps.
set_comp(comp)	Set model compressibility
set_solution(name)
set_units([unit])	Set object units.
solve(**kwargs)	Solve a single timestep.

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 ⚖.