This boundary condition provides a waveVelocity condition. This sets the velocity to that specified by a superposition of wave models. The corresponding phase fraction condition looks this condition up and re-uses the wave modelling. More...

Inheritance diagram for waveVelocityFvPatchVectorField:

[legend]

Collaboration diagram for waveVelocityFvPatchVectorField:

[legend]

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

	waveVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
	Construct from patch and internal field. More...

	waveVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	waveVelocityFvPatchVectorField (const waveVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given mixedTypeFvPatchField onto a new patch. More...

	waveVelocityFvPatchVectorField (const waveVelocityFvPatchVectorField &)
	Construct as copy. More...

virtual tmp< fvPatchVectorField >	clone () const
	Construct and return a clone. More...

	waveVelocityFvPatchVectorField (const waveVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< fvPatchVectorField >	clone (const DimensionedField< vector, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

const waveSuperposition &	waves () const
	Access the wave models. More...

tmp< vectorField >	U () const
	Return the current modelled velocity field. 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 waveVelocity condition. This sets the velocity to that specified by a superposition of wave models. The corresponding phase fraction condition looks this condition up and re-uses the wave modelling.

Usage

Property	Description	Req'd?	Default
`origin`	origin of the wave coordinate system	yes
`direction`	direction of the mean flow	yes
`speed`	speed of the mean flow	yes
`waves`	list of wave models to superimpose	yes
`scale`	scale factor along the mean flow direction	no	None
`crossScale`	scale factor across the mean flow direction	no	None

Example of the boundary condition specification:

    <patchName>
    {
        type        waveVelocity;
        origin      (0 25 0);
        direction   (1 0 0);
        speed       2;
        waves
        (
            Airy
            {
                length      40;
                amplitude   0.5;
                phase       0;
                angle       0;
            }
            Airy
            {
                length      20;
                amplitude   0.25;
                phase       1.5708;
                angle       0;
            }
        );
        scale       table ((100 1) (200 0));
        crossScale  constant 1;
    }

Source files

Definition at line 131 of file waveVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ waveVelocityFvPatchVectorField() [1/5]

waveVelocityFvPatchVectorField	(	const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 35 of file waveVelocityFvPatchVectorField.C.

References Foam::Zero.

Referenced by waveVelocityFvPatchVectorField::clone(), and waveVelocityFvPatchVectorField::waveVelocityFvPatchVectorField().

Here is the caller graph for this function:

◆ waveVelocityFvPatchVectorField() [2/5]

waveVelocityFvPatchVectorField	(	const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 50 of file waveVelocityFvPatchVectorField.C.

References dictionary::found(), fvPatch::size(), vectorField(), waveVelocityFvPatchVectorField::waveVelocityFvPatchVectorField(), and Foam::Zero.

Here is the call graph for this function:

◆ waveVelocityFvPatchVectorField() [3/5]

waveVelocityFvPatchVectorField	(	const waveVelocityFvPatchVectorField &	ptf,
		const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)