debug_utilities Namespace Reference

Functions
def	GetVariableAndType (var_name, split_by_commponents)
	Return the variable with the given name. More...
def	GetHistoricalVariableList (model_part, split_by_commponents=False)
	Get all variables in the historical database (GetSolutionStepValues). More...
def	GetNodalNonHistoricalVariableList (modelPart, container, full_search=False, split_by_commponents=False)
	Get all variables in the historical database (GetValues) for entities in container. More...
def	GetNonHistoricalVariableList (modelPart, full_search=False, split_by_commponents=False)
	Get all variables in the non historical database (GetValues) for all entities(nodes, elements and conditions). More...
def	CheckAll (model_part)
	Check the consistency of all entities and its variables. More...
def	CheckAllHistoricalVariables (model_part)
	Check the consistency of all historical variables. More...
def	CheckAllNonHistoricalVariables (model_part)
	Check the consistency of all non-historical variables. More...
def	CheckAllHistoricalVariablesStatistics (model_part)
	Compute the statistics of all the historical variables. More...
def	CheckAllNonHistoricalVariablesStatistics (model_part)
	Compute the statistics of all the non-historical variables. More...
def	CheckHistoricalVariableStatistics (model_part, input_variable)
	Compute the statistics of the given historical variable. More...

Function Documentation

CheckAll()

def debug_utilities.CheckAll

(

model_part

)

Check the consistency of all entities and its variables.

CheckAllHistoricalVariables()

def debug_utilities.CheckAllHistoricalVariables

(

model_part

)

Check the consistency of all historical variables.

CheckAllHistoricalVariablesStatistics()

def debug_utilities.CheckAllHistoricalVariablesStatistics

(

model_part

)

Compute the statistics of all the historical variables.

CheckAllNonHistoricalVariables()

def debug_utilities.CheckAllNonHistoricalVariables

(

model_part

)

Check the consistency of all non-historical variables.

CheckAllNonHistoricalVariablesStatistics()

def debug_utilities.CheckAllNonHistoricalVariablesStatistics

(

model_part

)

Compute the statistics of all the non-historical variables.

CheckHistoricalVariableStatistics()

def debug_utilities.CheckHistoricalVariableStatistics	(		model_part,
			input_variable
	)

Compute the statistics of the given historical variable.

GetHistoricalVariableList()

def debug_utilities.GetHistoricalVariableList	(		model_part,
			split_by_commponents = False
	)

Get all variables in the historical database (GetSolutionStepValues).

GetNodalNonHistoricalVariableList()

def debug_utilities.GetNodalNonHistoricalVariableList	(		modelPart,
			container,
			full_search = False,
			split_by_commponents = False
	)

Get all variables in the historical database (GetValues) for entities in container.

Get all variables in the historical database (GetSolutionStepValues) for entities in container. If not specified the function will asume that all entities in container have the same variables.

Keyword arguments: model_part – Input Modelpart container – Specific container of the modelpart to perform the check (Elements, Nodes, etc...) full_search – Default: False. If set to true will individually check all the variables for every single individual entity in the container. split_by_commponents – If set to True will split the variable into commponents if possible (VAR --> VAR_X, VAR_Y, etc...)

GetNonHistoricalVariableList()

def debug_utilities.GetNonHistoricalVariableList	(		modelPart,
			full_search = False,
			split_by_commponents = False
	)

Get all variables in the non historical database (GetValues) for all entities(nodes, elements and conditions).

Get all variables in the non historical database (GetValues) for all entities (nodes, elements and conditions).
If not specified the function will asume that all entities of the same type in `modelPart` have the same variables.

Keyword arguments:
modelPart -- Input Modelpart
full_search -- Default: False. If set to true will individually check all the variables for every single individual entity in the container.
split_by_commponents -- If set to True will split the variable into commponents if possible (VAR --> VAR_X, VAR_Y, etc...)

GetVariableAndType()

def debug_utilities.GetVariableAndType	(		var_name,
			split_by_commponents
	)

Return the variable with the given name.

Keyword arguments: var_name – The name of the variable to return split_by_commponents – If set to True will split the variable into commponents if possible (VAR --> VAR_X, VAR_Y, etc...)