Public Member Functions | List of all members
waveDisplacementPointPatchVectorField Class Reference

Specified surface wave moving boundary. More...

Inheritance diagram for waveDisplacementPointPatchVectorField:
Inheritance graph
[legend]
Collaboration diagram for waveDisplacementPointPatchVectorField:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("waveDisplacement")
 Runtime type information. More...
 
 waveDisplacementPointPatchVectorField (const pointPatch &, const DimensionedField< vector, pointMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 waveDisplacementPointPatchVectorField (const waveDisplacementPointPatchVectorField &, const pointPatch &, const DimensionedField< vector, pointMesh > &, const fieldMapper &)
 Construct by mapping given patchField<vector> onto a new patch. More...
 
 waveDisplacementPointPatchVectorField (const waveDisplacementPointPatchVectorField &, const DimensionedField< vector, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual autoPtr< pointPatchVectorField > clone (const DimensionedField< vector, pointMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Detailed Description

Specified surface wave moving boundary.

The motion is a cosine wave with specified amplitude, frequency, wave number and optional leading and trailing spatial ramps and temporal ramp to allow the motion to be applied to an initially flat surface.

Usage
Property Description Required Default value
amplitude Amplitude of the cosine wave yes
omega Frequency of the cosine wave yes
waveNumber Wave number of the cosine wave no (0 0 0)
startRamp Leading ramp no 1
endRamp Trailing ramp no 1
timeRamp Temporal ramp no 1

Example of the boundary condition specification: 

    <patchName>
    {
        type            waveDisplacement;
        value           uniform (0 0 0);
        amplitude       (0 0.05 0);
        omega           2;
        waveNumber      (5 0 0);
        startRamp
        {
            type            linearRamp;
            duration        1;
            start           4;
        }
        endRamp
        {
            type            linearRamp;
            duration        1;
            start           4;
        }
        timeRamp
        {
            type            linearRamp;
            duration        1;
        }
    }
Source files

Definition at line 129 of file waveDisplacementPointPatchVectorField.H.

Constructor & Destructor Documentation

◆ waveDisplacementPointPatchVectorField() [1/3]

waveDisplacementPointPatchVectorField ( const pointPatch &  p,
const DimensionedField< vector, pointMesh > &  iF,
const dictionary &  dict 
)

Construct from patch, internal field and dictionary.

Definition at line 34 of file waveDisplacementPointPatchVectorField.C.

References dict, and waveDisplacementPointPatchVectorField::updateCoeffs().

Here is the call graph for this function:

◆ waveDisplacementPointPatchVectorField() [2/3]

waveDisplacementPointPatchVectorField ( const waveDisplacementPointPatchVectorField &  ptf,
const pointPatch &  p,
const DimensionedField< vector, pointMesh > &  iF,
const fieldMapper &  mapper 
)

Construct by mapping given patchField<vector> onto a new patch.

Definition at line 84 of file waveDisplacementPointPatchVectorField.C.

◆ waveDisplacementPointPatchVectorField() [3/3]

waveDisplacementPointPatchVectorField ( const waveDisplacementPointPatchVectorField &  ptf,
const DimensionedField< vector, pointMesh > &  iF 
)

Construct as copy setting internal field reference.

Definition at line 100 of file waveDisplacementPointPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "waveDisplacement"  )

Runtime type information.

◆ clone()

virtual autoPtr<pointPatchVectorField> clone ( const DimensionedField< vector, pointMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 182 of file waveDisplacementPointPatchVectorField.H.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 116 of file waveDisplacementPointPatchVectorField.C.

References Foam::cos(), mesh, points, List< T >::size(), fvMesh::time(), and dimensioned< Type >::value().

Referenced by waveDisplacementPointPatchVectorField::waveDisplacementPointPatchVectorField().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 146 of file waveDisplacementPointPatchVectorField.C.

References Foam::isType(), pointPatchField< Type >::write(), and Foam::writeEntry().

Here is the call graph for this function:
The documentation for this class was generated from the following files: