gstools.field.base

GStools subpackage providing a base class for spatial fields.

The following classes are provided

Field(model[, mean]) A field base class for random and kriging fields ect.
class gstools.field.base.Field(model, mean=0.0)[source]

A field base class for random and kriging fields ect.

Parameters:
  • model (CovModel) – Covariance Model related to the field.
  • mean (float, optional) – Mean value of the field.
Attributes:
mean

float: The mean of the field.

model

CovModel: The covariance model of the field.

value_type

str: Type of the field values (scalar, vector).

Methods

__call__(\*args, \*\*kwargs) Generate the field.
mesh(self, mesh[, points, direction, name]) Generate a field on a given meshio or ogs5py mesh.
plot(self[, field, fig, ax]) Plot the spatial random field.
structured(self, \*args, \*\*kwargs) Generate a field on a structured mesh.
to_pyvista(self[, field_select, fieldname]) Create a VTK/PyVista grid of the stored field.
unstructured(self, \*args, \*\*kwargs) Generate a field on an unstructured mesh.
vtk_export(self, filename[, field_select, …]) Export the stored field to vtk.
__call__(*args, **kwargs)[source]

Generate the field.

mesh(self, mesh, points='centroids', direction='xyz', name='field', **kwargs)[source]

Generate a field on a given meshio or ogs5py mesh.

Parameters:
  • mesh (meshio.Mesh or ogs5py.MSH) – The given meshio or ogs5py mesh
  • points (str, optional) – The points to evaluate the field at. Either the “centroids” of the mesh cells (calculated as mean of the cell vertices) or the “points” of the given mesh. Default: “centroids”
  • direction (str, optional) – Here you can state which direction should be choosen for lower dimension. For example, if you got a 2D mesh in xz direction, you have to pass “xz” Default: “xyz”
  • name (str, optional) – Name to store the field in the given mesh as point_data or cell_data. Default: “field”
  • **kwargs – Keyword arguments forwareded to Field.__call__.

Notes

This will store the field in the given mesh under the given name, if a meshio mesh was given.

See: https://github.com/nschloe/meshio

See: Field.__call__

plot(self, field='field', fig=None, ax=None)[source]

Plot the spatial random field.

Parameters:
  • field (str, optional) – Field that should be plotted. Can be: “field”, “raw_field”, “krige_field”, “err_field” or “krige_var”. Default: “field”
  • fig (Figure or None) – Figure to plot the axes on. If None, a new one will be created. Default: None
  • ax (Axes or None) – Axes to plot on. If None, a new one will be added to the figure. Default: None
structured(self, *args, **kwargs)[source]

Generate a field on a structured mesh.

See Field.__call__

to_pyvista(self, field_select='field', fieldname='field')[source]

Create a VTK/PyVista grid of the stored field.

Parameters:
  • field_select (str, optional) – Field that should be stored. Can be: “field”, “raw_field”, “krige_field”, “err_field” or “krige_var”. Default: “field”
  • fieldname (str, optional) – Name of the field in the VTK file. Default: “field”
unstructured(self, *args, **kwargs)[source]

Generate a field on an unstructured mesh.

See Field.__call__

vtk_export(self, filename, field_select='field', fieldname='field')[source]

Export the stored field to vtk.

Parameters:
  • filename (str) – Filename of the file to be saved, including the path. Note that an ending (.vtr or .vtu) will be added to the name.
  • field_select (str, optional) – Field that should be stored. Can be: “field”, “raw_field”, “krige_field”, “err_field” or “krige_var”. Default: “field”
  • fieldname (str, optional) – Name of the field in the VTK file. Default: “field”
mean

The mean of the field.

Type:float
model

The covariance model of the field.

Type:CovModel
value_type

Type of the field values (scalar, vector).

Type:str