compare_two_files_check_process.CompareTwoFilesCheckProcess Class Reference

This process compares files that are written during a simulation against reference files. More...

Inheritance diagram for compare_two_files_check_process.CompareTwoFilesCheckProcess:

Collaboration diagram for compare_two_files_check_process.CompareTwoFilesCheckProcess:

Public Member Functions
def	__init__ (self, params)
def	Execute (self)
	Executes all functions required to compare the files Intended to be directly used within python-scripts. More...
def	ExecuteFinalize (self)
	The files are compared in this function Please see the respective files for details on the format of the files. More...
Public Member Functions inherited from KratosUnittest.TestCase
def	run (self, result=None)
def	skipTestIfApplicationsNotAvailable (self, *application_names)
	Skips the test if required applications are not available. More...
def	assertEqualTolerance (self, first, second, tolerance, msg=None)
	Fails if first and second have a difference greater than tolerance. More...
def	assertIsClose (self, first, second, rel_tol=None, abs_tol=None, msg=None)
	Fails if the two objects are unequal as determined by their absolute and relative difference. More...
def	assertVectorAlmostEqual (self, vector1, vector2, places=7, msg=None, delta=None)
def	assertMatrixAlmostEqual (self, matrix1, matrix2, places=7, msg=None, delta=None)

Public Attributes
	reference_file_name
	Settings string in json format. More...
	output_file_name
	remove_output_file
	comparison_type
	only do the check in ranks zero, otherwise this can experience in race condition More...
	tol
	reltol
	dimension
	info_msg
Public Attributes inherited from KratosUnittest.TestCase
	mismatch_idx
	aux_message
	idx_1
	idx_2

Detailed Description

This process compares files that are written during a simulation against reference files.

Please see the "ExecuteFinalize" functions for details about the available file-formats

Constructor & Destructor Documentation

__init__()

def compare_two_files_check_process.CompareTwoFilesCheckProcess.__init__	(		self,
			params
	)

Member Function Documentation

Execute()

def compare_two_files_check_process.CompareTwoFilesCheckProcess.Execute

(

self

)

Executes all functions required to compare the files Intended to be directly used within python-scripts.

ExecuteFinalize()

def compare_two_files_check_process.CompareTwoFilesCheckProcess.ExecuteFinalize

(

self

)

The files are compared in this function Please see the respective files for details on the format of the files.

Member Data Documentation

comparison_type

compare_two_files_check_process.CompareTwoFilesCheckProcess.comparison_type

only do the check in ranks zero, otherwise this can experience in race condition

dimension

compare_two_files_check_process.CompareTwoFilesCheckProcess.dimension

info_msg

compare_two_files_check_process.CompareTwoFilesCheckProcess.info_msg

output_file_name

compare_two_files_check_process.CompareTwoFilesCheckProcess.output_file_name

reference_file_name

compare_two_files_check_process.CompareTwoFilesCheckProcess.reference_file_name

Settings string in json format.

Overwrite the default settings with user-provided parameters

reltol

compare_two_files_check_process.CompareTwoFilesCheckProcess.reltol

remove_output_file

compare_two_files_check_process.CompareTwoFilesCheckProcess.remove_output_file

tol

compare_two_files_check_process.CompareTwoFilesCheckProcess.tol

---

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

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