wave_envelope_output_process.WaveHeightOutputProcess Class Reference

WaveHeightOutputProcess. More...

Inheritance diagram for wave_envelope_output_process.WaveHeightOutputProcess:

Collaboration diagram for wave_envelope_output_process.WaveHeightOutputProcess:

Public Member Functions
def	GetDefaultParameters (self)
def	__init__ (self, model, settings)
	The constructor of the WaveHeightOutputProcess. More...
def	ExecuteBeforeSolutionLoop (self)
	Initialize the utility to calculate the water height. More...
def	ExecuteFinalizeSolutionStep (self)
	Calculate the maximum wave height along the path. 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...

Public Attributes
	settings
	model_part
	positions
	next_output
	wave_height_utility
	max_values

Detailed Description

WaveHeightOutputProcess.

This process records the wave height along a path.
If a sampling point is not found, Nan will be printed.
Possible specifications of the Parameters:
 - output_file_settings: a parameters encapsulating the 'file_name', 'output_path' and
                         other settings according to 'TimeBasedAsciiFileWritterUtility'.
 - wave_calculation_settings: a parameters according to 'CalculateWaveHeightOutputProcess'

Constructor & Destructor Documentation

__init__()

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

The constructor of the WaveHeightOutputProcess.

Member Function Documentation

ExecuteBeforeSolutionLoop()

def wave_envelope_output_process.WaveHeightOutputProcess.ExecuteBeforeSolutionLoop

(

self

)

Initialize the utility to calculate the water height.

ExecuteFinalizeSolutionStep()

def wave_envelope_output_process.WaveHeightOutputProcess.ExecuteFinalizeSolutionStep

(

self

)

Calculate the maximum wave height along the path.

GetDefaultParameters()

def wave_envelope_output_process.WaveHeightOutputProcess.GetDefaultParameters

(

self

)

IsOutputStep()

def wave_envelope_output_process.WaveHeightOutputProcess.IsOutputStep

(

self

)

The output control is time based.

PrintOutput()

def wave_envelope_output_process.WaveHeightOutputProcess.PrintOutput

(

self

)

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

    The previous output files are overwitten. If the simulation
    does not reach the end, an envelope will be kept.

Member Data Documentation

max_values

wave_envelope_output_process.WaveHeightOutputProcess.max_values

model_part

wave_envelope_output_process.WaveHeightOutputProcess.model_part

next_output

wave_envelope_output_process.WaveHeightOutputProcess.next_output

positions

wave_envelope_output_process.WaveHeightOutputProcess.positions

settings

wave_envelope_output_process.WaveHeightOutputProcess.settings

wave_height_utility

wave_envelope_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_envelope_output_process.py