kratos_utilities Namespace Reference

Functions
def	IssueDeprecationWarning (label, *message)
def	DeleteFileIfExisting (file_name)
	This function tries to delete a file It uses try/except to also work in MPI. More...
def	DeleteDirectoryIfExisting (directory_name)
	This function tries to delete a folder It uses try/except to also work in MPI. More...
def	DeleteTimeFiles (directory_name)
	This function deletes all *.time files in a directory. More...
def	GetKratosMultiphysicsPath ()
	Returning the path to the KratosMultiphysics-module. More...
def	GetListOfAvailableApplications ()
	Return a list of compiled applications available in the KratosMultiphysics module. More...
def	GetListOfImportedApplications (module_name="KratosMultiphysics")
	Returns the list of moldules that are or were imported at call time, including the main module_name module. More...
def	GetMapOfImportedApplications (module_name="KratosMultiphysics")
	Returns the tree of modules that are or were imported at call time, including the main "module_name" module. More...
def	IsMPIAvailable ()
	Check if the KratosMPI module (the MPI core) is available. More...
def	CheckIfApplicationsAvailable (*application_names)
	Returns whether the inquired applications are available. More...
def	GetNotAvailableApplications (*application_names)
	Returns a list of applications that are not available out of a provided list of applications. More...
def	GenerateVariableListFromInput (param)
	Retrieve variable name from input (a string) and request the corresponding C++ object to the kernel. More...
def	GenerateFlagsListFromInput (param)
	Retrieve flag name from input (a string) and request the corresponding C++ object to the kernel. More...

Function Documentation

CheckIfApplicationsAvailable()

def kratos_utilities.CheckIfApplicationsAvailable

(

*

application_names

)

Returns whether the inquired applications are available.

DeleteDirectoryIfExisting()

def kratos_utilities.DeleteDirectoryIfExisting

(

directory_name

)

This function tries to delete a folder It uses try/except to also work in MPI.

DeleteFileIfExisting()

def kratos_utilities.DeleteFileIfExisting

(

file_name

)

This function tries to delete a file It uses try/except to also work in MPI.

DeleteTimeFiles()

def kratos_utilities.DeleteTimeFiles

(

directory_name

)

This function deletes all *.time files in a directory.

GenerateFlagsListFromInput()

def kratos_utilities.GenerateFlagsListFromInput

(

param

)

Retrieve flag name from input (a string) and request the corresponding C++ object to the kernel.

GenerateVariableListFromInput()

def kratos_utilities.GenerateVariableListFromInput

(

param

)

Retrieve variable name from input (a string) and request the corresponding C++ object to the kernel.

GetKratosMultiphysicsPath()

def kratos_utilities.GetKratosMultiphysicsPath

(

)

Returning the path to the KratosMultiphysics-module.

GetListOfAvailableApplications()

def kratos_utilities.GetListOfAvailableApplications

(

)

Return a list of compiled applications available in the KratosMultiphysics module.

GetListOfImportedApplications()

def kratos_utilities.GetListOfImportedApplications

(

module_name = "KratosMultiphysics"

)

Returns the list of moldules that are or were imported at call time, including the main module_name module.

GetMapOfImportedApplications()

def kratos_utilities.GetMapOfImportedApplications

(

module_name = "KratosMultiphysics"

)

Returns the tree of modules that are or were imported at call time, including the main "module_name" module.

GetNotAvailableApplications()

def kratos_utilities.GetNotAvailableApplications

(

*

application_names

)

Returns a list of applications that are not available out of a provided list of applications.

IsMPIAvailable()

def kratos_utilities.IsMPIAvailable

(

)

Check if the KratosMPI module (the MPI core) is available.

IssueDeprecationWarning()

def kratos_utilities.IssueDeprecationWarning	(		label,
		*	message
	)