HDF5Snapshot Class Reference
Class representing a snapshot of a ModelPart state and its associated output file in HDF5 format. More...
Inheritance diagram for HDF5Snapshot:
Collaboration diagram for HDF5Snapshot:
Public Member Functions | |
| None | Erase (self, KratosMultiphysics.DataCommunicator communicator) |
| typing.Type[HDF5SnapshotManager] | GetManagerType (cls) |
| Return the manager type associated with the specialized Snapshot type. More... | |
 Public Member Functions inherited from SnapshotFS | |
| bool | Exists (self) |
| Check whether the data related to this Snapshot has already been written. More... | |
| bool | IsValid (self) |
| Check whether the stored data matches the ID of the Snapshot. More... | |
| "SnapshotFS" | FromFile (typing.Type["SnapshotFS"] cls, KratosMultiphysics.Parameters parameters) |
| Construct a Snapshot instance from a snapshot file. More... | |
| "SnapshotFS" | FromModelPart (typing.Type["SnapshotFS"] cls, KratosMultiphysics.ModelPart model_part, typing.Union[KratosMultiphysics.Parameters, None] parameters=None) |
| Deduce variables from an input ModelPart and construct a SnapshotFS. More... | |
| list | Collect (typing.Type["SnapshotFS"] cls, str pattern, KratosMultiphysics.Parameters parameters) |
| Find and read all snapshot files that match the provided file name pattern. More... | |
| Public Member Functions inherited from Snapshot | |
| None | Load (self, KratosMultiphysics.ModelPart model_part) |
| Load data from this snapshot to the specified model part. More... | |
| None | Write (self, KratosMultiphysics.ModelPart model_part) |
| Write data from the current state of the specified model part to the snapshot. More... | |
| KratosMultiphysics.Parameters | GetDefaultParameters (cls) |
| "Snapshot" | FromModelPart (cls, KratosMultiphysics.ModelPart model_part, KratosMultiphysics.Parameters parameters) |
| int | analysis_path (self) |
| int | step (self) |
| WRApp.CheckpointID | id (self) |
Static Public Member Functions | |
| typing.Type[HDF5SnapshotInput] | GetInputType () |
| Get the class responsible for reading snapshot data. More... | |
| typing.Type[HDF5SnapshotOutput] | GetOutputType () |
| Get the class responsible for writing snapshot data. More... | |
| Static Public Member Functions inherited from Snapshot | |
| list | GetSolutionPath (list snapshots) |
| Pick snapshots from the provided list that are part of the solution path. More... | |
Detailed Description
Class representing a snapshot of a ModelPart state and its associated output file in HDF5 format.
@classname HDF5Snapshot
Member Function Documentation
◆ Erase()
| None Erase | ( | self, | |
| KratosMultiphysics.DataCommunicator | communicator | ||
| ) |
Don't allow deleting the associated file if all snapshots are written into the same file.
Reimplemented from SnapshotFS.
◆ GetInputType()
|
static |
Get the class responsible for reading snapshot data.
- Note
- Override this member if you need a custom read logic.
Reimplemented from Snapshot.
◆ GetManagerType()
| typing.Type[HDF5SnapshotManager] GetManagerType | ( | cls | ) |
◆ GetOutputType()
|
static |
Get the class responsible for writing snapshot data.
- Note
- Override this member if you need a custom write logic.
Reimplemented from Snapshot.
The documentation for this class was generated from the following file:
