check_scalar_base_process.CheckScalarBaseProcess Class Reference

This process is the base class to check analytically from a function the solution (scalar) in a certain entity belonging a certain submodelpart. More...

Inheritance diagram for check_scalar_base_process.CheckScalarBaseProcess:

Collaboration diagram for check_scalar_base_process.CheckScalarBaseProcess:

Public Member Functions
def	__init__ (self, Model, settings)
	The default constructor of the class. 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
	settings
	model_part
	variable
	interval
	value_is_numeric
	is_time_function
	value
	function_string
	aux_function
	tolerance_rank
Public Attributes inherited from KratosUnittest.TestCase
	mismatch_idx
	aux_message
	idx_1
	idx_2

Detailed Description

This process is the base class to check analytically from a function the solution (scalar) in a certain entity belonging a certain submodelpart.

Only the member variables listed below should be accessed directly.

Public member variables:
Model -- the container of the different model parts.
settings -- Kratos parameters containing solver settings.

Constructor & Destructor Documentation

__init__()

def check_scalar_base_process.CheckScalarBaseProcess.__init__	(		self,
			Model,
			settings
	)

The default constructor of the class.

   Keyword arguments:
   self -- It signifies an instance of a class.
   Model -- the container of the different model parts.
   settings -- Kratos parameters containing solver settings.

Member Data Documentation

aux_function

check_scalar_base_process.CheckScalarBaseProcess.aux_function

function_string

check_scalar_base_process.CheckScalarBaseProcess.function_string

interval

check_scalar_base_process.CheckScalarBaseProcess.interval

is_time_function

check_scalar_base_process.CheckScalarBaseProcess.is_time_function

model_part

check_scalar_base_process.CheckScalarBaseProcess.model_part

settings

check_scalar_base_process.CheckScalarBaseProcess.settings

tolerance_rank

check_scalar_base_process.CheckScalarBaseProcess.tolerance_rank

value

check_scalar_base_process.CheckScalarBaseProcess.value

value_is_numeric

check_scalar_base_process.CheckScalarBaseProcess.value_is_numeric

variable

check_scalar_base_process.CheckScalarBaseProcess.variable

---

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

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