coupling_interface_data.CouplingInterfaceData Class Reference

This class serves as interface to the data structure (Model and ModelPart) that holds the data used during CoSimulation. More...

Inheritance diagram for coupling_interface_data.CouplingInterfaceData:

Collaboration diagram for coupling_interface_data.CouplingInterfaceData:

Public Member Functions
def	__init__ (self, custom_settings, model, name="default", solver_name="default_solver")
def	__str__ (self)
def	PrintInfo (self)
def	GetModelPart (self)
def	IsDistributed (self)
def	IsDefinedOnThisRank (self)
def	Size (self)
def	GetBufferSize (self)
def	GetHistoricalVariableDict (self)
"np.ndarray[typing.Union[bool,np.intc,np.uintc,np.double]]"	GetData (self, solution_step_index=0)
def	SetData (self, new_data, solution_step_index=0)
Public Member Functions inherited from coupling_interface_data.BaseCouplingInterfaceData
def	__init__ (self, custom_settings, name="default", solver_name="default_solver")

Public Attributes
	model
	model_part
	dimension
	variable_type
	location
Public Attributes inherited from coupling_interface_data.BaseCouplingInterfaceData
	settings
	name
	solver_name
	model_part_name
	variable_type
	variable
	dtype
	is_scalar_variable
	location
	dimension

Additional Inherited Members
Static Public Member Functions inherited from coupling_interface_data.BaseCouplingInterfaceData
def	GetDefaultParameters ()

Detailed Description

This class serves as interface to the data structure (Model and ModelPart) that holds the data used during CoSimulation.

Constructor & Destructor Documentation

__init__()

def coupling_interface_data.CouplingInterfaceData.__init__	(		self,
			custom_settings,
			model,
			name = "default",
			solver_name = "default_solver"
	)

Member Function Documentation

__str__()

def coupling_interface_data.CouplingInterfaceData.__str__

(

self

)

GetBufferSize()

def coupling_interface_data.CouplingInterfaceData.GetBufferSize

(

self

)

GetData()

"np.ndarray[typing.Union[bool,np.intc,np.uintc,np.double]]" coupling_interface_data.CouplingInterfaceData.GetData	(		self,
			solution_step_index = 0
	)

GetHistoricalVariableDict()

def coupling_interface_data.CouplingInterfaceData.GetHistoricalVariableDict

(

self

)

GetModelPart()

def coupling_interface_data.CouplingInterfaceData.GetModelPart

(

self

)

IsDefinedOnThisRank()

def coupling_interface_data.CouplingInterfaceData.IsDefinedOnThisRank

(

self

)

Reimplemented from coupling_interface_data.BaseCouplingInterfaceData.

IsDistributed()

def coupling_interface_data.CouplingInterfaceData.IsDistributed

(

self

)

PrintInfo()

def coupling_interface_data.CouplingInterfaceData.PrintInfo

(

self

)

SetData()

def coupling_interface_data.CouplingInterfaceData.SetData	(		self,
			new_data,
			solution_step_index = 0
	)

Size()

def coupling_interface_data.CouplingInterfaceData.Size

(

self

)

Member Data Documentation

dimension

coupling_interface_data.CouplingInterfaceData.dimension

location

coupling_interface_data.CouplingInterfaceData.location

model

coupling_interface_data.CouplingInterfaceData.model

model_part

coupling_interface_data.CouplingInterfaceData.model_part

variable_type

coupling_interface_data.CouplingInterfaceData.variable_type

---

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

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