depth_integration_output_process.DepthIntegrationOutputProcess Class Reference

DepthIntegrationOutputProcess. More...

Inheritance diagram for depth_integration_output_process.DepthIntegrationOutputProcess:

Collaboration diagram for depth_integration_output_process.DepthIntegrationOutputProcess:

Public Member Functions
def	__init__ (self, model, settings)
	The constructor of the DepthIntegrationOutputProcess. More...
def	Check (self)
	Check the processes. More...
def	ExecuteInitialize (self)
	Initialize the output model part. More...
def	ExecuteBeforeSolutionLoop (self)
	Write the interface model part in HDF5 format. More...
def	ExecuteInitializeSolutionStep (self)
	Synchronize the ProcessInfo of the output and interface model part. More...
def	IsOutputStep (self)
	IsOutputStep. More...
def	PrintOutput (self)
	Perform the depth integration over the interface model part. More...

Static Public Member Functions
def	GetDefaultParameters ()

Public Attributes
	settings
	volume_model_part
	interface_model_part
	output_model_part
	interval
	variables
	integration_process
	hdf5_process

Detailed Description

DepthIntegrationOutputProcess.

This process performs a depth integration from a Navier-Stokes domain to a shallow water domain.
The depth integration values are stored in the nodes of the shallow water domain and
printed in HDF5 format.

Constructor & Destructor Documentation

__init__()

def depth_integration_output_process.DepthIntegrationOutputProcess.__init__	(		self,
			model,
			settings
	)

The constructor of the DepthIntegrationOutputProcess.

Member Function Documentation

Check()

def depth_integration_output_process.DepthIntegrationOutputProcess.Check

(

self

)

Check the processes.

ExecuteBeforeSolutionLoop()

def depth_integration_output_process.DepthIntegrationOutputProcess.ExecuteBeforeSolutionLoop

(

self

)

Write the interface model part in HDF5 format.

ExecuteInitialize()

def depth_integration_output_process.DepthIntegrationOutputProcess.ExecuteInitialize

(

self

)

Initialize the output model part.

ExecuteInitializeSolutionStep()

def depth_integration_output_process.DepthIntegrationOutputProcess.ExecuteInitializeSolutionStep

(

self

)

Synchronize the ProcessInfo of the output and interface model part.

GetDefaultParameters()

def depth_integration_output_process.DepthIntegrationOutputProcess.GetDefaultParameters ( )

static

IsOutputStep()

def depth_integration_output_process.DepthIntegrationOutputProcess.IsOutputStep

(

self

)

IsOutputStep.

PrintOutput()

def depth_integration_output_process.DepthIntegrationOutputProcess.PrintOutput

(

self

)

Perform the depth integration over the interface model part.

Member Data Documentation

hdf5_process

depth_integration_output_process.DepthIntegrationOutputProcess.hdf5_process

integration_process

depth_integration_output_process.DepthIntegrationOutputProcess.integration_process

interface_model_part

depth_integration_output_process.DepthIntegrationOutputProcess.interface_model_part

interval

depth_integration_output_process.DepthIntegrationOutputProcess.interval

output_model_part

depth_integration_output_process.DepthIntegrationOutputProcess.output_model_part

settings

depth_integration_output_process.DepthIntegrationOutputProcess.settings

variables

depth_integration_output_process.DepthIntegrationOutputProcess.variables

volume_model_part

depth_integration_output_process.DepthIntegrationOutputProcess.volume_model_part

---

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

• /home/runner/work/Documentation/Documentation/master/applications/ShallowWaterApplication/python_scripts/coupling/depth_integration_output_process.py