waveAlpha

Description

The waveAlpha is a boundary condition that establishes the phase fraction by combining multiple wave models.

Usage

The condition requires entries in both the boundary and field files.

Boundary file

<patchName>
{
    type            patch;
    ...
}

Field file

<patchName>
{
    // Mandatory entries
    type            waveAlpha;

    // Optional entries
    waveDict        <word>;

    // Inherited entries
    ...
}

where:

Property	Description	Type	Required	Default
type	Type name: waveAlpha	word	yes	-
waveDict	Name of the wave variables dictionary	word	no	-

The inherited entries are elaborated in:

• fixedValueFvPatchField.H
• waveModel.H

Further information

Tutorial:

• cnoidal

Source code:

• waveAlpha

API:

• Foam::waveAlphaFvPatchScalarField

History: Introduced in version v1612+