This boundary condition provides a waveAlpha condition. This sets the phase fraction to that specified by a superposition of wave models. All the wave modelling parameters are obtained from a centrally registered waveSuperposition class. More...

Inheritance diagram for waveAlphaFvPatchScalarField:

[legend]

Collaboration diagram for waveAlphaFvPatchScalarField:

[legend]

Public Member Functions
	TypeName ("waveAlpha")
	Runtime type information. More...

	waveAlphaFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, fvMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	waveAlphaFvPatchScalarField (const waveAlphaFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, fvMesh > &, const fieldMapper &)
	Construct by mapping given fixedValueTypeFvPatchField onto a new. More...

	waveAlphaFvPatchScalarField (const waveAlphaFvPatchScalarField &)=delete
	Disallow copy without setting internal field reference. More...

	waveAlphaFvPatchScalarField (const waveAlphaFvPatchScalarField &, const DimensionedField< scalar, fvMesh > &)
	Copy constructor setting internal field reference. More...

virtual tmp< fvPatchScalarField >	clone (const DimensionedField< scalar, fvMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

bool	liquid () const
	Access the liquid flag. More...

const fvMeshSubset &	faceCellSubset () const
	Access the face-cell subset. More...

tmp< scalarField >	alpha (const scalar t) const
	Return the current modelled phase fraction field on the patch. More...

tmp< scalarField >	alphan (const scalar t) const
	Return the current modelled phase fraction field in the. More...

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

virtual void	write (Ostream &) const
	Write. More...

Detailed Description

This boundary condition provides a waveAlpha condition. This sets the phase fraction to that specified by a superposition of wave models. All the wave modelling parameters are obtained from a centrally registered waveSuperposition class.

Usage

Property	Description	Required?	Default
`phi`	Name of the flux field	no	phi
`liquid`	Is the alpha field that of the liquid?	no	true

Example of the boundary condition specification:

    <patchName>
    {
        type        waveAlpha;
        libs        ("libwaves.so");
        liquid      true;
    }

See also: Foam::waveSuperposition

Source files

Definition at line 89 of file waveAlphaFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ waveAlphaFvPatchScalarField() [1/4]

waveAlphaFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, fvMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 34 of file waveAlphaFvPatchScalarField.C.

References dict, DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), and p.

Referenced by waveAlphaFvPatchScalarField::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ waveAlphaFvPatchScalarField() [2/4]

waveAlphaFvPatchScalarField	(	const waveAlphaFvPatchScalarField &	ptf,
		const fvPatch &	p,
		const DimensionedField< scalar, fvMesh > &	iF,
		const fieldMapper &	mapper
	)