SnapshotInMemory Class Reference

Snapshot that stores/fetches its data in/from memory. More...

Inheritance diagram for SnapshotInMemory:

Collaboration diagram for SnapshotInMemory:

Public Member Functions
KratosMultiphysics.Expression.Expression	GetExpression (self, KratosMultiphysics.Globals.DataLocation container_type, WRApp.Typing.Variable variable)
bool	Exists (self)
	Check whether the data related to this Snapshot has already been written. More...
None	Erase (self, KratosMultiphysics.DataCommunicator communicator)
	Erase stored data related to this snapshot. More...
bool	IsValid (self)
	Check whether the stored data matches the ID of the Snapshot. More...
"SnapshotInMemory"	FromModelPart (typing.Type["SnapshotInMemory"] cls, KratosMultiphysics.ModelPart model_part, typing.Union[KratosMultiphysics.Parameters, None] parameters=None)
	Deduce variables from an input ModelPart and construct a SnapshotFS. More...
typing.Type["SnapshotInMemoryManager"]	GetManagerType (cls)
	Return the manager type associated with the specialized Snapshot type. 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[SnapshotInMemoryInput]	GetInputType ()
	Get the class responsible for reading snapshot data. More...
typing.Type[SnapshotInMemoryOutput]	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

Snapshot that stores/fetches its data in/from memory.

@classname SnapshotInMemory

Member Function Documentation

Erase()

None Erase	(		self,
		KratosMultiphysics.DataCommunicator	communicator
	)

Erase stored data related to this snapshot.

Reimplemented from Snapshot.

Exists()

bool Exists

(

self

)

Check whether the data related to this Snapshot has already been written.

Reimplemented from Snapshot.

FromModelPart()

"SnapshotInMemory" FromModelPart	(	typing.Type["SnapshotInMemory"]	cls,
		KratosMultiphysics.ModelPart	model_part,
		typing.Union[KratosMultiphysics.Parameters,None]	parameters = None
	)

Deduce variables from an input ModelPart and construct a SnapshotFS.

Input- and output parameters are defaulted if they are not specified by the user. The related file name defaults to "<model_part_name>_step_<step>_path_<path>".

GetExpression()

KratosMultiphysics.Expression.Expression GetExpression	(		self,
		KratosMultiphysics.Globals.DataLocation	container_type,
		WRApp.Typing.Variable	variable
	)

GetInputType()

typing.Type[SnapshotInMemoryInput] 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["SnapshotInMemoryManager"] GetManagerType

(

cls

)

Return the manager type associated with the specialized Snapshot type.

Reimplemented from Snapshot.

GetOutputType()

typing.Type[SnapshotInMemoryOutput] GetOutputType ( )

static

Get the class responsible for writing snapshot data.

Note

Override this member if you need a custom write logic.

Reimplemented from Snapshot.

IsValid()

bool IsValid

(

self

)

Check whether the stored data matches the ID of the Snapshot.

Reimplemented from Snapshot.

---

The documentation for this class was generated from the following file:

• SnapshotInMemory.py