Skip to main content

fielddata

DataGroup​

This pointer points to the data directory. Item accessor returns the individual data fields. `meshes` is passed to here for access of linked meshes.

DataGroup (
    file_handler: bamboost.common.file_handler.FileHandler,
    meshes: bamboost.accessors.meshes.MeshGroup,
    path_to_data: str = '/data',
    **kwargs
)
Parameters:
Variables:
  • meshes :

  • info : : 'pd.Dataframe'

    View the data stored.

DataGroup[key]

__getitem__ (self, key) -> bamboost.accessors.fielddata.FieldData

None

Parameters:
  • self : Any

  • key : Any

Returns:

iter(DataGroup)

__iter__ (self) -> bamboost.accessors.fielddata.FieldData

None

Parameters:
  • self : Any

Returns:

FieldData​

This pointer points to a specific data field. `meshes` is passed to here for access of linked meshes.

FieldData (
    file_handler: bamboost.common.file_handler.FileHandler,
    path_to_data: str,
    meshes: bamboost.accessors.meshes.MeshGroup
)
Parameters:
Variables:
  • meshes :

  • shape : : tuple

  • dtype : : type

  • times : : numpy.ndarray

    Return the array of timestamps.

  • mesh : bamboost.accessors.meshes.Mesh

    Return the linked mesh. Currently returns the linked mesh of first step only.

  • coordinates : : numpy.ndarray

    Wrapper for mesh.coordinates

  • connectivity : : numpy.ndarray

    Wrapper for mesh.connectivity

  • msh : : Tuple[numpy.ndarray, numpy.ndarray]

    Wrapper to get mesh as tuple

FieldData[key]

__getitem__ (self, key) -> numpy.ndarray

None

Parameters:
  • self : Any

  • key : Any

Returns:
    <class 'numpy.ndarray'>

len(FieldData)

__len__ (self) -> int

None

Parameters:
  • self : Any

Returns:
    <class 'int'>

at_step

at_step (self, *steps: int) -> numpy.ndarray

Direct access to data at step. Does not require the virtual dataset.

Parameters:
  • self : Any

  • steps : <class 'int'>

Returns:

regenerate_virtual_datasets

regenerate_virtual_datasets (self) -> None

Regenerate virtual dataset. Call this if the data has changed, thus the virtual datasets need to be updated to cover the actual data.

Parameters:
  • self : Any

Returns:
    None