Inheritance diagram for wave_generator_process.WaveGeneratorProcess:

Collaboration diagram for wave_generator_process.WaveGeneratorProcess:

Public Member Functions
def	__init__ (self, model, settings)

def	ExecuteInitialize (self)
	Initialize the wave theory and the periodic function. More...

def	Check (self)

def	ExecuteInitializeSolutionStep (self)

Static Public Member Functions
def	GetDefaultParameters ()
	Default parameters for wave generator process. More...

Public Attributes
	settings

	direction_by_normal

	model_part

	interval

	variables_to_fix

	compute_momentum

	velocity_process

Constructor & Destructor Documentation

◆ init()

def wave_generator_process.WaveGeneratorProcess.__init__	(	self,
		model,
		settings
	)

Member Function Documentation

◆ Check()

def wave_generator_process.WaveGeneratorProcess.Check ( self )

◆ ExecuteInitialize()

def wave_generator_process.WaveGeneratorProcess.ExecuteInitialize ( self )

Initialize the wave theory and the periodic function.

◆ ExecuteInitializeSolutionStep()

def wave_generator_process.WaveGeneratorProcess.ExecuteInitializeSolutionStep ( self )

◆ GetDefaultParameters()

def wave_generator_process.WaveGeneratorProcess.GetDefaultParameters ( )

static

Default parameters for wave generator process.

    A zero value in the wave specifications will be ignored.
    The direction can be specified with a vector or the 'normal' keyword. If the direction is missing,
    it will be taken as the normal to the boundary.

Member Data Documentation

◆ compute_momentum

wave_generator_process.WaveGeneratorProcess.compute_momentum

◆ direction_by_normal

wave_generator_process.WaveGeneratorProcess.direction_by_normal

◆ interval

wave_generator_process.WaveGeneratorProcess.interval

◆ model_part

wave_generator_process.WaveGeneratorProcess.model_part

◆ settings

wave_generator_process.WaveGeneratorProcess.settings

◆ variables_to_fix

wave_generator_process.WaveGeneratorProcess.variables_to_fix

◆ velocity_process

wave_generator_process.WaveGeneratorProcess.velocity_process

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

/home/runner/work/Documentation/Documentation/master/applications/ShallowWaterApplication/python_scripts/wave_generator_process.py

Public Member Functions

Static Public Member Functions

Public Attributes