Specifications¶

MeshSpecifications¶

class nuftio.spec.MeshSpecifications(**kwargs)[source]¶

Bases: properties.base.base.HasProperties

specifies the mesh geometry, element material types and names as well as: dual permeability parameters and radiation parameters.

Required Properties:

coord (String): specifies the type of mesh that will be generated, a unicode string
down (Array): Vector orientation of down direction and in the direction of the gravity vector., a list or numpy array of <class ‘float’> with shape (3)
dx (Array): widths of the mesh in the X-dimension, a list or numpy array of <class ‘float’> with shape (*)
dy (Array): widths of the mesh in the Y-dimension, a list or numpy array of <class ‘float’> with shape (*)
dz (Array): widths of the mesh in the Z-dimension, a list or numpy array of <class ‘float’> with shape (*)
mat (Dictionary): The materials int the model space., a dictionary (keys: a unicode string; values: a dictionary (keys: a unicode string; values: a list (each item is an instance of MaterialComponent)))

coord¶

specifies the type of mesh that will be generated, a unicode string

Type:	coord (`String`)

definitions¶: Gets the mat_type definitions as integers to be matched with any given rocktab file via the lookup table.

down¶

Vector orientation of down direction and in the direction of the gravity vector., a list or numpy array of <class ‘float’> with shape (3)

Type:	down (`Array`)

dx¶

widths of the mesh in the X-dimension, a list or numpy array of <class ‘float’> with shape (*)

Type:	dx (`Array`)

dy¶

widths of the mesh in the Y-dimension, a list or numpy array of <class ‘float’> with shape (*)

Type:	dy (`Array`)

dz¶

widths of the mesh in the Z-dimension, a list or numpy array of <class ‘float’> with shape (*)

Type:	dz (`Array`)

injector¶

lookup_table¶

mat¶

a unicode string; values: a dictionary (keys: a unicode string; values: a list (each item is an instance of MaterialComponent)))

Type:	mat (`Dictionary`)
Type:	The materials int the model space., a dictionary (keys

materials¶

nC¶

nx¶

ny¶

nz¶

shape¶

toTensorMesh()[source]¶

RockType¶

class nuftio.spec.RockType(**kwargs)[source]¶

Bases: properties.base.base.HasProperties

Required Properties:

K0 (Float): The Kx value, a float
K1 (Float): The Kx value, a float
K2 (Float): The Kx value, a float
Kd (a list of Param): Dimensionless solid sorption coefficient of the component, a list (each item is an instance of Param)
KdFactor (a list of Param): Dimensionless solid sorption coefficient of the component, a list (each item is an instance of Param)
kr (a list of EqnParams): The relative permeability/saturation per phase., a list (each item is an instance of EqnParams)
mat_type (String): The rock type name corresponding to MaterialComponent.mat_type., a unicode string
pc (a list of EqnParams): The pressure parameters per phase., a list (each item is an instance of EqnParams)
porosity (Float): The fractional porosity, a float in range [0.0, 1.0]
solid_density (Float): The solid density value., a float
tort (a list of EqnParams): The Tortuosity parameters per phase., a list (each item is an instance of EqnParams)

K0¶

The Kx value, a float

Type:	K0 (`Float`)

K1¶

The Kx value, a float

Type:	K1 (`Float`)

K2¶

The Kx value, a float

Type:	K2 (`Float`)

Kd¶

Dimensionless solid sorption coefficient of the component, a list (each item is an instance of Param)

Type:	Kd (a list of `Param`)

KdFactor¶

Dimensionless solid sorption coefficient of the component, a list (each item is an instance of Param)

Type:	KdFactor (a list of `Param`)

kr¶

The relative permeability/saturation per phase., a list (each item is an instance of EqnParams)

Type:	kr (a list of `EqnParams`)

mat_type¶

The rock type name corresponding to MaterialComponent.mat_type., a unicode string

Type:	mat_type (`String`)

pc¶

The pressure parameters per phase., a list (each item is an instance of EqnParams)

Type:	pc (a list of `EqnParams`)

porosity¶

The fractional porosity, a float in range [0.0, 1.0]

Type:	porosity (`Float`)

solid_density¶

The solid density value., a float

Type:	solid_density (`Float`)

tort¶

The Tortuosity parameters per phase., a list (each item is an instance of EqnParams)

Type:	tort (a list of `EqnParams`)

USNT¶

class nuftio.spec.USNT(**kwargs)[source]¶

Bases: nuftio.spec.MeshSpecifications

The base object to instantiate.

Required Properties:

coord (String): specifies the type of mesh that will be generated, a unicode string
down (Array): Vector orientation of down direction and in the direction of the gravity vector., a list or numpy array of <class ‘float’> with shape (3)
dx (Array): widths of the mesh in the X-dimension, a list or numpy array of <class ‘float’> with shape (*)
dy (Array): widths of the mesh in the Y-dimension, a list or numpy array of <class ‘float’> with shape (*)
dz (Array): widths of the mesh in the Z-dimension, a list or numpy array of <class ‘float’> with shape (*)
mat (Dictionary): The materials int the model space., a dictionary (keys: a unicode string; values: a dictionary (keys: a unicode string; values: a list (each item is an instance of MaterialComponent)))
rocktab (Dictionary): Porous medium properties, a dictionary (keys: a unicode string; values: an instance of RockType)

allModels(dataframe=True)[source]¶: Returns all attributes in a Pandas DataFrame

attributes¶

model(attribute)[source]¶: Gets a rocktab attribute as a NumPy array ready for discretize or PVGeo

rocktab¶

a unicode string; values: an instance of RockType)

Type:	rocktab (`Dictionary`)
Type:	Porous medium properties, a dictionary (keys

saveLithLookupTable(filename)[source]¶