wave_height_output_process.WaveHeightOutputProcess Class Reference

WaveHeightOutputProcess. More...

Inheritance diagram for wave_height_output_process.WaveHeightOutputProcess:

Collaboration diagram for wave_height_output_process.WaveHeightOutputProcess:

Public Member Functions
def	GetDefaultParameters (self)
def	__init__ (self, model, settings)
	The constructor of the WaveHeightOutputProcess. More...
def	Check (self)
	Check all the variables have the right size. More...
def	ExecuteBeforeSolutionLoop (self)
	Initialize the files and the utility to calculate the water height. More...
def	IsOutputStep (self)
	The output control is time based. More...
def	PrintOutput (self)
	Print the wave height corresponding to each gauge and schedule the next output. More...
def	ExecuteFinalize (self)
	Close all the files. More...

Public Attributes
	settings
	model_part
	coordinates_list
	next_output
	wave_height_utility
	files

Detailed Description

WaveHeightOutputProcess.

This process records the wave height at several points.
The direction used to calculate the water weight is defined as the opposite of the gravity direction.
If no node is found, Nan will be printed.
Possible specifications of the Parameters:
 - coordinates: it can be a single coordinate or a list of coordinates for each gauge.
 - output_file_settings: a parameters encapsulating the 'file_name', 'output_path' and
                         other settings according to 'TimeBasedAsciiFileWritterUtility'.
                         Some replacements can be specified to 'file_name', e.g.:
                          - 'file_name' : 'gauge_<x>' or
                          - 'file_name' : 'gauge_<Y>' or
                          - 'file_name' : 'gauge_<i>'
 - wave_calculation_settings: parameters according to 'CalculateWaveHeightUtility'
                          - 'mean_water_level'
                          - 'relative_search_radius'
                          - 'search_tolerance'
                          - 'use_local_element_size'
                          - 'use_nearest_node'

Constructor & Destructor Documentation

__init__()

def wave_height_output_process.WaveHeightOutputProcess.__init__	(		self,
			model,
			settings
	)

The constructor of the WaveHeightOutputProcess.

Member Function Documentation

Check()

def wave_height_output_process.WaveHeightOutputProcess.Check

(

self

)

Check all the variables have the right size.

ExecuteBeforeSolutionLoop()

def wave_height_output_process.WaveHeightOutputProcess.ExecuteBeforeSolutionLoop

(

self

)

Initialize the files and the utility to calculate the water height.

ExecuteFinalize()

def wave_height_output_process.WaveHeightOutputProcess.ExecuteFinalize

(

self

)

Close all the files.

GetDefaultParameters()

def wave_height_output_process.WaveHeightOutputProcess.GetDefaultParameters

(

self

)

IsOutputStep()

def wave_height_output_process.WaveHeightOutputProcess.IsOutputStep

(

self

)

The output control is time based.

PrintOutput()

def wave_height_output_process.WaveHeightOutputProcess.PrintOutput

(

self

)

Print the wave height corresponding to each gauge and schedule the next output.

Member Data Documentation

coordinates_list

wave_height_output_process.WaveHeightOutputProcess.coordinates_list

files

wave_height_output_process.WaveHeightOutputProcess.files

model_part

wave_height_output_process.WaveHeightOutputProcess.model_part

next_output

wave_height_output_process.WaveHeightOutputProcess.next_output

settings

wave_height_output_process.WaveHeightOutputProcess.settings

wave_height_utility

wave_height_output_process.WaveHeightOutputProcess.wave_height_utility

---

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

• /home/runner/work/Documentation/Documentation/master/applications/PfemFluidDynamicsApplication/python_scripts/wave_height_output_process.py