project.Project Class Reference

Kratos Multiphysics multistage project container. More...

Collaboration diagram for project.Project:

Public Member Functions
None	__init__ (self, KratosMultiphysics.Parameters settings)
	Constructs the multistage project container instance and sets current Kratos version in the settings. More...
KratosMultiphysics.Model	GetModel (self)
	Returns the current multistage simulation model. More...
KratosMultiphysics.Parameters	GetSettings (self)
	Returns the current multistage simulation settings. More...
dict	GetOutputData (self)
	Returns the current multistage simulation output data container. More...
dict	GetActiveStages (self)
	Returns the current multistage simulation active stages dictionary. More...
None	AddActiveStage (self, str stage_name, AnalysisStage stage_instance)
	Adds the provided stage instance to the active stages dictionary. More...
None	RemoveActiveStage (self, str stage_name)
	Removes an active stage instance from the current stages dictionary. More...
None	Save (self, pathlib.Path save_folder_path, pathlib.Path checkpoint_file_path, Optional[pathlib.Path] output_settings_file_path=None)
	Saves the Project current status. More...
None	Load (self, pathlib.Path loading_path)
	Loads a saved Project status into current one. More...

Detailed Description

Kratos Multiphysics multistage project container.

This class has two main purposes. First one is to hold the multistage components (output data, active stages and model)
Second one is to perform the checkpoint save and load operations.

Member variables:
__settings -- Kratos parameters object with the multistage simulation settings
__output_data -- Dictionary containing the stages data retrieved from GetFinalData
__active_stages -- Dictionary containing the active (alive) stage instances
__model -- Model instance

Constructor & Destructor Documentation

__init__()

None project.Project.__init__	(		self,
		KratosMultiphysics.Parameters	settings
	)

Constructs the multistage project container instance and sets current Kratos version in the settings.

Member Function Documentation

AddActiveStage()

None project.Project.AddActiveStage	(		self,
		str	stage_name,
		AnalysisStage	stage_instance
	)

Adds the provided stage instance to the active stages dictionary.

GetActiveStages()

dict project.Project.GetActiveStages

(

self

)

Returns the current multistage simulation active stages dictionary.

GetModel()

KratosMultiphysics.Model project.Project.GetModel

(

self

)

Returns the current multistage simulation model.

GetOutputData()

dict project.Project.GetOutputData

(

self

)

Returns the current multistage simulation output data container.

GetSettings()

KratosMultiphysics.Parameters project.Project.GetSettings

(

self

)

Returns the current multistage simulation settings.

Load()

None project.Project.Load	(		self,
		pathlib.Path	loading_path
	)

Loads a saved Project status into current one.

RemoveActiveStage()

None project.Project.RemoveActiveStage	(		self,
		str	stage_name
	)

Removes an active stage instance from the current stages dictionary.

Save()

None project.Project.Save	(		self,
		pathlib.Path	save_folder_path,
		pathlib.Path	checkpoint_file_path,
		Optional[pathlib.Path]	output_settings_file_path = None
	)

Saves the Project current status.

---

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

• /home/runner/work/Documentation/Documentation/master/kratos/python_scripts/project.py