This class collects the common functionalities needed for saving / loading restart files. More...

Collaboration diagram for restart_utility.RestartUtility:

Public Member Functions
def	__init__ (self, model_part, settings)

def	LoadRestart (self, restart_file_name="")
	Public functions ####. More...

def	SaveRestart (self)
	This function saves the restart file. More...

def	IsRestartOutputStep (self)
	This function checks and returns whether a restart file should be written in this time-step. More...

def	CreateOutputFolder (self)

Public Attributes
	model_part

	model_part_name

	raw_file_name

	raw_path

	input_output_path

	serializer_flag

	echo_level

	input_file_label

	load_restart_files_from_folder

	restart_save_frequency

	restart_control_type_is_time

	next_output

	save_restart_files_in_folder

	max_files_to_keep

	restart_files

Detailed Description

This class collects the common functionalities needed for saving / loading restart files.

It can either be integrated into python-solvers or used directly in the main-script

Constructor & Destructor Documentation

◆ init()

def restart_utility.RestartUtility.__init__	(	self,
		model_part,
		settings
	)

Member Function Documentation

◆ CreateOutputFolder()

def restart_utility.RestartUtility.CreateOutputFolder ( self )

◆ IsRestartOutputStep()

def restart_utility.RestartUtility.IsRestartOutputStep ( self )

This function checks and returns whether a restart file should be written in this time-step.

◆ LoadRestart()

def restart_utility.RestartUtility.LoadRestart	(	self,
		restart_file_name = `""`
	)

Public functions ####.

This function loads a restart file into a ModelPart

◆ SaveRestart()

def restart_utility.RestartUtility.SaveRestart ( self )

This function saves the restart file.

It should be called at the end of a time-step. Use "IsRestartOutputStep" to check if a restart file should be written in this time-step

Member Data Documentation

◆ echo_level

restart_utility.RestartUtility.echo_level

◆ input_file_label

restart_utility.RestartUtility.input_file_label

◆ input_output_path

restart_utility.RestartUtility.input_output_path

◆ load_restart_files_from_folder

restart_utility.RestartUtility.load_restart_files_from_folder

◆ max_files_to_keep

restart_utility.RestartUtility.max_files_to_keep

◆ model_part

restart_utility.RestartUtility.model_part

◆ model_part_name

restart_utility.RestartUtility.model_part_name

◆ next_output

restart_utility.RestartUtility.next_output

◆ raw_file_name

restart_utility.RestartUtility.raw_file_name

◆ raw_path

restart_utility.RestartUtility.raw_path

◆ restart_control_type_is_time

restart_utility.RestartUtility.restart_control_type_is_time

◆ restart_files

restart_utility.RestartUtility.restart_files

◆ restart_save_frequency

restart_utility.RestartUtility.restart_save_frequency

◆ save_restart_files_in_folder

restart_utility.RestartUtility.save_restart_files_in_folder

◆ serializer_flag

restart_utility.RestartUtility.serializer_flag

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

/home/runner/work/Documentation/Documentation/master/kratos/python_scripts/restart_utility.py

Public Member Functions

Public Attributes