bamboost.core.simulation.groups
Attributes
- log=
BAMBOOST_LOGGER.getChild(__name__)
Functions
get_git_status
(repo_path) -> _GitStatusArguments:
- repo_path
Classes
GroupMeshes
GroupMeshes
(self, simulation)Arguments:
- simulation:
'_Simulation'
Attributes:
- _simulation=
bamboost.core.simulation.groups.GroupMeshes(simulation)
Bases
ElligibleForPlugin1
H5Reference6
H5Object5
Group20
Group._statusGroup._objGroup._is_valid()Group._group_mapGroup.__setitem__()Group.__delitem__()Group.__contains__()Group._ipython_key_completions_()Group.__iter__()Group._assert_file_map_is_valid()Group.keys()Group.groups()Group.datasets()Group.items()Group._repr_html_()Group.require_self()Group.require_group()Group.require_dataset()Group.add_numerical_dataset()Group.add_dataset()
GroupMeshes.__getitem__
(self, key) -> GroupMesh[_MT]Arguments:
- key:
str
GroupMeshes.add
(self, nodes, cells, name=DEFAULT_MESH_NAME, cell_type=CellType.TRIANGLE) -> NoneAdd a mesh with the given name to the simulation.
Arguments:
- nodes:
numpy.numpy.ndarrayNode coordinates
- cells:
numpy.numpy.ndarrayCell connectivity
- name:
str=bamboost.constants.DEFAULT_MESH_NAMEName of the mesh
Cell type (default: "triangle"). In general, we do not care about the cell type and leave it up to the user to make sense of the data they provide. However, the cell type specified is needed for writing an XDMF file. For possible types, consult the XDMF/paraview manual.
GroupMesh
GroupMesh
(self, simulation, name)Arguments:
- simulation:
'_Simulation' - name:
str
Attributes:
- NODES=
'coordinates' - CELLS=
'topology' - coordinates:
numpy.numpy.ndarray[tuple[int, ...], numpy.numpy.dtype[numpy.numpy.float64]] - cells:
numpy.numpy.ndarray[tuple[int, ...], numpy.numpy.dtype[numpy.numpy.int64]] - cell_type:
str
Bases
ElligibleForPlugin1
H5Reference7
H5Object5
Group20
Group._statusGroup._objGroup._is_valid()Group._group_mapGroup.__setitem__()Group.__delitem__()Group.__contains__()Group._ipython_key_completions_()Group.__iter__()Group._assert_file_map_is_valid()Group.keys()Group.groups()Group.datasets()Group.items()Group._repr_html_()Group.require_self()Group.require_group()Group.require_dataset()Group.add_numerical_dataset()Group.add_dataset()
_GitStatus
Attributes:
- origin:
str - commit:
str - branch:
str - patch:
str
GroupGit
GroupGit
(self, simulation)Arguments:
- simulation:
'_Simulation[_MT]'
Bases
ElligibleForPlugin1
H5Reference6
H5Object5
Group20
Group._statusGroup._objGroup._is_valid()Group._group_mapGroup.__setitem__()Group.__delitem__()Group.__contains__()Group._ipython_key_completions_()Group.__iter__()Group._assert_file_map_is_valid()Group.keys()Group.groups()Group.datasets()Group.items()Group._repr_html_()Group.require_self()Group.require_group()Group.require_dataset()Group.add_numerical_dataset()Group.add_dataset()
GroupGit.__getitem__
(self, key) -> GitItemArguments:
- key:
str
GroupGit.add
(self, repo_name, repo_path) -> NoneArguments:
- repo_name:
str - repo_path:
StrPath
GitItem
GitItem
(self, name, attrs, patch)Arguments:
- name:
str - attrs:
typing.Mapping[str, typing.Any] - patch:
bytes
Attributes:
- name=
bamboost.core.simulation.groups.GitItem(name) - branch=
status['branch'] - commit=
status['commit'] - origin=
status['origin'] - patch=
patch.decode()
GitItem.__repr__
(self) -> str
Bamboost