convergence_criteria.convergence_criteria_wrapper.ConvergenceCriteriaWrapper Class Reference

This class wraps the convergence criteria such that they can be used "automated". More...

Collaboration diagram for convergence_criteria.convergence_criteria_wrapper.ConvergenceCriteriaWrapper:

Public Member Functions
def	__init__ (self, KratosMultiphysics.Parameters settings, CouplingInterfaceData interface_data, KratosMultiphysics.DataCommunicator parent_coupled_solver_data_communicator)
def	Initialize (self)
def	Finalize (self)
def	InitializeSolutionStep (self)
def	FinalizeSolutionStep (self)
def	InitializeNonLinearIteration (self)
def	FinalizeNonLinearIteration (self)
def	IsConverged (self)
def	PrintInfo (self)
def	Check (self)

Public Attributes
	interface_data
	conv_crit
	data_communicator
	executing_rank
	data_comm
	input_data

Detailed Description

This class wraps the convergence criteria such that they can be used "automated".

This class stores the residual and updates the solutions, such that the convergence criteria can be configured through JSON. In case of distributed data, the data is gathered on one rank, the convergence checked and the result broadcast to the other ranks.

Constructor & Destructor Documentation

__init__()

def convergence_criteria.convergence_criteria_wrapper.ConvergenceCriteriaWrapper.__init__	(		self,
		KratosMultiphysics.Parameters	settings,
		CouplingInterfaceData	interface_data,
		KratosMultiphysics.DataCommunicator	parent_coupled_solver_data_communicator
	)

Member Function Documentation

Check()

def convergence_criteria.convergence_criteria_wrapper.ConvergenceCriteriaWrapper.Check

(

self

)

Finalize()

def convergence_criteria.convergence_criteria_wrapper.ConvergenceCriteriaWrapper.Finalize

(

self

)

FinalizeNonLinearIteration()

def convergence_criteria.convergence_criteria_wrapper.ConvergenceCriteriaWrapper.FinalizeNonLinearIteration

(

self

)

FinalizeSolutionStep()

def convergence_criteria.convergence_criteria_wrapper.ConvergenceCriteriaWrapper.FinalizeSolutionStep

(

self

)

Initialize()

def convergence_criteria.convergence_criteria_wrapper.ConvergenceCriteriaWrapper.Initialize

(

self

)

InitializeNonLinearIteration()

def convergence_criteria.convergence_criteria_wrapper.ConvergenceCriteriaWrapper.InitializeNonLinearIteration

(

self

)

InitializeSolutionStep()

def convergence_criteria.convergence_criteria_wrapper.ConvergenceCriteriaWrapper.InitializeSolutionStep

(

self

)

IsConverged()

def convergence_criteria.convergence_criteria_wrapper.ConvergenceCriteriaWrapper.IsConverged

(

self

)

PrintInfo()

def convergence_criteria.convergence_criteria_wrapper.ConvergenceCriteriaWrapper.PrintInfo

(

self

)

Member Data Documentation

conv_crit

convergence_criteria.convergence_criteria_wrapper.ConvergenceCriteriaWrapper.conv_crit

data_comm

convergence_criteria.convergence_criteria_wrapper.ConvergenceCriteriaWrapper.data_comm

data_communicator

convergence_criteria.convergence_criteria_wrapper.ConvergenceCriteriaWrapper.data_communicator

executing_rank

convergence_criteria.convergence_criteria_wrapper.ConvergenceCriteriaWrapper.executing_rank

input_data

convergence_criteria.convergence_criteria_wrapper.ConvergenceCriteriaWrapper.input_data

interface_data

convergence_criteria.convergence_criteria_wrapper.ConvergenceCriteriaWrapper.interface_data

---

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

• /home/runner/work/Documentation/Documentation/master/applications/CoSimulationApplication/python_scripts/convergence_criteria/convergence_criteria_wrapper.py